refactor: replace request-sync with axios

Author: GabrielCousin

package.json

@@ -156,7 +156,6 @@
     "@types/node": "20.2.5",
     "@types/simple-mock": "^0.8.6",
     "@types/tar": "^6.1.13",
-    "@types/unzipper": "^0.10.10",
     "@types/vscode": "^1.81.0",
     "@typescript-eslint/eslint-plugin": "^5.59.8",
     "@typescript-eslint/parser": "^5.59.8",
@@ -169,7 +168,7 @@
   },
   "dependencies": {
     "adm-zip": "^0.5.16",
-    "sync-request": "^6.1.0",
+    "axios": "^1.9.0",
     "tar": "^7.4.3"
   }
 }

src/extension.ts

@@ -69,9 +69,9 @@ function registerOpenViewsCommands(
   );
 }
 
-export function activate(context: ExtensionContext) {
+export async function activate(context: ExtensionContext) {
   const outputChannel = window.createOutputChannel("GitGuardian");
-  let configuration = getConfiguration(context, outputChannel);
+  let configuration = await getConfiguration(context, outputChannel);
 
   const ggshieldResolver = new GGShieldResolver(
     outputChannel,

src/lib/ggshield-configuration-utils.ts

@@ -7,17 +7,17 @@ import { getGGShield } from "./ggshield-resolver-utils";
  * Retrieve configuration from settings
  * @returns {GGShieldConfiguration} from the extension settings
  */
-export function getConfiguration(
+export async function getConfiguration(
   context: ExtensionContext,
   outputChannel: OutputChannel
-): GGShieldConfiguration {
+): Promise<GGShieldConfiguration> {
   const config = workspace.getConfiguration("gitguardian");
 
   const ggshieldPath: string | undefined = config.get("GGShieldPath");
   const apiUrl: string | undefined = config.get("apiUrl");
   const allowSelfSigned: boolean = config.get("allowSelfSigned", false);
 
-  const pathToGGShield: string = getGGShield(
+  const pathToGGShield: string = await getGGShield(
     os.platform(),
     os.arch(),
     context,

src/lib/ggshield-resolver-utils.ts

@@ -1,9 +1,16 @@
 import * as path from "path";
 import * as fs from "fs";
 import * as tar from "tar";
+import axios, { AxiosRequestConfig} from "axios";
+
 const AdmZip = require("adm-zip");
 import { ExtensionContext, OutputChannel } from "vscode";
 
+const defaultRequestConfig = {
+  headers: { "User-Agent": "GitGuardian-VSCode-Extension" },
+  timeout: 30_000
+} satisfies AxiosRequestConfig;
+
 /**
  * Get the absolute path to GGShield binary. If it doesn't exist, it will be installed.
  * @param platform The platform of the user
@@ -12,12 +19,12 @@ import { ExtensionContext, OutputChannel } from "vscode";
  * @param outputChannel The output channel to use
  * @returns The absolute path to the GGShield binary
  */
-export function getGGShield(
+export async function getGGShield(
   platform: NodeJS.Platform,
   arch: string,
   context: ExtensionContext,
   outputChannel: OutputChannel
-): string {
+): Promise<string> {
   const version = fs
     .readFileSync(path.join(context.extensionPath, "ggshield_version"), "utf8")
     .trim();
@@ -47,7 +54,7 @@ export function getGGShield(
   }
   fs.mkdirSync(ggshieldFolder);
   // install GGShield
-  installGGShield(platform, arch, ggshieldFolder, version);
+  await installGGShield(platform, arch, ggshieldFolder, version);
   outputChannel.appendLine(
     `Updated to GGShield v${version}. Checkout https://github.com/GitGuardian/ggshield for more info.`
   );
@@ -59,14 +66,16 @@ export function getGGShield(
  * Get the latest version of GGShield
  * @returns The latest version of GGShield
  */
-export function getGGShieldLatestVersion(): string {
-  const response = require("sync-request")(
-    "GET",
+export async function getGGShieldLatestVersion(): Promise<string> {
+  const { data } = await axios.get<{tag_name?: string}>(
     "https://api.github.com/repos/GitGuardian/ggshield/releases/latest",
-    { headers: { "User-Agent": "GitGuardian-VSCode-Extension" } }
+    {
+      ...defaultRequestConfig,
+      responseEncoding: 'utf8'
+    }
   );
-  const data = JSON.parse(response.getBody("utf8"));
-  return data.tag_name?.replace(/^v/, "");
+
+  return data.tag_name?.replace(/^v/, "") ?? "";
 }
 
 /**
@@ -119,12 +128,12 @@ export function computeGGShieldFolderName(
  * @param ggshieldFolder The folder of the GGShield binary
  * @param version The version of GGShield
  */
-export function installGGShield(
+export async function installGGShield(
   platform: NodeJS.Platform,
   arch: string,
   ggshieldFolder: string,
   version: string
-): void {
+): Promise<void> {
   let extension: string = "";
   switch (platform) {
     case "win32":
@@ -144,7 +153,7 @@ export function installGGShield(
     version
   )}.${extension}`;
   const downloadUrl: string = `https://github.com/GitGuardian/ggshield/releases/download/v${version}/${fileName}`;
-  downloadGGShieldFromGitHub(fileName, downloadUrl, ggshieldFolder);
+  await downloadGGShieldFromGitHub(fileName, downloadUrl, ggshieldFolder);
   extractGGShieldBinary(path.join(ggshieldFolder, fileName), ggshieldFolder);
 }
 
@@ -177,16 +186,18 @@ export function extractGGShieldBinary(
  * @param downloadUrl The URL of the GGShield binary
  * @param ggshieldFolder The folder of the GGShield binary
  */
-function downloadGGShieldFromGitHub(
+async function downloadGGShieldFromGitHub(
   fileName: string,
   downloadUrl: string,
   ggshieldFolder: string
-): void {
+): Promise<void> {
   console.log(`Downloading GGShield from ${downloadUrl}`);
-  const response = require("sync-request")("GET", downloadUrl, {
-    headers: { "User-Agent": "GitGuardian-VSCode-Extension" },
+  const { data } = await axios.get(downloadUrl, {
+    ...defaultRequestConfig,
+    responseType: 'arraybuffer'
   });
-  fs.writeFileSync(path.join(ggshieldFolder, fileName), response.getBody());
+
+  fs.writeFileSync(path.join(ggshieldFolder, fileName), data);
   console.log(
     `GGShield archive downloaded to ${path.join(ggshieldFolder, fileName)}`
   );

src/test/suite/lib/ggshield-configuration-utils.test.ts

@@ -27,7 +27,7 @@ suite("getConfiguration", () => {
     simple.restore();
   });
 
-  test("Vscode settings are correctly read", () => {
+  test("Vscode settings are correctly read", async () => {
     const context = {} as ExtensionContext;
     const outputChannel = window.createOutputChannel("GitGuardian");
     simple.mock(context, "asAbsolutePath").returnWith("");
@@ -42,7 +42,7 @@ suite("getConfiguration", () => {
         }
       },
     });
-    const configuration = getConfiguration(context, outputChannel);
+    const configuration = await getConfiguration(context, outputChannel);
 
     // Assert both workspace.getConfiguration and GGShieldConfiguration constructor were called
     assert(

src/test/suite/lib/ggshield-resolver-utils.test.ts

@@ -7,13 +7,13 @@ const AdmZip = require("adm-zip");
 import * as getGGShieldUtils from "../../../lib/ggshield-resolver-utils";
 import { ExtensionContext, window, OutputChannel } from "vscode";
 
-suite("getGGShield integration tests", () => {
+suite("getGGShield integration tests", async () => {
   let tempDir: string;
   let mockContext: ExtensionContext;
   let outputChannel: OutputChannel = window.createOutputChannel("GitGuardian");
   const platform = process.platform;
   const arch = process.arch;
-  const latestVersion = getGGShieldUtils.getGGShieldLatestVersion();
+  const latestVersion = await getGGShieldUtils.getGGShieldLatestVersion();
   let originalLog: (message?: any, ...optionalParams: any[]) => void;
   let output: string;
 
@@ -66,7 +66,7 @@ suite("getGGShield integration tests", () => {
     );
   });
 
-  test("installs binary when it doesn't exist", () => {
+  test("installs binary when it doesn't exist", async () => {
     const expectedBinaryPath: string = getGGShieldUtils.computeGGShieldPath(
       platform,
       arch,
@@ -75,7 +75,7 @@ suite("getGGShield integration tests", () => {
     );
     assert(!fs.existsSync(expectedBinaryPath));
 
-    const result = getGGShieldUtils.getGGShield(
+    const result = await getGGShieldUtils.getGGShield(
       platform,
       arch,
       mockContext,
@@ -91,14 +91,14 @@ suite("getGGShield integration tests", () => {
     );
   });
 
-  test("updates binary when newer version set by ggshield_version file", () => {
+  test("updates binary when newer version set by ggshield_version file", async () => {
     const oldBinaryPath: string = createFakeBinary(
       tempDir,
       platform,
       arch,
       "1.0.0"
     );
-    const result = getGGShieldUtils.getGGShield(
+    const result = await getGGShieldUtils.getGGShield(
       platform,
       arch,
       mockContext,