CDS extractor rewrite project cleanup

Cleanup remaining, known problems with the CDS extractor rewrite
for PR #195 , including:

- Fixes a bug that was introduced to the `index-files.sh` script by the
  previous commit;
- Removes dead `src/**/*.ts` code, where found;
- Replaces hardcoded, system-local paths in CDS project files;
- Improves the organization, logic, and testing of `src/cds/compiler`
  code.

Author: data-douser

extractors/cds/tools/cds-extractor.ts

@@ -212,7 +212,7 @@ cdsExtractorLog(
 startPerformanceTracking('CDS Compilation');
 try {
   // Use the new orchestrated compilation approach (autobuild mode, no debug)
-  orchestrateCompilation(dependencyGraph, projectCacheDirMap, codeqlExePath, false);
+  orchestrateCompilation(dependencyGraph, projectCacheDirMap, codeqlExePath);
 
   // Handle compilation failures for normal mode
   if (!dependencyGraph.statusSummary.overallSuccess) {

extractors/cds/tools/eslint.config.mjs

@@ -50,6 +50,7 @@ export default defineConfig([
         ...globals.node,
       },
       // @ts-expect-error - tsParser is a valid parser
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
       parser: tsParser,
       ecmaVersion: 2018,
       sourceType: 'module',
@@ -141,7 +142,7 @@ export default defineConfig([
       sourceType: 'script',
       parserOptions: {
         project: './tsconfig.json',
-        tsconfigRootDir: '/Users/data-douser/Git/data-douser/codeql-sap-js/extractors/cds/tools',
+        tsconfigRootDir: __dirname,
       },
     },
   },
@@ -156,7 +157,7 @@ export default defineConfig([
       sourceType: 'module',
       parserOptions: {
         project: './tsconfig.json',
-        tsconfigRootDir: '/Users/data-douser/Git/data-douser/codeql-sap-js/extractors/cds/tools',
+        tsconfigRootDir: __dirname,
       },
     },
     rules: {

extractors/cds/tools/index-files.sh

@@ -27,12 +27,6 @@ _script_dir=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 _cds_extractor_js_path="${_script_dir}/dist/cds-extractor.js"
 _cds_extractor_node_modules_dir="${_script_dir}/node_modules"
 
-if [ ! -f "${_cds_extractor_js_path}" ]; then
-    echo "Error: The 'cds-extractor.js' script does not exist at the expected path: ${_cds_extractor_js_path}"
-    echo "Please ensure that the script has been built and is available in the 'dist' directory."
-    exit 3
-fi
-
 # Change to the directory of this shell script to ensure that npm looks up the
 # package.json file in the correct directory and installs the dependencies
 # (i.e. node_modules) relative to this directory. This is technically a violation

extractors/cds/tools/package.json

@@ -8,7 +8,7 @@
     "build:all": "npm run lint:fix && npm run test:coverage && npm run build",
     "clean": "rm -rf coverage dist",
     "prebuild": "npm run clean",
-    "lint": "eslint --ext .ts src/",
+    "lint": "eslint --ext .ts cds-extractor.ts src/ test/src/",
     "lint:fix": "eslint --ext .ts --fix cds-extractor.ts src/ test/src/",
     "format": "prettier --write 'src/**/*.ts'",
     "test": "jest",

extractors/cds/tools/src/cds/compiler/command.ts

@@ -43,85 +43,22 @@ const cdsCommandCache: CdsCommandCache = {
 };
 
 /**
- * Reset the command cache - primarily for testing
- */
-export function resetCdsCommandCache(): void {
-  cdsCommandCache.commandResults.clear();
-  cdsCommandCache.availableCacheDirs = [];
-  cdsCommandCache.globalCommand = undefined;
-  cdsCommandCache.initialized = false;
-}
-
-/**
- * Check if a CDS command is available and working
- * @param command The command to test
- * @param sourceRoot The source root directory to use as cwd when testing the command
- * @param silent Whether to suppress logging of test failures
- * @returns Object with test result and version information
+ * Determine the `cds` command to use based on the environment and cache directory.
+ *
+ * This function uses a caching strategy to minimize repeated CLI command testing:
+ * - Initializes a global cache on first call
+ * - Tests global commands once and caches results
+ * - Discovers all available cache directories upfront
+ * - Reuses test results across multiple calls
  */
-function testCdsCommand(
-  command: string,
-  sourceRoot: string,
-  silent: boolean = false,
-): { works: boolean; version?: string; error?: string } {
-  // Check cache first
-  const cachedResult = cdsCommandCache.commandResults.get(command);
-  if (cachedResult) {
-    return cachedResult;
-  }
-
+export function determineCdsCommand(cacheDir: string | undefined, sourceRoot: string): string {
   try {
-    // Try to run the command with --version to see if it works
-    // CRITICAL: Use sourceRoot as cwd and clean environment to avoid conflicts
-    let result: string;
-
-    const cleanEnv = {
-      ...process.env,
-      // Remove any CodeQL-specific environment variables that might interfere
-      CODEQL_EXTRACTOR_CDS_WIP_DATABASE: undefined,
-      CODEQL_RUNNER: undefined,
-    };
-
-    if (command.includes('node ')) {
-      // For node commands, we need to split and execute properly
-      const parts = command.split(' ');
-      const nodeExecutable = parts[0]; // 'node'
-      const scriptPath = parts[1].replace(/"/g, ''); // Remove quotes from path
-      result = execFileSync(nodeExecutable, [scriptPath, '--version'], {
-        encoding: 'utf8',
-        stdio: 'pipe',
-        timeout: 5000, // Reduced timeout for faster failure
-        cwd: sourceRoot,
-        env: cleanEnv,
-      }).toString();
-    } else {
-      // Use shell-quote to properly escape the command and prevent injection
-      const escapedCommand = quote([command, '--version']);
-      result = execFileSync('sh', ['-c', escapedCommand], {
-        encoding: 'utf8',
-        stdio: 'pipe',
-        timeout: 5000, // Reduced timeout for faster failure
-        cwd: sourceRoot,
-        env: cleanEnv,
-      }).toString();
-    }
-
-    // Extract version from output (typically in format "@sap/cds-dk: 6.1.3" or just "6.1.3")
-    const versionMatch = result.match(/(\d+\.\d+\.\d+)/);
-    const version = versionMatch ? versionMatch[1] : undefined;
-
-    const testResult = { works: true, version };
-    cdsCommandCache.commandResults.set(command, testResult);
-    return testResult;
+    // Always use the efficient path - debug information is collected separately
+    return getBestCdsCommand(cacheDir, sourceRoot);
   } catch (error) {
-    const errorMessage = String(error);
-    if (!silent) {
-      cdsExtractorLog('debug', `CDS command test failed for '${command}': ${errorMessage}`);
-    }
-
-    const testResult = { works: false, error: errorMessage };
-    cdsCommandCache.commandResults.set(command, testResult);
-    return testResult;
+    const errorMessage = `Failed to determine CDS command: ${String(error)}`;
+    cdsExtractorLog('error', errorMessage);
+    throw new Error(errorMessage);
   }
 }
 
@@ -159,44 +96,6 @@ function discoverAvailableCacheDirs(sourceRoot: string): string[] {
   return availableDirs;
 }
 
-/**
- * Initialize the CDS command cache by testing global commands
- * @param sourceRoot The source root directory
- */
-function initializeCdsCommandCache(sourceRoot: string): void {
-  if (cdsCommandCache.initialized) {
-    return;
-  }
-
-  cdsExtractorLog('info', 'Initializing CDS command cache...');
-
-  // Test global commands first (most commonly used)
-  const globalCommands = ['cds', 'npx -y --package @sap/cds-dk cds'];
-
-  for (const command of globalCommands) {
-    const result = testCdsCommand(command, sourceRoot, true); // Silent testing
-    if (result.works) {
-      cdsCommandCache.globalCommand = command;
-      cdsExtractorLog(
-        'info',
-        `Found working global CDS command: ${command} (v${result.version ?? 'unknown'})`,
-      );
-      break;
-    }
-  }
-
-  // Discover available cache directories
-  const cacheDirs = discoverAvailableCacheDirs(sourceRoot);
-  if (cacheDirs.length > 0) {
-    cdsExtractorLog(
-      'info',
-      `Discovered ${cacheDirs.length} CDS cache director${cacheDirs.length === 1 ? 'y' : 'ies'}`,
-    );
-  }
-
-  cdsCommandCache.initialized = true;
-}
-
 /**
  * Get the best CDS command for a specific cache directory
  * @param cacheDir Optional specific cache directory
@@ -246,26 +145,6 @@ function getBestCdsCommand(cacheDir: string | undefined, sourceRoot: string): st
   return 'npx -y --package @sap/cds-dk cds';
 }
 
-/**
- * Determine the `cds` command to use based on the environment and cache directory.
- *
- * This function uses a caching strategy to minimize repeated CLI command testing:
- * - Initializes a global cache on first call
- * - Tests global commands once and caches results
- * - Discovers all available cache directories upfront
- * - Reuses test results across multiple calls
- */
-export function determineCdsCommand(cacheDir: string | undefined, sourceRoot: string): string {
-  try {
-    // Always use the efficient path - debug information is collected separately
-    return getBestCdsCommand(cacheDir, sourceRoot);
-  } catch (error) {
-    const errorMessage = `Failed to determine CDS command: ${String(error)}`;
-    cdsExtractorLog('error', errorMessage);
-    throw new Error(errorMessage);
-  }
-}
-
 /**
  * Get detailed command analysis for debug purposes
  * This replaces the old performComprehensiveAnalysis function
@@ -353,3 +232,124 @@ export function getCommandAnalysisForDebug(
     throw new Error(`Failed to analyze CDS commands: ${String(error)}`);
   }
 }
+
+/**
+ * Initialize the CDS command cache by testing global commands
+ * @param sourceRoot The source root directory
+ */
+function initializeCdsCommandCache(sourceRoot: string): void {
+  if (cdsCommandCache.initialized) {
+    return;
+  }
+
+  cdsExtractorLog('info', 'Initializing CDS command cache...');
+
+  // Test global commands first (most commonly used)
+  const globalCommands = ['cds', 'npx -y --package @sap/cds-dk cds'];
+
+  for (const command of globalCommands) {
+    const result = testCdsCommand(command, sourceRoot, true); // Silent testing
+    if (result.works) {
+      cdsCommandCache.globalCommand = command;
+      cdsExtractorLog(
+        'info',
+        `Found working global CDS command: ${command} (v${result.version ?? 'unknown'})`,
+      );
+      break;
+    }
+  }
+
+  // Discover available cache directories
+  const cacheDirs = discoverAvailableCacheDirs(sourceRoot);
+  if (cacheDirs.length > 0) {
+    cdsExtractorLog(
+      'info',
+      `Discovered ${cacheDirs.length} CDS cache director${cacheDirs.length === 1 ? 'y' : 'ies'}`,
+    );
+  }
+
+  cdsCommandCache.initialized = true;
+}
+
+/**
+ * Reset the command cache - primarily for testing
+ */
+export function resetCdsCommandCache(): void {
+  cdsCommandCache.commandResults.clear();
+  cdsCommandCache.availableCacheDirs = [];
+  cdsCommandCache.globalCommand = undefined;
+  cdsCommandCache.initialized = false;
+}
+
+/**
+ * Check if a CDS command is available and working
+ * @param command The command to test
+ * @param sourceRoot The source root directory to use as cwd when testing the command
+ * @param silent Whether to suppress logging of test failures
+ * @returns Object with test result and version information
+ */
+function testCdsCommand(
+  command: string,
+  sourceRoot: string,
+  silent: boolean = false,
+): { works: boolean; version?: string; error?: string } {
+  // Check cache first
+  const cachedResult = cdsCommandCache.commandResults.get(command);
+  if (cachedResult) {
+    return cachedResult;
+  }
+
+  try {
+    // Try to run the command with --version to see if it works
+    // CRITICAL: Use sourceRoot as cwd and clean environment to avoid conflicts
+    let result: string;
+
+    const cleanEnv = {
+      ...process.env,
+      // Remove any CodeQL-specific environment variables that might interfere
+      CODEQL_EXTRACTOR_CDS_WIP_DATABASE: undefined,
+      CODEQL_RUNNER: undefined,
+    };
+
+    if (command.includes('node ')) {
+      // For node commands, we need to split and execute properly
+      const parts = command.split(' ');
+      const nodeExecutable = parts[0]; // 'node'
+      const scriptPath = parts[1].replace(/"/g, ''); // Remove quotes from path
+      result = execFileSync(nodeExecutable, [scriptPath, '--version'], {
+        encoding: 'utf8',
+        stdio: 'pipe',
+        timeout: 5000, // Reduced timeout for faster failure
+        cwd: sourceRoot,
+        env: cleanEnv,
+      }).toString();
+    } else {
+      // Use shell-quote to properly escape the command and prevent injection
+      const escapedCommand = quote([command, '--version']);
+      result = execFileSync('sh', ['-c', escapedCommand], {
+        encoding: 'utf8',
+        stdio: 'pipe',
+        timeout: 5000, // Reduced timeout for faster failure
+        cwd: sourceRoot,
+        env: cleanEnv,
+      }).toString();
+    }
+
+    // Extract version from output (typically in format "@sap/cds-dk: 6.1.3" or just "6.1.3")
+    const versionMatch = result.match(/(\d+\.\d+\.\d+)/);
+    const version = versionMatch ? versionMatch[1] : undefined;
+
+    const testResult = { works: true, version };
+    cdsCommandCache.commandResults.set(command, testResult);
+    return testResult;
+  } catch (error) {
+    const errorMessage = String(error);
+    if (!silent) {
+      cdsExtractorLog('debug', `CDS command test failed for '${command}': ${errorMessage}`);
+    }
+
+    const testResult = { works: false, error: errorMessage };
+    cdsCommandCache.commandResults.set(command, testResult);
+    return testResult;
+  }
+}