Download db

[catreedle]

Contributor checklist

• This pull request is on a separate branch and not the main branch
• I have tested my code with the ./gradlew lintKotlin detekt test command as directed in the testing section of the contributing guide

---

Description

This PR adds call to Scribe-Server API and write the response into SQLite database for the download language functionality.

• API calls to Scribe-Server being made when the user presses the download data or update data buttons within the download UI
  • If the user already has data, then only the data with last updated date above that of the current data is called
  • If the user has no data, then the full dataset would be called
• The response being received and then inserting the resulting data into the SQLite database for the language in which the download data or update data button was pressed
• The UI elements of the download UI matching the status of the request (download/update data, downloading, up to date)
• Any final work to make sure that any noun or verb based processes are running off of the new database with contracts

New Files:

• ApiService.kt, RetrofitClient.kt: Retrofit API client setup
• DynamicDbHelper.kt: Creates SQLite tables dynamically from API contract and inserts data
• DataResponse.kt, DataVersionResponse.kt: API response models

Changes:

• DataDownloadViewModel.kt: Introduces and centralizes download/update behavior:
  • initializeStates: Initializes language download states based on persisted update timestamps and triggers update checks on app launch
  • handleDownloadAction: Entry point for all download actions. Handles state transitions, cancels jobs, fetches data from the API, writes to SQLite, and persists update timestamps.
  • checkForUpdates, checkAllForUpdates: Uses the data version endpoint to determine whether newer server data exists and updates the UI state
  • isUpdateAvailable: Compares local and server timestamps to determine update availability.
• DataDownloadScreen.kt:
  • Added LaunchedEffect to restore states on launch
  • "Check for new data" toggle now calls checkAllForUpdates
• SelectLanguageScreen.kt: Add forceDownload parameter to download action, triggers download with redirect to Download screen on translation source change.
• App.kt: Pass ViewModel functions to screen composables.
• SettingsUtil.kt: Fix keyboard check to use context.packageName instead of hardcoded value.
• build.gradle.kts, AndroidManifest.xml: Adds Retrofit dependencies and network permissions.

Related issue

• Make data request API call to Scribe-Server and insert resulting data into SQLite tables #547

[github-actions]

Thank you for the pull request! 💙

The Scribe-Android team will do our best to address your contribution as soon as we can. If you're not already a member of our public Matrix community, please consider joining! We'd suggest that you use the Element client as well as Element X for a mobile app, and definitely join the General and Android rooms once you're in. Also consider attending our bi-weekly Saturday dev syncs. It'd be great to meet you 😊

Note

Scribe uses Conventional Comments in reviews to make sure that communication is as clear as possible.

[github-actions]

Maintainer Checklist

The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

• Tests for changes have been written and the unit test, linting and formatting workflows within the PR checks do not indicate new errors in the files changed

  • Tests may need to be reran as they're at times not deterministic

• The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

[andrewtavis]

note @catreedle: The above commits have added the final working versions of the contracts. Could you integrate them and delete the JSON versions of the contracts in this PR? Please let us know if you're having issues with them!

[catreedle]

note @catreedle: The above commits have added the final working versions of the contracts. Could you integrate them and delete the JSON versions of the contracts in this PR? Please let us know if you're having issues with them!

sure @andrewtavis. Thank you!

[catreedle]

I have integrated to using YAML contracts and deleted the JSON contract @andrewtavis. It is working as expected aside from this issue.

[andrewtavis]

Amazing, @catreedle! Thanks for the quick work here :)

[andrewtavis]

@angrezichatterbox, @DeleMike: Would you two have a moment to look this over?

[angrezichatterbox]

@andrewtavis What was the all languages download button supposed to do ?

[andrewtavis]

It was supposed to make a request for all the languages that the user has installed - so trigger all of the individual downloads.

[angrezichatterbox]

It was supposed to make a request for all the languages that the user has installed - so trigger all of the individual downloads.

That doesn't work right now when I tried.

[catreedle]

It was supposed to make a request for all the languages that the user has installed - so trigger all of the individual downloads.

That doesn't work right now when I tried.

I have not implemented that functionality. I will notify here when I have. :)

[andrewtavis]

Contracts are updated here now, @catreedle! Please let us know if you have any questions about them! Once the functionality is updated to use all data based on the order of the indexes we'll be able to bring this in! 😊

[andrewtavis]

Note @angrezichatterbox and @DeleMike: In the sync we realized we needed one (hopefully) final update of the contracts. We now have all conjugations and declensions being fully indexed, which allows us to explicitly place them in specific fields of the tables. We don't need to sort any response from the contracts. be39d68 has the changes 😊

[andrewtavis]

And just checking, @catreedle: Plan for this is that we first merge in this PR, and then we can work on bringing in #550?