Fix CDS extractor environment setup

Fixes the setup of the CDS extractor environment to ensure that the
codeql CLI can be reliably found and to avoid duplicate runs of
the CDS parser's graph building process for "debug-parser" versus
other run modes.

Author: data-douser

extractors/cds/tools/cds-extractor.ts

@@ -3,8 +3,8 @@ import {
   compileCdsToJson,
   determineCdsCommand,
   findProjectForCdsFile,
-  writeParserDebugInfo,
 } from './src/cds';
+import { CdsProjectMapWithDebugSignals } from './src/cds/parser/types';
 import { runJavaScriptExtractor } from './src/codeql';
 import { addCompilationDiagnostic } from './src/diagnostics';
 import { configureLgtmIndexFilters, setupAndValidateEnvironment } from './src/environment';
@@ -25,42 +25,14 @@ if (!validationResult.isValid) {
 // Get the validated and sanitized arguments
 const { runMode, sourceRoot, responseFile } = validationResult.args!;
 
-// Handle debug parser mode
-if (runMode === (RunMode.DEBUG_PARSER as string)) {
-  console.log('Running CDS Parser in debug mode...');
-  console.log(`Source Root Directory: ${sourceRoot}`);
-
-  // Use the project-aware parser as the main entry point
-  const scriptDir = __dirname;
-  const projectMap = buildCdsProjectDependencyGraph(sourceRoot, runMode, scriptDir);
-
-  if (projectMap.size === 0) {
-    console.warn('No CDS projects found. Cannot generate debug information.');
-    process.exit(1);
-  }
-
-  // Check if debug information was successfully written
-  if (runMode === 'debug-parser' && !writeParserDebugInfo(projectMap, sourceRoot, scriptDir)) {
-    console.warn('Failed to write debug information.');
-    process.exit(1);
-  }
-
-  console.log('Debug parser process completed successfully.');
-  process.exit(0);
-} else if (runMode === (RunMode.AUTOBUILD as string)) {
+// Check for autobuild mode
+if (runMode === (RunMode.AUTOBUILD as string)) {
   console.log('Autobuild mode is not implemented yet.');
   process.exit(1);
 }
 
-// Force this script, and any process it spawns, to use the project (source) root
-// directory as the current working directory.
-process.chdir(sourceRoot);
-
-console.log(
-  `INFO: CodeQL CDS extractor using run mode '${runMode}' for scan of project source root directory '${sourceRoot}'.`,
-);
-
-// Setup the environment and validate all requirements.
+// Setup the environment and validate all requirements first, before changing directory
+// This ensures we can properly locate the CodeQL tools
 const {
   success: envSetupSuccess,
   errorMessages,
@@ -80,6 +52,16 @@ if (!envSetupSuccess) {
   process.exit(1);
 }
 
+// Force this script, and any process it spawns, to use the project (source) root
+// directory as the current working directory.
+process.chdir(sourceRoot);
+
+console.log(
+  `INFO: CodeQL CDS extractor using run mode '${runMode}' for scan of project source root directory '${sourceRoot}'.`,
+);
+console.log(`DEBUG: CodeQL executable path: ${codeqlExePath}`);
+console.log(`DEBUG: Current working directory: ${process.cwd()}`);
+
 // Only process response file for INDEX_FILES mode
 let cdsFilePathsToProcess: string[] = [];
 if (runMode === (RunMode.INDEX_FILES as string)) {
@@ -99,10 +81,25 @@ if (runMode === (RunMode.INDEX_FILES as string)) {
 console.log('Detecting CDS projects and analyzing their structure...');
 
 // Build the project dependency graph using the project-aware parser
-const projectMap = buildCdsProjectDependencyGraph(sourceRoot, runMode);
+// Pass the script directory (__dirname) to support debug-parser mode internally
+const projectMap = buildCdsProjectDependencyGraph(sourceRoot, runMode, __dirname);
+
+// Cast to the interface with debug signals to properly handle debug mode
+const typedProjectMap = projectMap as CdsProjectMapWithDebugSignals;
+
+// Check if we're in debug-parser mode and should exit (based on signals from buildCdsProjectDependencyGraph)
+if (typedProjectMap.__debugParserSuccess) {
+  console.log('Debug parser mode completed successfully.');
+  process.exit(0);
+} else if (typedProjectMap.__debugParserFailure) {
+  console.warn('No CDS projects found. Cannot generate debug information.');
+  process.exit(1);
+}
 
 // Install dependencies using the new caching approach
 console.log('Installing required CDS compiler versions using cached approach...');
+console.log(`DEBUG: Before installDependencies - CodeQL path: ${codeqlExePath}`);
+console.log(`DEBUG: Current working directory: ${process.cwd()}`);
 const projectCacheDirMap = installDependencies(projectMap, sourceRoot, codeqlExePath);
 
 // Determine the CDS command to use.
@@ -140,6 +137,7 @@ for (const rawCdsFilePath of cdsFilePathsToProcess) {
 // Configure the "LGTM" index filters for proper extraction.
 configureLgtmIndexFilters();
 
+console.log(`DEBUG: CODEQL_DIST before runJavaScriptExtractor: ${process.env.CODEQL_DIST}`);
 // Run CodeQL's JavaScript extractor to process the compiled JSON files.
 const extractorResult = runJavaScriptExtractor(sourceRoot, autobuildScriptPath, codeqlExePath);
 if (!extractorResult.success && extractorResult.error) {

extractors/cds/tools/src/cds/parser/debug.ts

@@ -113,7 +113,7 @@ export function writeParserDebugInfo(
     // cat/read when debugging.
     writeFileSync(debugFilePath, `${debugContent}\n`, 'utf-8');
 
-    console.log(`Parser debug information written to: ${debugFilePath}`);
+    console.log(`INFO: CDS extractor parser debug information written to: ${debugFilePath}`);
     return true;
   } catch (error: unknown) {
     console.error(`Error writing parser debug information: ${String(error)}`);

extractors/cds/tools/src/cds/parser/functions.ts

@@ -39,6 +39,12 @@ export function buildCdsProjectDependencyGraph(
   runMode?: string,
   scriptDir?: string,
 ): Map<string, CdsProject> {
+  // If debug-parser mode, log additional information
+  if (runMode === 'debug-parser') {
+    console.log('Running CDS Parser in debug mode...');
+    console.log(`Source Root Directory: ${sourceRootDir}`);
+  }
+
   // Find all CDS projects under the source directory
   console.log('Detecting CDS projects...');
   const projectDirs = determineCdsProjectsUnderSourceDir(sourceRootDir);
@@ -145,6 +151,13 @@ export function buildCdsProjectDependencyGraph(
         'Failed to write parser debug information. This indicates an empty project map, possibly due to a misconfiguration when calling the parent script.',
       );
     }
+
+    // Instead of exiting directly (which interrupts tests), return with a signal property
+    if (projectMap.size === 0) {
+      return Object.assign(projectMap, { __debugParserFailure: true });
+    } else {
+      return Object.assign(projectMap, { __debugParserSuccess: true });
+    }
   }
 
   return projectMap;

extractors/cds/tools/src/cds/parser/types.ts

@@ -176,6 +176,15 @@ export interface CdsProject {
   projectDir: string;
 }
 
+/** Extended CdsProject map with debug signals */
+export interface CdsProjectMapWithDebugSignals extends Map<string, CdsProject> {
+  /** Signal for successful debug parser operation */
+  __debugParserSuccess?: boolean;
+
+  /** Signal for failed debug parser operation */
+  __debugParserFailure?: boolean;
+}
+
 /** Represents a CDS service definition. */
 export interface CdsService {
   /** Annotations attached to the service. */