feat: add retry-after-limit (#6)

* feat: add throttled-retry and onStatusChange

* fix: throttledRetry

* chore: format

* chore: retry-after more second

* revert: remove onStatusChange

* revert: remove SignAddonStatus

* chore: rename to retry-after-limit

* chore: remove AMOClientExtra

* chore: comment

Author: sylingd

README.md

@@ -39,7 +39,8 @@ $ npx amo-upload \
   --addon-version $VERSION \
   --channel listed \
   --dist-file path/to/dist.zip \
-  --source-file path/to/source.zip
+  --source-file path/to/source.zip \
+  --retry-after-limit 120 \
   --output path/to/my-ext-v1.2.3.xpi
 ```
 
@@ -75,6 +76,7 @@ try {
     channel: 'listed',
     distFile: 'path/to/dist.zip',
     sourceFile: 'path/to/source.zip',
+    retryAfterLimit: 120,
     output: 'path/to/my-ext-v1.2.3.xpi',
   });
   console.info('The signed file is stored at:', output);

src/bin.ts

@@ -59,6 +59,10 @@ This command could be run multiple times to check the status, and the version wi
     '--compatibility <jsonString>',
     'the compatibility info as a JSON string, e.g. `["android","firefox"]`',
   )
+  .option(
+    '--retry-after-limit <maxTime>',
+    'when a throttled error occurs, if a retry is possible within this parameter, the request will wait for a certain period before being re-requested. e.g. 120',
+  )
   .option('--output <output>', 'the file path to save the signed XPI file')
   .option('--verbose', 'show verbose logs')
   .action(
@@ -68,6 +72,10 @@ This command could be run multiple times to check the status, and the version wi
         ...command.optsWithGlobals(),
       };
       verifyKeys(options, ['apiKey', 'apiSecret', 'addonId', 'addonVersion']);
+      let retryAfterLimit = Number(options.retryAfterLimit);
+      if (Number.isNaN(retryAfterLimit)) {
+        retryAfterLimit = 0;
+      }
       const downloadedFile = await signAddon({
         apiKey: options.apiKey as string,
         apiSecret: options.apiSecret as string,
@@ -84,6 +92,7 @@ This command could be run multiple times to check the status, and the version wi
         compatibility: options.compatibility
           ? (JSON.parse(options.compatibility) as CompatibilityInfo)
           : undefined,
+        retryAfterLimit,
         output: options.output as string,
         onDebug: getLogHandler(options.verbose as boolean),
       });

src/index.ts

@@ -79,15 +79,25 @@ export class AMOClient {
     });
   }
 
-  private async request<T = unknown>(url: string, opts?: RequestInit) {
+  private async request<T = unknown>(url: string, opts?: RequestInit): Promise<T> {
     this.options.onDebug?.('request-start', {
       method: opts?.method || 'GET',
       url,
     });
     const res = await this.fetch(this.apiUrlPrefix + url, opts);
     const data = (await res.json()) as T;
     this.options.onDebug?.('request-end', { url, status: res.status });
-    if (!res.ok) throw { res, data };
+    if (!res.ok) {
+      if (res.headers.has('retry-after') && this.options.retryAfterLimit && this.options.retryAfterLimit > 0) {
+        const after = Number(res.headers.get('retry-after'));
+        if (!Number.isNaN(after) && after <= this.options.retryAfterLimit) {
+          // wait one more second
+          await setTimeout(after * 1000 + 1000);
+          return this.request<T>(url, opts);
+        }
+      }
+      throw { res, data };
+    }
     return data;
   }
 

src/types.ts

@@ -35,6 +35,8 @@ export type AMOClientActions =
 
 export interface AMOClientOptions {
   onDebug?: (type: AMOClientActions, payload?: unknown) => void;
+  /** When a throttled error occurs, if a retry is possible within this parameter, the system will wait until that time before retrying. */
+  retryAfterLimit?: number;
 }
 
 export interface FileInfo {