PR feedback, use emulators:exec instead

Author: sam-gc

packages-exp/auth-exp/README.md

@@ -25,18 +25,27 @@ are not broken into such granular details. Check out `package.json` for more.
 
 To test against the emulator, set up the Auth emulator
 ([instructions](https://firebase.google.com/docs/emulator-suite/connect_and_prototype)).
-When starting the emulators, make sure to specify the project ID manually
-when issuing the command (the local integration tests use a fake project ID):
-`firebase emulators:start --project test-emulator`). Once the emulator is
-started and waiting, you can execute the tests. In addition to the npm commands
-above, you can execute the following:
+The easiest way to run these tests is to use the `firebase emulators:exec`
+command
+([documentation](https://firebase.google.com/docs/emulator-suite/install_and_configure#startup)).
+You can also manually start the emulator separately, and then point the tests
+to it by setting the `GCLOUD_PROJECT` and `FIREBASE_AUTH_EMULATOR_HOST`
+environmental variables. In addition to the commands listed above, the below
+commands also run various tests:
 
   * `yarn test:integration:local` — Executes Node and browser emulator
     integration tests, as well as the Selenium WebDriver tests
 
   * `yarn test:webdriver` — Executes only the Selenium WebDriver
     integration tests
 
+For example, to run all integration and WebDriver tests against the emulator,
+you would simply execute the following command:
+
+```sh
+firebase emulators:exec --project foo-bar --only auth "yarn test:integration:local"
+```
+
 ### Selenium Webdriver tests
 
 These tests assume that you have both Firefox and Chrome installed on your

packages-exp/auth-exp/karma.conf.js

@@ -57,13 +57,20 @@ function getClientConfig(argv) {
     return {};
   }
 
+  if (!process.env.GCLOUD_PROJECT || !process.env.FIREBASE_AUTH_EMULATOR_HOST) {
+    console.error('Local testing against emulator requested, but ' +
+    'GCLOUD_PROJECT and FIREBASE_AUTH_EMULATOR_HOST env variables ' +
+    'are missing');
+    process.exit(1);
+  }
+
   return {
     authAppConfig: {
       apiKey: 'local-api-key',
-      projectId: 'test-emulator',
+      projectId: process.env.GCLOUD_PROJECT,
       authDomain: 'local-auth-domain'
     },
-    authEmulatorPort: '9099'
+    authEmulatorHost: process.env.FIREBASE_AUTH_EMULATOR_HOST,
   };
 }
 

packages-exp/auth-exp/scripts/run-node-tests.js

@@ -61,17 +61,28 @@ let args = [
   '../../config/mocharc.node.js'
 ];
 
+// Make sure that the environment variables are present for local test
 if (argv.local) {
-  process.env.AUTH_EMULATOR_PORT = '9099';
-  process.env.AUTH_EMULATOR_PROJECT_ID = 'test-emulator';
+  if (!process.env.GCLOUD_PROJECT || !process.env.FIREBASE_AUTH_EMULATOR_HOST) {
+    console.error('Local testing against emulator requested, but ' +
+    'GCLOUD_PROJECT and FIREBASE_AUTH_EMULATOR_HOST env variables ' +
+    'are missing');
+    process.exit(1);
+  }
 }
 
 args = args.concat(argv._ as string[]);
 
-const childProcess = spawn(nyc, args, {
+const spawned = spawn(nyc, args, {
   stdio: 'inherit',
   cwd: process.cwd()
-}).childProcess;
+});
+
+const childProcess = spawned.childProcess;
+spawned.catch(() => {
+  childProcess.kill();
+  process.exit(1);
+});
 
 process.once('exit', () => childProcess.kill());
 process.once('SIGINT', () => childProcess.kill('SIGINT'));

packages-exp/auth-exp/scripts/run-node-tests.ts

@@ -15,11 +15,9 @@
  * limitations under the License.
  */
 
-// eslint-disable-next-line import/no-extraneous-dependencies
-import { Auth } from '@firebase/auth-exp';
-import { getApps } from '@firebase/app-exp';
 import { FetchProvider } from '../../../src/core/util/fetch_provider';
 import * as fetchImpl from 'node-fetch';
+import { getAppConfig, getEmulatorUrl } from './settings';
 
 if (typeof document !== 'undefined') {
   FetchProvider.initialize(fetch);
@@ -53,10 +51,8 @@ interface OobCodesResponse {
 }
 
 export async function getPhoneVerificationCodes(
-  auth: Auth
 ): Promise<Record<string, VerificationSession>> {
-  assertEmulator(auth);
-  const url = getEmulatorUrl(auth, 'verificationCodes');
+  const url = buildEmulatorUrlForPath('verificationCodes');
   const response: VerificationCodesResponse = await (
     await FetchProvider.fetch()(url)
   ).json();
@@ -67,27 +63,21 @@ export async function getPhoneVerificationCodes(
   }, {} as Record<string, VerificationSession>);
 }
 
-export async function getOobCodes(auth: Auth): Promise<OobCodeSession[]> {
-  assertEmulator(auth);
-  const url = getEmulatorUrl(auth, 'oobCodes');
+export async function getOobCodes(): Promise<OobCodeSession[]> {
+  const url = buildEmulatorUrlForPath('oobCodes');
   const response: OobCodesResponse = await (
     await FetchProvider.fetch()(url)
   ).json();
   return response.oobCodes;
 }
 
-function getEmulatorUrl(auth: Auth, endpoint: string): string {
-  const { host, port, protocol } = auth.emulatorConfig!;
-  const projectId = getProjectId(auth);
-  return `${protocol}://${host}:${port}/emulator/v1/projects/${projectId}/${endpoint}`;
+export async function resetEmulator(): Promise<void> {
+  const url = buildEmulatorUrlForPath('accounts');
+  await FetchProvider.fetch()(url, {method: 'DELETE'});
 }
 
-function getProjectId(auth: Auth): string {
-  return getApps().find(app => app.name === auth.name)!.options.projectId!;
-}
-
-function assertEmulator(auth: Auth): void {
-  if (!auth.emulatorConfig) {
-    throw new Error("Can't fetch OOB codes against prod API");
-  }
+function buildEmulatorUrlForPath(endpoint: string): string {
+  const emulatorBaseUrl = getEmulatorUrl();
+  const projectId = getAppConfig().projectId;
+  return `${emulatorBaseUrl}/emulator/v1/projects/${projectId}/${endpoint}`;
 }

packages-exp/auth-exp/test/helpers/integration/emulator_rest_helpers.ts

@@ -22,6 +22,7 @@ import { Auth, User } from '../../../src/model/public_types';
 import { getAuth, useAuthEmulator } from '../../../'; // Use browser OR node dist entrypoint depending on test env.
 import { _generateEventId } from '../../../src/core/util/event_id';
 import { getAppConfig, getEmulatorUrl } from './settings';
+import { resetEmulator } from './emulator_rest_helpers';
 
 interface IntegrationTestAuth extends Auth {
   cleanUp(): Promise<void>;
@@ -55,12 +56,17 @@ export function getTestInstance(requireEmulator = false): Auth {
   });
 
   auth.cleanUp = async () => {
-    // Clear out any new users that were created in the course of the test
-    for (const user of createdUsers) {
-      try {
-        await user.delete();
-      } catch {
-        // Best effort. Maybe the test already deleted the user ¯\_(ツ)_/¯
+    // If we're in an emulated environment, the emulator will clean up for us
+    if (emulatorUrl) {
+      await resetEmulator();
+    } else {
+      // Clear out any new users that were created in the course of the test
+      for (const user of createdUsers) {
+        try {
+          await user.delete();
+        } catch {
+          // Best effort. Maybe the test already deleted the user ¯\_(ツ)_/¯
+        }
       }
     }
 

packages-exp/auth-exp/test/helpers/integration/helpers.ts

@@ -24,10 +24,10 @@ declare const __karma__: any;
 // eslint-disable-next-line @typescript-eslint/no-require-imports
 const PROJECT_CONFIG = require('../../../../../config/project.json');
 
-const EMULATOR_PORT = process.env.AUTH_EMULATOR_PORT;
-const EMULATOR_PROJECT_ID = process.env.AUTH_EMULATOR_PROJECT_ID;
+const EMULATOR_HOST = process.env.FIREBASE_AUTH_EMULATOR_HOST;
+const EMULATOR_PROJECT_ID = process.env.GCLOUD_PROJECT;
 
-export const USE_EMULATOR = !!EMULATOR_PORT;
+export const USE_EMULATOR = !!EMULATOR_HOST;
 
 export const PROJECT_ID = USE_EMULATOR
   ? EMULATOR_PROJECT_ID
@@ -52,11 +52,8 @@ export function getAppConfig(): FirebaseOptions {
 
 export function getEmulatorUrl(): string | null {
   // Check karma first, then fallback on node process
-  const emulatorPort: string | null =
-    getKarma()?.config?.authEmulatorPort ||
-    (USE_EMULATOR ? EMULATOR_PORT : null);
-
-  return emulatorPort ? `http://localhost:${emulatorPort}` : null;
+  const host = getKarma()?.config?.authEmulatorHost || (USE_EMULATOR ? EMULATOR_HOST : null);
+  return host ? `http://${host}` : null;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

packages-exp/auth-exp/test/helpers/integration/settings.ts

@@ -77,7 +77,7 @@ describe('Integration test: oob codes', () => {
   });
 
   async function code(toEmail: string): Promise<OobCodeSession> {
-    const codes = await getOobCodes(auth);
+    const codes = await getOobCodes();
     return codes.reverse().find(({ email }) => email === toEmail)!;
   }
 

packages-exp/auth-exp/test/integration/flows/oob.local.test.ts

@@ -88,7 +88,7 @@ describe('Integration test: phone auth', () => {
     fallback: string
   ): Promise<string> {
     if (auth.emulatorConfig) {
-      const codes = await getPhoneVerificationCodes(auth);
+      const codes = await getPhoneVerificationCodes();
       const vid = typeof crOrId === 'string' ? crOrId : crOrId.verificationId;
       return codes[vid].code;
     }

packages-exp/auth-exp/test/integration/flows/phone.test.ts

@@ -42,14 +42,11 @@ window.userSnap = async () => auth.currentUser;
 
 window.authSnap = async () => auth;
 
-// Initialize library and attach globals
-(async () => {
-  const app = initializeApp({
-    apiKey: 'api-key',
-    projectId: 'test-emulator',
-    authDomain: 'http://localhost/emulator'
-  });
+// The config and emulator URL are injected by the test. The test framework
+// calls this function after that injection.
+window.startAuth = async () => {
+  const app = initializeApp(firebaseConfig);
   auth = getAuth(app);
-  useAuthEmulator(auth, 'http://localhost:9099');
+  useAuthEmulator(auth, emulatorUrl);
   window.auth = auth;
-})();
+}

packages-exp/auth-exp/test/integration/webdriver/static/index.js

@@ -18,6 +18,8 @@
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { Auth, User } from '@firebase/auth-exp';
 import { Builder, WebDriver } from 'selenium-webdriver';
+import { resetEmulator } from '../../../helpers/integration/emulator_rest_helpers';
+import { getEmulatorUrl, PROJECT_ID, USE_EMULATOR } from '../../../helpers/integration/settings';
 import { authTestServer } from './test_server';
 
 /** Browsers to run the tests on */
@@ -29,7 +31,8 @@ export enum TestFunction {
   RESET = 'reset',
   AWAIT_AUTH_INIT = 'authInit',
   USER_SNAPSHOT = 'userSnap',
-  AUTH_SNAPSHOT = 'authSnap'
+  AUTH_SNAPSHOT = 'authSnap',
+  START_AUTH = 'startAuth',
 }
 
 /** Helper wraper around the WebDriver object */
@@ -40,6 +43,7 @@ export class AuthDriver {
     await authTestServer.start();
     this.webDriver = await new Builder().forBrowser(browser).build();
     await this.webDriver.get(authTestServer.address!);
+    await this.injectConfigAndInitAuth();
   }
 
   async stop(): Promise<void> {
@@ -92,6 +96,7 @@ export class AuthDriver {
   }
 
   async reset(): Promise<void> {
+    await resetEmulator();
     return this.call(TestFunction.RESET);
   }
 
@@ -101,6 +106,25 @@ export class AuthDriver {
 
   async refresh(): Promise<void> {
     await this.webDriver.navigate().refresh();
+    await this.injectConfigAndInitAuth();
     await this.waitForAuthInit();
   }
+
+  private async injectConfigAndInitAuth(): Promise<void> {
+    if (!USE_EMULATOR) {
+      throw new Error('Local testing against emulator requested, but ' +
+    'GCLOUD_PROJECT and FIREBASE_AUTH_EMULATOR_HOST env variables ' +
+    'are missing');
+    }
+
+    await this.webDriver.executeScript(`
+      window.firebaseConfig = {
+        apiKey: 'emulator-api-key',
+        projectId: '${PROJECT_ID}',
+        authDomain: 'http://localhost/emulator',
+      };
+      window.emulatorUrl = '${getEmulatorUrl()}';
+    `);
+    await this.call(TestFunction.START_AUTH);
+  }
 }