RAI-10177 add abort signal pollTransaction (#83)

* RAI-10177 add abort signal to poll transaction api

* add abort signal to all get apis

* add abort signal to all apis

* fix tests

* revert

* refactor

* refactor

* export AbortError in index

Author: OsamaSBCrea

index.web.ts

@@ -23,7 +23,12 @@ export * from './src/api/transaction/types';
 export * from './src/api/user/types';
 export * from './src/credentials';
 export type { SdkError } from './src/errors';
-export { ApiError, MaxRelationSizeError, TransactionError } from './src/errors';
+export {
+  AbortError,
+  ApiError,
+  MaxRelationSizeError,
+  TransactionError,
+} from './src/errors';
 export * from './src/proto/generated/message';
 export * from './src/proto/generated/schema';
 export * from './src/results/resultTable';

src/errors.ts

@@ -82,7 +82,20 @@ export class MaxRelationSizeError extends Error {
   }
 }
 
+export class AbortError extends Error {
+  constructor(message?: string) {
+    super(message);
+
+    this.name = 'AbortError';
+  }
+
+  toString() {
+    return this.message ?? this.name;
+  }
+}
+
 export type SdkError =
+  | AbortError
   | ApiError
   | TransactionError
   | MaxRelationSizeError

src/rest.ts

@@ -16,7 +16,7 @@
 
 import { stringify } from 'query-string';
 
-import { makeError } from './errors';
+import { AbortError, makeError } from './errors';
 import { getFetch, Response } from './fetch.node';
 import { ApiResponse, VERSION } from './types';
 
@@ -37,6 +37,7 @@ export type PollOptions = {
   overheadRate?: number;
   maxInterval?: number;
   timeout?: number;
+  signal?: AbortSignal;
 };
 
 export type PollingResult<T> = {
@@ -173,6 +174,11 @@ export async function pollWithOverhead<T = void>(
   return new Promise<T>((resolve, reject) => {
     const poll = (delay: number) => {
       setTimeout(async () => {
+        if (options?.signal?.aborted) {
+          reject(new AbortError());
+          return;
+        }
+
         try {
           const pollingResult = await callback();
           if (pollingResult.done && pollingResult.result) {