refactor: update fetcher interface to support retries

well-known-components · May 5, 2023 · cb8324b · cb8324b
1 parent 22f0edb
commit cb8324b
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 5 deletions.
diff --git a/etc/interfaces.api.md b/etc/interfaces.api.md
@@ -64,10 +64,10 @@ export interface IDatabase {
     query<T extends Record<string, any>>(sql: string): Promise<IDatabase.IQueryResult<T>>;
 }
 
-// @alpha (undocumented)
+// @public (undocumented)
 export type IFetchComponent = {
     fetch(url: fetch_2.Request): Promise<fetch_2.Response>;
-    fetch(url: fetch_2.RequestInfo, init?: fetch_2.RequestInit): Promise<fetch_2.Response>;
+    fetch(url: fetch_2.RequestInfo, init?: RequestOptions): Promise<fetch_2.Response>;
 };
 
 // @alpha (undocumented)
@@ -372,6 +372,14 @@ export namespace Lifecycle {
     export function run<Components extends Record<string, any>>(config: ProgramConfig<Components>): PromiseLike<ComponentBasedProgram<Components>>;
 }
 
+// @public (undocumented)
+export type RequestOptions = fetch_2.RequestInit & {
+    abortController?: AbortController;
+    timeout?: number;
+    attempts?: number;
+    retryDelay?: number;
+};
+
 // @public (undocumented)
 export type Trace = Pick<TraceContext, "traceId" | "version" | "parentId" | "traceFlags">;
 

diff --git a/src/components/fetcher.ts b/src/components/fetcher.ts
@@ -1,9 +1,19 @@
 import * as fetch from "node-fetch"
 
 /**
- * @alpha
+ * @public
+ */
+export type RequestOptions = fetch.RequestInit & {
+  abortController?: AbortController
+  timeout?: number
+  attempts?: number
+  retryDelay?: number
+}
+
+/**
+ * @public
  */
 export type IFetchComponent = {
   fetch(url: fetch.Request): Promise<fetch.Response>
-  fetch(url: fetch.RequestInfo, init?: fetch.RequestInit): Promise<fetch.Response>
-}
+  fetch(url: fetch.RequestInfo, init?: RequestOptions): Promise<fetch.Response>
+}