NEW @W-17701084@ CLI update and logfile adjustment (#1746)

Author: jfeingold35

package.json

@@ -6,13 +6,13 @@
 	"bugs": "https://github.com/forcedotcom/sfdx-scanner/issues",
 	"dependencies": {
 		"@oclif/core": "3.27.0",
-		"@salesforce/code-analyzer-core": "0.22.0",
-		"@salesforce/code-analyzer-engine-api": "0.17.0",
-		"@salesforce/code-analyzer-eslint-engine": "0.19.0",
-		"@salesforce/code-analyzer-flowtest-engine": "0.17.0",
-		"@salesforce/code-analyzer-pmd-engine": "0.19.0",
-		"@salesforce/code-analyzer-regex-engine": "0.17.0",
-		"@salesforce/code-analyzer-retirejs-engine": "0.17.0",
+		"@salesforce/code-analyzer-core": "0.23.0",
+		"@salesforce/code-analyzer-engine-api": "0.18.0",
+		"@salesforce/code-analyzer-eslint-engine": "0.20.0",
+		"@salesforce/code-analyzer-flowtest-engine": "0.18.0",
+		"@salesforce/code-analyzer-pmd-engine": "0.20.0",
+		"@salesforce/code-analyzer-regex-engine": "0.18.0",
+		"@salesforce/code-analyzer-retirejs-engine": "0.18.0",
 		"@salesforce/core": "6.7.6",
 		"@salesforce/sf-plugins-core": "5.0.13",
 		"@salesforce/ts-types": "^2.0.12",

src/lib/utils/DateTimeUtils.ts

@@ -0,0 +1,20 @@
+export interface Clock {
+	now(): Date;
+}
+
+export class RealClock implements Clock {
+	public now(): Date {
+		return new Date();
+	}
+}
+
+export function formatToDateTimeString(dateTime: Date): string {
+	const year: number = dateTime.getFullYear();
+	const month: string = String(dateTime.getMonth() + 1).padStart(2, '0'); // Months are 0-indexed
+	const day: string = String(dateTime.getDate()).padStart(2, '0');
+	const hours: string = String(dateTime.getHours()).padStart(2, '0');
+	const minutes: string = String(dateTime.getMinutes()).padStart(2, '0');
+	const seconds: string = String(dateTime.getSeconds()).padStart(2, '0');
+	const milliseconds: string = String(dateTime.getMilliseconds()).padStart(3, '0');
+	return `${year}_${month}_${day}_${hours}_${minutes}_${seconds}_${milliseconds}`;
+}

src/lib/writers/LogWriter.ts

@@ -1,6 +1,7 @@
 import * as path from 'node:path';
 import * as fs from 'node:fs/promises';
 import {CodeAnalyzerConfig} from '@salesforce/code-analyzer-core';
+import {Clock, RealClock, formatToDateTimeString} from '../utils/DateTimeUtils';
 
 export interface LogWriter {
 	writeToLog(message: string): void;
@@ -29,11 +30,11 @@ export class LogFileWriter implements LogWriter {
 		this.writeStream.end();
 	}
 
-	public static async fromConfig(config: CodeAnalyzerConfig): Promise<LogFileWriter> {
+	public static async fromConfig(config: CodeAnalyzerConfig, clock: Clock = new RealClock()): Promise<LogFileWriter> {
 		const logFolder = config.getLogFolder();
 		// Use the current timestamp to make sure each transaction has a unique logfile. If we want to reuse logfiles,
 		// or just have one running logfile, we can change this.
-		const logFile = path.join(logFolder, `sfca-${Date.now()}.log`);
+		const logFile = path.join(logFolder, `sfca-${formatToDateTimeString(clock.now())}.log`);
 		// 'w' flag causes the file to be created if it doesn't already exist.
 		const fh = await fs.open(logFile, 'w');
 		return new LogFileWriter(fh.createWriteStream({}), logFile);

test/lib/writers/LogWriter.test.ts

@@ -3,6 +3,7 @@ import * as fs from 'node:fs/promises';
 import * as tmp from 'tmp';
 import {CodeAnalyzerConfig} from '@salesforce/code-analyzer-core';
 import {LogFileWriter} from '../../../src/lib/writers/LogWriter';
+import {Clock} from '../../../src/lib/utils/DateTimeUtils';
 
 describe('LogWriter implementations', () => {
 
@@ -30,10 +31,11 @@ describe('LogWriter implementations', () => {
 			jest.restoreAllMocks();
 		})
 
-		it('Writes to file specified by config', async () => {
+		it('Writes properly-named file to config-specified folder', async () => {
 			// ==== TEST SETUP ====
 			const config = CodeAnalyzerConfig.withDefaults();
-			const logWriter = await LogFileWriter.fromConfig(config);
+			const fixedDate: Date = new Date(2025, 1, 20, 14, 30, 18, 14);
+			const logWriter = await LogFileWriter.fromConfig(config, new FixedClock(fixedDate));
 
 			// ==== TESTED BEHAVIOR ====
 			logWriter.writeToLog('beep');
@@ -44,10 +46,23 @@ describe('LogWriter implementations', () => {
 			const logFolderContents = await fs.readdir(tmpLogFolder);
 			expect(logFolderContents).toHaveLength(1);
 			const logFilePath = path.join(tmpLogFolder, logFolderContents[0]);
+			expect(path.basename(logFilePath)).toEqual('sfca-2025_02_20_14_30_18_014.log');
 			const logFileContents = await fs.readFile(logFilePath, {encoding: 'utf-8'});
 			expect(logFileContents).toContain('beep');
 			expect(logFileContents).toContain('boop');
 			expect(logFileContents).toContain('bop');
 		});
 	});
 });
+
+class FixedClock implements Clock {
+	private readonly fixedDate: Date;
+
+	public constructor(fixedDate: Date) {
+		this.fixedDate = fixedDate;
+	}
+
+	public now(): Date {
+		return this.fixedDate;
+	}
+}