NotetypeId is defined upstream in models.py.
Since we may not convert Models.java, using the definition from PythonTypes is
the best solution.
Those variables were found by searching for "mid: Long" and "odelId: Long".
https://github.com/ankidroid/Anki-Android/pull/11849#issuecomment-1211775736
Android's onCreateOptionsMenu does not play well with coroutines, as
it expects the menu to have been fully configured by the time the routine
returns. This results in flicker, as the menu gets blanked out, and then
configured a moment later when the coroutine runs. To work around this,
the current state is stored in the deck picker, so that we can redraw the
menu immediately, and then make any potential changes in the background.
Other changes:
- refactored onCreateOptionsMenu to make it simpler
- instead of the sdCardAvailable checks (which I assume is a proxy for
"col is available"), the entire menu is wrapped in a group, and the
visibility of the group is toggled depending on whether the col is available
or not. This also fixes the error on a full sync.
- there are three sets of unit tests (one for search icon, one for sync icon,
one for entire menu) that have been a pain since I originally introduced
this PR, and and I've sunk a number of hours into trying to get them to work
properly at this point. The issue appears to be that when mixing coroutine
calls and invalidateOptionsMenu(), onCreateOptionsMenu() is not getting called
before trying to await the job, leading to a hang or stale data. I tried
advancing robolectric, but it did not help. Maybe someone more experienced
in this area can figure it out, but for now I've changed these routines
to be more of a unit test and less of an integration test: rather than
checking the menu itself, they directly invoke the function that updates
the menu state, and check the state instead. This takes onCreateOptionsMenu()
out of the loop, and avoids the problems (and probably allows these tests
to be re-enabled on Windows as well). The sync tests I've removed, as the
entire menu is hidden/shown now when the col is closed, so they are redundant.
Currently there are many instances in the AnkiDroid codebase where
the collection is accessed a) on the UI thread, blocking the UI, and
b) in unsafe ways (eg by checking to see if the collection is open,
and then assuming it will remain open for the rest of a method call.
"Fix full download crashing in new schema case" (159a108dcb) demonstrates
a few of these cases.
This PR is an attempt at addressing those issues. It introduces
a `withCol` function that is intended to be used instead of
CollectionHelper.getCol(). For example, code that previously looked
like:
val col = CollectionHelper.getInstance().getCol(this)
val count = col.decks.count()
Can now be used like this:
val count = withCol { decks.count() }
The block is run on a background thread, and other withCol calls made
in parallel will be queued up and executed sequentially. Because of
the exclusive access, routines can safely close and reopen the
collection inside the block without fear of affecting other callers.
It's not practical to update all the legacy code to use withCol
immediately - too much work is required, and coroutines are not
accessible from Java code. The intention here is that this new path is
gradually bought into. Legacy code can continue calling CollectionHelper.
getCol(), which internally delegates to CollectionManager.
Two caveats to be aware of:
- Legacy callers will wait for other pending operations to complete
before they receive the collection handle, but because they retain it,
subsequent access is not guaranteed to be exclusive.
- Because getCol() and colIsOpen() are often used on the main thread,
they will block the UI if a background operation is already running.
Logging has been added to help diagnose this, eg messages like:
E/CollectionManager: blocked main thread for 2626ms:
com.ichi2.anki.DeckPicker.onCreateOptionsMenu(DeckPicker.kt:624)
Other changes:
- simplified CoroutineHelpers
- added TR function for accessing translations without a col reference
- onCreateOptionsMenu() needed refactoring to avoid blocking the UI.
- The blocking colIsOpen() call in onPrepareOptionsMenu() had to be
removed. I can not reproduce the issue it reports, and the code checks
for col in onCreateOptionsMenu().
- The subscribers in ChangeManager need to be cleared out at the start
of each test, or two tests are flaky when run with the new schema.
CardId is defined in cards.py upstream. Since Cards.java may not be converted,
Consts.kt may be the better place for it.
Values were found by searching "cid: Long" and "ardId: Long".
Ideally, one fragment should call other fragments by the common parent activity, not directly.
This reduces the code duplication and organizes better the classes' responsibilities.
1. Fix/Simplify "Third-party API apps" configuration
- It crashed if the user's browser couldn't handle the link. Tested it by setting "MX player" (a video player that can be found on play store) as my browser.
- And as we already have a method that handles the lack of a browser that doesn't crash, just reuse it
2. Move `removeUnnecessaryAdvancedPrefs` to the top of `initSubscreen`, just to make it more visible
So the user can search preferences from any screen
Changes' description:
- Move the search bar configuration from HeaderFragment.kt to the preferences activity
- a change made to it was disabling the search history, as it was poor
- Remove the previous SearchPreference bar
- Embed the searchBar by creating a new menu (preferences.xml) and a new SearchView (PreferencesSearchView)
It's necessary for all "PreferenceScreen" to have keys, so they are being added to the screens which hadn't a key
search:ignore is an attribute that allows to skip a preference indexing on a XML file. It is added to subscreens' preferences to avoid duplication of the results of the screens themselves and the preferences that open them
Added as well to "Day" and "Night" preferences to avoid duplication of their entries and "Theme" preference's entries
It's used upstream. It was defined in notes.py, but since Notes.java may not get
converted, consts is the most relevant place to put it.
Those ones were found by searching for "nodeId: Long", "NoteId: Long" and "nid:
Long".
- rename "formattedSummary" to "summaryFormat"
- simplify SeekBarPreferenceCompat and NumberRangePreferenceCompat constructors and declare styleable attributes for "useSimpleSummaryProvider" and "summaryFormat" so they can be previewed on Android Studio's layout viewer
