Implement cdsExtractorLog for consistent logging

Creates tests and code for a new, unified `cdsExtractorLog` function and
integrates this function throughout the CDS extractor code.

Updates `test/jest.setup.ts` config for the CDS extractor in order to
simplify setup of the source root directory config required by the new
`cdsExtractorLog` function.

Author: data-douser

extractors/cds/tools/cds-extractor.ts

@@ -8,6 +8,7 @@ import { CdsProjectMapWithDebugSignals } from './src/cds/parser/types';
 import { runJavaScriptExtractor } from './src/codeql';
 import { addCompilationDiagnostic } from './src/diagnostics';
 import { configureLgtmIndexFilters, setupAndValidateEnvironment } from './src/environment';
+import { cdsExtractorLog, setSourceRootDirectory } from './src/logging';
 import { installDependencies } from './src/packageManager';
 import { RunMode } from './src/runMode';
 import { validateArguments } from './src/utils';
@@ -25,9 +26,12 @@ if (!validationResult.isValid) {
 // Get the validated and sanitized arguments
 const { runMode, sourceRoot } = validationResult.args!;
 
+// Initialize the unified logging system with the source root directory
+setSourceRootDirectory(sourceRoot);
+
 // Check for autobuild mode
 if (runMode === (RunMode.AUTOBUILD as string)) {
-  console.log('Autobuild mode is not implemented yet.');
+  cdsExtractorLog('info', 'Autobuild mode is not implemented yet.');
   process.exit(1);
 }
 
@@ -43,7 +47,8 @@ const {
 
 if (!envSetupSuccess) {
   const codeqlExe = platformInfo.isWindows ? 'codeql.exe' : 'codeql';
-  console.warn(
+  cdsExtractorLog(
+    'warn',
     `'${codeqlExe} database index-files --language cds' terminated early due to: ${errorMessages.join(
       ', ',
     )}.`,
@@ -56,12 +61,13 @@ if (!envSetupSuccess) {
 // 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}'.`,
+cdsExtractorLog(
+  'info',
+  `CodeQL CDS extractor using run mode '${runMode}' for scan of project source root directory '${sourceRoot}'.`,
 );
 
 // Using the new project-aware approach to find CDS projects and their dependencies
-console.log('Detecting CDS projects and analyzing their structure...');
+cdsExtractorLog('info', 'Detecting CDS projects and analyzing their structure...');
 
 // Build the project dependency graph using the project-aware parser
 // Pass the script directory (__dirname) to support debug-parser mode internally
@@ -72,20 +78,23 @@ 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.');
+  cdsExtractorLog('info', 'Debug parser mode completed successfully.');
   process.exit(0);
 } else if (typedProjectMap.__debugParserFailure) {
-  console.warn('No CDS projects found. Cannot generate debug information.');
+  cdsExtractorLog('warn', 'No CDS projects found. Cannot generate debug information.');
   process.exit(1);
 }
 
 // Install dependencies of discovered CAP/CDS projects
-console.log('Ensuring dependencies are installed in cache for required CDS compiler versions...');
+cdsExtractorLog(
+  'info',
+  'Ensuring dependencies are installed in cache for required CDS compiler versions...',
+);
 const projectCacheDirMap = installDependencies(projectMap, sourceRoot, codeqlExePath);
 
 const cdsFilePathsToProcess: string[] = [];
 
-console.log('Extracting CDS files from discovered projects...');
+cdsExtractorLog('info', 'Extracting CDS files from discovered projects...');
 
 // Use the project map to collect all `.cds` files from each project.
 // We want to "extract" all `.cds` files from all projects so that we have a copy
@@ -94,7 +103,7 @@ for (const [, project] of projectMap.entries()) {
   cdsFilePathsToProcess.push(...project.cdsFiles);
 }
 
-console.log('Processing CDS files to JSON ...');
+cdsExtractorLog('info', 'Processing CDS files to JSON ...');
 
 // Collect files that need compilation, handling project-level compilation
 const cdsFilesToCompile: string[] = [];
@@ -115,7 +124,8 @@ for (const [projectDir, project] of projectMap.entries()) {
   }
 }
 
-console.log(
+cdsExtractorLog(
+  'info',
   `Found ${cdsFilePathsToProcess.length} total CDS files, ${cdsFilesToCompile.length} files to compile (${projectsForProjectLevelCompilation.size} project-level compilations)`,
 );
 
@@ -141,14 +151,16 @@ for (const rawCdsFilePath of cdsFilesToCompile) {
     );
 
     if (!compilationResult.success && compilationResult.message) {
-      console.error(
-        `ERROR: adding diagnostic for source file=${rawCdsFilePath} : ${compilationResult.message} ...`,
+      cdsExtractorLog(
+        'error',
+        `adding diagnostic for source file=${rawCdsFilePath} : ${compilationResult.message} ...`,
       );
       addCompilationDiagnostic(rawCdsFilePath, compilationResult.message, codeqlExePath);
     }
   } catch (errorMessage) {
-    console.error(
-      `ERROR: adding diagnostic for source file=${rawCdsFilePath} : ${String(errorMessage)} ...`,
+    cdsExtractorLog(
+      'error',
+      `adding diagnostic for source file=${rawCdsFilePath} : ${String(errorMessage)} ...`,
     );
     addCompilationDiagnostic(rawCdsFilePath, String(errorMessage), codeqlExePath);
   }
@@ -160,7 +172,7 @@ configureLgtmIndexFilters();
 // Run CodeQL's JavaScript extractor to process the compiled JSON files.
 const extractorResult = runJavaScriptExtractor(sourceRoot, autobuildScriptPath, codeqlExePath);
 if (!extractorResult.success && extractorResult.error) {
-  console.error(`Error running JavaScript extractor: ${extractorResult.error}`);
+  cdsExtractorLog('error', `Error running JavaScript extractor: ${extractorResult.error}`);
 }
 
 // Use the `cds-extractor.js` name in the log message as that is the name of the script

extractors/cds/tools/package.json

@@ -26,13 +26,13 @@
     "tmp": "^0.2.3"
   },
   "devDependencies": {
-    "@eslint/compat": "^1.2.9",
+    "@eslint/compat": "^1.3.0",
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.28.0",
     "@types/glob": "^8.1.0",
     "@types/jest": "^29.5.14",
     "@types/mock-fs": "^4.13.4",
-    "@types/node": "^24.0.0",
+    "@types/node": "^24.0.1",
     "@types/shell-quote": "^1.7.5",
     "@typescript-eslint/eslint-plugin": "^8.34.0",
     "@typescript-eslint/parser": "^8.34.0",
@@ -43,7 +43,7 @@
     "eslint-plugin-jest": "^28.13.3",
     "eslint-plugin-prettier": "^5.4.1",
     "globals": "^16.2.0",
-    "jest": "^30.0.0",
+    "jest": "^29.7.0",
     "mock-fs": "^5.5.0",
     "prettier": "^3.5.3",
     "ts-jest": "^29.3.4",

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

@@ -4,6 +4,7 @@ import { resolve, join, delimiter, relative } from 'path';
 import { CdsCompilationResult } from './types';
 import { getCdsVersion } from './version';
 import { fileExists, dirExists, recursivelyRenameJsonFiles } from '../../filesystem';
+import { cdsExtractorLog } from '../../logging';
 import { CdsProject } from '../parser/types';
 
 /**
@@ -59,7 +60,8 @@ function compileProjectLevel(
   spawnOptions: SpawnSyncOptions,
   versionInfo: string,
 ): CdsCompilationResult {
-  console.log(
+  cdsExtractorLog(
+    'info',
     `${resolvedCdsFilePath} is part of a CAP project - using project-aware compilation ${versionInfo}...`,
   );
 
@@ -102,7 +104,7 @@ function compileProjectLevel(
     'warn',
   ];
 
-  console.log(`Compiling CAP project directories: ${existingDirectories.join(', ')}`);
+  cdsExtractorLog('info', `Compiling CAP project directories: ${existingDirectories.join(', ')}`);
 
   // CRITICAL: Use the provided spawnOptions which has sourceRoot as cwd
   const result = spawnSync(cdsCommand, compileArgs, spawnOptions);
@@ -127,11 +129,14 @@ function compileProjectLevel(
 
   // Handle directory output if the CDS compiler generated a directory
   if (dirExists(projectJsonOutPath)) {
-    console.log(`CDS compiler generated JSON to output directory: ${projectJsonOutPath}`);
+    cdsExtractorLog(
+      'info',
+      `CDS compiler generated JSON to output directory: ${projectJsonOutPath}`,
+    );
     // Recursively rename all .json files to have a .cds.json extension
     recursivelyRenameJsonFiles(projectJsonOutPath);
   } else {
-    console.log(`CDS compiler generated JSON to file: ${projectJsonOutPath}`);
+    cdsExtractorLog('info', `CDS compiler generated JSON to file: ${projectJsonOutPath}`);
   }
 
   return {
@@ -196,11 +201,11 @@ function compileIndividualFile(
 
   // Handle directory output if the CDS compiler generated a directory
   if (dirExists(cdsJsonOutPath)) {
-    console.log(`CDS compiler generated JSON to output directory: ${cdsJsonOutPath}`);
+    cdsExtractorLog('info', `CDS compiler generated JSON to output directory: ${cdsJsonOutPath}`);
     // Recursively rename all .json files to have a .cds.json extension
     recursivelyRenameJsonFiles(cdsJsonOutPath);
   } else {
-    console.log(`CDS compiler generated JSON to file: ${cdsJsonOutPath}`);
+    cdsExtractorLog('info', `CDS compiler generated JSON to file: ${cdsJsonOutPath}`);
   }
 
   return {
@@ -286,7 +291,8 @@ export function compileCdsToJson(
 
       // Check if this file is in the list of files to compile for this project
       if (!shouldCompileIndividually(project, relativePath)) {
-        console.log(
+        cdsExtractorLog(
+          'info',
           `${resolvedCdsFilePath} is imported by other files - will be compiled as part of a project ${versionInfo}...`,
         );
         return {
@@ -296,13 +302,17 @@ export function compileCdsToJson(
           message: 'File was compiled as part of a project-based compilation',
         };
       } else {
-        console.log(
+        cdsExtractorLog(
+          'info',
           `${resolvedCdsFilePath} identified as a root CDS file - using individual file compilation ${versionInfo}...`,
         );
       }
     } else {
       // Fallback to individual file compilation if project information is not available
-      console.log(`Processing individual CDS file ${resolvedCdsFilePath} ${versionInfo}...`);
+      cdsExtractorLog(
+        'info',
+        `Processing individual CDS file ${resolvedCdsFilePath} ${versionInfo}...`,
+      );
     }
 
     return compileIndividualFile(resolvedCdsFilePath, cdsCommand, spawnOptions, !!isProjectAware);

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

@@ -2,6 +2,7 @@ import { writeFileSync, mkdirSync, existsSync } from 'fs';
 import { join } from 'path';
 
 import { CdsProject } from './types';
+import { cdsExtractorLog } from '../../logging';
 
 const PARSER_DEBUG_FILE = 'cds-extractor.parser.debug.txt';
 const PARSER_DEBUG_SUBDIR = 'debug';
@@ -22,7 +23,10 @@ export function writeParserDebugInfo(
   try {
     // Early check if project map is empty
     if (!projectMap || projectMap.size === 0) {
-      console.warn('Cannot write debug information: Empty project map or no CDS projects found.');
+      cdsExtractorLog(
+        'warn',
+        'Cannot write debug information: Empty project map or no CDS projects found.',
+      );
       return false;
     }
 
@@ -112,10 +116,10 @@ export function writeParserDebugInfo(
     // cat/read when debugging.
     writeFileSync(debugFilePath, `${outputLines.join('\n')}\n`, 'utf-8');
 
-    console.log(`INFO: CDS extractor parser debug information written to: ${debugFilePath}`);
+    cdsExtractorLog('info', `CDS extractor parser debug information written to: ${debugFilePath}`);
     return true;
   } catch (error: unknown) {
-    console.error(`Error writing parser debug information: ${String(error)}`);
+    cdsExtractorLog('error', `Error writing parser debug information: ${String(error)}`);
     return false;
   }
 }

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

@@ -15,6 +15,7 @@ import {
   FileCache,
   PackageJson,
 } from './types';
+import { cdsExtractorLog } from '../../logging';
 
 // Global file cache to avoid multiple reads of the same file
 const fileCache: FileCache = {
@@ -200,7 +201,7 @@ export function determineCdsFilesForProjectDir(
     // Convert absolute paths to paths relative to sourceRootDir
     return cdsFiles.map(file => relative(sourceRootDir, file));
   } catch (error: unknown) {
-    console.error(`Error finding CDS files in ${projectDir}: ${String(error)}`);
+    cdsExtractorLog('error', `Error finding CDS files in ${projectDir}: ${String(error)}`);
     return [];
   }
 }
@@ -664,7 +665,7 @@ export function isLikelyCdsProject(dir: string): boolean {
 
     return false;
   } catch (error: unknown) {
-    console.error(`Error checking directory ${dir}: ${String(error)}`);
+    cdsExtractorLog('error', `Error checking directory ${dir}: ${String(error)}`);
     return false;
   }
 }
@@ -958,7 +959,7 @@ export function processCdsProject(sourceRootDir: string, projectDir: string): Cd
       const result = parseCdsFile(absoluteFilePath);
       parseResults.push(result);
     } catch (error: unknown) {
-      console.error(`Error processing file ${absoluteFilePath}: ${String(error)}`);
+      cdsExtractorLog('error', `Error processing file ${absoluteFilePath}: ${String(error)}`);
       // Add an empty result with the error
       parseResults.push({
         entities: [],
@@ -989,7 +990,7 @@ export function readFileWithCache(filePath: string): string {
     fileCache.fileContents.set(filePath, content);
     return content;
   } catch (error) {
-    console.error(`Error reading file ${filePath}: ${String(error)}`);
+    cdsExtractorLog('error', `Error reading file ${filePath}: ${String(error)}`);
     throw error;
   }
 }
@@ -1014,7 +1015,7 @@ export function readPackageJsonWithCache(filePath: string): PackageJson | undefi
     fileCache.packageJsonCache.set(filePath, packageJson);
     return packageJson;
   } catch (error) {
-    console.warn(`Error parsing package.json at ${filePath}: ${String(error)}`);
+    cdsExtractorLog('warn', `Error parsing package.json at ${filePath}: ${String(error)}`);
     return undefined;
   }
 }
@@ -1088,7 +1089,7 @@ export function determineCdsFilesToCompile(
           }
         }
       } catch (error) {
-        console.warn(`Warning: Error processing imports for ${file}: ${String(error)}`);
+        cdsExtractorLog('warn', `Error processing imports for ${file}: ${String(error)}`);
       }
     }
 
@@ -1105,16 +1106,18 @@ export function determineCdsFilesToCompile(
 
     // If no root files were identified, fall back to compiling all files
     if (rootFiles.length === 0) {
-      console.warn(
-        `Warning: No root CDS files identified in project ${project.projectDir}, will compile all files`,
+      cdsExtractorLog(
+        'warn',
+        `No root CDS files identified in project ${project.projectDir}, will compile all files`,
       );
       return [...project.cdsFiles];
     }
 
     return rootFiles;
   } catch (error) {
-    console.warn(
-      `Warning: Error determining files to compile for project ${project.projectDir}: ${String(error)}`,
+    cdsExtractorLog(
+      'warn',
+      `Error determining files to compile for project ${project.projectDir}: ${String(error)}`,
     );
     // Fall back to compiling all files on error
     return [...project.cdsFiles];