chore: remove getGGShieldLatestVersion

Author: sevbch

.pre-commit-config.yaml

@@ -18,8 +18,8 @@ repos:
         stages: [commit-msg]
         additional_dependencies: [ggcommitizen]
 
-  - repo: https://github.com/pre-commit/mirrors-prettier # to format JSON, YAML and markdown files among others
-    rev: v2.6.2 # Keep synchronize with .gitlab-ci.yml
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.1.0
     hooks:
       - id: prettier
 

src/lib/ggshield-resolver-utils.ts

@@ -1,17 +1,28 @@
 import * as path from "path";
 import * as fs from "fs";
 import * as tar from "tar";
-import axios, { AxiosRequestConfig} from "axios";
+import axios, { AxiosRequestConfig } from "axios";
 import { Agent } from "https";
 
 const AdmZip = require("adm-zip");
 import { ExtensionContext, OutputChannel } from "vscode";
 
 const defaultRequestConfig = {
   headers: { "User-Agent": "GitGuardian-VSCode-Extension" },
-  timeout: 30_000
+  timeout: 30_000,
 } satisfies AxiosRequestConfig;
 
+/**
+ * Get the version of GGShield
+ * @param context The extension context
+ * @returns The version of GGShield
+ */
+export function getGGShieldVersion(context: ExtensionContext): string {
+  return fs
+    .readFileSync(path.join(context.extensionPath, "ggshield_version"), "utf8")
+    .trim();
+}
+
 /**
  * Get the absolute path to GGShield binary. If it doesn't exist, it will be installed.
  * @param platform The platform of the user
@@ -25,27 +36,25 @@ export async function getGGShield(
   arch: string,
   context: ExtensionContext,
   outputChannel: OutputChannel,
-  ignoreSSLErrors: boolean
+  ignoreSSLErrors: boolean,
 ): Promise<string> {
-  const version = fs
-    .readFileSync(path.join(context.extensionPath, "ggshield_version"), "utf8")
-    .trim();
+  const version = getGGShieldVersion(context);
   console.log(`Latest GGShield version: ${version}`);
   const ggshieldFolder: string = path.join(
     context.extensionPath,
-    "ggshield-internal"
+    "ggshield-internal",
   );
   const ggshieldBinaryPath: string = computeGGShieldPath(
     platform,
     arch,
     ggshieldFolder,
-    version
+    version,
   );
 
   // if exists, return the path
   if (fs.existsSync(ggshieldBinaryPath)) {
     outputChannel.appendLine(
-      `Using GGShield v${version}. Checkout https://github.com/GitGuardian/ggshield for more info.`
+      `Using GGShield v${version}. Checkout https://github.com/GitGuardian/ggshield for more info.`,
     );
     console.log(`GGShield already exists at ${ggshieldBinaryPath}`);
     return ggshieldBinaryPath;
@@ -56,30 +65,20 @@ export async function getGGShield(
   }
   fs.mkdirSync(ggshieldFolder);
   // install GGShield
-  await installGGShield(platform, arch, ggshieldFolder, version, ignoreSSLErrors);
+  await installGGShield(
+    platform,
+    arch,
+    ggshieldFolder,
+    version,
+    ignoreSSLErrors,
+  );
   outputChannel.appendLine(
-    `Updated to GGShield v${version}. Checkout https://github.com/GitGuardian/ggshield for more info.`
+    `Updated to GGShield v${version}. Checkout https://github.com/GitGuardian/ggshield for more info.`,
   );
   console.log(`GGShield binary installed at ${ggshieldBinaryPath}`);
   return ggshieldBinaryPath;
 }
 
-/**
- * Get the latest version of GGShield
- * @returns The latest version of GGShield
- */
-export async function getGGShieldLatestVersion(): Promise<string> {
-  const { data } = await axios.get<{tag_name?: string}>(
-    "https://api.github.com/repos/GitGuardian/ggshield/releases/latest",
-    {
-      ...defaultRequestConfig,
-      responseEncoding: 'utf8'
-    }
-  );
-
-  return data.tag_name?.replace(/^v/, "") ?? "";
-}
-
 /**
  * Compute the folder name of the GGShield binary
  * @param platform The platform of the user
@@ -90,7 +89,7 @@ export async function getGGShieldLatestVersion(): Promise<string> {
 export function computeGGShieldFolderName(
   platform: NodeJS.Platform,
   arch: string,
-  version: string
+  version: string,
 ): string {
   let archString: string = "";
   let platformString: string = "";
@@ -153,10 +152,15 @@ export async function installGGShield(
   const fileName: string = `${computeGGShieldFolderName(
     platform,
     arch,
-    version
+    version,
   )}.${extension}`;
   const downloadUrl: string = `https://github.com/GitGuardian/ggshield/releases/download/v${version}/${fileName}`;
-  await downloadGGShieldFromGitHub(fileName, downloadUrl, ggshieldFolder, ignoreSSLErrors);
+  await downloadGGShieldFromGitHub(
+    fileName,
+    downloadUrl,
+    ggshieldFolder,
+    ignoreSSLErrors,
+  );
   extractGGShieldBinary(path.join(ggshieldFolder, fileName), ggshieldFolder);
 }
 
@@ -167,7 +171,7 @@ export async function installGGShield(
  */
 export function extractGGShieldBinary(
   filePath: string,
-  ggshieldFolder: string
+  ggshieldFolder: string,
 ): void {
   if (filePath.endsWith(".tar.gz")) {
     tar.x({
@@ -193,25 +197,25 @@ async function downloadGGShieldFromGitHub(
   fileName: string,
   downloadUrl: string,
   ggshieldFolder: string,
-  ignoreSSLErrors: boolean
+  ignoreSSLErrors: boolean,
 ): Promise<void> {
   console.log(`Downloading GGShield from ${downloadUrl}`);
 
   const instance = ignoreSSLErrors
     ? new Agent({
         rejectUnauthorized: false,
-      })
+    })
     : undefined;
 
   const { data } = await axios.get(downloadUrl, {
     ...defaultRequestConfig,
-    responseType: 'arraybuffer',
-    httpsAgent: instance
+    responseType: "arraybuffer",
+    httpsAgent: instance,
   });
 
   fs.writeFileSync(path.join(ggshieldFolder, fileName), data);
   console.log(
-    `GGShield archive downloaded to ${path.join(ggshieldFolder, fileName)}`
+    `GGShield archive downloaded to ${path.join(ggshieldFolder, fileName)}`,
   );
 }
 
@@ -226,7 +230,7 @@ export function computeGGShieldPath(
   platform: NodeJS.Platform,
   arch: string,
   ggshieldFolder: string,
-  version: string
+  version: string,
 ): string {
   console.log(`Platform: ${platform}; Arch: ${arch}`);
   let executable: string = "";
@@ -245,6 +249,6 @@ export function computeGGShieldPath(
   return path.join(
     ggshieldFolder,
     computeGGShieldFolderName(platform, arch, version),
-    executable
+    executable,
   );
 }