Add conditional delays to auth-next

Author: avolkovi

packages-exp/auth-exp/src/api/index.test.ts

@@ -175,7 +175,7 @@ describe('performApiRequest', () => {
         Endpoint.SIGN_UP,
         request
       );
-      clock.tick(DEFAULT_API_TIMEOUT_MS + 1);
+      clock.tick(DEFAULT_API_TIMEOUT_MS.get() + 1);
       await expect(promise).to.be.rejectedWith(
         FirebaseError,
         'Firebase: The operation has timed out. (auth/timeout).'

packages-exp/auth-exp/src/api/index.ts

@@ -25,6 +25,7 @@ import {
   ServerErrorMap,
   SERVER_ERROR_MAP
 } from './errors';
+import { Delay } from '../core/util/delay';
 
 export enum HttpMethod {
   POST = 'POST',
@@ -53,7 +54,7 @@ export enum Endpoint {
   WITHDRAW_MFA = '/v2/accounts/mfaEnrollment:withdraw'
 }
 
-export const DEFAULT_API_TIMEOUT_MS = 30_000;
+export const DEFAULT_API_TIMEOUT_MS = new Delay(30_000, 60_000);
 
 export async function performApiRequest<T, V>(
   auth: Auth,
@@ -101,7 +102,7 @@ export async function performApiRequest<T, V>(
               appName: auth.name
             })
           );
-        }, DEFAULT_API_TIMEOUT_MS)
+        }, DEFAULT_API_TIMEOUT_MS.get())
       )
     ]);
     if (response.ok) {

packages-exp/auth-exp/src/core/util/delay.test.ts

@@ -0,0 +1,55 @@
+/**
+ * @license
+ * Copyright 2020 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 util from '@firebase/util';
+import { expect } from 'chai';
+import { restore, stub } from 'sinon';
+import { Delay, _OFFLINE_DELAY_MS } from './delay';
+import * as navigator from './navigator';
+
+describe('Delay.get()', () => {
+  const SHORT_DELAY = 30_000;
+  const LONG_DELAY = 60_000;
+  
+  afterEach(restore);
+
+  it('should return the short delay in browser environments', () => {
+    const delay = new Delay(SHORT_DELAY, LONG_DELAY);
+    expect(delay.get()).to.eq(SHORT_DELAY);
+  });
+
+  it('should return the long delay in Cordova environments', () => {
+    const mock = stub(util, 'isMobileCordova');
+    mock.callsFake(() => true);
+    const delay = new Delay(SHORT_DELAY, LONG_DELAY);
+    expect(delay.get()).to.eq(LONG_DELAY);
+  });
+
+  it('should return the long delay in React Native environments', () => {
+    const mock = stub(util, 'isReactNative');
+    mock.callsFake(() => true);
+    const delay = new Delay(SHORT_DELAY, LONG_DELAY);
+    expect(delay.get()).to.eq(LONG_DELAY);
+  });
+
+  it('should return quicker when offline', () => {
+    const mock = stub(navigator, 'isOnline');
+    mock.callsFake(() => false);
+    const delay = new Delay(SHORT_DELAY, LONG_DELAY);
+    expect(delay.get()).to.eq(_OFFLINE_DELAY_MS);
+  });
+});

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

@@ -0,0 +1,54 @@
+/**
+ * @license
+ * Copyright 2020 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 { isMobileCordova, isReactNative } from '@firebase/util';
+import { isOnline } from './navigator';
+
+export const _OFFLINE_DELAY_MS = 5000;
+
+/**
+ * A structure to help pick between a range of long and short delay durations
+ * depending on the current environment. In general, the long delay is used for
+ * mobile environments whereas short delays are used for desktop environments.
+ */
+export class Delay {
+  // The default value for the offline delay timeout in ms.
+
+  private readonly isMobile: boolean;
+  constructor(
+    private readonly shortDelay: number,
+    private readonly longDelay: number
+  ) {
+    // Internal error when improperly initialized.
+    if (shortDelay > longDelay) {
+      throw new Error('Short delay should be less than long delay!');
+    }
+    this.isMobile = isMobileCordova() || isReactNative();
+  }
+
+  get(): number {
+    if (!isOnline()) {
+      // Pick the shorter timeout.
+      return Math.min(_OFFLINE_DELAY_MS, this.shortDelay);
+    }
+    // If running in a mobile environment, return the long delay, otherwise
+    // return the short delay.
+    // This could be improved in the future to dynamically change based on other
+    // variables instead of just reading the current environment.
+    return this.isMobile ? this.longDelay : this.shortDelay;
+  }
+}

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

@@ -0,0 +1,56 @@
+/**
+ * @license
+ * Copyright 2020 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 { isBrowserExtension } from '@firebase/util';
+import { isHttpOrHttps } from './location';
+
+/**
+ * For some reason the TS library doesn't know about NetworkInformation
+ */
+interface NetworkInformation {
+  downlink?: number;
+  downlinkMax?: number;
+  effectiveType?: string;
+  rtt?: number;
+  saveData?: boolean;
+  type?: string;
+}
+interface StandardNavigator extends Navigator {
+  connection: NetworkInformation;
+}
+
+/**
+ * Determine whether the browser is working online
+ */
+export function isOnline(): boolean {
+  if (
+    navigator &&
+    typeof navigator.onLine === 'boolean' &&
+    // Apply only for traditional web apps and Chrome extensions.
+    // This is especially true for Cordova apps which have unreliable
+    // navigator.onLine behavior unless cordova-plugin-network-information is
+    // installed which overwrites the native navigator.onLine value and
+    // defines navigator.connection.
+    (isHttpOrHttps() ||
+      isBrowserExtension() ||
+      typeof (navigator as StandardNavigator).connection !== 'undefined')
+  ) {
+    return navigator.onLine;
+  }
+  // If we can't determine the state, assume it is online.
+  return true;
+}