@ampsec/platform-client 3.0.0 → 4.0.1

package/src/services/rest/RestResponse.ts

@@ -0,0 +1,8 @@
+import {HeadersMap} from './utils';
+
+export type RestResponse = {
+  status: number;
+  headers: HeadersMap;
+  data: unknown;
+  error: unknown;
+};

package/src/services/rest/index.ts

@@ -0,0 +1,5 @@
+export * from './RestClient';
+export * from './RestRequest';
+export * from './RestResponse';
+export * from './rateLimit.rest';
+export * from './retry.rest';

package/src/services/rest/rateLimit.rest.ts

@@ -0,0 +1,31 @@
+import {RestRequest} from './RestRequest';
+
+export interface RestClientRateLimitStrategy {
+  reserve(_req: RestRequest): Promise<void>;
+}
+
+export const noopRestClientRateLimitStrategy: RestClientRateLimitStrategy = {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  reserve(_req: RestRequest): Promise<void> {
+    return Promise.resolve();
+  },
+};
+
+const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
+
+export class StaticRestClientRateLimitStrategy implements RestClientRateLimitStrategy {
+  private readonly delay: number;
+  private lastRequest: number;
+
+  constructor(delay: number) {
+    this.delay = delay;
+    this.lastRequest = 0;
+  }
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async reserve(_req: RestRequest): Promise<void> {
+    while (Date.now() - this.lastRequest < this.delay) {
+      await sleep(this.delay);
+    }
+    this.lastRequest = Date.now();
+  }
+}

package/src/services/rest/retry.rest.ts

@@ -0,0 +1,21 @@
+import {AxiosError} from 'axios';
+import {convertHeaders} from './utils';
+import {RestRequest} from './RestRequest';
+import {RestResponse} from './RestResponse';
+
+export interface RestClientRetryStrategy {
+  onError(_req: RestRequest, _err: AxiosError): Promise<RestResponse>;
+}
+
+export const noopRestRetryStrategy: RestClientRetryStrategy = {
+  onError(req: RestRequest, err: AxiosError): Promise<RestResponse> {
+    const axiosError = err as AxiosError;
+    const res: RestResponse = {
+      status: axiosError.response?.status ?? 500,
+      headers: axiosError.response ? convertHeaders(axiosError.response) : {},
+      data: null,
+      error: err,
+    };
+    return Promise.resolve(res);
+  },
+};

package/src/services/rest/utils.ts

@@ -0,0 +1,13 @@
+import {AxiosResponse} from 'axios';
+
+export type StringMap<T> = {[key: string]: T};
+export type HeadersMap = StringMap<string>;
+export type QueryMap = StringMap<unknown>;
+
+export function convertHeaders(res: AxiosResponse): HeadersMap {
+  const headers: HeadersMap = {};
+  for (const [key, value] of Object.entries(res.headers)) {
+    headers[key] = value as string;
+  }
+  return headers;
+}