Fix git download on first use

Was failing to download git if the first action was to create an example project

Signed-off-by: William Vinnicombe <[email protected]>

Author: will-v-pi

src/utils/download.mts

@@ -6,7 +6,7 @@ import { join as joinPosix } from "path/posix";
 import Logger from "../logger.mjs";
 import { get, type RequestOptions } from "https";
 import type { SupportedToolchainVersion } from "./toolchainUtil.mjs";
-import { cloneRepository, initSubmodules } from "./gitUtil.mjs";
+import { cloneRepository, initSubmodules, getGit } from "./gitUtil.mjs";
 import { checkForInstallationRequirements } from "./requirementsUtil.mjs";
 import { HOME_VAR, SettingsKey } from "../settings.mjs";
 import Settings from "../settings.mjs";
@@ -136,15 +136,9 @@ export async function downloadAndInstallSDK(
     return false;
   }
 
-  let gitExecutable: string | undefined =
-    settings
-      .getString(SettingsKey.gitPath)
-      ?.replace(HOME_VAR, homedir().replaceAll("\\", "/")) || "git";
-
   // TODO: this does take about 2s - may be reduced
   const requirementsCheck = await checkForInstallationRequirements(
-    settings,
-    gitExecutable
+    settings
   );
   if (!requirementsCheck) {
     return false;
@@ -161,33 +155,15 @@ export async function downloadAndInstallSDK(
 
   // Ensure the target directory exists
   //await mkdir(targetDirectory, { recursive: true });
-  const gitPath = await which(gitExecutable, { nothrow: true });
-  if (gitPath === null) {
-    // if git is not in path then checkForInstallationRequirements
-    // maye downloaded it, so reload
-    //settings.reload();
-    gitExecutable = settings
-      .getString(SettingsKey.gitPath)
-      ?.replace(HOME_VAR, homedir().replaceAll("\\", "/"));
-    if (gitExecutable === null) {
-      Logger.log("Error: Git not found.");
-
-      await window.showErrorMessage(
-        "Git not found. Please install and add to PATH or " +
-          "set the path to the git executable in global settings."
-      );
-
-      return false;
-    }
-  }
+  const gitPath = await getGit(settings);
   // using deferred execution to avoid git clone if git is not available
   if (
-    gitPath !== null &&
+    gitPath !== undefined &&
     (await cloneRepository(
       repositoryUrl,
       version,
       targetDirectory,
-      gitExecutable
+      gitPath
     ))
   ) {
     settings.reload();
@@ -210,7 +186,7 @@ export async function downloadAndInstallSDK(
       return false;
     }
 
-    return initSubmodules(targetDirectory, gitExecutable);
+    return initSubmodules(targetDirectory, gitPath);
   }
 
   return false;

src/utils/examplesUtil.mts

@@ -4,9 +4,10 @@ import { fileURLToPath } from "url";
 import Logger from "../logger.mjs";
 import { existsSync, readFileSync } from "fs";
 import { homedir } from "os";
-import { sparseCheckout, sparseCloneRepository } from "./gitUtil.mjs";
+import { getGit, sparseCheckout, sparseCloneRepository } from "./gitUtil.mjs";
 import { EXAMPLES_REPOSITORY_URL } from "./githubREST.mjs";
-import Settings, { HOME_VAR, SettingsKey } from "../settings.mjs";
+import Settings from "../settings.mjs";
+import { checkForInstallationRequirements } from "./requirementsUtil.mjs";
 import { cp } from "fs/promises";
 import { get } from "https";
 import { isInternetConnected } from "./downloadHelpers.mjs";
@@ -125,17 +126,30 @@ export async function setupExample(
 ): Promise<boolean> {
   const examplesRepoPath = buildExamplesPath();
   const absoluteExamplePath = joinPosix(examplesRepoPath, example.path);
-  const gitExecutable: string | undefined =
-    Settings.getInstance()
-      ?.getString(SettingsKey.gitPath)
-      ?.replace(HOME_VAR, homedir().replaceAll("\\", "/")) || "git";
+
+  const settings = Settings.getInstance();
+  if (settings === undefined) {
+    Logger.log("Error: Settings not initialized.");
+
+    return false;
+  }
+
+  // TODO: this does take about 2s - may be reduced
+  const requirementsCheck = await checkForInstallationRequirements(
+    settings
+  );
+  if (!requirementsCheck) {
+    return false;
+  }
+
+  const gitPath = await getGit(settings);
 
   if (!existsSync(examplesRepoPath)) {
     const result = await sparseCloneRepository(
       EXAMPLES_REPOSITORY_URL,
       "master",
       examplesRepoPath,
-      gitExecutable
+      gitPath
     );
 
     if (!result) {
@@ -147,7 +161,7 @@ export async function setupExample(
   const result = await sparseCheckout(
     examplesRepoPath,
     example.path,
-    gitExecutable
+    gitPath
   );
   if (!result) {
     return result;

src/utils/gitUtil.mts

@@ -2,9 +2,49 @@ import { promisify } from "util";
 import { exec } from "child_process";
 import Logger from "../logger.mjs";
 import { unlink } from "fs/promises";
+import type Settings from "../settings.mjs";
+import { SettingsKey, HOME_VAR } from "../settings.mjs";
+import { homedir } from "os";
+import which from "which";
+import { window } from "vscode";
 
 const execAsync = promisify(exec);
 
+/**
+ * Get installed version of git, and install it if it isn't already
+ */
+export async function getGit(
+  settings: Settings
+): Promise<string | undefined> {
+  let gitExecutable: string | undefined =
+    settings
+      .getString(SettingsKey.gitPath)
+      ?.replace(HOME_VAR, homedir().replaceAll("\\", "/")) || "git";
+  let gitPath = await which(gitExecutable, { nothrow: true });
+  if (gitPath === null) {
+    // if git is not in path then checkForInstallationRequirements
+    // maye downloaded it, so reload
+    settings.reload();
+    gitExecutable = settings
+      .getString(SettingsKey.gitPath)
+      ?.replace(HOME_VAR, homedir().replaceAll("\\", "/"));
+    if (gitExecutable === null || gitExecutable === undefined) {
+      Logger.log("Error: Git not found.");
+
+      await window.showErrorMessage(
+        "Git not found. Please install and add to PATH or " +
+          "set the path to the git executable in global settings."
+      );
+
+      return undefined;
+    } else {
+      gitPath = await which(gitExecutable, { nothrow: true });
+    }
+  }
+
+  return gitPath;
+}
+
 /**
  * Initialize git submodules in downloaded Pico-SDK.
  *

src/utils/requirementsUtil.mts

@@ -1,7 +1,8 @@
 import { window } from "vscode";
 import which from "which";
 import type Settings from "../settings.mjs";
-import { SettingsKey } from "../settings.mjs";
+import { SettingsKey, HOME_VAR } from "../settings.mjs";
+import { homedir } from "os";
 import { downloadGit } from "./downloadGit.mjs";
 import Logger from "../logger.mjs";
 
@@ -23,10 +24,12 @@ export async function showRequirementsNotMetErrorMessage(
  * @returns true if all requirements are met, false otherwise
  */
 export async function checkForInstallationRequirements(
-  settings: Settings,
-  gitPath?: string
+  settings: Settings
 ): Promise<boolean> {
-  const gitExe: string = gitPath || "git";
+  const gitExe: string =
+    settings
+      .getString(SettingsKey.gitPath)
+      ?.replace(HOME_VAR, homedir().replaceAll("\\", "/")) || "git";
   const compilerExe: string[] = ["clang", "gcc", "cl"];
 
   const git: string | null = await which(gitExe, { nothrow: true });