Fix Saucelabs tests for Firestore unit tests except IE (#3095)

Author: hsubox76

config/karma.saucelabs.js

@@ -49,6 +49,14 @@ const packageConfigs = {
   messaging: {
     // Messaging currently only supports these browsers.
     browsers: ['Chrome_Windows', 'Firefox_Windows', 'Edge_Windows']
+  },
+  firestore: {
+    browsers: [
+      'Chrome_Windows',
+      'Firefox_Windows',
+      'Edge_Windows',
+      'Safari_macOS'
+    ]
   }
 };
 
@@ -170,7 +178,8 @@ module.exports = function(config) {
       'packages/polyfill/index.ts': ['webpack', 'sourcemap'],
       '**/test/**/*.ts': ['webpack', 'sourcemap'],
       '**/*.test.ts': ['webpack', 'sourcemap'],
-      'packages/firestore/test/**/bootstrap.ts': ['webpack', 'babel'],
+      // Restore when ready to run Firestore unit tests in IE.
+      // 'packages/firestore/test/**/bootstrap.ts': ['webpack', 'babel'],
       'integration/**/namespace.*': ['webpack', 'babel', 'sourcemap']
     },
 

package.json

@@ -40,7 +40,6 @@
     "test:changed": "node scripts/run_changed.js",
     "test:setup": "node tools/config.js",
     "test:saucelabs": "node scripts/run_saucelabs.js",
-    "test:saucelabs:single": "karma start config/karma.saucelabs.js --single-run",
     "docgen:js": "node scripts/docgen/generate-docs.js --api js",
     "docgen:node": "node scripts/docgen/generate-docs.js --api node",
     "docgen": "yarn docgen:js; yarn docgen:node",

packages/firestore/karma.conf.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2017 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,6 @@
  * limitations under the License.
  */
 
-const karma = require('karma');
-const path = require('path');
 const karmaBase = require('../../config/karma.base');
 const { argv } = require('yargs');
 

packages/firestore/src/util/async_queue.ts

@@ -358,7 +358,7 @@ export class AsyncQueue {
         .catch((error: FirestoreError) => {
           this.failure = error;
           this.operationInProgress = false;
-          const message = error.stack || error.message || '';
+          const message = getMessageOrStack(error);
           logError('INTERNAL UNHANDLED ERROR: ', message);
 
           // Re-throw the error so that this.tail becomes a rejected Promise and
@@ -411,10 +411,7 @@ export class AsyncQueue {
 
   private verifyNotFailed(): void {
     if (this.failure) {
-      fail(
-        'AsyncQueue is already failed: ' +
-          (this.failure.stack || this.failure.message)
-      );
+      fail('AsyncQueue is already failed: ' + getMessageOrStack(this.failure));
     }
   }
 
@@ -515,3 +512,20 @@ export function wrapInUserErrorIfRecoverable(
     throw e;
   }
 }
+
+/**
+ * Chrome includes Error.message in Error.stack. Other browsers do not.
+ * This returns expected output of message + stack when available.
+ * @param error Error or FirestoreError
+ */
+function getMessageOrStack(error: Error): string {
+  let message = error.message || '';
+  if (error.stack) {
+    if (error.stack.includes(error.message)) {
+      message = error.stack;
+    } else {
+      message = error.message + '\n' + error.stack;
+    }
+  }
+  return message;
+}

packages/firestore/test/unit/core/event_manager.test.ts

@@ -224,9 +224,10 @@ describe('QueryListener', () => {
     const query = Query.atPath(path('rooms/Eros'));
 
     const listener = queryListener(query, [], events);
+    const error = new Error('bad');
 
-    listener.onError(Error('bad'));
-    expect(events[0]).to.deep.equal(new Error('bad'));
+    listener.onError(error);
+    expect(events[0]).to.deep.equal(error);
   });
 
   it('raises event for empty collection after sync', () => {

packages/firestore/test/unit/util/async_queue.test.ts

@@ -24,6 +24,7 @@ import { getLogLevel, LogLevel, setLogLevel } from '../../../src/util/log';
 import { Deferred, Rejecter, Resolver } from '../../../src/util/promise';
 import { fail } from '../../../src/util/assert';
 import { IndexedDbTransactionError } from '../../../src/local/simple_db';
+import { isSafari } from '@firebase/util';
 
 use(chaiAsPromised);
 
@@ -137,7 +138,9 @@ describe('AsyncQueue', () => {
     });
   });
 
-  it('can schedule ops in the future', async () => {
+  // Flaky on Safari.
+  // eslint-disable-next-line no-restricted-properties
+  (isSafari() ? it.skip : it)('can schedule ops in the future', async () => {
     const queue = new AsyncQueue();
     const completedSteps: number[] = [];
     const doStep = (n: number): Promise<number> =>

packages/firestore/test/util/test_platform.ts

@@ -271,12 +271,3 @@ export class TestPlatform implements Platform {
     return this.basePlatform.randomBytes(nBytes);
   }
 }
-
-/** Returns true if we are running under Node. */
-export function isNode(): boolean {
-  return (
-    typeof process !== 'undefined' &&
-    process.title !== undefined &&
-    process.title.indexOf('node') !== -1
-  );
-}

packages/util/src/environment.ts

@@ -125,3 +125,12 @@ export function isUWP(): boolean {
 export function isNodeSdk(): boolean {
   return CONSTANTS.NODE_CLIENT === true || CONSTANTS.NODE_ADMIN === true;
 }
+
+/** Returns true if we are running in Safari. */
+export function isSafari(): boolean {
+  return (
+    !isNode() &&
+    navigator.userAgent.includes('Safari') &&
+    !navigator.userAgent.includes('Chrome')
+  );
+}

scripts/run_saucelabs.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2019 Google Inc.
+ * Copyright 2019 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -44,8 +44,7 @@ const testFiles = configFiles.length
 // Get CI build number or generate one if running locally.
 const buildNumber =
   process.env.TRAVIS_BUILD_NUMBER ||
-  // GitHub Actions does not have a build number, but the feature has been requested.
-  process.env.GITHUB_SHA ||
+  process.env.GITHUB_RUN_ID ||
   `local_${process.env.USER}_${new Date().getTime()}`;
 
 /**
@@ -67,26 +66,25 @@ async function runTest(testFile) {
       });
     }
   }
+  return runKarma(testFile);
+}
 
-  const promise = spawn('yarn', [
-    'test:saucelabs:single',
+async function runKarma(testFile) {
+  const karmaArgs = [
+    'karma',
+    'start',
+    'config/karma.saucelabs.js',
+    '--single-run',
     '--testConfigFile',
     testFile,
     '--buildNumber',
     buildNumber
-  ]);
+  ];
+
+  const promise = spawn('npx', karmaArgs, { stdio: 'inherit' });
   const childProcess = promise.childProcess;
   let exitCode = 0;
 
-  childProcess.stdout.on('data', data => {
-    console.log(`[${testFile}]:`, data.toString());
-  });
-
-  // Lerna's normal output goes to stderr for some reason.
-  childProcess.stderr.on('data', data => {
-    console.log(`[${testFile}]:`, data.toString());
-  });
-
   // Capture exit code of this single package test run
   childProcess.on('exit', code => {
     exitCode = code;