Merge pull request #24 from GitGuardian/salomevoltz/standardize-api-dashboard-conversion

fix(remediation-message): convert dashboard to api

Author: fnareoh

src/lib/ggshield-api.ts

@@ -11,6 +11,7 @@ import axios from 'axios';
 import { GGShieldConfiguration } from "./ggshield-configuration";
 import { GGShieldScanResults } from "./api-types";
 import * as os from "os";
+import { apiToDashboard, dasboardToApi } from "../utils";
 
 /**
  * Run ggshield CLI application with specified arguments
@@ -97,9 +98,10 @@ export async function getAPIquota(
 export async function getRemediationMessage(
   configuration: GGShieldConfiguration
 ): Promise<string> {
+  const apiUrl = dasboardToApi(configuration.apiUrl);
   const path = require('node:path');
     try {
-      const response = await axios.get(path.join(configuration.apiUrl,'v1/metadata'), {
+      const response = await axios.get(path.join(apiUrl,'v1/metadata'), {
           headers: {
               'authorization': `Token ${configuration.apiKey}`
           }
@@ -305,7 +307,7 @@ export function ggshieldApiKey(
     const apiUrl = configuration.apiUrl;
     const re = /api/;
 
-    const regexInstanceSection = `\\[${apiUrl.replace(re, "dashboard")}\\]([\\s\\S]*?)(?=\\[|$)`;
+    const regexInstanceSection = `\\[${apiToDashboard(apiUrl)}\\]([\\s\\S]*?)(?=\\[|$)`;
     const instanceSectionMatch = proc.stdout.match(regexInstanceSection);
 
     if (instanceSectionMatch) {

src/utils.ts

@@ -2,6 +2,10 @@ import * as vscode from "vscode";
 import { spawnSync } from "child_process";
 import path = require("path");
 
+const reDashboard = "dashboard";
+const reApi = "api";
+const gitGuardianDomains = ["gitguardian.tech", "gitguardian.com"];
+
 export async function isGitInstalled(): Promise<boolean> {
   return new Promise((resolve) => {
     let proc = spawnSync("git", ["--version"]);
@@ -22,3 +26,21 @@ export function getCurrentFile(): string {
     return "";
   }
 }
+
+export function dasboardToApi(dashboardUrl: string): string {
+  const domainMatch = gitGuardianDomains.some((domain) => dashboardUrl.includes(domain));
+  if (domainMatch) {
+    return dashboardUrl.replace(reDashboard, reApi);
+  } else {
+    return dashboardUrl;
+  }
+}
+
+export function apiToDashboard(apiUrl: string): string {
+  const domainMatch = gitGuardianDomains.some((domain) => apiUrl.includes(domain));
+  if (domainMatch) {
+    return apiUrl.replace(reApi, reDashboard);
+  } else {
+    return apiUrl;
+  }
+}