getta 0.2.3 → 0.4.0

package/lib/module/main.js

@@ -3,7 +3,7 @@ import _merge from "lodash/merge";
 import _castArray from "lodash/castArray";
 import "core-js/modules/es.promise.js";
 import md5 from "md5";
-import { CACHE_CONTROL_HEADER, DEFAULT_BODY_PARSER, DEFAULT_FETCH_TIMEOUT, DEFAULT_HEADERS, DEFAULT_MAX_REDIRECTS, DEFAULT_MAX_RETRIES, DEFAULT_PATH_TEMPLATE_REGEX, DEFAULT_REQUEST_RETRY_WAIT, DELETE_METHOD, ETAG_HEADER, FETCH_METHODS, FETCH_TIMEOUT_ERROR, GET_METHOD, IF_NONE_MATCH_HEADER, INVALID_FETCH_METHOD_ERROR, JSON_FORMAT, LOCATION_HEADER, MAX_REDIRECTS_EXCEEDED_ERROR, MAX_RETRIES_EXCEEDED_ERROR, MISSING_BASE_PATH_ERROR, NOT_FOUND_STATUS_CODE, NOT_MODIFIED_STATUS_CODE, OPTIONAL_PATH_TEMPLATE_REGEX, POST_METHOD, PUT_METHOD, REDIRECTION_REPSONSE, RESOURCE_NOT_FOUND_ERROR, SERVER_ERROR_REPSONSE } from "./constants";
+import { CACHE_CONTROL_HEADER, DEFAULT_BODY_PARSER, DEFAULT_FETCH_TIMEOUT, DEFAULT_HEADERS, DEFAULT_MAX_REDIRECTS, DEFAULT_MAX_RETRIES, DEFAULT_PATH_TEMPLATE_REGEX, DEFAULT_RATE_LIMIT, DEFAULT_REQUEST_RETRY_WAIT, DELETE_METHOD, ETAG_HEADER, FETCH_METHODS, FETCH_TIMEOUT_ERROR, GET_METHOD, IF_NONE_MATCH_HEADER, INVALID_FETCH_METHOD_ERROR, JSON_FORMAT, LOCATION_HEADER, MAX_REDIRECTS_EXCEEDED_ERROR, MAX_RETRIES_EXCEEDED_ERROR, MISSING_BASE_PATH_ERROR, NOT_FOUND_STATUS_CODE, NOT_MODIFIED_STATUS_CODE, OPTIONAL_PATH_TEMPLATE_REGEX, POST_METHOD, PUT_METHOD, REDIRECTION_REPSONSE, REQUEST_SENT, RESOURCE_NOT_FOUND_ERROR, RESPONSE_RECEIVED, SERVER_ERROR_REPSONSE } from "./constants";
 import buildEndpoint from "./helpers/build-endpoint";
 import defaultPathTemplateCallback from "./helpers/default-path-template-callback";
 import delay from "./helpers/delay";
@@ -23,6 +23,8 @@ export class Getta {
 
     _defineProperty(this, "_headers", void 0);
 
+    _defineProperty(this, "_log", void 0);
+
     _defineProperty(this, "_maxRedirects", void 0);
 
     _defineProperty(this, "_maxRetries", void 0);
@@ -33,8 +35,18 @@ export class Getta {
 
     _defineProperty(this, "_pathTemplateRegExp", void 0);
 
+    _defineProperty(this, "_performance", void 0);
+
     _defineProperty(this, "_queryParams", void 0);
 
+    _defineProperty(this, "_rateLimitCount", 0);
+
+    _defineProperty(this, "_rateLimitedRequestQueue", []);
+
+    _defineProperty(this, "_rateLimitPerSecond", void 0);
+
+    _defineProperty(this, "_rateLimitTimer", null);
+
     _defineProperty(this, "_requestRetryWait", void 0);
 
     _defineProperty(this, "_requestTracker", {
@@ -51,12 +63,15 @@ export class Getta {
       enableConditionalRequests = true,
       fetchTimeout = DEFAULT_FETCH_TIMEOUT,
       headers,
+      log,
       maxRedirects = DEFAULT_MAX_REDIRECTS,
       maxRetries = DEFAULT_MAX_RETRIES,
       optionalPathTemplateRegExp = OPTIONAL_PATH_TEMPLATE_REGEX,
       pathTemplateCallback = defaultPathTemplateCallback,
       pathTemplateRegExp = DEFAULT_PATH_TEMPLATE_REGEX,
+      performance,
       queryParams = {},
+      rateLimitPerSecond = DEFAULT_RATE_LIMIT,
       requestRetryWait = DEFAULT_REQUEST_RETRY_WAIT,
       streamReader = JSON_FORMAT
     } = options;
@@ -73,12 +88,15 @@ export class Getta {
     this._headers = { ...DEFAULT_HEADERS,
       ...(headers || {})
     };
+    this._log = log;
     this._maxRedirects = maxRedirects;
     this._maxRetries = maxRetries;
     this._optionalPathTemplateRegExp = optionalPathTemplateRegExp;
     this._pathTemplateCallback = pathTemplateCallback;
     this._pathTemplateRegExp = pathTemplateRegExp;
+    this._performance = performance;
     this._queryParams = queryParams;
+    this._rateLimitPerSecond = rateLimitPerSecond;
     this._requestRetryWait = requestRetryWait;
     this._streamReader = streamReader;
   }
@@ -101,23 +119,29 @@ export class Getta {
     } = {}) => this[requestMethod !== null && requestMethod !== void 0 ? requestMethod : method](path, _merge({}, rest, requestRest));
   }
 
-  async delete(path, options = {}) {
-    return this._delete(path, options);
+  async delete(path, options = {}, context) {
+    return this._delete(path, options, context);
   }
 
-  async get(path, options = {}) {
-    return this._get(path, options);
+  async get(path, options = {}, context) {
+    return this._get(path, options, context);
   }
 
-  async post(path, options) {
+  async post(path, options, context) {
     return this._request(path, { ...options,
       method: POST_METHOD
-    });
+    }, context);
   }
 
-  async put(path, options) {
+  async put(path, options, context) {
     return this._request(path, { ...options,
       method: PUT_METHOD
+    }, context);
+  }
+
+  _addRequestToRateLimitedQueue(endpoint, options) {
+    return new Promise(resolve => {
+      this._rateLimitedRequestQueue.push([resolve, endpoint, options]);
     });
   }
 
@@ -168,7 +192,7 @@ export class Getta {
     pathTemplateData,
     queryParams = {},
     ...rest
-  }) {
+  }, context) {
     const endpoint = buildEndpoint(this._basePath, path, {
       optionalPathTemplateRegExp: this._optionalPathTemplateRegExp,
       pathTemplateCallback: this._pathTemplateCallback,
@@ -191,20 +215,66 @@ export class Getta {
       },
       method: DELETE_METHOD,
       ...rest
-    });
+    }, context);
   }
 
   async _fetch(endpoint, {
     redirects,
     retries,
     ...rest
-  }) {
+  }, context = {}) {
     try {
       return new Promise(async (resolve, reject) => {
+        var _this$_log, _this$_log2;
+
         const fetchTimer = setTimeout(() => {
           reject(new Error(`${FETCH_TIMEOUT_ERROR} ${this._fetchTimeout}ms.`));
         }, this._fetchTimeout);
+
+        this._rateLimit();
+
+        if (!(this._rateLimitCount < this._rateLimitPerSecond)) {
+          resolve(await this._addRequestToRateLimitedQueue(endpoint, {
+            redirects,
+            retries,
+            ...rest
+          }));
+          return;
+        }
+
+        const startTime = this._performance.now();
+
+        (_this$_log = this._log) === null || _this$_log === void 0 ? void 0 : _this$_log.call(this, REQUEST_SENT, {
+          context: {
+            redirects,
+            retries,
+            url: endpoint,
+            ...rest,
+            ...context
+          },
+          stats: {
+            startTime
+          }
+        });
         const res = await fetch(endpoint, rest);
+
+        const endTime = this._performance.now();
+
+        const duration = endTime - startTime;
+        (_this$_log2 = this._log) === null || _this$_log2 === void 0 ? void 0 : _this$_log2.call(this, RESPONSE_RECEIVED, {
+          context: {
+            redirects,
+            retries,
+            url: endpoint,
+            ...rest,
+            ...context
+          },
+          stats: {
+            duration,
+            endTime,
+            startTime
+          }
+        });
         clearTimeout(fetchTimer);
         const {
           headers,
@@ -218,6 +288,7 @@ export class Getta {
             status,
             ...rest
           }));
+          return;
         }
 
         if (responseGroup === SERVER_ERROR_REPSONSE) {
@@ -225,27 +296,16 @@ export class Getta {
             retries,
             ...rest
           }));
+          return;
         }
 
         const fetchRes = res;
-        const resClone = res.clone();
 
         try {
           fetchRes.data = res.body ? this._bodyParser(await res[this._streamReader]()) : undefined;
           resolve(fetchRes);
         } catch (e) {
-          try {
-            if (this._streamReader === "json" && res.body) {
-              const fetchResClone = resClone;
-              const text = await resClone.text();
-              fetchResClone.data = JSON.parse(text);
-              resolve(fetchResClone);
-            } else {
-              reject([e, new Error(`Unable to ${rest.method} ${endpoint} due to previous error`)]);
-            }
-          } catch {
-            reject([e, new Error(`Unable to ${rest.method} ${endpoint} due to previous error`)]);
-          }
+          reject([e, new Error(`Unable to ${rest.method} ${endpoint} due to previous error`)]);
         }
       });
     } catch (error) {
@@ -300,7 +360,7 @@ export class Getta {
     headers = {},
     pathTemplateData,
     queryParams = {}
-  }) {
+  }, context) {
     const endpoint = buildEndpoint(this._basePath, path, {
       optionalPathTemplateRegExp: this._optionalPathTemplateRegExp,
       pathTemplateCallback: this._pathTemplateCallback,
@@ -339,7 +399,7 @@ export class Getta {
         ...headers
       },
       method: GET_METHOD
-    }));
+    }, context));
   }
 
   async _getResolve(requestHash, res) {
@@ -381,6 +441,29 @@ export class Getta {
     return res;
   }
 
+  _rateLimit() {
+    if (!this._rateLimitTimer) {
+      this._rateLimitTimer = setTimeout(() => {
+        this._rateLimitTimer = null;
+        this._rateLimitCount = 0;
+
+        if (this._rateLimitedRequestQueue.length) {
+          this._releaseRateLimitedRequestQueue();
+        }
+      }, 1000);
+    }
+
+    this._rateLimitCount += 1;
+  }
+
+  _releaseRateLimitedRequestQueue() {
+    this._rateLimitedRequestQueue.forEach(async ([resolve, endpoint, options]) => {
+      resolve(await this._fetch(endpoint, options));
+    });
+
+    this._rateLimitedRequestQueue = [];
+  }
+
   async _request(path, {
     body,
     headers,
@@ -388,7 +471,7 @@ export class Getta {
     pathTemplateData,
     queryParams,
     ...rest
-  }) {
+  }, context) {
     const endpoint = buildEndpoint(this._basePath, path, {
       optionalPathTemplateRegExp: this._optionalPathTemplateRegExp,
       pathTemplateCallback: this._pathTemplateCallback,
@@ -405,7 +488,7 @@ export class Getta {
       },
       method,
       ...rest
-    });
+    }, context);
   }
 
   _resolvePendingRequests(requestHash, responseData) {

package/lib/types/constants.d.ts

@@ -20,6 +20,7 @@ export declare const DEFAULT_MAX_REDIRECTS: 5;
 export declare const DEFAULT_MAX_RETRIES: 3;
 export declare const DEFAULT_PATH_TEMPLATE_REGEX: RegExp;
 export declare const OPTIONAL_PATH_TEMPLATE_REGEX: RegExp;
+export declare const DEFAULT_RATE_LIMIT = 50;
 export declare const DEFAULT_REQUEST_RETRY_WAIT = 100;
 export declare const MISSING_BASE_PATH_ERROR = "Getta expected to receive 'basePath' in the constructor options,\n  but recevied undefined.";
 export declare const MAX_REDIRECTS_EXCEEDED_ERROR = "The request exceeded the maximum number of redirects, which is";
@@ -44,4 +45,6 @@ export declare const ETAG_HEADER: "ETag";
 export declare const LOCATION_HEADER: "Location";
 export declare const IF_NONE_MATCH_HEADER: "If-None-Match";
 export declare const CACHE_CONTROL_HEADER: "Cache-Control";
+export declare const REQUEST_SENT: "request_sent";
+export declare const RESPONSE_RECEIVED: "response_received";
 //# sourceMappingURL=constants.d.ts.map

package/lib/types/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,eAAO,MAAM,mBAAmB,eAAyB,CAAC;AAC1D,eAAO,MAAM,WAAW,QAAkB,CAAC;AAC3C,eAAO,MAAM,gBAAgB,YAAsB,CAAC;AACpD,eAAO,MAAM,WAAW,QAAkB,CAAC;AAC3C,eAAO,MAAM,WAAW,QAAkB,CAAC;AAE3C,eAAO,MAAM,cAAc;;;;;;CAM1B,CAAC;AAEF,eAAO,MAAM,mBAAmB,SAAU,WAAW,gBAAS,CAAC;AAC/D,eAAO,MAAM,qBAAqB,MAAgB,CAAC;AACnD,eAAO,MAAM,eAAe;;CAAyC,CAAC;AACtE,eAAO,MAAM,qBAAqB,GAAa,CAAC;AAChD,eAAO,MAAM,mBAAmB,GAAa,CAAC;AAC9C,eAAO,MAAM,2BAA2B,QAAmD,CAAC;AAC5F,eAAO,MAAM,4BAA4B,QAAyB,CAAC;AACnE,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C,eAAO,MAAM,uBAAuB,gGACV,CAAC;AAE3B,eAAO,MAAM,4BAA4B,mEAAmE,CAAC;AAE7G,eAAO,MAAM,0BAA0B,iEAAiE,CAAC;AAEzG,eAAO,MAAM,0BAA0B,6EAA6E,CAAC;AAErH,eAAO,MAAM,wBAAwB,iDAAiD,CAAC;AAEvF,eAAO,MAAM,mBAAmB,+DAA+D,CAAC;AAEhG,eAAO,MAAM,UAAU,OAAiB,CAAC;AACzC,eAAO,MAAM,WAAW,QAAkB,CAAC;AAC3C,eAAO,MAAM,UAAU,OAAiB,CAAC;AACzC,eAAO,MAAM,aAAa,UAAoB,CAAC;AAE/C,eAAO,MAAM,aAAa,uCAAuD,CAAC;AAElF,eAAO,MAAM,oBAAoB,eAAyB,CAAC;AAC3D,eAAO,MAAM,mBAAmB,cAAwB,CAAC;AACzD,eAAO,MAAM,oBAAoB,eAAyB,CAAC;AAC3D,eAAO,MAAM,qBAAqB,eAAyB,CAAC;AAC5D,eAAO,MAAM,qBAAqB,eAAyB,CAAC;AAE5D,eAAO,MAAM,wBAAwB,KAAe,CAAC;AACrD,eAAO,MAAM,qBAAqB,KAAe,CAAC;AAElD,eAAO,MAAM,aAAa,UAAoB,CAAC;AAC/C,eAAO,MAAM,WAAW,QAAkB,CAAC;AAC3C,eAAO,MAAM,eAAe,YAAsB,CAAC;AACnD,eAAO,MAAM,oBAAoB,iBAA2B,CAAC;AAC7D,eAAO,MAAM,oBAAoB,iBAA2B,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,eAAO,MAAM,mBAAmB,eAAyB,CAAC;AAC1D,eAAO,MAAM,WAAW,QAAkB,CAAC;AAC3C,eAAO,MAAM,gBAAgB,YAAsB,CAAC;AACpD,eAAO,MAAM,WAAW,QAAkB,CAAC;AAC3C,eAAO,MAAM,WAAW,QAAkB,CAAC;AAE3C,eAAO,MAAM,cAAc;;;;;;CAM1B,CAAC;AAEF,eAAO,MAAM,mBAAmB,SAAU,WAAW,gBAAS,CAAC;AAC/D,eAAO,MAAM,qBAAqB,MAAgB,CAAC;AACnD,eAAO,MAAM,eAAe;;CAAyC,CAAC;AACtE,eAAO,MAAM,qBAAqB,GAAa,CAAC;AAChD,eAAO,MAAM,mBAAmB,GAAa,CAAC;AAC9C,eAAO,MAAM,2BAA2B,QAAmD,CAAC;AAC5F,eAAO,MAAM,4BAA4B,QAAyB,CAAC;AACnE,eAAO,MAAM,kBAAkB,KAAK,CAAC;AACrC,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C,eAAO,MAAM,uBAAuB,gGACV,CAAC;AAE3B,eAAO,MAAM,4BAA4B,mEAAmE,CAAC;AAE7G,eAAO,MAAM,0BAA0B,iEAAiE,CAAC;AAEzG,eAAO,MAAM,0BAA0B,6EAA6E,CAAC;AAErH,eAAO,MAAM,wBAAwB,iDAAiD,CAAC;AAEvF,eAAO,MAAM,mBAAmB,+DAA+D,CAAC;AAEhG,eAAO,MAAM,UAAU,OAAiB,CAAC;AACzC,eAAO,MAAM,WAAW,QAAkB,CAAC;AAC3C,eAAO,MAAM,UAAU,OAAiB,CAAC;AACzC,eAAO,MAAM,aAAa,UAAoB,CAAC;AAE/C,eAAO,MAAM,aAAa,uCAAuD,CAAC;AAElF,eAAO,MAAM,oBAAoB,eAAyB,CAAC;AAC3D,eAAO,MAAM,mBAAmB,cAAwB,CAAC;AACzD,eAAO,MAAM,oBAAoB,eAAyB,CAAC;AAC3D,eAAO,MAAM,qBAAqB,eAAyB,CAAC;AAC5D,eAAO,MAAM,qBAAqB,eAAyB,CAAC;AAE5D,eAAO,MAAM,wBAAwB,KAAe,CAAC;AACrD,eAAO,MAAM,qBAAqB,KAAe,CAAC;AAElD,eAAO,MAAM,aAAa,UAAoB,CAAC;AAC/C,eAAO,MAAM,WAAW,QAAkB,CAAC;AAC3C,eAAO,MAAM,eAAe,YAAsB,CAAC;AACnD,eAAO,MAAM,oBAAoB,iBAA2B,CAAC;AAC7D,eAAO,MAAM,oBAAoB,iBAA2B,CAAC;AAE7D,eAAO,MAAM,YAAY,gBAA0B,CAAC;AACpD,eAAO,MAAM,iBAAiB,qBAA+B,CAAC"}

package/lib/types/main.d.ts

@@ -9,25 +9,32 @@ export declare class Getta {
     private _conditionalRequestsEnabled;
     private _fetchTimeout;
     private _headers;
+    private _log;
     private _maxRedirects;
     private _maxRetries;
     private _optionalPathTemplateRegExp;
     private _pathTemplateCallback;
     private _pathTemplateRegExp;
+    private _performance;
     private _queryParams;
+    private _rateLimitCount;
+    private _rateLimitedRequestQueue;
+    private _rateLimitPerSecond;
+    private _rateLimitTimer;
     private _requestRetryWait;
     private _requestTracker;
     private _streamReader;
     constructor(options: ConstructorOptions);
     get cache(): Cachemap | undefined;
     createShortcut(name: string, path: string, { method, ...rest }: Required<RequestOptions, "method">): void;
-    delete(path: string, options?: Omit<RequestOptions, "method">): Promise<FetchResponse<PlainObject>>;
-    get(path: string, options?: Omit<RequestOptions, "method">): Promise<FetchResponse<PlainObject> | {
+    delete(path: string, options?: Omit<RequestOptions, "method">, context?: PlainObject): Promise<FetchResponse<PlainObject>>;
+    get(path: string, options?: Omit<RequestOptions, "method">, context?: PlainObject): Promise<FetchResponse<PlainObject> | {
         data: PlainObject | undefined;
         headers: Headers;
     }>;
-    post(path: string, options: Omit<Required<RequestOptions, "body">, "method">): Promise<FetchResponse<PlainObject>>;
-    put(path: string, options: Omit<Required<RequestOptions, "body">, "methood">): Promise<FetchResponse<PlainObject>>;
+    post(path: string, options: Omit<Required<RequestOptions, "body">, "method">, context?: PlainObject): Promise<FetchResponse<PlainObject>>;
+    put(path: string, options: Omit<Required<RequestOptions, "body">, "methood">, context?: PlainObject): Promise<FetchResponse<PlainObject>>;
+    private _addRequestToRateLimitedQueue;
     private _cacheEntryDelete;
     private _cacheEntryGet;
     private _cacheEntryHas;
@@ -38,6 +45,8 @@ export declare class Getta {
     private _fetchRetryHandler;
     private _get;
     private _getResolve;
+    private _rateLimit;
+    private _releaseRateLimitedRequestQueue;
     private _request;
     private _resolvePendingRequests;
     private _setPendingRequest;

package/lib/types/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,QAA0B,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAQ,WAAW,EAAgB,MAAM,gBAAgB,CAAC;AAIjE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAoCzC,OAAO,EACL,kBAAkB,EAGlB,aAAa,EAIb,cAAc,EAEd,kBAAkB,EAClB,SAAS,EAEV,MAAM,SAAS,CAAC;AAEjB,qBAAa,KAAK;IAChB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAO;IAC1B,OAAO,CAAC,MAAM,CAAC,CAAW;IAC1B,OAAO,CAAC,2BAA2B,CAAU;IAC7C,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAe;IAC/B,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,2BAA2B,CAAS;IAC5C,OAAO,CAAC,qBAAqB,CAAuB;IACpD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,eAAe,CAAsD;IAC7E,OAAO,CAAC,aAAa,CAAe;gBAExB,OAAO,EAAE,kBAAkB;IAsCvC,IAAI,KAAK,IAAI,QAAQ,GAAG,SAAS,CAEhC;IAEM,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC;IAW5F,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM;IAIjE,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM;;;;IAI9D,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC;IAI5E,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC;YAI3E,iBAAiB;YAUjB,cAAc;YAUd,cAAc;YAUd,cAAc;YAUd,OAAO;YA0BP,MAAM;YA4DN,qBAAqB;YAiBrB,kBAAkB;YAYlB,IAAI;YAsCJ,WAAW;YAkCX,QAAQ;IAoBtB,OAAO,CAAC,uBAAuB;IAW/B,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,aAAa;CAStB;AAED,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,SAAS,CAAC,EAAE,SAAS,iCAS5G"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,QAA0B,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAQ,WAAW,EAAgB,MAAM,gBAAgB,CAAC;AAIjE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAuCzC,OAAO,EACL,kBAAkB,EAGlB,aAAa,EAMb,cAAc,EAGd,kBAAkB,EAClB,SAAS,EAEV,MAAM,SAAS,CAAC;AAEjB,qBAAa,KAAK;IAChB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAO;IAC1B,OAAO,CAAC,MAAM,CAAC,CAAW;IAC1B,OAAO,CAAC,2BAA2B,CAAU;IAC7C,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAe;IAC/B,OAAO,CAAC,IAAI,CAAkB;IAC9B,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,2BAA2B,CAAS;IAC5C,OAAO,CAAC,qBAAqB,CAAuB;IACpD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,eAAe,CAAa;IACpC,OAAO,CAAC,wBAAwB,CAAoB;IACpD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,eAAe,CAA6B;IACpD,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,eAAe,CAAsD;IAC7E,OAAO,CAAC,aAAa,CAAe;gBAExB,OAAO,EAAE,kBAAkB;IA4CvC,IAAI,KAAK,IAAI,QAAQ,GAAG,SAAS,CAEhC;IAEM,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC;IAW5F,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM,EAAE,OAAO,CAAC,EAAE,WAAW;IAIxF,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM,EAAE,OAAO,CAAC,EAAE,WAAW;;;;IAIrF,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW;IAInG,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW;IAIhH,OAAO,CAAC,6BAA6B;YAMvB,iBAAiB;YAUjB,cAAc;YAUd,cAAc;YAUd,cAAc;YAUd,OAAO;YA+BP,MAAM;YA8EN,qBAAqB;YAiBrB,kBAAkB;YAYlB,IAAI;YAuCJ,WAAW;IAkCzB,OAAO,CAAC,UAAU;IAelB,OAAO,CAAC,+BAA+B;YASzB,QAAQ;IAyBtB,OAAO,CAAC,uBAAuB;IAW/B,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,aAAa;CAStB;AAED,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,SAAS,CAAC,EAAE,SAAS,iCAS5G"}

package/lib/types/types.d.ts

@@ -13,12 +13,15 @@ export interface ConstructorOptions {
     enableConditionalRequests?: boolean;
     fetchTimeout?: number;
     headers?: StringObject;
+    log?: Log;
     maxRedirects?: number;
     maxRetries?: number;
     optionalPathTemplateRegExp?: RegExp;
     pathTemplateCallback?: PathTemplateCallback;
     pathTemplateRegExp?: RegExp;
+    performance: Performance;
     queryParams?: PlainObject;
+    rateLimitPerSecond?: number;
     requestRetryWait?: number;
     streamReader?: StreamReader;
 }
@@ -34,6 +37,11 @@ export interface FetchResponse<Resource = PlainObject> extends ResponseDataWithE
 export interface FetchRedirectHandlerOptions extends FetchOptions {
     status: number;
 }
+export declare type Log = (message: string, data: PlainObject, logLevel?: LogLevel) => void;
+export declare type LogLevel = "error" | "warn" | "info" | "http" | "verbose" | "debug" | "silly";
+export interface Performance {
+    now(): number;
+}
 export interface RequestOptions {
     body?: BodyInit;
     headers?: StringObject;
@@ -41,6 +49,7 @@ export interface RequestOptions {
     pathTemplateData?: StringObject;
     queryParams?: PlainObject;
 }
+export declare type RequestQueue = [(value: FetchResponse) => void, string, FetchOptions][];
 export interface ResponseDataWithErrors<Resource = PlainObject> {
     data?: Resource;
     errors?: Error[];

package/lib/types/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,oBAAY,WAAW,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE5D,oBAAY,YAAY,GAAG,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEjF,oBAAY,kBAAkB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;KACzD,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;CACvF,CAAC;AAEF,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,YAAY,CAAC;IACtB,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAa,CAAC,QAAQ,GAAG,WAAW,CAAE,SAAQ,sBAAsB,CAAC,QAAQ,CAAC,EAAE,QAAQ;CAAG;AAE5G,MAAM,WAAW,2BAA4B,SAAQ,YAAY;IAC/D,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAsB,CAAC,QAAQ,GAAG,WAAW;IAC5D,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;CAClB;AAED,oBAAY,oBAAoB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,KAAK,MAAM,CAAC;AAE5G,oBAAY,sBAAsB,GAAG,CAAC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;AAEjF,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,sBAAsB,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,uBAAuB,EAAE,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;CAC7D"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,oBAAY,WAAW,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE5D,oBAAY,YAAY,GAAG,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEjF,oBAAY,kBAAkB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;KACzD,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;CACvF,CAAC;AAEF,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,YAAY,CAAC;IACtB,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAa,CAAC,QAAQ,GAAG,WAAW,CAAE,SAAQ,sBAAsB,CAAC,QAAQ,CAAC,EAAE,QAAQ;CAAG;AAE5G,MAAM,WAAW,2BAA4B,SAAQ,YAAY;IAC/D,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,QAAQ,KAAK,IAAI,CAAC;AAEpF,oBAAY,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC;AAE1F,MAAM,WAAW,WAAW;IAC1B,GAAG,IAAI,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,oBAAY,YAAY,GAAG,CAAC,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC;AAEpF,MAAM,WAAW,sBAAsB,CAAC,QAAQ,GAAG,WAAW;IAC5D,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;CAClB;AAED,oBAAY,oBAAoB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,KAAK,MAAM,CAAC;AAE5G,oBAAY,sBAAsB,GAAG,CAAC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;AAEjF,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,sBAAsB,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,uBAAuB,EAAE,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;CAC7D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "getta",
-  "version": "0.2.3",
+  "version": "0.4.0",
   "description": "An isomorphic rest client based on the Fetch API.",
   "keywords": [
     "api-client",

package/src/constants.ts

@@ -21,6 +21,7 @@ export const DEFAULT_MAX_REDIRECTS = 5 as const;
 export const DEFAULT_MAX_RETRIES = 3 as const;
 export const DEFAULT_PATH_TEMPLATE_REGEX = /({type})|({id})|({id,\+})|({brief\|standard})/g;
 export const OPTIONAL_PATH_TEMPLATE_REGEX = /({[a-zA-Z0-9_]+\?})/g;
+export const DEFAULT_RATE_LIMIT = 50;
 export const DEFAULT_REQUEST_RETRY_WAIT = 100;
 
 export const MISSING_BASE_PATH_ERROR = `Getta expected to receive 'basePath' in the constructor options,
@@ -57,3 +58,6 @@ export const ETAG_HEADER = "ETag" as const;
 export const LOCATION_HEADER = "Location" as const;
 export const IF_NONE_MATCH_HEADER = "If-None-Match" as const;
 export const CACHE_CONTROL_HEADER = "Cache-Control" as const;
+
+export const REQUEST_SENT = "request_sent" as const;
+export const RESPONSE_RECEIVED = "response_received" as const;

package/src/main.test.ts

@@ -1,6 +1,7 @@
 import { StringObject } from "@repodog/types";
 import fetchMock, { MockRequest } from "fetch-mock";
 import md5 from "md5";
+import { performance } from "perf_hooks";
 import { PRD_136_7317 } from "./__tests__/data";
 import {
   basePath,
@@ -33,7 +34,7 @@ import { ResponseDataWithErrors, ShortcutProperties } from "./types";
 describe("Getta", () => {
   describe("constructor", () => {
     it("SHOULD return an instance of the Getta class", () => {
-      const restClient = createRestClient({ basePath, cache: getCache() });
+      const restClient = createRestClient({ basePath, cache: getCache(), performance });
       expect(restClient).toBeInstanceOf(Getta);
     });
   });
@@ -44,7 +45,7 @@ describe("Getta", () => {
 
     beforeAll(() => {
       restClient = createRestClient<"getProduct">(
-        { basePath, cache: getCache() },
+        { basePath, cache: getCache(), performance },
         {
           getProduct: [
             defaultPath,
@@ -397,7 +398,7 @@ describe("Getta", () => {
 
     beforeAll(() => {
       restClient = createRestClient<"postProduct">(
-        { basePath, cache: getCache() },
+        { basePath, cache: getCache(), performance },
         {
           postProduct: [
             defaultPath,
@@ -483,7 +484,7 @@ describe("Getta", () => {
 
     beforeAll(() => {
       restClient = createRestClient<"deleteProduct">(
-        { basePath, cache: getCache() },
+        { basePath, cache: getCache(), performance },
         {
           deleteProduct: [
             defaultPath,
@@ -589,7 +590,7 @@ describe("Getta", () => {
 
     beforeAll(() => {
       restClient = createRestClient<"putProduct">(
-        { basePath, cache: getCache() },
+        { basePath, cache: getCache(), performance },
         {
           putProduct: [
             defaultPath,
@@ -657,4 +658,44 @@ describe("Getta", () => {
       });
     });
   });
+
+  describe("rate limiting", () => {
+    let restClient: Getta;
+
+    beforeAll(() => {
+      restClient = createRestClient({ basePath, performance });
+    });
+
+    describe("WHEN the number of requests per second exceeds rateLimitPerSecond", () => {
+      beforeAll(async () => {
+        const requestKeys = [...Array(55).keys()];
+
+        requestKeys.forEach(key => {
+          mockRequest(`product/${key}`, {}, {}, ({ endpoint, ...rest }) => {
+            fetchMock.get(endpoint, rest);
+          });
+        });
+
+        // @ts-ignore
+        restClient._addRequestToRateLimitedQueue = jest
+          .fn()
+          .mockResolvedValue({ data: {}, headers: new Headers(), status: 200 });
+
+        await Promise.all(requestKeys.map(key => restClient.get(`product/${key}`)));
+      });
+
+      afterAll(async () => {
+        await tearDownTest({ fetchMock, restClient });
+      });
+
+      it("SHOULD call fetch one less than the rate limit", () => {
+        expect(fetchMock.calls().length).toBe(49);
+      });
+
+      it("SHOULD add the excess requests to rateLimitedRequestQueue", async () => {
+        // @ts-ignore
+        expect(restClient._addRequestToRateLimitedQueue).toHaveBeenCalledTimes(6);
+      });
+    });
+  });
 });