@webex/webex-core 3.0.0-beta.2 → 3.0.0-beta.21

package/test/unit/spec/interceptors/rate-limit.js

@@ -6,13 +6,7 @@
 import {assert} from '@webex/test-helper-chai';
 import MockWebex from '@webex/test-helper-mock-webex';
 import FakeTimers from '@sinonjs/fake-timers';
-import {
-  RateLimitInterceptor,
-  config,
-  Credentials,
-  WebexHttpError,
-  Token
-} from '@webex/webex-core';
+import {RateLimitInterceptor, config, Credentials, WebexHttpError, Token} from '@webex/webex-core';
 import {cloneDeep} from 'lodash';
 
 describe('webex-core', () => {
@@ -20,22 +14,23 @@ describe('webex-core', () => {
     describe('RateLimitInterceptor', () => {
       const idBrokerURL = process.env.IDBROKER_BASE_URL || 'https://idbroker.webex.com';
       const identityURL = process.env.IDENTITY_BASE_URL || 'https://identity.webex.com';
-      let clock,
-        interceptor,
-        webex;
+      let clock, interceptor, webex;
 
       beforeEach(() => {
         webex = new MockWebex({
           children: {
-            credentials: Credentials
+            credentials: Credentials,
           },
-          config: cloneDeep(config)
+          config: cloneDeep(config),
         });
 
-        webex.credentials.supertoken = new Token({
-          access_token: 'ST1',
-          token_type: 'Bearer'
-        }, {parent: webex});
+        webex.credentials.supertoken = new Token(
+          {
+            access_token: 'ST1',
+            token_type: 'Bearer',
+          },
+          {parent: webex}
+        );
 
         interceptor = Reflect.apply(RateLimitInterceptor.create, webex, []);
         clock = FakeTimers.install({now: Date.now()});
@@ -58,8 +53,10 @@ describe('webex-core', () => {
 
           return assert.equal(interceptor.isRateLimited(`${identityURL}/horse/v1/myID`), false);
         });
-        it('returns false when URI is not IDbroker URI', () => assert.equal(interceptor.isRateLimited('https://example.com/testFake'), false));
-        it('returns false if the URI is null', () => assert.equal(interceptor.isRateLimited(null), false));
+        it('returns false when URI is not IDbroker URI', () =>
+          assert.equal(interceptor.isRateLimited('https://example.com/testFake'), false));
+        it('returns false if the URI is null', () =>
+          assert.equal(interceptor.isRateLimited(null), false));
         it.skip('returns true when idbroker API is rate limited', () => {
           interceptor.setRateLimitExpiry(`${idBrokerURL}/horse/v1/myID`, new Date().getTime() * 2);
 
@@ -73,35 +70,46 @@ describe('webex-core', () => {
       });
 
       describe('#getApiName', () => {
-        it('returns null when there is no regex match', () => assert.equal(interceptor.getApiName('https://example.com/testFake'), null));
-        it('returns null when the argument is null', () => assert.equal(interceptor.getApiName(null), null));
-        it.skip('returns idbroker API name if there is a match', () => assert.equal(interceptor.getApiName(`${idBrokerURL}/horse/v1/myID`), 'horse'));
-        it.skip('returns identity API name if there is a match', () => assert.equal(interceptor.getApiName(`${identityURL}/horse/v1/myID`), 'horse'));
+        it('returns null when there is no regex match', () =>
+          assert.equal(interceptor.getApiName('https://example.com/testFake'), null));
+        it('returns null when the argument is null', () =>
+          assert.equal(interceptor.getApiName(null), null));
+        it.skip('returns idbroker API name if there is a match', () =>
+          assert.equal(interceptor.getApiName(`${idBrokerURL}/horse/v1/myID`), 'horse'));
+        it.skip('returns identity API name if there is a match', () =>
+          assert.equal(interceptor.getApiName(`${identityURL}/horse/v1/myID`), 'horse'));
       });
 
       describe('#getRateLimitStatus', () => {
-        it('returns false if API name is not in rate limit expiry map', () => assert.equal(interceptor.getRateLimitStatus('https://example.com/testFake'), false));
+        it('returns false if API name is not in rate limit expiry map', () =>
+          assert.equal(interceptor.getRateLimitStatus('https://example.com/testFake'), false));
         it('returns false if idbroker API name is not rate limited', () => {
           interceptor.setRateLimitExpiry(`${idBrokerURL}/horse/v1/myID`, 1);
           clock.tick(2000);
 
-          return assert.equal(interceptor.getRateLimitStatus(`${idBrokerURL}/horse/v1/myID`), false);
+          return assert.equal(
+            interceptor.getRateLimitStatus(`${idBrokerURL}/horse/v1/myID`),
+            false
+          );
         });
         it('returns false if identity API name is not rate limited', () => {
           interceptor.setRateLimitExpiry(`${identityURL}/horse/v1/myID`, 1);
           clock.tick(2000);
 
-          return assert.equal(interceptor.getRateLimitStatus(`${identityURL}/horse/v1/myID`), false);
+          return assert.equal(
+            interceptor.getRateLimitStatus(`${identityURL}/horse/v1/myID`),
+            false
+          );
         });
         it.skip('returns true if idbroker the API name is rate limited', () => {
-          const future = (new Date().getTime()) * 2;
+          const future = new Date().getTime() * 2;
 
           interceptor.setRateLimitExpiry(`${idBrokerURL}/horse/v1/myID`, future);
 
           return assert.equal(interceptor.getRateLimitStatus(`${idBrokerURL}/horse/v1/myID`), true);
         });
         it.skip('returns true if the identity API name is rate limited', () => {
-          const future = (new Date().getTime()) * 2;
+          const future = new Date().getTime() * 2;
 
           interceptor.setRateLimitExpiry(`${identityURL}/horse/v1/myID`, future);
 
@@ -110,7 +118,8 @@ describe('webex-core', () => {
       });
 
       describe('#setRateLimitExpiry', () => {
-        it('returns false if URI results in API name that is null', () => assert.equal(interceptor.setRateLimitExpiry('https://example.com/testFake', 1), false));
+        it('returns false if URI results in API name that is null', () =>
+          assert.equal(interceptor.setRateLimitExpiry('https://example.com/testFake', 1), false));
         it.skip('sets expiry if idroker URI results in API name that can be mapped', () => {
           interceptor.setRateLimitExpiry(`${idBrokerURL}/horse/v1/myID`, new Date().getTime() * 2);
 
@@ -126,10 +135,26 @@ describe('webex-core', () => {
       describe('#extractRetryAfterTime', () => {
         const milliMultiplier = 1000;
 
-        it('returns 60K milliseconds when retry-after <= 0S', () => assert.equal(interceptor.extractRetryAfterTime({headers: {'retry-after': -1}}), 60 * milliMultiplier));
-        it('returns 60K milliseconds when retry-after is null', () => assert.equal(interceptor.extractRetryAfterTime({headers: {'retry-after-missing': 10}}), 60 * milliMultiplier));
-        it('returns 3600K milliseconds when retry-after is > 3600S', () => assert.equal(interceptor.extractRetryAfterTime({headers: {'retry-after': 7200}}), 3600 * milliMultiplier));
-        it('returns retry-after * 1000 (converts to milliseconds) if 0S < retry-after < 3600S', () => assert.equal(interceptor.extractRetryAfterTime({headers: {'retry-after': 55}}), 55 * milliMultiplier));
+        it('returns 60K milliseconds when retry-after <= 0S', () =>
+          assert.equal(
+            interceptor.extractRetryAfterTime({headers: {'retry-after': -1}}),
+            60 * milliMultiplier
+          ));
+        it('returns 60K milliseconds when retry-after is null', () =>
+          assert.equal(
+            interceptor.extractRetryAfterTime({headers: {'retry-after-missing': 10}}),
+            60 * milliMultiplier
+          ));
+        it('returns 3600K milliseconds when retry-after is > 3600S', () =>
+          assert.equal(
+            interceptor.extractRetryAfterTime({headers: {'retry-after': 7200}}),
+            3600 * milliMultiplier
+          ));
+        it('returns retry-after * 1000 (converts to milliseconds) if 0S < retry-after < 3600S', () =>
+          assert.equal(
+            interceptor.extractRetryAfterTime({headers: {'retry-after': 55}}),
+            55 * milliMultiplier
+          ));
       });
 
       describe('#onRequest', () => {
@@ -175,98 +200,102 @@ describe('webex-core', () => {
           options: {
             headers: {
               trackingid: 'test',
-              'retry-after': 60
+              'retry-after': 60,
             },
-            uri: `${idBrokerURL}/horse/v1/myID`
+            uri: `${idBrokerURL}/horse/v1/myID`,
           },
           body: {
-            error: 'Too Many Requests'
-          }
+            error: 'Too Many Requests',
+          },
         });
         const err429identity = new WebexHttpError.TooManyRequests({
           statusCode: 429,
           options: {
             headers: {
               trackingid: 'test',
-              'retry-after': 60
+              'retry-after': 60,
             },
-            uri: `${identityURL}/horse/v1/myID`
+            uri: `${identityURL}/horse/v1/myID`,
           },
           body: {
-            error: 'Too Many Requests'
-          }
+            error: 'Too Many Requests',
+          },
         });
         const err429notIdBroker = new WebexHttpError.TooManyRequests({
           statusCode: 429,
           options: {
             headers: {
               trackingid: 'test',
-              'retry-after': 60
+              'retry-after': 60,
             },
-            uri: 'https://example.com/horse/v1/myID'
+            uri: 'https://example.com/horse/v1/myID',
           },
           body: {
-            error: 'Too Many Requests'
-          }
+            error: 'Too Many Requests',
+          },
         });
         const err404 = new WebexHttpError.BadRequest({
           statusCode: 404,
           options: {
             headers: {
               trackingid: 'test',
-              'retry-after': 60
+              'retry-after': 60,
             },
-            uri: `${idBrokerURL}/horse/v1/myID`
+            uri: `${idBrokerURL}/horse/v1/myID`,
           },
           body: {
-            error: 'Resource Not Found'
-          }
+            error: 'Resource Not Found',
+          },
         });
         const optionsIdBroker = {
           headers: {
             trackingid: 'test',
-            'retry-after': 60
+            'retry-after': 60,
           },
-          uri: `${idBrokerURL}/horse/v1/myID`
+          uri: `${idBrokerURL}/horse/v1/myID`,
         };
 
-
         const optionsIdentity = {
           headers: {
             trackingid: 'test',
-            'retry-after': 60
+            'retry-after': 60,
           },
-          uri: `${identityURL}/horse/v1/myID`
+          uri: `${identityURL}/horse/v1/myID`,
         };
 
         const optionsNotIdBroker = {
           headers: {
             trackingid: 'test',
-            'retry-after': 60
+            'retry-after': 60,
           },
-          uri: 'https://example.com/horse/v1/myID'
+          uri: 'https://example.com/horse/v1/myID',
         };
 
-        it.skip('Stores API name and retry-after when status code is 429 and URI is idbroker', () => interceptor.onResponseError(optionsIdBroker, err429).catch((resp) => {
-          assert.equal(interceptor.isRateLimited(`${idBrokerURL}/horse/v1/myID`), true);
-          assert.equal(resp, err429);
-        }));
-        it.skip('Stores API name and retry-after when status code is 429 and URI is identity', () => interceptor.onResponseError(optionsIdentity, err429identity).catch((resp) => {
-          assert.equal(interceptor.isRateLimited(`${identityURL}/horse/v1/myID`), true);
-          assert.equal(resp, err429identity);
-        }));
-        it('Does not store API name and retry-after when URI is idbroker and status code is not 429', () => interceptor.onResponseError(optionsIdBroker, err404).catch((resp) => {
-          assert.equal(interceptor.isRateLimited(`${idBrokerURL}/horse/v1/myID`), false);
-          assert.equal(resp, err404);
-        }));
-        it('Does not store API name and retry-after when URI is identity and status code is not 429', () => interceptor.onResponseError(optionsIdentity, err404).catch((resp) => {
-          assert.equal(interceptor.isRateLimited(`${identityURL}/horse/v1/myID`), false);
-          assert.equal(resp, err404);
-        }));
-        it('Does not store API name and retry-after when status is 429 and URI is not idbroker', () => interceptor.onResponseError(optionsNotIdBroker, err429notIdBroker).catch((resp) => {
-          assert.equal(interceptor.isRateLimited('https://example.com/horse/v1/myID'), false);
-          assert.equal(resp, err429notIdBroker);
-        }));
+        it.skip('Stores API name and retry-after when status code is 429 and URI is idbroker', () =>
+          interceptor.onResponseError(optionsIdBroker, err429).catch((resp) => {
+            assert.equal(interceptor.isRateLimited(`${idBrokerURL}/horse/v1/myID`), true);
+            assert.equal(resp, err429);
+          }));
+        it.skip('Stores API name and retry-after when status code is 429 and URI is identity', () =>
+          interceptor.onResponseError(optionsIdentity, err429identity).catch((resp) => {
+            assert.equal(interceptor.isRateLimited(`${identityURL}/horse/v1/myID`), true);
+            assert.equal(resp, err429identity);
+          }));
+        it('Does not store API name and retry-after when URI is idbroker and status code is not 429', () =>
+          interceptor.onResponseError(optionsIdBroker, err404).catch((resp) => {
+            assert.equal(interceptor.isRateLimited(`${idBrokerURL}/horse/v1/myID`), false);
+            assert.equal(resp, err404);
+          }));
+        it('Does not store API name and retry-after when URI is identity and status code is not 429', () =>
+          interceptor.onResponseError(optionsIdentity, err404).catch((resp) => {
+            assert.equal(interceptor.isRateLimited(`${identityURL}/horse/v1/myID`), false);
+            assert.equal(resp, err404);
+          }));
+        it('Does not store API name and retry-after when status is 429 and URI is not idbroker', () =>
+          interceptor.onResponseError(optionsNotIdBroker, err429notIdBroker).catch((resp) => {
+            assert.equal(interceptor.isRateLimited('https://example.com/horse/v1/myID'), false);
+            assert.equal(resp, err429notIdBroker);
+          }));
       });
     });
   });

package/test/unit/spec/interceptors/redirect.js

@@ -7,11 +7,7 @@
 import sinon from 'sinon';
 import {assert} from '@webex/test-helper-chai';
 import MockWebex from '@webex/test-helper-mock-webex';
-import {
-  RedirectInterceptor,
-  config,
-  Credentials
-} from '@webex/webex-core';
+import {RedirectInterceptor, config, Credentials} from '@webex/webex-core';
 import {cloneDeep} from 'lodash';
 
 describe('webex-core', () => {
@@ -22,10 +18,10 @@ describe('webex-core', () => {
       beforeEach(() => {
         webex = new MockWebex({
           children: {
-            credentials: Credentials
+            credentials: Credentials,
           },
           config: cloneDeep(config),
-          request: sinon.spy()
+          request: sinon.spy(),
         });
 
         interceptor = Reflect.apply(RedirectInterceptor.create, webex, []);
@@ -38,12 +34,15 @@ describe('webex-core', () => {
             headers: {},
             body: {
               errorCode: 2000002,
-              location: 'http://newlocus.example.com'
-            }
+              location: 'http://newlocus.example.com',
+            },
           };
 
           interceptor.onResponse({$redirectCount: 0}, response);
-          sinon.assert.calledWith(webex.request, {$redirectCount: 1, uri: 'http://newlocus.example.com'});
+          sinon.assert.calledWith(webex.request, {
+            $redirectCount: 1,
+            uri: 'http://newlocus.example.com',
+          });
         });
 
         it('redirects POST requests to new url on locus redirect error', () => {
@@ -52,15 +51,18 @@ describe('webex-core', () => {
             headers: {},
             body: {
               errorCode: 2000002,
-              location: 'http://newlocus.example.com?alternate=true'
+              location: 'http://newlocus.example.com?alternate=true',
             },
             options: {
-              qs: true
-            }
+              qs: true,
+            },
           };
 
           interceptor.onResponse({$redirectCount: 4}, response);
-          sinon.assert.calledWith(webex.request, {$redirectCount: 5, uri: 'http://newlocus.example.com'});
+          sinon.assert.calledWith(webex.request, {
+            $redirectCount: 5,
+            uri: 'http://newlocus.example.com',
+          });
         });
 
         it('does not redirect on reaching max redirects', () => {
@@ -69,11 +71,11 @@ describe('webex-core', () => {
             headers: {},
             body: {
               errorCode: 2000002,
-              location: 'http://newlocus.example.com?alternate=true'
+              location: 'http://newlocus.example.com?alternate=true',
             },
             options: {
-              qs: true
-            }
+              qs: true,
+            },
           };
 
           assert.isRejected(interceptor.onResponse({$redirectCount: 5}, response));
@@ -85,11 +87,11 @@ describe('webex-core', () => {
             headers: {},
             body: {
               errorCode: 20000,
-              location: 'http://newlocus.example.com?alternate=true'
+              location: 'http://newlocus.example.com?alternate=true',
             },
             options: {
-              qs: true
-            }
+              qs: true,
+            },
           };
 
           assert.equal(interceptor.onResponse({$redirectCount: 5}, response), response);

package/test/unit/spec/interceptors/request-timing.js

@@ -24,7 +24,7 @@ describe('webex-core', () => {
 
         it('adds a requestStart time to options.$timings', () => {
           const options = {
-            $timings: {}
+            $timings: {},
           };
 
           interceptor.onRequest(options);
@@ -36,31 +36,29 @@ describe('webex-core', () => {
       describe('.onRequestError()', () => {
         it('adds a requestEnd time to options.$timings', () => {
           const options = {
-            $timings: {}
+            $timings: {},
           };
 
-          return assert.isRejected(interceptor.onRequestError(options))
-            .then(() => {
-              assert.property(options.$timings, 'requestEnd');
-            });
+          return assert.isRejected(interceptor.onRequestError(options)).then(() => {
+            assert.property(options.$timings, 'requestEnd');
+          });
         });
 
         it('adds a requestFail time to options.$timings', () => {
           const options = {
-            $timings: {}
+            $timings: {},
           };
 
-          return assert.isRejected(interceptor.onRequestError(options))
-            .then(() => {
-              assert.property(options.$timings, 'requestFail');
-            });
+          return assert.isRejected(interceptor.onRequestError(options)).then(() => {
+            assert.property(options.$timings, 'requestFail');
+          });
         });
       });
 
       describe('.onResponse()', () => {
         it('adds a requestEnd time to options.$timings', () => {
           const options = {
-            $timings: {}
+            $timings: {},
           };
 
           interceptor.onResponse(options);
@@ -71,24 +69,22 @@ describe('webex-core', () => {
       describe('.onResponseError()', () => {
         it('adds a requestEnd time to options.$timings', () => {
           const options = {
-            $timings: {}
+            $timings: {},
           };
 
-          return assert.isRejected(interceptor.onResponseError(options))
-            .then(() => {
-              assert.property(options.$timings, 'requestEnd');
-            });
+          return assert.isRejected(interceptor.onResponseError(options)).then(() => {
+            assert.property(options.$timings, 'requestEnd');
+          });
         });
 
         it('adds a requestFail time to options.$timings', () => {
           const options = {
-            $timings: {}
+            $timings: {},
           };
 
-          return assert.isRejected(interceptor.onResponseError(options))
-            .then(() => {
-              assert.property(options.$timings, 'requestFail');
-            });
+          return assert.isRejected(interceptor.onResponseError(options)).then(() => {
+            assert.property(options.$timings, 'requestFail');
+          });
         });
       });
     });

package/test/unit/spec/interceptors/user-agent.js

@@ -14,9 +14,13 @@ describe('webex-core', () => {
       // Do not set custom headers for browsers
       skipInBrowser(describe)('#onRequest', () => {
         it('default user-agent header', () => {
-          const interceptor = Reflect.apply(UserAgentInterceptor.create, {
-            version: pkg.version
-          }, []);
+          const interceptor = Reflect.apply(
+            UserAgentInterceptor.create,
+            {
+              version: pkg.version,
+            },
+            []
+          );
           const options = {headers: {}};
 
           interceptor.onRequest(options);
@@ -27,13 +31,17 @@ describe('webex-core', () => {
         });
 
         it('custom user-agent header', () => {
-          const interceptor = Reflect.apply(UserAgentInterceptor.create, {
-            version: pkg.version,
-            config: {
-              appName: 'sample',
-              appVersion: '1.0.0'
-            }
-          }, []);
+          const interceptor = Reflect.apply(
+            UserAgentInterceptor.create,
+            {
+              version: pkg.version,
+              config: {
+                appName: 'sample',
+                appVersion: '1.0.0',
+              },
+            },
+            []
+          );
           const options = {headers: {}};
 
           interceptor.onRequest(options);
@@ -44,12 +52,16 @@ describe('webex-core', () => {
         });
 
         it('custom user-agent header when there is no appVersion', () => {
-          const interceptor = Reflect.apply(UserAgentInterceptor.create, {
-            version: pkg.version,
-            config: {
-              appName: 'sample'
-            }
-          }, []);
+          const interceptor = Reflect.apply(
+            UserAgentInterceptor.create,
+            {
+              version: pkg.version,
+              config: {
+                appName: 'sample',
+              },
+            },
+            []
+          );
           const options = {headers: {}};
 
           interceptor.onRequest(options);

package/test/unit/spec/interceptors/webex-tracking-id.js

@@ -11,9 +11,13 @@ describe('webex-core', () => {
       let interceptor;
 
       beforeEach(() => {
-        interceptor = Reflect.apply(WebexTrackingIdInterceptor.create, {
-          sessionId: 'mock-webex_uuid'
-        }, []);
+        interceptor = Reflect.apply(
+          WebexTrackingIdInterceptor.create,
+          {
+            sessionId: 'mock-webex_uuid',
+          },
+          []
+        );
       });
 
       describe('#sequence', () => {
@@ -36,11 +40,13 @@ describe('webex-core', () => {
         });
 
         it('does not add a trackingid if one has already been added', () => {
-          assert.isFalse(interceptor.requiresTrackingId({
-            headers: {
-              trackingid: 'some id'
-            }
-          }));
+          assert.isFalse(
+            interceptor.requiresTrackingId({
+              headers: {
+                trackingid: 'some id',
+              },
+            })
+          );
         });
       });