Refactor environment variable handling and path resolution; remove outdated workflows and update dependabot configuration

Author: Kinin-Code-Offical

.github/dependabot.yml

@@ -1,7 +1,7 @@
 version: 2
 updates:
   - package-ecosystem: "npm"
-    directory: "/cloudsqlctl"
+    directory: "/"
     schedule:
       interval: "weekly"
   - package-ecosystem: "github-actions"

.github/workflows/codeql.yml

@@ -5,19 +5,15 @@
 #define MyAppExeName "cloudsqlctl.exe"
 
 [Setup]
-; NOTE: The value of AppId uniquely identifies this application. Do not use the same AppId value in installers for other applications.
-; (To generate a new GUID, click Tools | Generate GUID inside the IDE.)
 AppId={{8A4B2C1D-E3F4-5678-9012-3456789ABCDE}
 AppName={#MyAppName}
 AppVersion={#MyAppVersion}
-;AppVerName={#MyAppName} {#MyAppVersion}
 AppPublisher={#MyAppPublisher}
 AppPublisherURL={#MyAppURL}
 AppSupportURL={#MyAppURL}
 AppUpdatesURL={#MyAppURL}
 DefaultDirName={autopf}\{#MyAppName}
 DisableProgramGroupPage=yes
-; Install for all users (requires admin)
 PrivilegesRequired=admin
 OutputDir=..\dist
 OutputBaseFilename=cloudsqlctl-setup
@@ -38,12 +34,20 @@ Name: "{autoprograms}\{#MyAppName}"; Filename: "{app}\{#MyAppExeName}"
 ; Add to System PATH
 Root: HKLM; Subkey: "SYSTEM\CurrentControlSet\Control\Session Manager\Environment"; ValueType: expandsz; ValueName: "Path"; ValueData: "{olddata};{app}"; Check: NeedsAddPath(ExpandConstant('{app}'))
 
-; Optional: Set Environment Variables for Machine Scope
-Root: HKLM; Subkey: "SYSTEM\CurrentControlSet\Control\Session Manager\Environment"; ValueType: string; ValueName: "CLOUDSQLCTL_HOME"; ValueData: "{commonappdata}\CloudSQLCTL"; Flags: createvalueifdoesntexist uninsdeletevalue
-Root: HKLM; Subkey: "SYSTEM\CurrentControlSet\Control\Session Manager\Environment"; ValueType: string; ValueName: "CLOUDSQLCTL_LOGS"; ValueData: "{commonappdata}\CloudSQLCTL\logs"; Flags: createvalueifdoesntexist uninsdeletevalue
-Root: HKLM; Subkey: "SYSTEM\CurrentControlSet\Control\Session Manager\Environment"; ValueType: string; ValueName: "CLOUDSQLCTL_PROXY_PATH"; ValueData: "{commonappdata}\CloudSQLCTL\bin\cloud-sql-proxy.exe"; Flags: createvalueifdoesntexist uninsdeletevalue
+; Environment Variables (Machine Scope) - Logic handled in Code section for smart reuse
+Root: HKLM; Subkey: "SYSTEM\CurrentControlSet\Control\Session Manager\Environment"; ValueType: string; ValueName: "CLOUDSQLCTL_HOME"; ValueData: "{code:GetHomeDir}"; Flags: uninsdeletevalue
+Root: HKLM; Subkey: "SYSTEM\CurrentControlSet\Control\Session Manager\Environment"; ValueType: string; ValueName: "CLOUDSQLCTL_LOGS"; ValueData: "{code:GetLogsDir}"; Flags: uninsdeletevalue
+Root: HKLM; Subkey: "SYSTEM\CurrentControlSet\Control\Session Manager\Environment"; ValueType: string; ValueName: "CLOUDSQLCTL_PROXY_PATH"; ValueData: "{code:GetProxyPath}"; Flags: uninsdeletevalue
+
+[Dirs]
+Name: "{commonappdata}\CloudSQLCTL"; Permissions: users-modify
+Name: "{commonappdata}\CloudSQLCTL\logs"; Permissions: users-modify
+Name: "{commonappdata}\CloudSQLCTL\bin"; Permissions: users-modify
 
 [Code]
+var
+  ProxyPath: string;
+
 function NeedsAddPath(Param: string): boolean;
 var
   OrigPath: string;
@@ -55,7 +59,68 @@ begin
     Result := True;
     exit;
   end;
-  // look for the path with leading and trailing semicolon
-  // Pos() returns 0 if not found
   Result := Pos(';' + Param + ';', ';' + OrigPath + ';') = 0;
 end;
+
+function GetHomeDir(Param: string): string;
+var
+  ExistingHome: string;
+begin
+  // Reuse existing HOME if set
+  if RegQueryStringValue(HKEY_LOCAL_MACHINE, 'SYSTEM\CurrentControlSet\Control\Session Manager\Environment', 'CLOUDSQLCTL_HOME', ExistingHome) then
+  begin
+    if DirExists(ExistingHome) then
+    begin
+      Result := ExistingHome;
+      exit;
+    end;
+  end;
+  Result := ExpandConstant('{commonappdata}\CloudSQLCTL');
+end;
+
+function GetLogsDir(Param: string): string;
+begin
+  Result := ExpandConstant('{commonappdata}\CloudSQLCTL\logs');
+end;
+
+function GetProxyPath(Param: string): string;
+var
+  ExistingProxy: string;
+  CommonBin: string;
+  UserBin: string;
+begin
+  // 1. Check Registry for existing
+  if RegQueryStringValue(HKEY_LOCAL_MACHINE, 'SYSTEM\CurrentControlSet\Control\Session Manager\Environment', 'CLOUDSQLCTL_PROXY_PATH', ExistingProxy) then
+  begin
+    if FileExists(ExistingProxy) then
+    begin
+      Result := ExistingProxy;
+      exit;
+    end;
+  end;
+
+  CommonBin := ExpandConstant('{commonappdata}\CloudSQLCTL\bin\cloud-sql-proxy.exe');
+  
+  // 2. Check if exists in Common AppData
+  if FileExists(CommonBin) then
+  begin
+    Result := CommonBin;
+    exit;
+  end;
+
+  // 3. Check User AppData (Migration scenario)
+  UserBin := ExpandConstant('{localappdata}\CloudSQLCTL\bin\cloud-sql-proxy.exe');
+  if FileExists(UserBin) then
+  begin
+    // Copy to Common AppData
+    ForceDirectories(ExpandConstant('{commonappdata}\CloudSQLCTL\bin'));
+    if FileCopy(UserBin, CommonBin, False) then
+    begin
+      Result := CommonBin;
+      exit;
+    end;
+  end;
+
+  // 4. Default
+  Result := CommonBin;
+end;

.github/workflows/dependabot.yml

@@ -11,8 +11,8 @@ export const checkCommand = new Command('check')
         try {
             logger.info('Checking system configuration...');
 
-            const envOk = await checkEnvironment();
-            logger.info(`Environment Variables: ${envOk ? 'OK' : 'MISSING/INCORRECT'}`);
+            const envOk = await checkEnvironment('Machine');
+            logger.info(`Environment Variables (Machine): ${envOk ? 'OK' : 'MISSING/INCORRECT'}`);
 
             const binaryOk = await fs.pathExists(PATHS.PROXY_EXE);
             logger.info(`Proxy Binary: ${binaryOk ? 'OK' : 'MISSING'}`);

installer/cloudsqlctl.iss

@@ -3,7 +3,7 @@ import { logger } from '../core/logger.js';
 import { checkGcloudInstalled, getActiveAccount } from '../core/gcloud.js';
 import { checkEnvironment } from '../system/env.js';
 import { isServiceInstalled } from '../system/service.js';
-import { SYSTEM_PATHS } from '../system/paths.js';
+import { PATHS } from '../system/paths.js';
 import fs from 'fs-extra';
 import axios from 'axios';
 
@@ -29,15 +29,15 @@ export const doctorCommand = new Command('doctor')
         }
 
         // Check Environment Variables
-        const envOk = await checkEnvironment();
+        const envOk = await checkEnvironment('Machine');
         if (envOk) {
             logger.info('✅ System Environment Variables are correct');
         } else {
             logger.warn('⚠️ System Environment Variables are missing or incorrect');
         }
 
         // Check Proxy Binary
-        if (await fs.pathExists(SYSTEM_PATHS.PROXY_EXE)) {
+        if (await fs.pathExists(PATHS.PROXY_EXE)) {
             logger.info('✅ Cloud SQL Proxy binary found');
         } else {
             logger.error('❌ Cloud SQL Proxy binary NOT found');

src/commands/check.ts

@@ -1,5 +1,6 @@
 import path from 'path';
 import os from 'os';
+import fs from 'fs-extra';
 
 const PROGRAM_DATA = process.env.ProgramData || 'C:\\ProgramData';
 const LOCAL_APP_DATA = process.env.LOCALAPPDATA || path.join(os.homedir(), 'AppData', 'Local');
@@ -32,25 +33,52 @@ export const ENV_VARS = {
 };
 
 function resolvePaths() {
-    const home = process.env[ENV_VARS.HOME] || USER_PATHS.HOME;
-    const logs = process.env[ENV_VARS.LOGS] || path.join(home, 'logs');
-    const bin = path.join(home, 'bin');
-    const proxyExe = process.env[ENV_VARS.PROXY_PATH] || path.join(bin, 'cloud-sql-proxy.exe');
+    // 1. Priority: Environment Variables
+    const envProxyPath = process.env[ENV_VARS.PROXY_PATH];
+    if (envProxyPath) {
+        const proxyPath = envProxyPath;
+        const home = process.env[ENV_VARS.HOME] || path.dirname(path.dirname(proxyPath)); // Guess home from proxy
+        return {
+            HOME: home,
+            LOGS: process.env[ENV_VARS.LOGS] || path.join(home, 'logs'),
+            BIN: path.dirname(proxyPath),
+            PROXY_EXE: proxyPath,
+            CONFIG_DIR: home,
+            CONFIG_FILE: path.join(home, 'config.json'),
+            TEMP: path.join(home, 'temp'),
+            GCLOUD_DIR: path.join(home, 'gcloud'),
+            PID_FILE: path.join(home, 'proxy.pid'),
+        };
+    }
 
+    // 2. Fallback: Check for existing proxy file (System then User)
+    if (fs.existsSync(SYSTEM_PATHS.PROXY_EXE)) {
+        return {
+            ...SYSTEM_PATHS,
+            CONFIG_DIR: SYSTEM_PATHS.HOME,
+            CONFIG_FILE: path.join(SYSTEM_PATHS.HOME, 'config.json'),
+            TEMP: path.join(SYSTEM_PATHS.HOME, 'temp'),
+            GCLOUD_DIR: path.join(SYSTEM_PATHS.HOME, 'gcloud'),
+            PID_FILE: path.join(SYSTEM_PATHS.HOME, 'proxy.pid'),
+        };
+    }
+
+    if (fs.existsSync(USER_PATHS.PROXY_EXE)) {
+        return USER_PATHS;
+    }
+
+    // 3. Default: System Paths (Target for new installation)
     return {
-        HOME: home,
-        LOGS: logs,
-        BIN: bin,
-        PROXY_EXE: proxyExe,
-        CONFIG_DIR: home,
-        CONFIG_FILE: path.join(home, 'config.json'),
-        TEMP: path.join(home, 'temp'),
-        GCLOUD_DIR: path.join(home, 'gcloud'),
-        PID_FILE: path.join(home, 'proxy.pid'),
+        ...SYSTEM_PATHS,
+        CONFIG_DIR: SYSTEM_PATHS.HOME,
+        CONFIG_FILE: path.join(SYSTEM_PATHS.HOME, 'config.json'),
+        TEMP: path.join(SYSTEM_PATHS.HOME, 'temp'),
+        GCLOUD_DIR: path.join(SYSTEM_PATHS.HOME, 'gcloud'),
+        PID_FILE: path.join(SYSTEM_PATHS.HOME, 'proxy.pid'),
     };
 }
 
-// Default to resolved paths (User scope by default, or ENV overrides)
+// Default to resolved paths
 export const PATHS = resolvePaths();
 
 export const SERVICE_NAME = 'cloudsql-proxy';

src/commands/doctor.ts

@@ -1,5 +1,5 @@
 import fs from 'fs-extra';
-import { SYSTEM_PATHS } from './paths.js';
+import { PATHS } from './paths.js';
 import { checkEnvironment, setupEnvironment } from './env.js';
 import { isServiceInstalled, installService } from './service.js';
 import { getLatestVersion, downloadProxy } from '../core/updater.js';
@@ -11,27 +11,33 @@ export async function selfHeal() {
     logger.info('Running self-healing checks...');
 
     const admin = await isAdmin();
+    const scope = admin ? 'Machine' : 'User';
 
     // 1. Check Environment Variables
-    if (!await checkEnvironment()) {
+    if (!await checkEnvironment(scope)) {
         if (admin) {
-            logger.warn('Environment variables missing or incorrect. Fixing...');
+            logger.warn(`Environment variables (${scope}) missing or incorrect. Fixing...`);
             try {
-                await setupEnvironment();
+                await setupEnvironment(scope);
             } catch (e) {
                 logger.error('Failed to fix environment variables', e);
             }
         } else {
-            logger.warn('Environment variables missing or incorrect. Run as Administrator to fix.');
+            logger.warn('Environment variables missing or incorrect. Run as Administrator to fix Machine scope, or we will fix User scope now.');
+            try {
+                await setupEnvironment(scope);
+            } catch (e) {
+                logger.error('Failed to fix environment variables', e);
+            }
         }
     }
 
     // 2. Check Proxy Binary
-    if (!await fs.pathExists(SYSTEM_PATHS.PROXY_EXE)) {
+    if (!await fs.pathExists(PATHS.PROXY_EXE)) {
         logger.warn('Proxy binary missing. Downloading...');
         try {
             const version = await getLatestVersion();
-            await downloadProxy(version);
+            await downloadProxy(version, PATHS.PROXY_EXE);
         } catch (e) {
             logger.error('Failed to download proxy binary', e);
         }

src/system/paths.ts

@@ -4,6 +4,7 @@ import { jest } from '@jest/globals';
 jest.unstable_mockModule('fs-extra', () => ({
     default: {
         pathExists: jest.fn().mockReturnValue(Promise.resolve(false)),
+        existsSync: jest.fn().mockReturnValue(false),
         readFile: jest.fn(),
         writeFile: jest.fn(),
         remove: jest.fn(),