Add bare-bones Cordova configuration / popup-redirect resolver

Author: sam-gc

packages-exp/auth-exp/index.cordova.ts

@@ -0,0 +1,53 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * This is the file that people using React Native will actually import. You
+ * should only include this file if you have something specific about your
+ * implementation that mandates having a separate entrypoint. Otherwise you can
+ * just use index.ts
+ */
+
+import { FirebaseApp } from '@firebase/app-types-exp';
+import { Auth } from '@firebase/auth-types-exp';
+import { indexedDBLocalPersistence } from './src/platform_browser/persistence/indexed_db';
+
+import { initializeAuth } from './src';
+import { registerAuth } from './src/core/auth/register';
+import { ClientPlatform } from './src/core/util/version';
+
+// Core functionality shared by all clients
+export * from './src';
+
+// Cordova also supports indexedDB / browserSession / browserLocal
+export {indexedDBLocalPersistence} from './src/platform_browser/persistence/indexed_db';
+export {browserLocalPersistence} from './src/platform_browser/persistence/local_storage';
+export {browserSessionPersistence} from './src/platform_browser/persistence/session_storage';
+
+export {cordovaPopupRedirectResolver} from './src/platform_cordova/popup_redirect';
+export {signInWithRedirect} from './src/platform_cordova/strategies/redirect';
+
+import {cordovaPopupRedirectResolver} from './src/platform_cordova/popup_redirect';
+
+export function getAuth(app: FirebaseApp): Auth {
+  return initializeAuth(app, {
+    persistence: indexedDBLocalPersistence,
+    popupRedirectResolver: cordovaPopupRedirectResolver,
+  });
+}
+
+registerAuth(ClientPlatform.CORDOVA);

packages-exp/auth-exp/package.json

@@ -7,6 +7,7 @@
   "main": "dist/node/index.js",
   "react-native": "dist/rn/index.js",
   "browser": "dist/esm5/index.js",
+  "cordova": "dist/cordova/index.esm5.js",
   "module": "dist/esm5/index.js",
   "esm2017": "dist/esm2017/index.js",
   "webworker": "dist/index.webworker.esm5.js",
@@ -26,7 +27,7 @@
     "test:browser:integration": "karma start --single-run --integration",
     "test:browser:debug": "karma start --auto-watch",
     "test:browser:unit:debug": "karma start --auto-watch --unit",
-    "test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'src/!(platform_browser|platform_react_native)/**/*.test.ts' --file index.node.ts --config ../../config/mocharc.node.js",
+    "test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'src/!(platform_browser|platform_react_native|platform_cordova)/**/*.test.ts' --file index.node.ts --config ../../config/mocharc.node.js",
     "api-report": "api-extractor run --local --verbose",
     "predoc": "node ../../scripts/exp/remove-exp.js temp",
     "doc": "api-documenter markdown --input temp --output docs",

packages-exp/auth-exp/src/core/auth/auth_impl.ts

@@ -101,17 +101,17 @@ export class AuthImpl implements Auth, _FirebaseService {
     persistenceHierarchy: Persistence[],
     popupRedirectResolver?: externs.PopupRedirectResolver
   ): Promise<void> {
+    if (popupRedirectResolver) {
+      this._popupRedirectResolver = _getInstance(popupRedirectResolver);
+    }
+
     // Have to check for app deletion throughout initialization (after each
     // promise resolution)
     this._initializationPromise = this.queue(async () => {
       if (this._deleted) {
         return;
       }
 
-      if (popupRedirectResolver) {
-        this._popupRedirectResolver = _getInstance(popupRedirectResolver);
-      }
-
       this.persistenceManager = await PersistenceUserManager.create(
         this,
         persistenceHierarchy

packages-exp/auth-exp/src/core/auth/register.ts

@@ -41,6 +41,8 @@ function getVersionForPlatform(
       return 'rn';
     case ClientPlatform.WORKER:
       return 'webworker';
+    case ClientPlatform.CORDOVA:
+      return 'cordova';
     default:
       return undefined;
   }

packages-exp/auth-exp/src/core/errors.ts

@@ -402,6 +402,10 @@ export interface AuthErrorParams extends GenericAuthErrorParams {
     appName: AppName;
     serverResponse: IdTokenMfaResponse;
   };
+  [AuthErrorCode.INVALID_CORDOVA_CONFIGURATION]: {
+    appName: AppName;
+    missingPlugin?: string;
+  }
 }
 
 export const _DEFAULT_AUTH_ERROR_FACTORY = new ErrorFactory<

packages-exp/auth-exp/src/core/util/resolver.ts

@@ -0,0 +1,43 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as externs from '@firebase/auth-types-exp';
+import { Auth } from '../../model/auth';
+import { PopupRedirectResolver } from '../../model/popup_redirect';
+import { AuthErrorCode } from '../errors';
+import { _assert } from './assert';
+import { _getInstance } from './instantiator';
+
+/**
+ * Chooses a popup/redirect resolver to use. This prefers the override (which
+ * is directly passed in), and falls back to the property set on the auth
+ * object. If neither are available, this function errors w/ an argument error.
+ *
+ * @internal
+ */
+export function _withDefaultResolver(
+  auth: Auth,
+  resolverOverride: externs.PopupRedirectResolver | undefined
+): PopupRedirectResolver {
+  if (resolverOverride) {
+    return _getInstance(resolverOverride);
+  }
+
+  _assert(auth._popupRedirectResolver, auth, AuthErrorCode.ARGUMENT_ERROR);
+
+  return auth._popupRedirectResolver;
+}

packages-exp/auth-exp/src/core/util/version.ts

@@ -27,6 +27,7 @@ export const enum ClientPlatform {
   BROWSER = 'Browser',
   NODE = 'Node',
   REACT_NATIVE = 'ReactNative',
+  CORDOVA = 'Cordova',
   WORKER = 'Worker'
 }
 

packages-exp/auth-exp/src/platform_browser/popup_redirect.ts

@@ -18,7 +18,6 @@
 import { SDK_VERSION } from '@firebase/app-exp';
 import * as externs from '@firebase/auth-types-exp';
 import { isEmpty, querystring } from '@firebase/util';
-import { _getInstance } from '../core/util/instantiator';
 
 import { AuthEventManager } from '../core/auth/auth_event_manager';
 import { AuthErrorCode } from '../core/errors';
@@ -72,26 +71,6 @@ interface ManagerOrPromise {
   promise?: Promise<EventManager>;
 }
 
-/**
- * Chooses a popup/redirect resolver to use. This prefers the override (which
- * is directly passed in), and falls back to the property set on the auth
- * object. If neither are available, this function errors w/ an argument error.
- *
- * @internal
- */
-export function _withDefaultResolver(
-  auth: Auth,
-  resolverOverride: externs.PopupRedirectResolver | undefined
-): PopupRedirectResolver {
-  if (resolverOverride) {
-    return _getInstance(resolverOverride);
-  }
-
-  _assert(auth._popupRedirectResolver, auth, AuthErrorCode.ARGUMENT_ERROR);
-
-  return auth._popupRedirectResolver;
-}
-
 class BrowserPopupRedirectResolver implements PopupRedirectResolver {
   private readonly eventManagers: Record<string, ManagerOrPromise> = {};
   private readonly iframes: Record<string, gapi.iframes.Iframe> = {};

packages-exp/auth-exp/src/platform_browser/strategies/popup.ts

@@ -29,7 +29,7 @@ import {
   PopupRedirectResolver
 } from '../../model/popup_redirect';
 import { User } from '../../model/user';
-import { _withDefaultResolver } from '../popup_redirect';
+import { _withDefaultResolver } from '../../core/util/resolver';
 import { AuthPopup } from '../util/popup';
 import { AbstractPopupRedirectOperation } from './abstract_popup_redirect_operation';
 

packages-exp/auth-exp/src/platform_browser/strategies/redirect.ts

@@ -30,7 +30,7 @@ import {
   PopupRedirectResolver
 } from '../../model/popup_redirect';
 import { User, UserCredential } from '../../model/user';
-import { _withDefaultResolver } from '../popup_redirect';
+import { _withDefaultResolver } from '../../core/util/resolver';
 import { AbstractPopupRedirectOperation } from './abstract_popup_redirect_operation';
 
 /**

packages-exp/auth-exp/src/platform_cordova/plugins.ts

@@ -0,0 +1,37 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// For some reason, the linter doesn't recognize that these are used elsewhere
+// in the SDK
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+declare namespace cordova.plugins.browsertab {
+  function isAvailable(cb: (available: boolean) => void): void;
+  function openUrl(url: string): void;
+}
+
+declare namespace cordova.InAppBrowser {
+  function open(url: string, target: string, options: string): unknown;
+}
+
+declare namespace universalLinks {
+  function subscribe(n: null, cb: (event: unknown) => void): void;
+}
+
+declare namespace BuildInfo {
+  const packageName: string;
+}

packages-exp/auth-exp/src/platform_cordova/popup_redirect.test.ts

@@ -0,0 +1,108 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as chaiAsPromised from 'chai-as-promised';
+import * as sinonChai from 'sinon-chai';
+import { expect, use } from 'chai';
+import { testAuth, TestAuth } from '../../test/helpers/mock_auth';
+import { SingletonInstantiator } from '../core/util/instantiator';
+import { AuthEventType, PopupRedirectResolver } from '../model/popup_redirect';
+import { cordovaPopupRedirectResolver } from './popup_redirect';
+import { GoogleAuthProvider } from '../core/providers/google';
+import { FirebaseError } from '@firebase/util';
+
+use(chaiAsPromised);
+use(sinonChai);
+
+describe('platform_cordova/popup_redirect', () => {
+  let auth: TestAuth;
+  let resolver: PopupRedirectResolver;
+
+  beforeEach(async () => {
+    auth = await testAuth();
+    resolver = new (cordovaPopupRedirectResolver as SingletonInstantiator<
+      PopupRedirectResolver
+    >)();
+  });
+
+  describe('_openRedirect plugin checks', () => {
+    // TODO: Rest of the tests go here
+    it('does not reject if all plugins installed', () => {
+      setExpectedPluginsButMissing([]);
+      expect(() => resolver._openRedirect(auth, new GoogleAuthProvider(), AuthEventType.SIGN_IN_VIA_REDIRECT))
+          .not.to.throw;
+    });
+
+    it('rejects if universal links is missing', () => {
+      setExpectedPluginsButMissing(['universalLinks.subscribe']);
+      expect(() => resolver._openRedirect(auth, new GoogleAuthProvider(), AuthEventType.SIGN_IN_VIA_REDIRECT))
+          .to.throw(FirebaseError, 'auth/invalid-cordova-configuration');
+    });
+
+    it('rejects if build info is missing', () => {
+      setExpectedPluginsButMissing(['BuildInfo.packageName']);
+      expect(() => resolver._openRedirect(auth, new GoogleAuthProvider(), AuthEventType.SIGN_IN_VIA_REDIRECT))
+        .to.throw(FirebaseError, 'auth/invalid-cordova-configuration');
+    });
+
+    it('rejects if browsertab openUrl', () => {
+      setExpectedPluginsButMissing(['cordova.plugins.browsertab.openUrl']);
+      expect(() => resolver._openRedirect(auth, new GoogleAuthProvider(), AuthEventType.SIGN_IN_VIA_REDIRECT))
+          .to.throw(FirebaseError, 'auth/invalid-cordova-configuration');
+    });
+
+    it('rejects if InAppBrowser is missing', () => {
+      setExpectedPluginsButMissing(['cordova.InAppBrowser.open']);
+      expect(() => resolver._openRedirect(auth, new GoogleAuthProvider(), AuthEventType.SIGN_IN_VIA_REDIRECT))
+          .to.throw(FirebaseError, 'auth/invalid-cordova-configuration');
+    });
+  });
+});
+
+function setExpectedPluginsButMissing(missingPlugins: string[]): void {
+  // eslint-disable @typescript-eslint/no-any We don't want a strictly typed window
+  const win: any = window;
+  // Eventually these will be replaced with mocks
+  win.cordova = {
+    plugins: {
+      browsertab: {
+        isAvailable: () => {},
+        openUrl: () => {},
+      }
+    },
+    InAppBrowser: {
+      open: () => {},
+    },
+  };
+  win.universalLinks = {
+    subscribe: () => {},
+  };
+  win.BuildInfo = {
+    packageName: 'com.name.package',
+  };
+
+  for (const missing of missingPlugins) {
+    const parts = missing.split('.');
+    const last = parts.pop()!;
+    // eslint-disable @typescript-eslint/no-any We're just traversing an object map
+    let obj: any = win;
+    for (const p of parts) {
+      obj = obj[p];
+    }
+    delete obj[last];
+  }
+}