feat: validate CLI installation and version during activation of CLI Integration extension

packages/salesforcedx-utils/package.json

@@ -19,7 +19,8 @@
     "cross-spawn": "7.0.3",
     "request-light": "^0.7.0",
     "rxjs": "^5.4.1",
-    "tree-kill": "^1.1.0"
+    "tree-kill": "^1.1.0",
+    "semver": "^7.5.4"
   },
   "devDependencies": {
     "@types/jest": "^29.5.5",

packages/salesforcedx-utils/src/cli/cliVersionStatus.ts

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { execSync } from 'child_process';
+import * as semver from 'semver';
+
+export enum CliStatusEnum {
+  validCli = 1,
+  outdatedSFDXVersion = 2,
+  onlySFv1 = 3,
+  cliNotInstalled = 4,
+  bothSFDXAndSFInstalled = 5
+}
+
+export class CliVersionStatus {
+
+  public getSfdxCliVersion(): string {
+    try {
+      const result = execSync('sfdx --version');
+      return result.toString();
+    } catch {
+      return 'No SFDX CLI';
+    }
+  }
+  public getSfCliVersion(): string {
+    try {
+      const result = execSync('sf --version');
+      return result.toString();
+    } catch {
+      return 'No SF CLI';
+    }
+  }
+
+  public parseCliVersion(sfCliVersion: string): string {
+    const pattern = /(?:sfdx-cli\/|@salesforce\/cli\/)(\d+\.\d+\.\d+)/;
+    const match = pattern.exec(sfCliVersion);
+    // SFDX v7 reports results in match[1], SF v2 reports results in match[2]
+    return match ? match[1] : '0.0.0';
+  }
+
+  public validateCliInstallationAndVersion(sfdxCliVersionString: string, sfCliVersionString: string): CliStatusEnum {
+
+    // Case 1: Neither SFDX CLI nor SF CLI is installed
+    if (semver.satisfies(sfdxCliVersionString, '0.0.0') && semver.satisfies(sfCliVersionString, '0.0.0')) {
+      return CliStatusEnum.cliNotInstalled;
+    }
+
+    // Case 2: Only SF CLI (v1) is installed (SF v1 cannot be used because it does not map sf to sfdx)
+    if (semver.satisfies(sfdxCliVersionString, '0.0.0') && semver.satisfies(sfCliVersionString, '1.x')) {
+      return CliStatusEnum.onlySFv1;
+    }
+
+    // Case 3: Both SFDX CLI (v7) and SF CLI (v2) are installed at the same time
+    if (semver.satisfies(sfCliVersionString, '2.x') && !semver.satisfies(sfdxCliVersionString, sfCliVersionString)) {
+      return CliStatusEnum.bothSFDXAndSFInstalled;
+    }
+
+    // Case 4: Outdated SFDX CLI version is installed
+    const minSFDXVersion = '7.193.2';
+    if (semver.satisfies(sfdxCliVersionString, (`<${minSFDXVersion}`)) && semver.satisfies(sfCliVersionString, '<2.0.0')) {
+      return CliStatusEnum.outdatedSFDXVersion;
+    }
+
+    // Case 5: Valid SFDX v7 version or SF v2 is installed
+    return CliStatusEnum.validCli;
+  }
+}

packages/salesforcedx-utils/src/cli/index.ts

@@ -12,3 +12,4 @@ export { ForceConfigGet } from './forceConfigGet';
 export { GlobalCliEnvironment } from './globalCliEnvironment';
 export { OrgDisplay } from './orgDisplay';
 export { SfdxCommandBuilder } from './sfdxCommandBuilder';
+export { CliStatusEnum, CliVersionStatus } from './cliVersionStatus';

packages/salesforcedx-utils/test/jest/cli/cliVersionStatus.test.ts

@@ -0,0 +1,125 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { CliStatusEnum, CliVersionStatus } from '../../../src/cli/cliVersionStatus';
+
+describe('CliVersionStatus unit tests.', () => {
+
+  const sfV2_string = '@salesforce/cli/2.15.9 darwin-arm64 node-v18.17.1';
+  const sfdxV7_valid_string = 'sfdx-cli/7.209.6 win32-x64 node-v18.15.0';
+  const sfV1_string = '@salesforce/cli/1.87.0 darwin-arm64 node-v18.17.1';
+  const sfdxV7_outdated_string = 'sfdx-cli/7.183.1 darwin-arm64 node-v16.19.1';
+  const noSFDX_string = 'No SFDX CLI';
+  const noSF_string = 'No SF CLI';
+
+  const sfV2_parsed = '2.15.9';
+  const sfdxV7_valid_parsed = '7.209.6';
+  const sfV1_parsed = '1.87.0';
+  const sfdxV7_outdated_parsed = '7.183.1';
+  const noSFDX_parsed = '0.0.0';
+  const noSF_parsed = '0.0.0';
+
+  /*
+  Test cases for the parseCliVersion() function
+  */
+  describe('Test cases for the parseCliVersion() function', () => {
+    it('Parse valid SFDX', () => {
+      const c = new CliVersionStatus();
+      const result = c.parseCliVersion(sfdxV7_valid_string);
+      expect(result).toStrictEqual(sfdxV7_valid_parsed);
+    });
+
+    it('Parse outdated SFDX', () => {
+      const c = new CliVersionStatus();
+      const result = c.parseCliVersion(sfdxV7_outdated_string);
+      expect(result).toStrictEqual(sfdxV7_outdated_parsed);
+    });
+
+    it('Parse valid SF v2', () => {
+      const c = new CliVersionStatus();
+      const result = c.parseCliVersion(sfV2_string);
+      expect(result).toStrictEqual(sfV2_parsed);
+    });
+
+    it('Parse SFDX not installed', () => {
+      const c = new CliVersionStatus();
+      const result = c.parseCliVersion(noSFDX_string);
+      expect(result).toStrictEqual(noSFDX_parsed);
+    });
+
+    it('Parse SF v1', () => {
+      const c = new CliVersionStatus();
+      const result = c.parseCliVersion(sfV1_string);
+      expect(result).toStrictEqual(sfV1_parsed);
+    });
+
+    it('Parse SF not installed', () => {
+      const c = new CliVersionStatus();
+      const result = c.parseCliVersion(noSF_string);
+      expect(result).toStrictEqual(noSF_parsed);
+    });
+  });
+
+  /*
+  Test cases for the validateCliInstallationAndVersion() function
+  */
+  describe('Test cases for the validateCliInstallationAndVersion() function', () => {
+    it('Case 1: No Salesforce CLI installed - should fail', () => {
+      const c = new CliVersionStatus();
+      const result = c.validateCliInstallationAndVersion(noSFDX_parsed, noSF_parsed);
+      expect(result).toStrictEqual(CliStatusEnum.cliNotInstalled);
+    });
+
+    it('Case 2: Only SF v1 installed - should fail', () => {
+      const c = new CliVersionStatus();
+      const result = c.validateCliInstallationAndVersion(noSFDX_parsed, sfV1_parsed);
+      expect(result).toStrictEqual(CliStatusEnum.onlySFv1);
+    });
+
+    it('Case 3: Both SFDX v7 (outdated) and SF v2 installed - should fail', () => {
+      const c = new CliVersionStatus();
+      const result = c.validateCliInstallationAndVersion(sfdxV7_outdated_parsed, sfV2_parsed);
+      expect(result).toStrictEqual(CliStatusEnum.bothSFDXAndSFInstalled);
+    });
+
+    it('Case 4: Both SFDX v7 (valid) and SF v2 installed - should fail', () => {
+      const c = new CliVersionStatus();
+      const result = c.validateCliInstallationAndVersion(sfdxV7_valid_parsed, sfV2_parsed);
+      expect(result).toStrictEqual(CliStatusEnum.bothSFDXAndSFInstalled);
+    });
+
+    it('Case 5: Only SFDX v7 (outdated) installed - should fail', () => {
+      const c = new CliVersionStatus();
+      const result = c.validateCliInstallationAndVersion(sfdxV7_outdated_parsed, noSF_parsed);
+      expect(result).toStrictEqual(CliStatusEnum.outdatedSFDXVersion);
+    });
+
+    it('Case 6: Only SFDX v7 (valid) installed - should activate Core extension', () => {
+      const c = new CliVersionStatus();
+      const result = c.validateCliInstallationAndVersion(sfdxV7_valid_parsed, noSF_parsed);
+      expect(result).toStrictEqual(CliStatusEnum.validCli);
+    });
+
+    it('Case 7: SFDX v7 (outdated) and SF v1 installed - should fail', () => {
+      const c = new CliVersionStatus();
+      const result = c.validateCliInstallationAndVersion(sfdxV7_outdated_parsed, sfV1_parsed);
+      expect(result).toStrictEqual(CliStatusEnum.outdatedSFDXVersion);
+    });
+
+    it('Case 8: SFDX v7 (valid) and SF v1 installed - should activate Core extension', () => {
+      const c = new CliVersionStatus();
+      const result = c.validateCliInstallationAndVersion(sfdxV7_valid_parsed, sfV1_parsed);
+      expect(result).toStrictEqual(CliStatusEnum.validCli);
+    });
+
+    it('Case 9: Only SF v2 installed - should activate Core extension', () => {
+      const c = new CliVersionStatus();
+      const result = c.validateCliInstallationAndVersion(sfV2_parsed, sfV2_parsed);
+      expect(result).toStrictEqual(CliStatusEnum.validCli);
+    });
+  });
+});

packages/salesforcedx-vscode-core/src/constants.ts

@@ -13,8 +13,8 @@ export const STATUS_BAR_MSG_TIMEOUT_MS = 5000;
 export const APEX_CODE_DEBUG_LEVEL = 'FINEST';
 export const VISUALFORCE_DEBUG_LEVEL = 'FINER';
 export const ENV_SF_DISABLE_TELEMETRY = 'SF_DISABLE_TELEMETRY';
-export const SFDX_CLI_DOWNLOAD_LINK =
-  'https://developer.salesforce.com/tools/sfdxcli';
+export const SF_CLI_DOWNLOAD_LINK =
+  'https://developer.salesforce.com/tools/salesforcecli';
 export const TARGET_ORG_KEY = 'target-org';
 export const PKG_ID_PREFIX = '04t';
 

packages/salesforcedx-vscode-core/src/index.ts

@@ -4,7 +4,7 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import { ensureCurrentWorkingDirIsProjectPath } from '@salesforce/salesforcedx-utils';
+import { CliStatusEnum, CliVersionStatus, ensureCurrentWorkingDirIsProjectPath } from '@salesforce/salesforcedx-utils';
 import {
   ChannelService,
   getRootWorkspacePath,
@@ -93,14 +93,16 @@ import {
 } from './conflict';
 import {
   ENABLE_SOBJECT_REFRESH_ON_STARTUP,
-  ORG_OPEN_COMMAND
+  ORG_OPEN_COMMAND,
+  SF_CLI_DOWNLOAD_LINK
 } from './constants';
 import { WorkspaceContext, workspaceContextUtils } from './context';
 import {
   decorators,
   disposeTraceFlagExpiration,
   showDemoMode
 } from './decorators';
+import { nls } from './messages';
 import { isDemoMode } from './modes/demo-mode';
 import { notificationService, ProgressNotification } from './notifications';
 import { orgBrowser } from './orgBrowser';
@@ -542,6 +544,11 @@ export async function activate(extensionContext: vscode.ExtensionContext) {
   // thus avoiding the potential errors surfaced when the libs call
   // process.cwd().
   ensureCurrentWorkingDirIsProjectPath(rootWorkspacePath);
+  const platform = process.platform.toLowerCase();
+  const isWindows = platform === 'win32';
+  if (!isWindows) {
+    await validateCliInstallationAndVersion();
+  }
   setNodeExtraCaCerts();
   await telemetryService.initializeService(extensionContext);
   showTelemetryMessage(extensionContext);
@@ -707,3 +714,44 @@ export function deactivate(): Promise<void> {
   disposeTraceFlagExpiration();
   return turnOffLogging();
 }
+
+export function validateCliInstallationAndVersion(): void {
+  // Check that the CLI is installed and that it is a supported version
+  // If there is no CLI or it is an unsupported version then the Core extension will not activate
+  const c = new CliVersionStatus();
+
+  const sfdxCliVersionString = c.getSfdxCliVersion();
+  const sfCliVersionString = c.getSfCliVersion();
+
+  const sfdxCliVersionParsed = c.parseCliVersion(sfdxCliVersionString);
+  const sfCliVersionParsed = c.parseCliVersion(sfCliVersionString);
+
+  const cliInstallationResult = c.validateCliInstallationAndVersion(sfdxCliVersionParsed, sfCliVersionParsed);
+
+  switch(cliInstallationResult) {
+    case CliStatusEnum.cliNotInstalled: {
+      showErrorNotification('sfdx_cli_not_found', [SF_CLI_DOWNLOAD_LINK, SF_CLI_DOWNLOAD_LINK]);
+      throw Error('No Salesforce CLI installed');
+    }
+    case CliStatusEnum.onlySFv1: {
+      showErrorNotification('sf_v1_not_supported', [SF_CLI_DOWNLOAD_LINK, SF_CLI_DOWNLOAD_LINK]);
+      throw Error('Only SF v1 installed');
+    }
+    case CliStatusEnum.outdatedSFDXVersion: {
+      showErrorNotification('sfdx_cli_not_supported', [SF_CLI_DOWNLOAD_LINK, SF_CLI_DOWNLOAD_LINK]);
+      throw Error('Outdated SFDX CLI version that is no longer supported');
+    }
+    case CliStatusEnum.bothSFDXAndSFInstalled: {
+      showErrorNotification('both_sfdx_and_sf', []);
+      throw Error('Both SFDX v7 and SF v2 are installed');
+    }
+  }
+}
+
+export function showErrorNotification(type: string, args: any[]) {
+  const showMessage = nls.localize(
+    type,
+    ...args
+  );
+  vscode.window.showErrorMessage(showMessage);
+}

packages/salesforcedx-vscode-core/src/messages/i18n.ja.ts

@@ -250,6 +250,12 @@ export const messages = {
     'sfdx-project.json ファイル (%s) をパースできませんでした。パースエラー: %s',
   sfdx_cli_not_found:
     'Salesforce CLI がインストールされていません。[%s](%s) からインストールしてください。',
+  sfdx_cli_not_supported:
+    'Your installed Salesforce CLI version is no longer supported. Uninstall CLI and install the latest version from [%s](%s).',
+  sf_v1_not_supported:
+    'Your installed Salesforce CLI version is incompatible with all versions of our extensions. Uninstall Salesforce CLI and install the latest version from [%s](%s).',
+  both_sfdx_and_sf:
+    'You have both SFDX(v7) and SF(v2) of Salesforce CLI installed. Uninstall SFDX(v7) by running `npm uninstall sfdx-cli --global` in your terminal.',
   table_header_errors: 'ERRORS',
   table_header_project_path: 'PROJECT PATH',
   table_header_type: 'TYPE',

packages/salesforcedx-vscode-core/src/messages/i18n.ts

@@ -292,6 +292,12 @@ export const messages = {
     "Couldn't parse sfdx-project.json file (%s). Parse error: %s",
   sfdx_cli_not_found:
     'Salesforce CLI is not installed. Install it from [%s](%s)',
+  sfdx_cli_not_supported:
+    'Your installed Salesforce CLI version is no longer supported. Uninstall CLI and install the latest version from [%s](%s).',
+  sf_v1_not_supported:
+    'Your installed Salesforce CLI version is incompatible with all versions of our extensions. Uninstall Salesforce CLI and install the latest version from [%s](%s).',
+  both_sfdx_and_sf:
+    'You have both SFDX(v7) and SF(v2) of Salesforce CLI installed. Uninstall SFDX(v7) by running `npm uninstall sfdx-cli --global` in your terminal.',
   table_header_errors: 'ERRORS',
   table_header_project_path: 'PROJECT PATH',
   table_header_type: 'TYPE',