-
-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support retriable Chelonia actions (#1768)
* Fix return value in 'chelonia/db/set' * Add chelonia/persistent-actions.js * Apply review * Make '/load' call '/retryAll' * Make trySBP async * Emit events on action success and failure * Use .checkDatabaseKey rather than .ready * Pause and unload persistent actions on logout * Add persistent-actions.test.js * Improve persistent action tests
- Loading branch information
1 parent
3200d25
commit bba9016
Showing
5 changed files
with
474 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,238 @@ | ||
| 'use strict' | ||
|
|
||
| import sbp from '@sbp/sbp' | ||
| import '@sbp/okturtles.events' | ||
| import { PERSISTENT_ACTION_FAILURE, PERSISTENT_ACTION_SUCCESS, PERSISTENT_ACTION_TOTAL_FAILURE } from './events.js' | ||
|
|
||
| type SbpInvocation = any[] | ||
| type UUIDV4 = string | ||
|
|
||
| type PersistentActionOptions = { | ||
| errorInvocation?: SbpInvocation, | ||
| // Maximum number of tries, default: Infinity. | ||
| maxAttempts: number, | ||
| // How many seconds to wait between retries. | ||
| retrySeconds: number, | ||
| skipCondition?: SbpInvocation, | ||
| totalFailureInvocation?: SbpInvocation | ||
| } | ||
|
|
||
| type PersistentActionStatus = {| | ||
| attempting: boolean, | ||
| failedAttemptsSoFar: number, | ||
| lastError: string, | ||
| nextRetry: string, | ||
| resolved: boolean | ||
| |} | ||
|
|
||
| const coerceToError = (arg: any): Error => { | ||
| if (arg && arg instanceof Error) return arg | ||
| console.warn(tag, 'Please use Error objects when throwing or rejecting') | ||
| return new Error((typeof arg === 'string' ? arg : JSON.stringify(arg)) ?? 'undefined') | ||
| } | ||
|
|
||
| const defaultOptions = { | ||
| maxAttempts: Number.POSITIVE_INFINITY, | ||
| retrySeconds: 30 | ||
| } | ||
| const tag = '[chelonia.persistentActions]' | ||
|
|
||
| class PersistentAction { | ||
| id: UUIDV4 | ||
| invocation: SbpInvocation | ||
| options: PersistentActionOptions | ||
| status: PersistentActionStatus | ||
| timer: TimeoutID | void | ||
|
|
||
| constructor (invocation: SbpInvocation, options: PersistentActionOptions = {}) { | ||
| // $FlowFixMe: Cannot resolve name `crypto`. | ||
| this.id = crypto.randomUUID() | ||
| this.invocation = invocation | ||
| this.options = { ...defaultOptions, ...options } | ||
| this.status = { | ||
| attempting: false, | ||
| failedAttemptsSoFar: 0, | ||
| lastError: '', | ||
| nextRetry: '', | ||
| resolved: false | ||
| } | ||
| } | ||
|
|
||
| async attempt (): Promise<void> { | ||
| // Bail out if the action is already attempting or resolved. | ||
| // TODO: should we also check whether the skipCondition call is pending? | ||
| if (this.status.attempting || this.status.resolved) return | ||
| if (await this.trySBP(this.options.skipCondition)) this.cancel() | ||
| // We need to check this again because cancel() could have been called while awaiting the trySBP call. | ||
| if (this.status.resolved) return | ||
| try { | ||
| this.status.attempting = true | ||
| const result = await sbp(...this.invocation) | ||
| this.status.attempting = false | ||
| this.handleSuccess(result) | ||
| } catch (error) { | ||
| this.status.attempting = false | ||
| await this.handleError(coerceToError(error)) | ||
| } | ||
| } | ||
|
|
||
| cancel (): void { | ||
| this.timer && clearTimeout(this.timer) | ||
| this.status.nextRetry = '' | ||
| this.status.resolved = true | ||
| } | ||
|
|
||
| async handleError (error: Error): Promise<void> { | ||
| const { id, options, status } = this | ||
| // Update relevant status fields before calling any optional code. | ||
| status.failedAttemptsSoFar++ | ||
| status.lastError = error.message | ||
| const anyAttemptLeft = options.maxAttempts > status.failedAttemptsSoFar | ||
| if (!anyAttemptLeft) status.resolved = true | ||
| status.nextRetry = anyAttemptLeft && !status.resolved | ||
| ? new Date(Date.now() + options.retrySeconds * 1e3).toISOString() | ||
| : '' | ||
| // Perform any optional SBP invocation. | ||
| // The event has to be fired first for the action to be immediately removed from the list. | ||
| sbp('okTurtles.events/emit', PERSISTENT_ACTION_FAILURE, { error, id }) | ||
| await this.trySBP(options.errorInvocation) | ||
| if (!anyAttemptLeft) { | ||
| sbp('okTurtles.events/emit', PERSISTENT_ACTION_TOTAL_FAILURE, { error, id }) | ||
| await this.trySBP(options.totalFailureInvocation) | ||
| } | ||
| // Schedule a retry if appropriate. | ||
| if (status.nextRetry) { | ||
| // Note: there should be no older active timeout to clear. | ||
| this.timer = setTimeout(() => this.attempt(), this.options.retrySeconds * 1e3) | ||
| } | ||
| } | ||
|
|
||
| handleSuccess (result: any): void { | ||
| const { id, status } = this | ||
| status.lastError = '' | ||
| status.nextRetry = '' | ||
| status.resolved = true | ||
| sbp('okTurtles.events/emit', PERSISTENT_ACTION_SUCCESS, { id, result }) | ||
| } | ||
|
|
||
| async trySBP (invocation: SbpInvocation | void): Promise<any> { | ||
| try { | ||
| return invocation ? await sbp(...invocation) : undefined | ||
| } catch (error) { | ||
| console.error(tag, coerceToError(error).message) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // SBP API | ||
|
|
||
| sbp('sbp/selectors/register', { | ||
| 'chelonia.persistentActions/_init' (): void { | ||
| this.actionsByID = Object.create(null) | ||
| this.checkDatabaseKey = () => { | ||
| if (!this.databaseKey) throw new TypeError(`${tag} No database key configured`) | ||
| } | ||
| sbp('okTurtles.events/on', PERSISTENT_ACTION_SUCCESS, ({ id }) => { | ||
| sbp('chelonia.persistentActions/cancel', id) | ||
| }) | ||
| sbp('okTurtles.events/on', PERSISTENT_ACTION_TOTAL_FAILURE, ({ id }) => { | ||
| sbp('chelonia.persistentActions/cancel', id) | ||
| }) | ||
| }, | ||
|
|
||
| // Cancels a specific action by its ID. | ||
| // The action won't be retried again, but an async action cannot be aborted if its promise is stil attempting. | ||
| 'chelonia.persistentActions/cancel' (id: UUIDV4): void { | ||
| if (id in this.actionsByID) { | ||
| this.actionsByID[id].cancel() | ||
| delete this.actionsByID[id] | ||
| // Likely no need to await this call. | ||
| sbp('chelonia.persistentActions/save') | ||
| } | ||
| }, | ||
|
|
||
| // TODO: validation | ||
| 'chelonia.persistentActions/configure' ({ databaseKey, options = {} }: { databaseKey: string; options: Object }): void { | ||
| this.databaseKey = databaseKey | ||
| for (const key in options) { | ||
| if (key in defaultOptions) { | ||
| defaultOptions[key] = options[key] | ||
| } else { | ||
| throw new TypeError(`${tag} Unknown option: ${key}`) | ||
| } | ||
| } | ||
| }, | ||
|
|
||
| 'chelonia.persistentActions/enqueue' (...args): UUIDV4[] { | ||
| const ids: UUIDV4[] = [] | ||
| for (const arg of args) { | ||
| const action = Array.isArray(arg) | ||
| ? new PersistentAction(arg) | ||
| : new PersistentAction(arg.invocation, arg) | ||
| this.actionsByID[action.id] = action | ||
| ids.push(action.id) | ||
| } | ||
| // Likely no need to await this call. | ||
| sbp('chelonia.persistentActions/save') | ||
| for (const id of ids) this.actionsByID[id].attempt() | ||
| return ids | ||
| }, | ||
|
|
||
| // Forces retrying a given persisted action immediately, rather than waiting for the scheduled retry. | ||
| // - 'status.failedAttemptsSoFar' will still be increased upon failure. | ||
| // - Does nothing if a retry is already running. | ||
| // - Does nothing if the action has already been resolved, rejected or cancelled. | ||
| 'chelonia.persistentActions/forceRetry' (id: UUIDV4): void { | ||
| if (id in this.actionsByID) { | ||
| this.actionsByID[id].attempt() | ||
| } | ||
| }, | ||
|
|
||
| // Loads and tries every stored persistent action under the configured database key. | ||
| async 'chelonia.persistentActions/load' (): Promise<void> { | ||
| this.checkDatabaseKey() | ||
| const storedActions = JSON.parse((await sbp('chelonia/db/get', this.databaseKey)) ?? '[]') | ||
| for (const { id, invocation, options } of storedActions) { | ||
| this.actionsByID[id] = new PersistentAction(invocation, options) | ||
| // Use the stored ID instead of the autogenerated one. | ||
| // TODO: find a cleaner alternative. | ||
| this.actionsByID[id].id = id | ||
| } | ||
| sbp('chelonia.persistentActions/retryAll') | ||
| }, | ||
|
|
||
| // Retry all existing persisted actions. | ||
| // TODO: add some delay between actions so as not to spam the server, | ||
| // or have a way to issue them all at once in a single network call. | ||
| 'chelonia.persistentActions/retryAll' (): void { | ||
| for (const id in this.actionsByID) { | ||
| sbp('chelonia.persistentActions/forceRetry', id) | ||
| } | ||
| }, | ||
|
|
||
| // Updates the database version of the attempting action list. | ||
| 'chelonia.persistentActions/save' (): Promise<Error | void> { | ||
| this.checkDatabaseKey() | ||
| return sbp( | ||
| 'chelonia/db/set', | ||
| this.databaseKey, | ||
| JSON.stringify(Object.values(this.actionsByID)) | ||
| ) | ||
| }, | ||
|
|
||
| 'chelonia.persistentActions/status' () { | ||
| return Object.values(this.actionsByID) | ||
| // $FlowFixMe: `PersistentAction` is incompatible with mixed | ||
| .map((action: PersistentAction) => ({ id: action.id, invocation: action.invocation, ...action.status })) | ||
| }, | ||
|
|
||
| // Pauses every currently loaded action, and removes them from memory. | ||
| // Note: persistent storage is not affected, so that these actions can be later loaded again and retried. | ||
| 'chelonia.persistentActions/unload' (): void { | ||
| for (const id in this.actionsByID) { | ||
| // Clear the action's timeout, but don't cancel it so that it can later resumed. | ||
| this.actionsByID[id].timer && clearTimeout(this.actionsByID[id].timer) | ||
| delete this.actionsByID[id] | ||
| } | ||
| } | ||
| }) |
Oops, something went wrong.