Add gis diagnostic check (#4030)

Author: mhkawano

demos/public/qual/subscriptions/gis-test.js

@@ -14,7 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
+const clientId =
+  '365425805315-ulc9hop6lvq3blgc7ubvtcu5322t3fcn.apps.googleusercontent.com';
 const sessionId = 'test-session-123';
 
 

src/api/basic-subscriptions.ts

@@ -83,6 +83,11 @@ export interface BasicSubscriptions {
    * purposes.
    */
   dismissSwgUI(): void;
+
+  /**
+   * Returns diagnostic information about the setup.
+   */
+  getDiagnostics(): {isGisReady: boolean};
 }
 
 /**

src/runtime/basic-runtime-test.js

@@ -109,6 +109,13 @@ describes.realWin('installBasicRuntime', (env) => {
     expect(getBasicRuntime()).to.equal(runtime1);
   });
 
+  it('should expose getDiagnostics on global SWG_BASIC', () => {
+    installBasicRuntime(win);
+    expect(win.SWG_BASIC.getDiagnostics).to.be.a('function');
+    const diagnostics = win.SWG_BASIC.getDiagnostics();
+    expect(diagnostics).to.have.property('isGisReady');
+  });
+
   it('handles recursive calls after installation', async () => {
     installBasicRuntime(win);
     let progress = '';
@@ -483,9 +490,54 @@ describes.realWin('BasicRuntime', (env) => {
       });
 
       const configuredRuntime = await basicRuntime.configured_(true);
-
       expect(configuredRuntime.gisInteropManager()).to.not.exist;
     });
+
+    it('should return getDiagnostics().isGisReady true when all params are present', () => {
+      basicRuntime.init({
+        ...DEFAULT_INIT_PARAMS,
+        gisInterop: true,
+        clientOptions: {
+          clientId: 'test-client-id',
+          onGisOptIn: () => {},
+        },
+      });
+      expect(basicRuntime.getDiagnostics().isGisReady).to.be.true;
+    });
+
+    it('should return getDiagnostics().isGisReady false when gisInterop is false', () => {
+      basicRuntime.init({
+        ...DEFAULT_INIT_PARAMS,
+        gisInterop: false,
+        clientOptions: {
+          clientId: 'test-client-id',
+          onGisOptIn: () => {},
+        },
+      });
+      expect(basicRuntime.getDiagnostics().isGisReady).to.be.false;
+    });
+
+    it('should return getDiagnostics().isGisReady false when clientId is missing', () => {
+      basicRuntime.init({
+        ...DEFAULT_INIT_PARAMS,
+        gisInterop: true,
+        clientOptions: {
+          onGisOptIn: () => {},
+        },
+      });
+      expect(basicRuntime.getDiagnostics().isGisReady).to.be.false;
+    });
+
+    it('should return getDiagnostics().isGisReady false when onGisOptIn is missing', () => {
+      basicRuntime.init({
+        ...DEFAULT_INIT_PARAMS,
+        gisInterop: true,
+        clientOptions: {
+          clientId: 'test-client-id',
+        },
+      });
+      expect(basicRuntime.getDiagnostics().isGisReady).to.be.false;
+    });
   });
 
   describe('configured', () => {
@@ -815,6 +867,51 @@ describes.realWin('BasicRuntime', (env) => {
 
       await basicRuntime.setupInlineCta();
     });
+
+    it('should return getDiagnostics().isGisReady true when all params are present in ConfiguredBasicRuntime', () => {
+      sandbox
+        .stub(configuredBasicRuntime, 'config')
+        .returns({gisInterop: true});
+      clientConfigManagerMock
+        .expects('getClientId')
+        .returns('test-client-id')
+        .once();
+      clientConfigManagerMock
+        .expects('getOnGisOptIn')
+        .returns(() => {})
+        .once();
+      expect(configuredBasicRuntime.getDiagnostics().isGisReady).to.be.true;
+    });
+
+    it('should return getDiagnostics().isGisReady false when gisInterop is false in ConfiguredBasicRuntime', () => {
+      sandbox
+        .stub(configuredBasicRuntime, 'config')
+        .returns({gisInterop: false});
+      expect(configuredBasicRuntime.getDiagnostics().isGisReady).to.be.false;
+    });
+
+    it('should return getDiagnostics().isGisReady false when clientId is missing in ConfiguredBasicRuntime', () => {
+      sandbox
+        .stub(configuredBasicRuntime, 'config')
+        .returns({gisInterop: true});
+      clientConfigManagerMock.expects('getClientId').returns(undefined).once();
+      expect(configuredBasicRuntime.getDiagnostics().isGisReady).to.be.false;
+    });
+
+    it('should return getDiagnostics().isGisReady false when onGisOptIn is missing in ConfiguredBasicRuntime', () => {
+      sandbox
+        .stub(configuredBasicRuntime, 'config')
+        .returns({gisInterop: true});
+      clientConfigManagerMock
+        .expects('getClientId')
+        .returns('test-client-id')
+        .once();
+      clientConfigManagerMock
+        .expects('getOnGisOptIn')
+        .returns(undefined)
+        .once();
+      expect(configuredBasicRuntime.getDiagnostics().isGisReady).to.be.false;
+    });
   });
 });
 

src/runtime/basic-runtime.ts

@@ -117,6 +117,7 @@ export function installBasicRuntime(win: Window): void {
   // they'll be queued up to receive the SwG Basic runtime when it's ready.
   (win[BASIC_RUNTIME_PROP] as {}) = {
     push: callWhenRuntimeIsReady,
+    getDiagnostics: () => publicBasicRuntime.getDiagnostics(),
   };
 
   // Set variable for testing.
@@ -308,6 +309,15 @@ export class BasicRuntime implements BasicSubscriptions {
     runtime.dismissSwgUI();
   }
 
+  getDiagnostics(): {isGisReady: boolean} {
+    return {
+      isGisReady:
+        !!this.gisInterop &&
+        !!this.clientOptions_?.clientId &&
+        !!this.clientOptions_?.onGisOptIn,
+    };
+  }
+
   /**
    * Sets up all the buttons on the page with attribute
    * 'swg-standard-button:subscription' or 'swg-standard-button:contribution'.
@@ -651,6 +661,15 @@ export class ConfiguredBasicRuntime implements Deps, BasicSubscriptions {
     this.dialogManager().completeAll();
   }
 
+  getDiagnostics(): {isGisReady: boolean} {
+    return {
+      isGisReady:
+        !!this.config().gisInterop &&
+        !!this.clientConfigManager().getClientId() &&
+        !!this.clientConfigManager().getOnGisOptIn(),
+    };
+  }
+
   /**
    * Sets up all the buttons on the page with attribute
    * 'swg-standard-button:subscription' or 'swg-standard-button:contribution'.
@@ -720,5 +739,6 @@ function createPublicBasicRuntime(
     setupAndShowAutoPrompt:
       basicRuntime.setupAndShowAutoPrompt.bind(basicRuntime),
     dismissSwgUI: basicRuntime.dismissSwgUI.bind(basicRuntime),
+    getDiagnostics: basicRuntime.getDiagnostics.bind(basicRuntime),
   };
 }