CHANGE: @W-17293079@: Update dependencies, refactor config command that fixes python_command issue

Author: stephen-carter-at-sf

package.json

@@ -6,13 +6,13 @@
 	"bugs": "https://github.com/forcedotcom/sfdx-scanner/issues",
 	"dependencies": {
 		"@oclif/core": "^3.3.2",
-		"@salesforce/code-analyzer-core": "0.17.0",
-		"@salesforce/code-analyzer-engine-api": "0.14.0",
-		"@salesforce/code-analyzer-eslint-engine": "0.14.0",
-		"@salesforce/code-analyzer-flowtest-engine": "0.14.1",
-		"@salesforce/code-analyzer-pmd-engine": "0.14.0",
-		"@salesforce/code-analyzer-regex-engine": "0.14.0",
-		"@salesforce/code-analyzer-retirejs-engine": "0.14.0",
+		"@salesforce/code-analyzer-core": "0.18.0",
+		"@salesforce/code-analyzer-engine-api": "0.15.0",
+		"@salesforce/code-analyzer-eslint-engine": "0.15.0",
+		"@salesforce/code-analyzer-flowtest-engine": "0.15.0",
+		"@salesforce/code-analyzer-pmd-engine": "0.15.0",
+		"@salesforce/code-analyzer-regex-engine": "0.15.0",
+		"@salesforce/code-analyzer-retirejs-engine": "0.15.0",
 		"@salesforce/core": "^5",
 		"@salesforce/sf-plugins-core": "^5.0.4",
 		"@salesforce/ts-types": "^2.0.9",

src/lib/messages.ts

@@ -17,7 +17,6 @@ export enum BundleName {
 	ResultsWriter = 'results-writer',
 	RunAction = 'run-action',
 	RunCommand = 'run-command',
-	RunSummaryViewer = 'run-summary-viewer',
 	Shared = 'shared',
 	WorkspaceUtil = 'workspace-util'
 }

src/lib/models/ConfigModel.ts

@@ -2,7 +2,8 @@ import {dump as yamlDump} from 'js-yaml';
 import {
 	CodeAnalyzer,
 	CodeAnalyzerConfig,
-	ConfigDescription,
+	ConfigDescription, ConfigFieldDescription,
+	EngineConfig,
 	Rule,
 	RuleSelection,
 	SeverityLevel
@@ -83,37 +84,51 @@ abstract class YamlFormatter {
 		return yamlCode.replace(/(\r?\n|$)/, ` ${comment}$1`);
 	}
 
-	private toYamlField(fieldName: string, userValue: unknown, defaultValue: unknown): string {
-		if (looksLikeAPathValue(userValue) && userValue === defaultValue) {
-			// We special handle a path value when it is equal to the default value, making it equal null because
-			// chances are it is a derived file or folder value based on the specific environment that we do not want to
-			// actually want to hard code since checking in the config to CI/CD system may create a different value
-			const commentText: string = getMessage(BundleName.ConfigModel, 'template.last-calculated-as', [JSON.stringify(userValue)]);
-			return this.toYamlUncheckedFieldWithInlineComment(fieldName, null, commentText);
-		} else if (JSON.stringify(userValue) === JSON.stringify(defaultValue)) {
-			return this.toYamlUncheckedField(fieldName, userValue);
+	private toYamlFieldUsingFieldDescription(fieldName: string, resolvedValue: unknown, fieldDescription: ConfigFieldDescription): string {
+		const resolvedValueJson: string = JSON.stringify(resolvedValue);
+		const defaultValueJson: string = JSON.stringify(fieldDescription.defaultValue);
+
+		if (!fieldDescription.wasSuppliedByUser && resolvedValueJson !== defaultValueJson) {
+			// Whenever the user did not supply the value themselves but the resolved value is different from the
+			// default value, this means the value was not a "fixed" value but a value "calculated" at runtime.
+			// Since "calculated" values often depend on the specific environment, we do not want to actually hard code
+			// this value into the config since checking in the config to CI/CD system may create a different value.
+			const commentText: string = getMessage(BundleName.ConfigModel, 'template.last-calculated-as', [resolvedValueJson]);
+			return this.toYamlUncheckedFieldWithInlineComment(fieldName, fieldDescription.defaultValue, commentText);
 		}
 
-		userValue = replaceAbsolutePathsWithRelativePathsWherePossible(userValue, this.userContext.config.getConfigRoot() + path.sep);
+		return this.toYamlField(fieldName, resolvedValue, fieldDescription.defaultValue);
+	}
+
+	private toYamlField(fieldName: string, resolvedValue: unknown, defaultValue: unknown): string {
+		const resolvedValueJson: string = JSON.stringify(resolvedValue);
+		const defaultValueJson: string = JSON.stringify(defaultValue);
 
-		const commentText: string = getMessage(BundleName.ConfigModel, 'template.modified-from', [JSON.stringify(defaultValue)]);
-		return this.toYamlUncheckedFieldWithInlineComment(fieldName, userValue, commentText);
+		if (resolvedValueJson === defaultValueJson) {
+			return this.toYamlUncheckedField(fieldName, resolvedValue);
+		}
+
+		const commentText: string = getMessage(BundleName.ConfigModel, 'template.modified-from', [defaultValueJson]);
+		resolvedValue = replaceAbsolutePathsWithRelativePathsWherePossible(resolvedValue, this.userContext.config.getConfigRoot() + path.sep);
+		return this.toYamlUncheckedFieldWithInlineComment(fieldName, resolvedValue, commentText);
 	}
 
 	toYaml(): string {
-		const topLevelDescription: ConfigDescription = CodeAnalyzerConfig.getConfigDescription();
-		return this.toYamlSectionHeadingComment(topLevelDescription.overview!) + '\n' +
+		const topLevelDescription: ConfigDescription = this.userContext.config.getConfigDescription();
+		return this.toYamlSectionHeadingComment(topLevelDescription.overview) + '\n' +
 			'\n' +
-			this.toYamlComment(topLevelDescription.fieldDescriptions!.config_root) + '\n' +
-			this.toYamlField('config_root', this.userContext.config.getConfigRoot(), this.defaultContext.config.getConfigRoot()) + '\n' +
+			this.toYamlComment(topLevelDescription.fieldDescriptions.config_root.descriptionText) + '\n' +
+			this.toYamlFieldUsingFieldDescription('config_root', this.userContext.config.getConfigRoot(),
+				topLevelDescription.fieldDescriptions.config_root) + '\n' +
 			'\n' +
-			this.toYamlComment(topLevelDescription.fieldDescriptions!.log_folder) + '\n' +
-			this.toYamlField('log_folder', this.userContext.config.getLogFolder(), this.defaultContext.config.getLogFolder()) + '\n' +
+			this.toYamlComment(topLevelDescription.fieldDescriptions.log_folder.descriptionText) + '\n' +
+			this.toYamlFieldUsingFieldDescription('log_folder', this.userContext.config.getLogFolder(),
+				topLevelDescription.fieldDescriptions.log_folder) + '\n' +
 			'\n' +
-			this.toYamlComment(topLevelDescription.fieldDescriptions!.rules) + '\n' +
+			this.toYamlComment(topLevelDescription.fieldDescriptions.rules.descriptionText) + '\n' +
 			this.toYamlRuleOverrides() + '\n' +
 			'\n' +
-			this.toYamlComment(topLevelDescription.fieldDescriptions!.engines) + '\n' +
+			this.toYamlComment(topLevelDescription.fieldDescriptions.engines.descriptionText) + '\n' +
 			this.toYamlEngineOverrides() + '\n' +
 			'\n' +
 			this.toYamlSectionHeadingComment(getMessage(BundleName.ConfigModel, 'template.common.end-of-config')) + '\n';
@@ -176,23 +191,21 @@ abstract class YamlFormatter {
 	}
 
 	private toYamlEngineOverridesForEngine(engineName: string): string {
-		const engineConfigDescriptor = this.userContext.core.getEngineConfigDescription(engineName);
-		const userEngineConfig = this.userContext.core.getEngineConfig(engineName);
-		const defaultEngineConfig = this.defaultContext.core.getEngineConfig(engineName);
+		const engineConfigDescriptor: ConfigDescription = this.userContext.core.getEngineConfigDescription(engineName);
+		const userEngineConfig: EngineConfig = this.userContext.core.getEngineConfig(engineName);
 
 		let yamlCode: string = '\n' +
-			this.toYamlSectionHeadingComment(engineConfigDescriptor.overview!) + '\n' +
+			this.toYamlSectionHeadingComment(engineConfigDescriptor.overview) + '\n' +
 			`${engineName}:\n`;
 		// By fiat, the field description will always include, at minimum, an entry for "disable_engine", so we can
 		// assume that the object is not undefined.
-		for (const configField of Object.keys(engineConfigDescriptor.fieldDescriptions!)) {
-			const fieldDescription = engineConfigDescriptor.fieldDescriptions![configField];
-			const defaultValue = defaultEngineConfig[configField] ?? null;
-			const userValue = userEngineConfig[configField] ?? defaultValue;
+		for (const configField of Object.keys(engineConfigDescriptor.fieldDescriptions)) {
+			const fieldDescription: ConfigFieldDescription = engineConfigDescriptor.fieldDescriptions[configField];
+			const userValue = userEngineConfig[configField] ?? fieldDescription.defaultValue;
 			// Add a leading newline to visually break up the property from the previous one.
 			yamlCode += '\n' +
-				indent(this.toYamlComment(fieldDescription), 2) + '\n' +
-				indent(this.toYamlField(configField, userValue, defaultValue), 2) + '\n';
+				indent(this.toYamlComment(fieldDescription.descriptionText), 2) + '\n' +
+				indent(this.toYamlFieldUsingFieldDescription(configField, userValue, fieldDescription), 2) + '\n';
 		}
 		return yamlCode.trimEnd();
 	}
@@ -218,10 +231,6 @@ class StyledYamlFormatter extends YamlFormatter {
 	}
 }
 
-function looksLikeAPathValue(value: unknown) {
-	return typeof(value) === 'string' && !value.includes('\n') && value.includes(path.sep);
-}
-
 function replaceAbsolutePathsWithRelativePathsWherePossible(value: unknown, parentFolder: string): unknown {
 	if (typeof value === 'string') {
 		// Check if the string starts with the parent folder

test/fixtures/comparison-files/lib/actions/ConfigAction.test.ts/override-configurations/StubEngine2_forConfigWithRelativePathScenario.yml.goldfile

@@ -7,6 +7,6 @@
     disable_engine: false
 
     # Some description for top_field
-    top_field: # Modified from: null
+    top_field: # Modified from: {}
       sub_field:
         - optional-input-config.yml

test/lib/actions/ConfigAction.test.ts

@@ -252,7 +252,7 @@ describe('ConfigAction tests', () => {
 			it.each([
 				{prop: 'config_root'},
 				{prop: 'log_folder'}
-			])(`When derivable property $prop input is non-null and non-default, it is rendered as-is with no comment`, async ({prop}) => {
+			])(`When derivable property $prop input is non-null and non-default, it is rendered as-is`, async ({prop}) => {
 				// ==== SETUP ====
 				// Make the config root and log folder both be the folder above this one.
 				const parentOfCurrentDirectory = path.resolve(__dirname, '..');
@@ -264,12 +264,11 @@ describe('ConfigAction tests', () => {
 				const output = await runActionAndGetDisplayedConfig(dependencies, ['all']);
 
 				// ==== ASSERTIONS ====
-				const defaultConfig = CodeAnalyzerConfig.withDefaults();
 				const goldFileContents = (await readGoldFile(path.join(PATH_TO_COMPARISON_DIR, 'derivables-as-non-defaults', `${prop}.yml.goldfile`)))
 					.replace('__DUMMY_CONFIG_ROOT__', parentOfCurrentDirectory)
 					.replace('__DUMMY_LOG_FOLDER__', parentOfCurrentDirectory)
-					.replace('__DUMMY_DEFAULT_CONFIG_ROOT__', JSON.stringify(defaultConfig.getConfigRoot()))
-					.replace('__DUMMY_DEFAULT_LOG_FOLDER__', JSON.stringify(defaultConfig.getLogFolder()))
+					.replace('__DUMMY_DEFAULT_CONFIG_ROOT__', JSON.stringify(null))
+					.replace('__DUMMY_DEFAULT_LOG_FOLDER__', JSON.stringify(null))
 				expect(output).toContain(goldFileContents);
 			});
 
@@ -573,22 +572,52 @@ class StubEnginePlugin extends EngineApi.EnginePluginV1 {
 
 	private readonly createdEngines: Map<string, EngineApi.Engine> = new Map();
 
+	/*
+	    descriptionText: string;
+    valueType: string;
+    defaultValue: ConfigValue;
+	 */
+
 	private readonly descriptionsByEngine: {[key: string]: EngineApi.ConfigDescription} = {
 		StubEngine1: {
 			overview: 'This is a generic overview for StubEngine1\nIt has multiple lines of text\nWhee!',
 			fieldDescriptions: {
-				'Property1': 'This is the description for Property1',
+				'Property1': {
+					descriptionText: 'This is the description for Property1',
+					valueType: 'string',
+					defaultValue: 'default1'
+				},
 				// Property2 is undocumented
-				'Property3': 'This is the description for Property3',
-				'Property4': 'This is the description for Property4',
-				'Property5': 'This is the description for Property5',
-				'Property6': 'This is the description for Property6'
+				'Property3': {
+					descriptionText: 'This is the description for Property3',
+					valueType: 'string',
+					defaultValue: 'default3'
+				},
+				'Property4': {
+					descriptionText: 'This is the description for Property4',
+					valueType: 'object',
+					defaultValue: {SubProperty1: 10, SubProperty2: true}
+				},
+				'Property5': {
+					descriptionText: 'This is the description for Property5',
+					valueType: 'array',
+					defaultValue: ['arr1', 'arr2']
+				},
+				'Property6': {
+					descriptionText: 'This is the description for Property6',
+					valueType: 'string',
+					defaultValue: null
+				},
 			}
 		},
 		StubEngine2: {
 			overview: 'Some overview for StubEngine2',
 			fieldDescriptions: {
-				'top_field': 'Some description for top_field'
+				'top_field': {
+					descriptionText: 'Some description for top_field',
+					valueType: 'object',
+					defaultValue: {}
+				}
 			}
 		}
 		// StubEngine3 also has no overview or documented properties.
@@ -651,6 +680,10 @@ class StubEngine1 extends EngineApi.Engine {
 		return 'StubEngine1';
 	}
 
+	getEngineVersion(): Promise<string> {
+		return Promise.resolve("1.0.0");
+	}
+
 	public describeRules(): Promise<EngineApi.RuleDescription[]> {
 		return Promise.resolve([{
 			name: 'Stub1Rule1',
@@ -719,6 +752,10 @@ class StubEngine2 extends EngineApi.Engine {
 		return 'StubEngine2';
 	}
 
+	getEngineVersion(): Promise<string> {
+		return Promise.resolve("1.0.2");
+	}
+
 	public describeRules(): Promise<EngineApi.RuleDescription[]> {
 		return Promise.resolve([{
 			name: 'Stub2Rule1',
@@ -745,6 +782,10 @@ class StubEngine3 extends EngineApi.Engine {
 		return 'StubEngine3';
 	}
 
+	getEngineVersion(): Promise<string> {
+		return Promise.resolve("1.0.3");
+	}
+
 	public describeRules(): Promise<EngineApi.RuleDescription[]> {
 		return Promise.resolve([{
 			name: 'Stub3Rule1',

test/lib/writers/ConfigWriter.test.ts

@@ -9,7 +9,7 @@ describe('ConfigWriter implementations', () => {
 	describe('ConfigWriterImpl', () => {
 
 		let writeFileSpy: jest.SpyInstance;
-		let writeFileInvocations: {file: fs.PathOrFileDescriptor, contents: String|ArrayBufferView}[];
+		let writeFileInvocations: {file: fs.PathOrFileDescriptor, contents: string|ArrayBufferView}[];
 		beforeEach(() => {
 			writeFileInvocations = [];
 			writeFileSpy = jest.spyOn(fs, 'writeFileSync').mockImplementation((file, contents) => {

test/stubs/SpyRunSummaryViewer.ts

@@ -71,6 +71,10 @@ export class StubEngine1 extends EngineApi.Engine {
 		return "stubEngine1";
 	}
 
+	getEngineVersion(): Promise<string> {
+		return Promise.resolve("1.0.0");
+	}
+
 	describeRules(): Promise<EngineApi.RuleDescription[]> {
 		this.emitEvent<EngineApi.DescribeRulesProgressEvent>({
 			type: EngineApi.EventType.DescribeRulesProgressEvent,
@@ -168,6 +172,10 @@ export class StubEngine2 extends EngineApi.Engine {
 		return "stubEngine2";
 	}
 
+	getEngineVersion(): Promise<string> {
+		return Promise.resolve("1.2.3");
+	}
+
 	describeRules(): Promise<EngineApi.RuleDescription[]> {
 		return Promise.resolve([
 			{
@@ -265,6 +273,10 @@ abstract class BaseTimeableEngine extends EngineApi.Engine {
 		this.executionWaitTime = 0;
 	}
 
+	getEngineVersion(): Promise<string> {
+		return Promise.resolve("1.0.1");
+	}
+
 	setRuleSelectionWaitTime(waitTime: number): void {
 		this.selectionWaitTime = waitTime;
 	}
@@ -366,6 +378,10 @@ export class EventConfigurableEngine1 extends EngineApi.Engine {
 		return "eventConfigurableEngine1";
 	}
 
+	getEngineVersion(): Promise<string> {
+		return Promise.resolve("1.0.5");
+	}
+
 	addEvents(...events: {logLevel: LogLevel, message: string}[]): void {
 		this.events = [...this.events, ...events];
 	}
@@ -428,6 +444,10 @@ export class TargetDependentEngine1 extends EngineApi.Engine {
 		return 'targetDependentEngine1';
 	}
 
+	getEngineVersion(): Promise<string> {
+		return Promise.resolve("1.3.0");
+	}
+
 	describeRules(describeOptions: EngineApi.DescribeOptions): Promise<EngineApi.RuleDescription[]> {
 		if (!describeOptions.workspace) {
 			return Promise.resolve([]);