feat: refacto authentication

Author: gg-jonathangriffe

package.json

@@ -38,7 +38,7 @@
         },
         "gitguardian.apiUrl": {
           "type": "string",
-          "default": "https://dashboard.gitguardian.com",
+          "default": "",
           "markdownDescription": "You can override the value here for On Premise installations"
         },
         "gitguardian.allowSelfSigned": {
@@ -65,6 +65,10 @@
         "command": "gitguardian.logout",
         "title": "gitguardian: logout"
       },
+      {
+        "command": "gitguardian.updateAuthenticationStatus",
+        "title": "gitguardian: Update authentication status"
+      },
       {
         "command": "gitguardian.showOutput",
         "title": "Show Output"
@@ -107,7 +111,7 @@
           "id": "gitguardianRemediationMessageView",
           "name": "remediation message",
           "collapsed": true,
-          "when": "isAuthenticated == true"
+          "when": "false"
         },
         {
           "type": "webview",
@@ -160,4 +164,4 @@
   "dependencies": {
     "axios": "^1.7.7"
   }
-}
+}

src/extension.ts

@@ -1,11 +1,8 @@
 import {
   cleanUpFileDiagnostics,
   createDiagnosticCollection,
-  ggshieldAuthStatus,
   ignoreLastFound,
   ignoreSecret,
-  loginGGShield,
-  logoutGGShield,
   scanFile,
   showAPIQuota,
 } from "./lib/ggshield-api";
@@ -33,6 +30,12 @@ import {
 } from "./gitguardian-interface/gitguardian-hover-provider";
 import { GitGuardianQuotaWebviewProvider } from "./ggshield-webview/gitguardian-quota-webview";
 import { GitGuardianRemediationMessageWebviewProvider } from "./ggshield-webview/gitguardian-remediation-message-view";
+import {
+  AuthenticationStatus,
+  loginGGShield,
+  logoutGGShield,
+  updateAuthenticationStatus,
+} from "./lib/authentication";
 
 function registerOpenViewsCommands(
   context: ExtensionContext,
@@ -67,9 +70,6 @@ function registerOpenViewsCommands(
 }
 
 export function activate(context: ExtensionContext) {
-  // Check if ggshield if available
-  commands.executeCommand("setContext", "isAuthenticated", false);
-
   const outputChannel = window.createOutputChannel("GitGuardian");
   let configuration = getConfiguration(context);
 
@@ -123,20 +123,18 @@ export function activate(context: ExtensionContext) {
     languages.registerHoverProvider("*", new GitGuardianSecretHoverProvider())
   );
 
-  checkGitInstalled();
+  if (!checkGitInstalled()) {
+    updateStatusBarItem(StatusBarStatus.error);
+    return;
+  }
 
   ggshieldResolver.checkGGShieldConfiguration();
 
-  // Check if ggshield is authenticated
-  ggshieldAuthStatus(configuration, context).then(() => {
-    if (context.globalState.get("isAuthenticated", false)) {
-      updateStatusBarItem(StatusBarStatus.ready);
-      ggshieldViewProvider.refresh();
-      ggshieldRemediationMessageViewProvider.refresh();
-      ggshieldQuotaViewProvider.refresh();
-    } else {
-      updateStatusBarItem(StatusBarStatus.unauthenticated);
-    }
+  // update authentication status
+  updateAuthenticationStatus(context, configuration).then(() => {
+    ggshieldViewProvider.refresh();
+    ggshieldRemediationMessageViewProvider.refresh();
+    ggshieldQuotaViewProvider.refresh();
   });
 
   // Start scanning documents on activation events
@@ -146,10 +144,9 @@ export function activate(context: ExtensionContext) {
     workspace.onDidSaveTextDocument((textDocument) => {
       // Check if the document is inside the workspace
       const workspaceFolder = workspace.getWorkspaceFolder(textDocument.uri);
-      if (
-        context.globalState.get("isAuthenticated", false) &&
-        workspaceFolder
-      ) {
+      const authStatus: AuthenticationStatus | undefined =
+        context.workspaceState.get("authenticationStatus");
+      if (authStatus?.success && workspaceFolder) {
         scanFile(
           textDocument.fileName,
           textDocument.uri,
@@ -193,12 +190,8 @@ export function activate(context: ExtensionContext) {
         ggshieldViewProvider.getView() as WebviewView,
         context
       )
-        .then(() => {
-          if (context.globalState.get("isAuthenticated", false)) {
-            updateStatusBarItem(StatusBarStatus.ready);
-          } else {
-            updateStatusBarItem(StatusBarStatus.unauthenticated);
-          }
+        .then(async () => {
+          await updateAuthenticationStatus(context, configuration);
           ggshieldViewProvider.refresh();
           ggshieldRemediationMessageViewProvider.refresh();
           ggshieldQuotaViewProvider.refresh();
@@ -208,12 +201,20 @@ export function activate(context: ExtensionContext) {
         });
     }),
     commands.registerCommand("gitguardian.logout", async () => {
-      logoutGGShield(ggshieldResolver.configuration, context);
-      updateStatusBarItem(StatusBarStatus.unauthenticated);
+      await logoutGGShield(ggshieldResolver.configuration, context);
       ggshieldViewProvider.refresh();
       ggshieldRemediationMessageViewProvider.refresh();
       ggshieldQuotaViewProvider.refresh();
-    })
+    }),
+    commands.registerCommand(
+      "gitguardian.updateAuthenticationStatus",
+      async () => {
+        await updateAuthenticationStatus(context, configuration);
+        ggshieldViewProvider.refresh();
+        ggshieldRemediationMessageViewProvider.refresh();
+        ggshieldQuotaViewProvider.refresh();
+      }
+    )
   );
 }
 

src/ggshield-webview/gitguardian-quota-webview.ts

@@ -1,24 +1,22 @@
+import { AuthenticationStatus } from "../lib/authentication";
 import { getAPIquota } from "../lib/ggshield-api";
-import { GGShieldConfiguration } from "../lib/ggshield-configuration";
 import * as vscode from "vscode";
+import { GGShieldConfiguration } from "../lib/ggshield-configuration";
 
 export class GitGuardianQuotaWebviewProvider
   implements vscode.WebviewViewProvider
 {
   public static readonly viewType = "gitguardian.gitguardianQuotaView";
   private _view?: vscode.WebviewView;
-  private isAuthenticated: boolean = false;
   private quota: number = 0;
   private isLoading: boolean = false;
+  private isAuthenticated: boolean = false;
 
   constructor(
     private ggshieldConfiguration: GGShieldConfiguration,
     private readonly _extensionUri: vscode.Uri,
     private context: vscode.ExtensionContext
-  ) {
-    this.checkAuthenticationStatus();
-    this.updateQuota();
-  }
+  ) {}
 
   public resolveWebviewView(
     webviewView: vscode.WebviewView,
@@ -36,64 +34,58 @@ export class GitGuardianQuotaWebviewProvider
     });
   }
 
-  private checkAuthenticationStatus() {
-    this.isAuthenticated = this.context.globalState.get(
-      "isAuthenticated",
-      false
-    );
-  }
-
   private updateQuota() {
-    if (this.isAuthenticated) {
+    const authStatus: AuthenticationStatus | undefined =
+      this.context.workspaceState.get("authenticationStatus");
+    this.isAuthenticated = authStatus?.success ?? false;
+    if (authStatus?.success) {
       this.quota = getAPIquota(this.ggshieldConfiguration);
     }
   }
 
-  private updateWebViewContent(webviewView?: vscode.WebviewView) {
-    if (webviewView) {
-      webviewView.webview.html = this.getHtmlForWebview();
+  private updateWebViewContent() {
+    if (this._view === undefined) {
+      return;
     }
-  }
 
-  private getHtmlForWebview(): string {
+    let computedHtml: string;
+
     if (this.isLoading) {
-      return `
+      computedHtml = `
         <!DOCTYPE html>
         <html lang="en">
         <body>
           <p>Loading...</p>
         </body>
         </html>`;
-    }
-
-    if (this.isAuthenticated) {
-      return `
+    } else if (this.quota !== undefined) {
+      computedHtml = `
         <!DOCTYPE html>
         <html lang="en">
         <body>
           <p>Your current quota: ${this.quota}</p>
         </body>
         </html>`;
     } else {
-      return `
+      computedHtml = `
         <!DOCTYPE html>
         <html lang="en">
         <body>
             <p>Please authenticate to see your quota.</p>
         </body>
         </html>`;
     }
+    this._view.webview.html = computedHtml;
   }
 
   public refresh() {
     this.isLoading = true;
-    this.updateWebViewContent(this._view);
+    this.updateWebViewContent();
 
-    this.checkAuthenticationStatus();
     this.updateQuota();
 
     this.isLoading = false;
-    this.updateWebViewContent(this._view);
+    this.updateWebViewContent();
   }
 
   dispose(): void {

src/ggshield-webview/gitguardian-remediation-message-view.ts

@@ -16,7 +16,6 @@ export class GitGuardianRemediationMessageWebviewProvider
     private readonly _extensionUri: vscode.Uri,
     private context: vscode.ExtensionContext
   ) {
-    this.checkAuthenticationStatus();
     this.updateRemediationMessage();
   }
 
@@ -37,8 +36,8 @@ export class GitGuardianRemediationMessageWebviewProvider
   }
 
   private checkAuthenticationStatus() {
-    this.isAuthenticated = this.context.globalState.get(
-      "isAuthenticated",
+    this.isAuthenticated = this.context.workspaceState.get(
+      "authenticationStatus",
       false
     );
   }