kobotoolbox / kpi

kpi is the (frontend) server for KoboToolbox. It includes an API for users to access data and manage their forms, question library, sharing settings, create reports, and export data.
https://www.kobotoolbox.org
GNU Affero General Public License v3.0
131 stars 177 forks source link

[TASK-541] Automatic transcriptions now request status with exponential backoff #4976

Closed duvld closed 3 months ago

duvld commented 3 months ago

Checklist

  1. [ ] If you've added code that should be tested, add tests
  2. [ ] If you've changed APIs, update (or create!) the documentation
  3. [ ] Ensure the tests pass
  4. [x] Make sure that your code lints and that you've followed our coding style
  5. [x] Write a title and, if necessary, a description of your work suitable for publishing in our release notes
  6. [x] Mention any related issues in this repository (as #ISSUE) and in other repositories (as kobotoolbox/other#ISSUE)
  7. [ ] Open an issue in the docs if there are UI/UX changes

Description

Before we sent requests to check on the status of an automatic transcription every 5 seconds on repeat. We now do it with exponential backoff.

Notes

The function responsible for exponential backoff has been refactored out of exportFetcher.tsx to utils.ts. To get around the circular dependency of importing envStore into utils.ts we now require the user to import envStore along with the function and pass down the min/max values that way.

The timing of the backoff should probably be adjusted in the future. Most transcription would not have any significant updates when the expo backoff is still firing faster (when it's 2, 4, 8 seconds in).

notion-workspace[bot] commented 3 months ago

Make exponential backoff from ExportFetcher more generic and use it with automatic transcriptions