Fix SauceLabs tests (#1920)

mmermerkaya · Feiyang1 · commit 353fc529f068 · 2019-09-18T12:06:50.000-07:00
* Fix SauceLabs tests for Installations and Performance * add resolveJsonModule * stub storage differently so tests work in Firefox and IE (#1940) * stub storage differently so tests work in Firefox and IE * [AUTOMATED]: Prettier Code Styling * rewrite test setup * [AUTOMATED]: Prettier Code Styling * change compilation target to es5 * fix IE11 errors * fix storage IE11 tests * fix util IE11 test * fix performance IE11 tests * make installations run in IE * fix integration/typescript tests in saucelabs * [AUTOMATED]: Prettier Code Styling * revert change that doesn't work * fix lint * add babel loader
diff --git a/config/karma.saucelabs.js b/config/karma.saucelabs.js
@@ -169,6 +169,7 @@ module.exports = function(config) {
     preprocessors: {
       'packages/polyfill/index.ts': ['webpack', 'sourcemap'],
       '**/test/**/*.ts': ['webpack', 'sourcemap'],
+      '**/*.test.ts': ['webpack', 'sourcemap'],
       'packages/firestore/test/**/bootstrap.ts': ['webpack', 'babel'],
       'integration/**/namespace.*': ['webpack', 'babel', 'sourcemap']
     },
diff --git a/config/webpack.test.js b/config/webpack.test.js
@@ -31,7 +31,9 @@ module.exports = {
           options: {
             compilerOptions: {
               module: 'commonjs',
-              downlevelIteration: true
+              target: 'es5',
+              downlevelIteration: true,
+              resolveJsonModule: true
             }
           }
         }
@@ -49,11 +51,29 @@ module.exports = {
         },
         enforce: 'post',
         include: path.resolve(process.cwd(), 'src')
+      },
+      {
+        test: /\.js$/,
+        include: [/node_modules\/chai-as-promised/],
+        use: {
+          loader: 'babel-loader',
+          options: {
+            presets: [
+              [
+                '@babel/preset-env',
+                {
+                  targets: ['ie 11']
+                }
+              ]
+            ]
+          }
+        }
       }
     ]
   },
   resolve: {
     modules: ['node_modules', path.resolve(__dirname, '../../node_modules')],
+    mainFields: ['browser', 'main', 'module'],
     extensions: ['.js', '.ts']
   },
   plugins: [
diff --git a/integration/shared/validator.js b/integration/shared/validator.js
@@ -106,3 +106,4 @@ function validateNamespace(definition, candidate) {
 }
 
 module.exports = validateNamespace;
+module.exports.default = validateNamespace;
diff --git a/package.json b/package.json
@@ -70,6 +70,7 @@
     "typedoc": "0.15.0",
     "ts-node": "8.3.0",
     "typescript": "3.5.3",
-    "yargs": "14.0.0"
+    "yargs": "14.0.0",
+    "babel-loader": "8.0.6"
   }
 }
diff --git a/packages/installations/src/helpers/buffer-to-base64-url-safe.test.ts b/packages/installations/src/helpers/buffer-to-base64-url-safe.test.ts
@@ -19,8 +19,13 @@ import { expect } from 'chai';
 import '../testing/setup';
 import { bufferToBase64UrlSafe } from './buffer-to-base64-url-safe';
 
-const TYPED_ARRAY_REPRESENTATION = new TextEncoder().encode('hello world');
-const BASE_64_REPRESENTATION = btoa('hello world');
+const str = 'hello world';
+const TYPED_ARRAY_REPRESENTATION = new Uint8Array(str.length);
+for (let i = 0; i < str.length; i++) {
+  TYPED_ARRAY_REPRESENTATION[i] = str.charCodeAt(i);
+}
+
+const BASE_64_REPRESENTATION = btoa(str);
 
 describe('bufferToBase64', () => {
   it('returns a base64 representation of a Uint8Array', () => {
diff --git a/packages/performance/src/services/api_service.test.ts b/packages/performance/src/services/api_service.test.ts
@@ -31,6 +31,8 @@ describe('Firebase Performance > api_service', () => {
   };
 
   const mockWindow = { ...self };
+  // hack for IE11. self.hasOwnProperty('performance') returns false in IE11
+  mockWindow.performance = self.performance;
 
   let api: Api;
 
diff --git a/packages/performance/src/services/remote_config_service.test.ts b/packages/performance/src/services/remote_config_service.test.ts
@@ -14,11 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { stub, SinonStub, useFakeTimers, SinonFakeTimers } from 'sinon';
+import { stub, useFakeTimers, SinonFakeTimers, SinonStub } from 'sinon';
 import { expect } from 'chai';
 import { SettingsService } from './settings_service';
 import { CONFIG_EXPIRY_LOCAL_STORAGE_KEY } from '../constants';
-import { setupApi } from './api_service';
+import { setupApi, Api } from './api_service';
 import * as iidService from './iid_service';
 import { getConfig } from './remote_config_service';
 import { FirebaseApp } from '@firebase/app-types';
@@ -41,11 +41,10 @@ describe('Performance Monitoring > remote_config_service', () => {
   const APP_ID = '1:23r:web:fewq';
   const API_KEY = 'asdfghjk';
 
-  let fetchStub: SinonStub<[RequestInfo, RequestInit?], Promise<Response>>;
-  let storageGetItemStub: SinonStub<[string], string | null>;
   let clock: SinonFakeTimers;
 
   setupApi(self);
+  const ApiInstance = Api.getInstance();
 
   function storageGetItemFakeFactory(
     expiry: string,
@@ -67,17 +66,47 @@ describe('Performance Monitoring > remote_config_service', () => {
     settingsService.tracesSamplingRate = 1;
   }
 
-  beforeEach(() => {
-    fetchStub = stub(self, 'fetch');
-    storageGetItemStub = stub(self.localStorage, 'getItem');
+  // parameterized beforeEach. Should be called at beginning of each test.
+  function setup(
+    storageConfig: { expiry: string; config: string },
+    fetchConfig?: { reject: boolean; value?: Response }
+  ): {
+    storageGetItemStub: SinonStub<[string], string | null>;
+    fetchStub: SinonStub<[RequestInfo, RequestInit?], Promise<Response>>;
+  } {
+    const fetchStub = stub(self, 'fetch');
+
+    if (fetchConfig) {
+      fetchConfig.reject
+        ? fetchStub.rejects()
+        : fetchStub.resolves(fetchConfig.value);
+    }
+
     stub(iidService, 'getAuthTokenPromise').returns(
       Promise.resolve(AUTH_TOKEN)
     );
+
     clock = useFakeTimers(GLOBAL_CLOCK_NOW);
     SettingsService.prototype.firebaseAppInstance = ({
       options: { projectId: PROJECT_ID, appId: APP_ID, apiKey: API_KEY }
     } as unknown) as FirebaseApp;
-  });
+
+    // we need to stub the entire localStorage, because storage can't be stubbed in Firefox and IE.
+    // stubbing on self(window) seems to only work the first time (at least in Firefox), the subsequent
+    // tests will have the same stub. stub.reset() in afterEach doesn't help either. As a result, we stub on ApiInstance.
+    // https://github.com/sinonjs/sinon/issues/662
+    const storageStub = stub(ApiInstance, 'localStorage');
+    const getItemStub: SinonStub<[string], string | null> = stub();
+
+    storageStub.value({
+      getItem: getItemStub.callsFake(
+        storageGetItemFakeFactory(storageConfig.expiry, storageConfig.config)
+      ),
+      setItem: () => {}
+    });
+
+    return { storageGetItemStub: getItemStub, fetchStub };
+  }
 
   afterEach(() => {
     resetSettingsService();
@@ -88,15 +117,14 @@ describe('Performance Monitoring > remote_config_service', () => {
     it('gets the config from the local storage if available and valid', async () => {
       // After global clock. Config not expired.
       const EXPIRY_LOCAL_STORAGE_VALUE = '1556524895330';
-      storageGetItemStub.callsFake(
-        storageGetItemFakeFactory(
-          EXPIRY_LOCAL_STORAGE_VALUE,
-          STRINGIFIED_CONFIG
-        )
-      );
+      const { storageGetItemStub: getItemStub } = setup({
+        expiry: EXPIRY_LOCAL_STORAGE_VALUE,
+        config: STRINGIFIED_CONFIG
+      });
+
       await getConfig(IID);
 
-      expect(storageGetItemStub).to.be.called;
+      expect(getItemStub).to.be.called;
       expect(SettingsService.getInstance().loggingEnabled).to.be.true;
       expect(SettingsService.getInstance().logEndPointUrl).to.equal(LOG_URL);
       expect(SettingsService.getInstance().logSource).to.equal(LOG_SOURCE);
@@ -111,12 +139,12 @@ describe('Performance Monitoring > remote_config_service', () => {
     it('does not call remote config if a valid config is in local storage', async () => {
       // After global clock. Config not expired.
       const EXPIRY_LOCAL_STORAGE_VALUE = '1556524895330';
-      storageGetItemStub.callsFake(
-        storageGetItemFakeFactory(
-          EXPIRY_LOCAL_STORAGE_VALUE,
-          STRINGIFIED_CONFIG
-        )
-      );
+
+      const { fetchStub } = setup({
+        expiry: EXPIRY_LOCAL_STORAGE_VALUE,
+        config: STRINGIFIED_CONFIG
+      });
+
       await getConfig(IID);
 
       expect(fetchStub).not.to.be.called;
@@ -125,16 +153,15 @@ describe('Performance Monitoring > remote_config_service', () => {
     it('gets the config from RC if local version is not valid', async () => {
       // Expired local config.
       const EXPIRY_LOCAL_STORAGE_VALUE = '1556524895320';
-      storageGetItemStub.callsFake(
-        storageGetItemFakeFactory(
-          EXPIRY_LOCAL_STORAGE_VALUE,
-          'not a valid config and should not be used'
-        )
+
+      const { storageGetItemStub: getItemStub } = setup(
+        { expiry: EXPIRY_LOCAL_STORAGE_VALUE, config: STRINGIFIED_CONFIG },
+        { reject: false, value: new Response(STRINGIFIED_CONFIG) }
       );
-      fetchStub.resolves(new Response(STRINGIFIED_CONFIG));
+
       await getConfig(IID);
 
-      expect(storageGetItemStub).to.be.calledOnce;
+      expect(getItemStub).to.be.calledOnce;
       expect(SettingsService.getInstance().loggingEnabled).to.be.true;
       expect(SettingsService.getInstance().logEndPointUrl).to.equal(LOG_URL);
       expect(SettingsService.getInstance().logSource).to.equal(LOG_SOURCE);
@@ -149,13 +176,15 @@ describe('Performance Monitoring > remote_config_service', () => {
     it('does not change the default config if call to RC fails', async () => {
       // Expired local config.
       const EXPIRY_LOCAL_STORAGE_VALUE = '1556524895320';
-      storageGetItemStub.callsFake(
-        storageGetItemFakeFactory(
-          EXPIRY_LOCAL_STORAGE_VALUE,
-          'not a valid config and should not be used'
-        )
+
+      setup(
+        {
+          expiry: EXPIRY_LOCAL_STORAGE_VALUE,
+          config: 'not a valid config and should not be used'
+        },
+        { reject: true }
       );
-      fetchStub.rejects();
+
       await getConfig(IID);
 
       expect(SettingsService.getInstance().loggingEnabled).to.equal(false);
@@ -164,17 +193,19 @@ describe('Performance Monitoring > remote_config_service', () => {
     it('uses secondary configs if the response does not have all the fields', async () => {
       // Expired local config.
       const EXPIRY_LOCAL_STORAGE_VALUE = '1556524895320';
-      storageGetItemStub.callsFake(
-        storageGetItemFakeFactory(
-          EXPIRY_LOCAL_STORAGE_VALUE,
-          'not a valid config and should not be used'
-        )
-      );
       const STRINGIFIED_PARTIAL_CONFIG = `{"entries":{\
       "fpr_vc_network_request_sampling_rate":"0.250000",\
       "fpr_vc_session_sampling_rate":"0.250000","fpr_vc_trace_sampling_rate":"0.500000"},\
       "state":"UPDATE"}`;
-      fetchStub.resolves(new Response(STRINGIFIED_PARTIAL_CONFIG));
+
+      setup(
+        {
+          expiry: EXPIRY_LOCAL_STORAGE_VALUE,
+          config: 'not a valid config and should not be used'
+        },
+        { reject: false, value: new Response(STRINGIFIED_PARTIAL_CONFIG) }
+      );
+
       await getConfig(IID);
 
       expect(SettingsService.getInstance().loggingEnabled).to.be.true;
@@ -183,14 +214,15 @@ describe('Performance Monitoring > remote_config_service', () => {
     it('uses secondary configs if the response does not have any fields', async () => {
       // Expired local config.
       const EXPIRY_LOCAL_STORAGE_VALUE = '1556524895320';
-      storageGetItemStub.callsFake(
-        storageGetItemFakeFactory(
-          EXPIRY_LOCAL_STORAGE_VALUE,
-          'not a valid config and should not be used'
-        )
-      );
       const STRINGIFIED_PARTIAL_CONFIG = '{"state":"NO TEMPLATE"}';
-      fetchStub.resolves(new Response(STRINGIFIED_PARTIAL_CONFIG));
+
+      setup(
+        {
+          expiry: EXPIRY_LOCAL_STORAGE_VALUE,
+          config: 'not a valid config and should not be used'
+        },
+        { reject: false, value: new Response(STRINGIFIED_PARTIAL_CONFIG) }
+      );
       await getConfig(IID);
 
       expect(SettingsService.getInstance().loggingEnabled).to.be.true;
diff --git a/packages/polyfill/index.ts b/packages/polyfill/index.ts
@@ -26,6 +26,7 @@ import 'core-js/features/array/find';
 import 'core-js/features/array/find-index';
 import 'core-js/features/array/from';
 import 'core-js/features/array/some';
+import 'core-js/features/typed-array/iterator';
 import 'core-js/features/object/assign';
 import 'core-js/features/object/entries';
 import 'core-js/features/object/values';
@@ -35,3 +36,4 @@ import 'core-js/features/symbol';
 import 'core-js/features/symbol/iterator';
 import 'core-js/features/map';
 import 'core-js/features/set';
+import 'core-js/features/number/is-integer';
diff --git a/packages/util/test/errors.test.ts b/packages/util/test/errors.test.ts
@@ -105,9 +105,16 @@ describe('FirebaseError', () => {
 
   it('has stack', () => {
     const e = ERROR_FACTORY.create('generic-error');
-    assert.isDefined(e.stack);
-    // Multi-line match trick - .* does not match \n
-    assert.match(e.stack!, /FirebaseError[\s\S]/);
+
+    // In case of IE11, stack will be set only after error is raised, so we throw the error then test.
+    // https://docs.microsoft.com/en-us/scripting/javascript/reference/stack-property-error-javascript
+    try {
+      throw e;
+    } catch (error) {
+      assert.isDefined(error.stack);
+      // Multi-line match trick - .* does not match \n
+      assert.match(error.stack, /FirebaseError[\s\S]/);
+    }
   });
 
   it('has function names in stack trace in correct order', () => {
diff --git a/yarn.lock b/yarn.lock
@@ -3079,6 +3079,16 @@ babel-generator@^6.18.0:
     source-map "^0.5.7"
     trim-right "^1.0.1"
 
+babel-loader@8.0.6:
+  version "8.0.6"
+  resolved "https://registry.npmjs.org/babel-loader/-/babel-loader-8.0.6.tgz#e33bdb6f362b03f4bb141a0c21ab87c501b70dfb"
+  integrity sha512-4BmWKtBOBm13uoUwd08UwjZlaw3O9GWf456R9j+5YykFZ6LUIjIKLc0zEZf+hauxPOJs96C8k6FvYD09vWzhYw==
+  dependencies:
+    find-cache-dir "^2.0.0"
+    loader-utils "^1.0.2"
+    mkdirp "^0.5.1"
+    pify "^4.0.1"
+
 babel-messages@^6.23.0:
   version "6.23.0"
   resolved "https://registry.npmjs.org/babel-messages/-/babel-messages-6.23.0.tgz#f3cdf4703858035b2a2951c6ec5edf6c62f2630e"

Original file line number	Diff line number	Diff line change
`@@ -106,3 +106,4 @@ function validateNamespace(definition, candidate) {`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`module.exports = validateNamespace;`
	`109`	`+module.exports.default = validateNamespace;`
Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,7 @@`
`70`	`70`	`"typedoc": "0.15.0",`
`71`	`71`	`"ts-node": "8.3.0",`
`72`	`72`	`"typescript": "3.5.3",`
`73`		`- "yargs": "14.0.0"`
	`73`	`+ "yargs": "14.0.0",`
	`74`	`+ "babel-loader": "8.0.6"`
`74`	`75`	`}`
`75`	`76`	`}`