Handle rate limit for all send requests (ringcentral#123)

* default handle rate limit option * added rate limiting in SDK constructor * default handle rate limits with tests
ElridgeDMello · Sep 28, 2019 · c53d114 · c53d114
1 parent 728fa8b
commit c53d114
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 3 deletions.
diff --git a/sdk/src/SDK-spec.ts b/sdk/src/SDK-spec.ts
@@ -25,6 +25,11 @@ describe('RingCentral.SDK', () => {
         return test(this, SDK.server.production);
     });
 
+    it('sets rate limit', async function rateLimitTest() {
+        const sdk = new SDK({handleRateLimit: 60});
+        expect(sdk.platform()['_handleRateLimit']).to.equal(60);
+    });
+
     describe('handleLoginRedirect', () => {
         const sdk = new SDK();
 

diff --git a/sdk/src/SDK.ts b/sdk/src/SDK.ts
@@ -57,7 +57,7 @@ export class SDK {
     }
 
     public constructor(options: SDKOptions = {}) {
-        const {cachePrefix, defaultRequestInit} = options;
+        const {cachePrefix, defaultRequestInit, handleRateLimit} = options;
 
         this._externals = new Externals({
             ...defaultExternals,
@@ -79,6 +79,7 @@ export class SDK {
             externals: this._externals,
             client: this._client,
             cache: this._cache,
+            handleRateLimit,
         });
     }
 
@@ -164,6 +165,7 @@ export class SDK {
 export interface SDKOptions extends PlatformOptions, ExternalsOptions {
     cachePrefix?: string;
     defaultRequestInit?: CreateRequestOptions;
+    handleRateLimit?: boolean | number;
 }
 
 export default SDK;
diff --git a/sdk/src/platform/Platform-spec.ts b/sdk/src/platform/Platform-spec.ts
@@ -198,6 +198,34 @@ describe('RingCentral.platform.Platform', () => {
             }),
         );
 
+        it(
+            'handles default rate limit 429',
+            asyncTest(async sdk => {
+                const platform = sdk.platform();
+                const path = '/restapi/xxx';
+                const response = {foo: 'bar'};
+                const rateLimitSpy = spy(() => {
+                    apiCall('GET', path, response, 200);
+                });
+
+                platform['_handleRateLimit'] = 0.01;
+
+                apiCall('GET', path, {message: 'expected'}, 429, 'Rate Limit Exceeded');
+
+                platform.on(platform.events.rateLimitError, rateLimitSpy);
+
+                const res = await platform.get(path);
+
+                expect(rateLimitSpy.calledOnce).to.be.true;
+
+                const e = rateLimitSpy.getCalls()[0].args[0];
+                expect(e.message).to.equal('expected');
+                expect(e.retryAfter).to.equal(10);
+
+                expect(await res.json()).to.deep.equal(response);
+            }),
+        );
+
         it(
             'emits rate limit 429 errors if they are not handled',
             asyncTest(async sdk => {

diff --git a/sdk/src/platform/Platform.ts b/sdk/src/platform/Platform.ts
@@ -69,6 +69,8 @@ export default class Platform extends EventEmitter {
 
     private _urlPrefix;
 
+    private _handleRateLimit: boolean | number;
+
     public constructor({
         server,
         clientId,
@@ -87,6 +89,7 @@ export default class Platform extends EventEmitter {
         authorizeEndpoint = '/restapi/oauth/authorize',
         authProxy = false,
         urlPrefix = '',
+        handleRateLimit,
     }: PlatformOptionsConstructor) {
         super();
 
@@ -114,6 +117,7 @@ export default class Platform extends EventEmitter {
         this._tokenEndpoint = tokenEndpoint;
         this._revokeEndpoint = revokeEndpoint;
         this._authorizeEndpoint = authorizeEndpoint;
+        this._handleRateLimit = handleRateLimit;
     }
 
     public on(event: events.beforeLogin, listener: () => void);
@@ -443,7 +447,7 @@ export default class Platform extends EventEmitter {
             request = await this.inflateRequest(request, options);
             return await this._client.sendRequest(request);
         } catch (e) {
-            const {retry, handleRateLimit} = options;
+            let {retry, handleRateLimit} = options;
 
             // Guard is for errors that come from polling
             if (!e.response || retry) throw e;
@@ -463,6 +467,8 @@ export default class Platform extends EventEmitter {
             }
 
             if (status === Client._rateLimitStatus) {
+                handleRateLimit = handleRateLimit || this._handleRateLimit;
+
                 const defaultRetryAfter =
                     !handleRateLimit || typeof handleRateLimit === 'boolean' ? 60 : handleRateLimit;
 
@@ -473,7 +479,7 @@ export default class Platform extends EventEmitter {
 
                 this.emit(this.events.rateLimitError, e);
 
-                if (!options.handleRateLimit) throw e;
+                if (!handleRateLimit) throw e;
             }
 
             await delay(retryAfter);
@@ -554,6 +560,7 @@ export interface PlatformOptions extends AuthOptions {
     authorizeEndpoint?: string;
     authProxy?: boolean;
     urlPrefix?: string;
+    handleRateLimit?: boolean | number;
 }
 
 export interface PlatformOptionsConstructor extends PlatformOptions {

diff --git a/sdk/src/test/test.ts b/sdk/src/test/test.ts
@@ -70,6 +70,7 @@ export function createSdk(options: SDKOptions = {}) {
         fetch: fetchMock.fetchHandler,
         refreshDelayMs: 1,
         redirectUri: 'http://foo',
+        handleRateLimit: false,
         ...options,
     });
 }