fix: address some bug see with shell profile setup

Author: karthiknadig

src/features/terminal/startup/activateUsingShellStartup.ts

@@ -86,16 +86,16 @@ export class ShellStartupActivationManagerImpl implements ShellStartupActivation
     }
 
     private async getSetupRequired(): Promise<ShellStartupProvider[]> {
-        const providers: ShellStartupProvider[] = [];
-
-        await Promise.all(
+        const results = await Promise.all(
             this.shellStartupProviders.map(async (provider) => {
-                if (await provider.isSetup()) {
-                    providers.push(provider);
+                if (!(await provider.isSetup())) {
+                    return provider;
                 }
+                return undefined;
             }),
         );
 
+        const providers = results.filter((provider): provider is ShellStartupProvider => provider !== undefined);
         return providers;
     }
 

src/features/terminal/startup/bashStartup.ts

@@ -29,46 +29,18 @@ async function isGitBashInstalled(): Promise<boolean> {
     return false;
 }
 
-async function getBashProfiles(): Promise<string[]> {
+async function getBashProfiles(): Promise<string> {
     const homeDir = os.homedir();
-    const profiles: string[] = [path.join(homeDir, '.bashrc')];
-
-    // Filter to only existing profiles or the first one if none exist
-    const existingProfiles = await Promise.all(
-        profiles.map(async (profile) => ({
-            profilePath: profile,
-            exists: await fs.pathExists(profile),
-        })),
-    );
-
-    const result = existingProfiles.filter((p) => p.exists);
-    if (result.length === 0) {
-        // If no profile exists, return the first one so we can create it
-        return [profiles[0]];
-    }
+    const profile: string = path.join(homeDir, '.bashrc');
 
-    return result.map((p) => p.profilePath);
+    return profile;
 }
 
-async function getZshProfiles(): Promise<string[]> {
+async function getZshProfiles(): Promise<string> {
     const homeDir = os.homedir();
-    const profiles: string[] = [path.join(homeDir, '.zshrc')];
-
-    // Filter to only existing profiles or the first one if none exist
-    const existingProfiles = await Promise.all(
-        profiles.map(async (profile) => ({
-            profilePath: profile,
-            exists: await fs.pathExists(profile),
-        })),
-    );
-
-    const result = existingProfiles.filter((p) => p.exists);
-    if (result.length === 0) {
-        // If no profile exists, return the first one so we can create it
-        return [profiles[0]];
-    }
+    const profile: string = path.join(homeDir, '.zshrc');
 
-    return result.map((p) => p.profilePath);
+    return profile;
 }
 
 const regionStart = '# >>> vscode python';
@@ -80,96 +52,65 @@ function getActivationContent(key: string): string {
     return ['', '', regionStart, `if [ -n "$${key}" ]; then`, `    eval "$${key}"`, 'fi', regionEnd, ''].join(lineSep);
 }
 
-async function isStartupSetup(profiles: string[], key: string): Promise<ShellSetupState> {
-    if (profiles.length === 0) {
+async function isStartupSetup(profile: string, key: string): Promise<ShellSetupState> {
+    if (await fs.pathExists(profile)) {
+        const content = await fs.readFile(profile, 'utf8');
+        return content.includes(key) ? ShellSetupState.Setup : ShellSetupState.NotSetup;
+    } else {
         return ShellSetupState.NotSetup;
     }
-
-    // Check if any profile has our activation content
-    const results = await Promise.all(
-        profiles.map(async (profile) => {
-            if (await fs.pathExists(profile)) {
-                const content = await fs.readFile(profile, 'utf8');
-                if (content.includes(key)) {
-                    return true;
-                }
-            }
-            return false;
-        }),
-    );
-
-    return results.some((result) => result) ? ShellSetupState.Setup : ShellSetupState.NotSetup;
 }
 
-async function setupStartup(profiles: string[], key: string): Promise<boolean> {
-    if (profiles.length === 0) {
-        traceVerbose('Cannot setup Bash startup - No profiles found');
-        return false;
-    }
-
+async function setupStartup(profile: string, key: string): Promise<boolean> {
     const activationContent = getActivationContent(key);
-    let successfulUpdates = 0;
 
-    for (const profile of profiles) {
-        try {
-            // Create profile directory if it doesn't exist
-            await fs.mkdirp(path.dirname(profile));
-
-            // Create or update profile
-            if (!(await fs.pathExists(profile))) {
-                // Create new profile with our content
-                await fs.writeFile(profile, activationContent);
-                traceInfo(`Created new profile at: ${profile}\n${activationContent}`);
-                successfulUpdates++;
-            } else {
-                // Update existing profile
-                const content = await fs.readFile(profile, 'utf8');
-                if (!content.includes(key)) {
-                    await fs.writeFile(profile, `${content}${activationContent}`);
-                    traceInfo(`Updated existing profile at: ${profile}\n${activationContent}`);
-                    successfulUpdates++;
-                } else {
-                    // Already contains our activation code
-                    successfulUpdates++;
-                }
-            }
-        } catch (err) {
-            traceVerbose(`Failed to setup ${profile} startup`, err);
-        }
-    }
+    try {
+        // Create profile directory if it doesn't exist
+        await fs.mkdirp(path.dirname(profile));
 
-    // Return true only if all profiles were successfully updated
-    return profiles.length > 0 && successfulUpdates === profiles.length;
-}
-
-async function removeStartup(profiles: string[], key: string): Promise<boolean> {
-    let successfulRemovals = 0;
-
-    for (const profile of profiles) {
+        // Create or update profile
         if (!(await fs.pathExists(profile))) {
-            successfulRemovals++; // Count as success if file doesn't exist since there's nothing to remove
-            continue;
-        }
-
-        try {
+            // Create new profile with our content
+            await fs.writeFile(profile, activationContent);
+            traceInfo(`SHELL: Created new profile at: ${profile}\n${activationContent}`);
+        } else {
+            // Update existing profile
             const content = await fs.readFile(profile, 'utf8');
-            if (content.includes(key)) {
-                // Use regex to remove the entire region including newlines
-                const pattern = new RegExp(`${regionStart}[\\s\\S]*?${regionEnd}\\n?`, 'g');
-                const newContent = content.replace(pattern, '');
-                await fs.writeFile(profile, newContent);
-                traceInfo(`Removed activation from profile at: ${profile}`);
-                successfulRemovals++;
+            if (!content.includes(key)) {
+                await fs.writeFile(profile, `${content}${activationContent}`);
+                traceInfo(`SHELL: Updated existing profile at: ${profile}\n${activationContent}`);
             } else {
-                successfulRemovals++; // Count as success if activation is not present
+                // Already contains our activation code
+                traceInfo(`SHELL: Profile already contains activation code at: ${profile}`);
             }
-        } catch (err) {
-            traceVerbose(`Failed to remove ${profile} startup`, err);
         }
+        return true;
+    } catch (err) {
+        traceError(`SHELL: Failed to setup startup for profile at: ${profile}`, err);
+        return false;
     }
+}
 
-    // Return true only if all profiles were successfully processed
-    return profiles.length > 0 && successfulRemovals === profiles.length;
+async function removeStartup(profile: string, key: string): Promise<boolean> {
+    if (!(await fs.pathExists(profile))) {
+        return true;
+    } // If the file doesn't exist, we're done. No need to remove anything. Return true to indicate success.
+    try {
+        const content = await fs.readFile(profile, 'utf8');
+        if (content.includes(key)) {
+            // Use regex to remove the entire region including newlines
+            const pattern = new RegExp(`${regionStart}[\\s\\S]*?${regionEnd}\\n?`, 'g');
+            const newContent = content.replace(pattern, '');
+            await fs.writeFile(profile, newContent);
+            traceInfo(`SHELL: Removed activation from profile at: ${profile}`);
+        } else {
+            traceVerbose(`Profile at ${profile} does not contain activation code`);
+        }
+        return true;
+    } catch (err) {
+        traceVerbose(`Failed to remove ${profile} startup`, err);
+        return false;
+    }
 }
 
 function getCommandAsString(command: PythonCommandRunConfiguration[]): string {
@@ -204,8 +145,8 @@ export class BashStartupProvider implements ShellStartupProvider {
         }
 
         try {
-            const bashProfiles = await getBashProfiles();
-            return await isStartupSetup(bashProfiles, this.bashActivationEnvVarKey);
+            const bashProfile = await getBashProfiles();
+            return await isStartupSetup(bashProfile, this.bashActivationEnvVarKey);
         } catch (err) {
             traceError('Failed to check bash startup scripts', err);
             return ShellSetupState.NotSetup;
@@ -235,8 +176,8 @@ export class BashStartupProvider implements ShellStartupProvider {
         }
 
         try {
-            const bashProfiles = await getBashProfiles();
-            const result = await removeStartup(bashProfiles, this.bashActivationEnvVarKey);
+            const bashProfile = await getBashProfiles();
+            const result = await removeStartup(bashProfile, this.bashActivationEnvVarKey);
             return result ? ShellScriptEditState.Edited : ShellScriptEditState.NotEdited;
         } catch (err) {
             traceError('Failed to teardown bash startup scripts', err);

src/features/terminal/startup/cmdStartup.ts

@@ -147,12 +147,12 @@ async function setupRegistryAutoRun(mainBatchFile: string): Promise<boolean> {
     }
 }
 
-async function isCmdStartupSetup(cmdFiles: CmdFilePaths, key: string): Promise<boolean> {
+async function isCmdStartupSetup(cmdFiles: CmdFilePaths, key: string): Promise<ShellSetupState> {
     // Check both the startup file and registry AutoRun setting
     const fileExists = await fs.pathExists(cmdFiles.startupFile);
     const fileHasContent = fileExists ? (await fs.readFile(cmdFiles.startupFile, 'utf8')).includes(key) : false;
     if (!fileHasContent) {
-        return false;
+        return ShellSetupState.NotSetup;
     }
 
     const mainFileExists = await fs.pathExists(cmdFiles.mainBatchFile);
@@ -164,11 +164,11 @@ async function isCmdStartupSetup(cmdFiles: CmdFilePaths, key: string): Promise<b
     }
 
     if (!mainFileHasContent) {
-        return false;
+        return ShellSetupState.NotSetup;
     }
 
     const registrySetup = await checkRegistryAutoRun(cmdFiles.regMainBatchFile, cmdFiles.mainBatchFile);
-    return registrySetup;
+    return registrySetup ? ShellSetupState.Setup : ShellSetupState.NotSetup;
 }
 
 async function setupCmdStartup(cmdFiles: CmdFilePaths, key: string): Promise<boolean> {
@@ -264,7 +264,7 @@ export class CmdStartupProvider implements ShellStartupProvider {
         try {
             const cmdFiles = await getCmdFilePaths();
             const isSetup = await isCmdStartupSetup(cmdFiles, this.cmdActivationEnvVarKey);
-            return isSetup ? ShellSetupState.Setup : ShellSetupState.NotSetup;
+            return isSetup;
         } catch (err) {
             traceError('Failed to check if CMD startup is setup', err);
             return ShellSetupState.NotSetup;