PR feedback

Author: sam-gc

packages-exp/auth-exp/src/platform_browser/iframe/gapi.iframes.d.ts

@@ -20,10 +20,7 @@ declare namespace gapi {
   interface LoadConfig {}
   interface LoadOptions {
     callback?: LoadCallback;
-    config?: LoadConfig;
     timeout?: number;
-    dotimeout?: LoadCallback;
-    sync?: boolean;
     ontimeout?: LoadCallback;
   }
   function load(
@@ -33,9 +30,6 @@ declare namespace gapi {
 }
 
 declare namespace gapi.iframes {
-  interface OptionsBag {
-    [key: string]: unknown;
-  }
   interface Message {
     type: string;
   }
@@ -45,136 +39,23 @@ declare namespace gapi.iframes {
     message: T
   ) => unknown | Promise<void>;
   type SendCallback = () => void;
-  type StyleHandler = (options: OptionsBag) => void;
-  type RpcFilter = (iframe: Iframe) => boolean | Promise<boolean>;
   type Callback = (iframe: Iframe) => void;
-  type ContextCallback = (iframe: Iframe, done: boolean) => void;
-  interface Params {
-    [key: string]: unknown;
-  }
-  interface StyleData {
-    [key: string]: unknown;
-  }
-
-  interface IframeOptions {
-    iframe: Iframe;
-    role?: string;
-    data?: unknown;
-    isReady: boolean;
-  }
 
   class Context {
-    constructor(options?: OptionsBag);
-    isDisposed(): boolean;
-    getFrameName(): string;
-    getWindow(): Window;
-    getGlobalParam(key: string): unknown;
-    setGlobalParam(key: string, value: unknown): void;
-    openChild(options: OptionsBag): Iframe;
-    open(options: OptionsBag, callback?: Callback): Promise<Iframe>;
-    getParentIframe(): Iframe;
-    closeSelf(params?: Params, callback?: ContextCallback): Promise<boolean>;
-    restyleSelf(
-      style?: StyleData,
-      callback?: ContextCallback
-    ): Promise<boolean>;
-    ready<T extends Message>(
-      params?: Params,
-      methods?: { [key: string]: MessageHandler<T> },
-      callback?: SendCallback,
-      filter?: IframesFilter
-    ): void;
-    setCloseSelfFilter(filter: RpcFilter): void;
-    setRestyleSelfFilter(filteR: RpcFilter): void;
-    connectIframes(
-      iframe1Data: IframeOptions,
-      iframe2Data?: IframeOptions
-    ): void;
-    addOnConnectHandler(
-      optionsOrRole: string | OptionsBag,
-      handler?: (iframe: Iframe, obj: object) => void,
-      apis?: string[],
-      filter?: IframesFilter
-    ): void;
-    removeOnConnectHander(role: string): void;
-    addOnOpenerHandler(
-      handler: (iframe: Iframe) => void,
-      apis?: string[],
-      filter?: IframesFilter
-    ): void;
+    open(options: Record<string, unknown>, callback?: Callback): Promise<Iframe>;
   }
 
   class Iframe {
-    constructor(
-      context: Context,
-      rpcAddr: string,
-      frameName: string,
-      options: OptionsBag
-    );
-    isDisposed(): boolean;
-    getContext(): Context;
-    getFrameName(): string;
-    getId(): string;
-    getParam(key: string): unknown;
-    setParam(key: string, value: unknown): void;
     register<T extends Message>(
       message: string,
       handler: MessageHandler<T>,
       filter?: IframesFilter
     ): void;
-    unregister<T extends Message>(
-      message: string,
-      hander: MessageHandler<T>
-    ): void;
-    send(
-      message: string,
-      data?: unknown,
-      callback?: SendCallback,
-      filter?: IframesFilter
-    ): Promise<unknown[]>;
     ping(callback: SendCallback, data?: unknown): Promise<unknown[]>;
-    applyIframesApi(api: string): void;
-    getIframeEl(): HTMLIFrameElement;
-    getSiteEl(): HTMLElement;
-    setSiteEl(el: HTMLElement): void;
-    getWindow(): Window;
-    getOrigin(): string;
-    close(params?: Params, callback?: SendCallback): Promise<unknown[]>;
-    restyle(style: StyleData, callback?: SendCallback): Promise<unknown[]>;
-    registerWasRestyled<T extends Message>(
-      handler: MessageHandler<T>,
-      filter?: IframesFilter
-    ): void;
-    registerWasClosed<T extends Message>(
-      handler: MessageHandler<T>,
-      filter?: IframesFilter
-    ): void;
+    restyle(style: Record<string, string|boolean>, callback?: SendCallback): Promise<unknown[]>;
   }
 
-  const SAME_ORIGIN_IFRAMES_FILTER: IframesFilter;
   const CROSS_ORIGIN_IFRAMES_FILTER: IframesFilter;
 
-  let selfContext: Context;
-
-  function create(
-    url: string,
-    where: HTMLElement,
-    options?: OptionsBag
-  ): HTMLIFrameElement;
   function getContext(): Context;
-  function makeWhiteListIframesFilter(origins: string[]): IframesFilter;
-  function registerStyle(style: string, handler: StyleHandler): void;
-  function registerBeforeOpenStyle(style: string, handler: StyleHandler): void;
-  function getStyle(style: string): StyleHandler;
-  function getBeforeOpenStyle(style: string): StyleHandler;
-  function registerIframesApi<T extends Message>(
-    api: string,
-    registry: { [key: string]: MessageHandler<T> },
-    filter?: IframesFilter
-  ): void;
-  function registerIframesApiHandler<T extends Message>(
-    api: string,
-    message: string,
-    handler: MessageHandler<T>
-  ): void;
 }

packages-exp/auth-exp/src/platform_browser/iframe/gapi.test.ts

@@ -25,31 +25,24 @@ import { FirebaseError } from '@firebase/util';
 import { testAuth } from '../../../test/mock_auth';
 import { Auth } from '../../model/auth';
 import { AUTH_WINDOW } from '../auth_window';
+import * as js from '../load_js';
 import { _loadGapi, _resetLoader } from './gapi';
 
 use(sinonChai);
 use(chaiAsPromised);
 
 describe('src/platform_browser/iframe/gapi', () => {
-  let library: unknown;
-  let tag: HTMLElement;
+  let library: typeof gapi;
   let auth: Auth;
-  function onJsLoad(): void {
+  function onJsLoad(globalLoadFnName: string): void {
     AUTH_WINDOW.gapi = library as typeof gapi;
-    AUTH_WINDOW[(tag as HTMLScriptElement).src.split('onload=')[1]]();
+    AUTH_WINDOW[globalLoadFnName]();
   }
 
   beforeEach(async () => {
-    const head = document.createElement('div');
-    tag = document.createElement('script');
-
-    sinon.stub(document, 'createElement').returns(tag);
-    sinon
-      .stub(document, 'getElementsByTagName')
-      .returns(([head] as unknown) as HTMLCollection);
-    sinon.stub(head, 'appendChild').callsFake(() => {
-      onJsLoad();
-      return head;
+    sinon.stub(js, '_loadJS').callsFake(url => {
+      onJsLoad(url.split('onload=')[1]);
+      return Promise.resolve(new Event('load'));
     });
 
     auth = await testAuth();
@@ -58,7 +51,7 @@ describe('src/platform_browser/iframe/gapi', () => {
   function makeGapi(
     result: unknown,
     timesout = false
-  ): Record<string, unknown> {
+  ): typeof gapi {
     const callbackFn = timesout === false ? 'callback' : 'ontimeout';
     return {
       load: sinon
@@ -67,9 +60,9 @@ describe('src/platform_browser/iframe/gapi', () => {
           params[callbackFn]()
         ),
       iframes: {
-        getContext: () => result
+        getContext: () => result as gapi.iframes.Context,
       }
-    };
+    } as unknown as typeof gapi;
   }
 
   afterEach(() => {
@@ -117,11 +110,11 @@ describe('src/platform_browser/iframe/gapi', () => {
     expect(await _loadGapi(auth)).to.eq('test');
     expect(await _loadGapi(auth)).to.eq('test');
 
-    expect(document.createElement).to.have.been.calledOnce;
+    expect(js._loadJS).to.have.been.calledOnce;
   });
 
   it('rejects with a network error if load fails', async () => {
-    library = {};
+    library = {} as typeof gapi;
     await expect(_loadGapi(auth)).to.be.rejectedWith(
       FirebaseError,
       'auth/network-request-failed'
@@ -137,7 +130,7 @@ describe('src/platform_browser/iframe/gapi', () => {
   });
 
   it('resets the load promise if the load errors', async () => {
-    library = {};
+    library = {} as typeof gapi;
     const firstAttempt = _loadGapi(auth);
     await expect(firstAttempt).to.be.rejectedWith(
       FirebaseError,

packages-exp/auth-exp/src/platform_browser/iframe/gapi.ts

@@ -19,7 +19,7 @@ import { AUTH_ERROR_FACTORY, AuthErrorCode } from '../../core/errors';
 import { Delay } from '../../core/util/delay';
 import { Auth } from '../../model/auth';
 import { AUTH_WINDOW } from '../auth_window';
-import { _generateCallbackName, _loadJS } from '../load_js';
+import * as js from '../load_js';
 
 const NETWORK_TIMEOUT = new Delay(30000, 60000);
 const LOADJS_CALLBACK_PREFIX = 'iframefcb';
@@ -32,7 +32,6 @@ function resetUnloadedGapiModules(): void {
   // Clear last failed gapi.load state to force next gapi.load to first
   // load the failed gapi.iframes module.
   // Get gapix.beacon context.
-  console.warn(AUTH_WINDOW.___jsl);
   const beacon = AUTH_WINDOW.___jsl;
   // Get current hint.
   if (beacon?.H) {
@@ -88,7 +87,6 @@ function loadGapi(auth: Auth): Promise<gapi.iframes.Context> {
       // If gapi.iframes.Iframe available, resolve.
       resolve(gapi.iframes.getContext());
     } else if (!!AUTH_WINDOW.gapi?.load) {
-      console.error('here');
       // Gapi loader ready, load gapi.iframes.
       loadGapiIframe();
     } else {
@@ -97,7 +95,7 @@ function loadGapi(auth: Auth): Promise<gapi.iframes.Context> {
       // multiple times in parallel and could result in the later callback
       // overwriting the previous one. This would end up with a iframe
       // timeout.
-      const cbName = _generateCallbackName(LOADJS_CALLBACK_PREFIX);
+      const cbName = js._generateCallbackName(LOADJS_CALLBACK_PREFIX);
       // GApi loader not available, dynamically load platform.js.
       AUTH_WINDOW[cbName] = () => {
         // GApi loader should be ready.
@@ -113,7 +111,7 @@ function loadGapi(auth: Auth): Promise<gapi.iframes.Context> {
         }
       };
       // Load GApi loader.
-      return _loadJS(`https://apis.google.com/js/api.js?onload=${cbName}`);
+      return js._loadJS(`https://apis.google.com/js/api.js?onload=${cbName}`);
     }
   }).catch(error => {
     // Reset cached promise to allow for retrial.

packages-exp/auth-exp/src/platform_browser/iframe/iframe.test.ts

@@ -68,7 +68,6 @@ describe('src/platform_browser/iframe/iframe', () => {
 
   it('sets all the correct settings', async () => {
     await _openIframe(auth);
-    console.warn(iframeSettings);
 
     expect(iframeSettings.where).to.eql(document.body);
     expect(iframeSettings.url).to.eq(

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

@@ -65,15 +65,14 @@ export async function _openIframe(auth: Auth): Promise<gapi.iframes.Iframe> {
           // Prevent iframe from closing on mouse out.
           setHideOnLeave: false
         });
+
+        const networkError = AUTH_ERROR_FACTORY.create(AuthErrorCode.NETWORK_REQUEST_FAILED, {
+          appName: auth.name
+        });
         // Confirm iframe is correctly loaded.
         // To fallback on failure, set a timeout.
-        console.warn('setting timeout');
         const networkErrorTimer = AUTH_WINDOW.setTimeout(() => {
-          reject(
-            AUTH_ERROR_FACTORY.create(AuthErrorCode.NETWORK_REQUEST_FAILED, {
-              appName: auth.name
-            })
-          );
+          reject(networkError);
         }, PING_TIMEOUT.get());
         // Clear timer and resolve pending iframe ready promise.
         function clearTimerAndResolve(): void {
@@ -83,11 +82,7 @@ export async function _openIframe(auth: Auth): Promise<gapi.iframes.Iframe> {
         // This returns an IThenable. However the reject part does not call
         // when the iframe is not loaded.
         iframe.ping(clearTimerAndResolve).then(clearTimerAndResolve, () => {
-          reject(
-            AUTH_ERROR_FACTORY.create(AuthErrorCode.NETWORK_REQUEST_FAILED, {
-              appName: auth.name
-            })
-          );
+          reject(networkError);
         });
       })
   );