Add Logging to SSO Process

bitwarden · Jan 9, 2024 · e8a54a7 · e8a54a7
1 parent 4806380
commit e8a54a7
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 10 deletions.
diff --git a/apps/browser/src/autofill/content/bootstrap-content-message-handler.ts b/apps/browser/src/autofill/content/bootstrap-content-message-handler.ts
@@ -3,9 +3,15 @@ import { setupExtensionDisconnectAction } from "../utils";
 import ContentMessageHandler from "./content-message-handler";
 
 (function (windowContext) {
+  // eslint-disable-next-line no-console -- In content script
+  console.debug("Initializing bitwardenContentMessageHandler");
   if (!windowContext.bitwardenContentMessageHandler) {
     windowContext.bitwardenContentMessageHandler = new ContentMessageHandler();
-    setupExtensionDisconnectAction(() => windowContext.bitwardenContentMessageHandler.destroy());
+    setupExtensionDisconnectAction(() => {
+      // eslint-disable-next-line no-console -- In content script
+      console.debug("Disconnecting content message handler.");
+      windowContext.bitwardenContentMessageHandler.destroy();
+    });
 
     windowContext.bitwardenContentMessageHandler.init();
   }

diff --git a/apps/browser/src/autofill/content/content-message-handler.ts b/apps/browser/src/autofill/content/content-message-handler.ts
@@ -14,6 +14,8 @@ class ContentMessageHandler implements ContentMessageHandlerInterface {
    * message listener.
    */
   init() {
+    // eslint-disable-next-line no-console -- In content script
+    console.debug("Attaching message event listener.");
     window.addEventListener("message", this.handleWindowMessage, false);
     chrome.runtime.onMessage.addListener(this.handleExtensionMessage);
   }
@@ -26,9 +28,13 @@ class ContentMessageHandler implements ContentMessageHandlerInterface {
    * @param event - The message event.
    */
   private handleWindowMessage = (event: MessageEvent) => {
+    // eslint-disable-next-line no-console -- In content script
+    console.debug("Handling window message");
     const { source, data } = event;
 
     if (source !== window || !data?.command) {
+      // eslint-disable-next-line no-console -- We are in a content script without our services
+      console.debug("Bad source or badly formatted message, skipping.");
       return;
     }
 
@@ -37,6 +43,8 @@ class ContentMessageHandler implements ContentMessageHandlerInterface {
 
     if (command === "authResult") {
       const { lastpass, code, state } = data;
+      // eslint-disable-next-line no-console -- In content script
+      console.debug("sending authResult message to chrome");
       chrome.runtime.sendMessage({ command, code, state, lastpass, referrer });
     }
 

diff --git a/apps/browser/src/background/runtime.background.ts b/apps/browser/src/background/runtime.background.ts
@@ -212,6 +212,7 @@ export default class RuntimeBackground {
         }
         break;
       case "authResult": {
+        this.logService.debug("Handling authResult message");
         const vaultUrl = this.environmentService.getWebVaultUrl();
 
         if (msg.referrer == null || Utils.getHostname(vaultUrl) !== msg.referrer) {

diff --git a/apps/browser/src/platform/popup/browser-popup-utils.ts b/apps/browser/src/platform/popup/browser-popup-utils.ts
@@ -130,14 +130,17 @@ class BrowserPopupUtils {
       url: BrowserPopupUtils.buildPopoutUrl(extensionUrlPath, singleActionKey),
     };
 
-    if (
-      (await BrowserPopupUtils.isSingleActionPopoutOpen(
-        singleActionKey,
-        popoutWindowOptions,
-        forceCloseExistingWindows,
-      )) &&
-      !forceCloseExistingWindows
-    ) {
+    const isSingleActionPopoutOpen = await BrowserPopupUtils.isSingleActionPopoutOpen(
+      singleActionKey,
+      popoutWindowOptions,
+      forceCloseExistingWindows,
+    );
+    // eslint-disable-next-line no-console -- Laziness, static method that doesn't easily have access to LogService
+    console.debug("isSingleActionPopoutOpen", isSingleActionPopoutOpen);
+
+    if (isSingleActionPopoutOpen && !forceCloseExistingWindows) {
+      // eslint-disable-next-line no-console -- Laziness, static method that doesn't easily have access to LogService
+      console.debug("Skipping creation of popout window.");
       return;
     }
 

diff --git a/apps/web/src/connectors/sso.ts b/apps/web/src/connectors/sso.ts
@@ -1,4 +1,4 @@
-import { getQsParam } from "./common";
+import { getQsParam } from "./common";
 
 require("./sso.scss");
 
@@ -24,6 +24,8 @@ document.addEventListener("DOMContentLoaded", () => {
 });
 
 function initiateBrowserSso(code: string, state: string, lastpass: boolean) {
+  // eslint-disable-next-line no-console -- In connector
+  console.debug("sending authResult message");
   window.postMessage({ command: "authResult", code: code, state: state, lastpass: lastpass }, "*");
   const handOffMessage = ("; " + document.cookie)
     .split("; ssoHandOffMessage=")

diff --git a/libs/angular/src/auth/components/sso.component.ts b/libs/angular/src/auth/components/sso.component.ts
@@ -65,6 +65,7 @@ export class SsoComponent {
   async ngOnInit() {
     // eslint-disable-next-line rxjs/no-async-subscribe
     this.route.queryParams.pipe(first()).subscribe(async (qParams) => {
+      this.logService.info("Handling sso params");
       if (qParams.code != null && qParams.state != null) {
         const codeVerifier = await this.stateService.getSsoCodeVerifier();
         const state = await this.stateService.getSsoState();