feat: use oclif/core v4 and sf-plugins-core v10 (#1038)

mdonnalley · mshanemc · web-flow · commit a09c19752db4 · 2024-06-05T23:47:59.000-05:00
* feat: use oclif/core v4 and sf-plugins-core v10

* chore: use sf-plugins-core 10

* chore: bump to non-beta

* chore: lockfile sdr

---------

Co-authored-by: mshanemc &lt;shane.mclaughlin@salesforce.com&gt;
diff --git a/package.json b/package.json
@@ -5,14 +5,14 @@
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
-    "@oclif/core": "^3.26.6",
+    "@oclif/core": "^4",
     "@salesforce/apex-node": "^6.0.0",
     "@salesforce/core": "^7.3.9",
     "@salesforce/kit": "^3.1.2",
     "@salesforce/plugin-info": "^3.3.4",
-    "@salesforce/sf-plugins-core": "^9.1.0",
-    "@salesforce/source-deploy-retrieve": "^11.6.3",
-    "@salesforce/source-tracking": "^6.3.2",
+    "@salesforce/sf-plugins-core": "^10.0.0",
+    "@salesforce/source-deploy-retrieve": "^11.6.5",
+    "@salesforce/source-tracking": "^6.3.4",
     "@salesforce/ts-types": "^2.0.9",
     "chalk": "^5.3.0"
   },
diff --git a/src/formatters/asyncDeployCancelResultFormatter.ts b/src/formatters/asyncDeployCancelResultFormatter.ts
@@ -5,10 +5,12 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { ux } from '@oclif/core';
+import { Ux } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
 import { AsyncDeployResultJson, DeployResultJson, Formatter } from '../utils/types.js';
 
+const ux = new Ux();
+
 export class AsyncDeployCancelResultFormatter implements Formatter<AsyncDeployResultJson> {
   public constructor(private id: string) {}
 
diff --git a/src/formatters/asyncDeployResultFormatter.ts b/src/formatters/asyncDeployResultFormatter.ts
@@ -5,10 +5,12 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { ux } from '@oclif/core';
+import { Ux } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
 import { AsyncDeployResultJson, Formatter } from '../utils/types.js';
 
+const ux = new Ux();
+
 export class AsyncDeployResultFormatter implements Formatter<AsyncDeployResultJson> {
   public constructor(private id: string) {}
 
diff --git a/src/formatters/deleteResultFormatter.ts b/src/formatters/deleteResultFormatter.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 { ux } from '@oclif/core';
+import { Ux } from '@salesforce/sf-plugins-core';
 import { DeployResult, FileResponse, FileResponseSuccess, RequestStatus } from '@salesforce/source-deploy-retrieve';
 import { ensureArray } from '@salesforce/kit';
 import chalk from 'chalk';
@@ -18,6 +18,8 @@ import {
 } from '../utils/output.js';
 import { TestResultsFormatter } from '../formatters/testResultsFormatter.js';
 
+const ux = new Ux();
+
 export class DeleteResultFormatter extends TestResultsFormatter implements Formatter<DeleteSourceJson> {
   public constructor(
     protected result: DeployResult,
@@ -99,20 +101,18 @@ export class DeleteResultFormatter extends TestResultsFormatter implements Forma
     const failures = ensureArray(this.result.response.details.componentFailures);
     if (!failures.length) return;
 
-    const columns = {
-      problemType: { header: 'Type' },
-      fullName: { header: 'Name' },
-      error: { header: 'Problem' },
-    };
-    const options: ux.Table.table.Options = {
-      title: StandardColors.error(chalk.bold(`Component Failures [${failures.length}]`)),
-      'no-truncate': true,
-    };
     ux.log();
     ux.table(
       failures.map((f) => ({ problemType: f.problemType, fullName: f.fullName, error: f.problem })),
-      columns,
-      options
+      {
+        problemType: { header: 'Type' },
+        fullName: { header: 'Name' },
+        error: { header: 'Problem' },
+      },
+      {
+        title: StandardColors.error(chalk.bold(`Component Failures [${failures.length}]`)),
+        'no-truncate': true,
+      }
     );
   }
 }
diff --git a/src/formatters/deployCancelResultFormatter.ts b/src/formatters/deployCancelResultFormatter.ts
@@ -4,10 +4,13 @@
  * 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 { ux } from '@oclif/core';
+import { Ux } from '@salesforce/sf-plugins-core';
+import { error } from '@oclif/core/ux';
 import { DeployResult, RequestStatus } from '@salesforce/source-deploy-retrieve';
 import { DeployResultJson, Formatter } from '../utils/types.js';
 
+const ux = new Ux();
+
 export class DeployCancelResultFormatter implements Formatter<DeployResultJson> {
   public constructor(protected result: DeployResult) {}
 
@@ -20,7 +23,7 @@ export class DeployCancelResultFormatter implements Formatter<DeployResultJson>
     if (this.result.response.status === RequestStatus.Canceled) {
       ux.log(`Successfully canceled ${this.result.response.id}`);
     } else {
-      ux.error(`Could not cancel ${this.result.response.id}`);
+      error(`Could not cancel ${this.result.response.id}`);
     }
   }
 }
diff --git a/src/formatters/deployReportResultFormatter.ts b/src/formatters/deployReportResultFormatter.ts
@@ -4,13 +4,15 @@
  * 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 { ux } from '@oclif/core';
+import { Ux } from '@salesforce/sf-plugins-core';
 import { RequestStatus } from '@salesforce/source-deploy-retrieve';
 import { StandardColors } from '@salesforce/sf-plugins-core';
 import { Duration } from '@salesforce/kit';
 import { tableHeader } from '../utils/output.js';
 import { DeployResultFormatter } from './deployResultFormatter.js';
 
+const ux = new Ux();
+
 export class DeployReportResultFormatter extends DeployResultFormatter {
   public display(): void {
     ux.log(`${this.result.response.id}... ${this.result.response.status}`);
diff --git a/src/formatters/deployResultFormatter.ts b/src/formatters/deployResultFormatter.ts
@@ -4,11 +4,11 @@
  * 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 * as path from 'node:path';
+import path from 'node:path';
 import { EOL } from 'node:os';
-import * as fs from 'node:fs';
+import fs from 'node:fs';
 import { join } from 'node:path';
-import { ux } from '@oclif/core';
+import { Ux } from '@salesforce/sf-plugins-core';
 import {
   ComponentStatus,
   DeployResult,
@@ -51,6 +51,8 @@ import {
 } from '../utils/output.js';
 import { TestResultsFormatter } from '../formatters/testResultsFormatter.js';
 
+const ux = new Ux();
+
 export class DeployResultFormatter extends TestResultsFormatter implements Formatter<DeployResultJson> {
   private readonly relativeFiles: FileResponse[];
   private readonly absoluteFiles: FileResponse[];
diff --git a/src/formatters/metadataConvertResultFormatter.ts b/src/formatters/metadataConvertResultFormatter.ts
@@ -4,11 +4,13 @@
  * 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 * as path from 'node:path';
-import { ux } from '@oclif/core';
+import path from 'node:path';
+import { Ux } from '@salesforce/sf-plugins-core';
 import { ConvertResult } from '@salesforce/source-deploy-retrieve';
 import { Formatter, ConvertMdapiJson } from '../utils/types.js';
 
+const ux = new Ux();
+
 export class MetadataConvertResultFormatter implements Formatter<ConvertMdapiJson> {
   private convertResults!: ConvertMdapiJson;
   public constructor(private result: ConvertResult) {}
diff --git a/src/formatters/metadataRetrieveResultFormatter.ts b/src/formatters/metadataRetrieveResultFormatter.ts
@@ -6,12 +6,14 @@
  */
 import { join, parse } from 'node:path';
 
-import { ux } from '@oclif/core';
+import { Ux } from '@salesforce/sf-plugins-core';
 import { FileResponse, RetrieveResult } from '@salesforce/source-deploy-retrieve';
 import { Messages } from '@salesforce/core';
 import { Formatter, MetadataRetrieveResultJson } from '../utils/types.js';
 import { fileResponseSortFn, makePathRelative } from '../utils/output.js';
 
+const ux = new Ux();
+
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 export const retrieveMessages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'retrieve.start');
 
diff --git a/src/formatters/retrieveResultFormatter.ts b/src/formatters/retrieveResultFormatter.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 * as path from 'node:path';
+import path from 'node:path';
 import { Ux } from '@salesforce/sf-plugins-core';
 import { FileResponse, RetrieveMessage, RetrieveResult } from '@salesforce/source-deploy-retrieve';
 import { NamedPackageDir, SfProject } from '@salesforce/core';
diff --git a/src/formatters/sourceConvertResultFormatter.ts b/src/formatters/sourceConvertResultFormatter.ts
@@ -6,12 +6,14 @@
  */
 import { resolve } from 'node:path';
 
-import { ux } from '@oclif/core';
+import { Ux } from '@salesforce/sf-plugins-core';
 import { ConvertResult } from '@salesforce/source-deploy-retrieve';
 import { SfError, Messages } from '@salesforce/core';
 import { ConvertResultJson, Formatter } from '../utils/types.js';
 import { exitCodeAsNumber } from '../utils/output.js';
 
+const ux = new Ux();
+
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 export const convertMessages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'convert.source');
 
diff --git a/src/formatters/testResultsFormatter.ts b/src/formatters/testResultsFormatter.ts
@@ -4,8 +4,8 @@
  * 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 * as os from 'node:os';
-import { ux } from '@oclif/core';
+import os from 'node:os';
+import { Ux } from '@salesforce/sf-plugins-core';
 import chalk from 'chalk';
 import {
   CodeCoverage,
@@ -21,6 +21,8 @@ import { TestLevel, Verbosity } from '../utils/types.js';
 import { tableHeader, error, success, check } from '../utils/output.js';
 import { coverageOutput } from '../utils/coverage.js';
 
+const ux = new Ux();
+
 export class TestResultsFormatter {
   public testLevel: TestLevel | undefined;
   public verbosity: Verbosity;
diff --git a/src/utils/conflicts.ts b/src/utils/conflicts.ts
@@ -5,9 +5,11 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { ux } from '@oclif/core';
+import { Ux } from '@salesforce/sf-plugins-core';
 import { ConflictResponse } from '@salesforce/source-tracking';
 
+const ux = new Ux();
+
 export const writeConflictTable = (conflicts?: ConflictResponse[]): void => {
   if (!conflicts || conflicts.length === 0) {
     return;
diff --git a/src/utils/previewOutput.ts b/src/utils/previewOutput.ts
@@ -6,7 +6,7 @@
  */
 import { isAbsolute, relative, resolve } from 'node:path';
 
-import { ux } from '@oclif/core';
+import { Ux } from '@salesforce/sf-plugins-core';
 import { StandardColors } from '@salesforce/sf-plugins-core';
 import chalk from 'chalk';
 import { Messages } from '@salesforce/core';
@@ -25,6 +25,8 @@ import { filePathsFromMetadataComponent } from '@salesforce/source-deploy-retrie
 import { SourceTracking } from '@salesforce/source-tracking';
 import { isSourceComponentWithXml } from './types.js';
 
+const ux = new Ux();
+
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'previewMessages');
 
diff --git a/src/utils/progressBar.ts b/src/utils/progressBar.ts
@@ -5,11 +5,10 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { envVars as env, EnvironmentVariable, Lifecycle, Messages } from '@salesforce/core';
+import { envVars as env, EnvironmentVariable, Lifecycle, Messages, Logger } from '@salesforce/core';
 import { MetadataApiDeploy, MetadataApiDeployStatus } from '@salesforce/source-deploy-retrieve';
 import { Progress } from '@salesforce/sf-plugins-core';
 import { SourceMemberPollingEvent } from '@salesforce/source-tracking';
-import { ux } from '@oclif/core';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const mdTransferMessages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'metadata.transfer');
@@ -18,6 +17,8 @@ const showBar = Boolean(
   process.env.TERM !== 'dumb' && process.stdin.isTTY && env.getBoolean(EnvironmentVariable.SF_USE_PROGRESS_BAR, true)
 );
 
+const logger = await Logger.child('deploy-progress');
+
 export class DeployProgress extends Progress {
   private static OPTIONS = {
     title: 'Status',
@@ -88,7 +89,7 @@ export class DeployProgress extends Progress {
       try {
         status = mdTransferMessages.getMessage(data.status);
       } catch (e) {
-        ux.debug(`data.status message lookup failed for: ${data.status}`);
+        logger.debug(`data.status message lookup failed for: ${data.status}`);
         status = 'Waiting';
       }
       this.update(0, { errorInfo, testInfo, status });
diff --git a/test/commands/convert/source.test.ts b/test/commands/convert/source.test.ts
@@ -6,13 +6,14 @@
  */
 
 import { join, resolve, sep } from 'node:path';
+import fs from 'node:fs/promises';
+import { Stats } from 'node:fs';
 import { ComponentSetBuilder, ComponentSetOptions, MetadataConverter } from '@salesforce/source-deploy-retrieve';
 import sinon from 'sinon';
 import { expect } from 'chai';
-import { stubMethod } from '@salesforce/ts-sinon';
+import { stubMethod, stubInterface } from '@salesforce/ts-sinon';
 import { MockTestOrgData, TestContext } from '@salesforce/core/testSetup';
 import { stubSfCommandUx } from '@salesforce/sf-plugins-core';
-import oclifUtils from '@oclif/core/lib/util/fs.js';
 import { SfProject } from '@salesforce/core';
 import { Source } from '../../../src/commands/project/convert/source.js';
 
@@ -50,8 +51,13 @@ describe('project convert source', () => {
     SfProject.instances.clear();
     stubSfCommandUx($$.SANDBOX);
     // the 2 oclif flags should act as if the dir/file is there and ok
-    $$.SANDBOX.stub(oclifUtils, 'fileExists').callsFake((path: string) => Promise.resolve(path));
-    $$.SANDBOX.stub(oclifUtils, 'dirExists').callsFake((path: string) => Promise.resolve(path));
+    $$.SANDBOX.stub(fs, 'stat').resolves(
+      stubInterface<Stats>($$.SANDBOX, {
+        isDirectory: () => true,
+        isFile: () => true,
+      })
+    );
+
     $$.setConfigStubContents('SfProjectJson', {
       contents: {
         packageDirectories: [{ path: defaultDir, default: true }],
diff --git a/test/commands/retrieve/start.test.ts b/test/commands/retrieve/start.test.ts
@@ -7,6 +7,8 @@
 
 import { resolve } from 'node:path';
 
+import fs from 'node:fs/promises';
+import { Stats } from 'node:fs';
 import sinon from 'sinon';
 import { expect } from 'chai';
 import {
@@ -19,10 +21,9 @@ import {
   RetrieveOptions,
 } from '@salesforce/source-deploy-retrieve';
 import { Messages, SfProject } from '@salesforce/core';
-import { stubMethod } from '@salesforce/ts-sinon';
+import { stubMethod, stubInterface } from '@salesforce/ts-sinon';
 import { stubSfCommandUx, stubSpinner, stubUx } from '@salesforce/sf-plugins-core';
 import { MockTestOrgData, TestContext } from '@salesforce/core/testSetup';
-import oclifUtils from '@oclif/core/lib/util/fs.js';
 import { RetrieveResultFormatter } from '../../../src/formatters/retrieveResultFormatter.js';
 import { getRetrieveResult } from '../../utils/retrieveResponse.js';
 import { RetrieveResultJson } from '../../../src/utils/types.js';
@@ -62,8 +63,12 @@ describe('project retrieve start', () => {
     await $$.stubConfig({ 'target-org': testOrg.username });
 
     // the 2 oclif flags should act as if the dir/file is there and ok
-    $$.SANDBOX.stub(oclifUtils, 'fileExists').callsFake((p: string) => Promise.resolve(p));
-    $$.SANDBOX.stub(oclifUtils, 'dirExists').callsFake((p: string) => Promise.resolve(p));
+    $$.SANDBOX.stub(fs, 'stat').resolves(
+      stubInterface<Stats>($$.SANDBOX, {
+        isDirectory: () => true,
+        isFile: () => true,
+      })
+    );
 
     sfCommandUxStubs = stubSfCommandUx($$.SANDBOX);
     stubUx($$.SANDBOX);
diff --git a/test/utils/output.test.ts b/test/utils/output.test.ts
@@ -4,11 +4,11 @@
  * 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 * as path from 'node:path';
+import path from 'node:path';
 import { assert, expect, config } from 'chai';
 import sinon from 'sinon';
 import { DeployMessage, DeployResult, FileResponse } from '@salesforce/source-deploy-retrieve';
-import { ux } from '@oclif/core';
+import { Ux } from '@salesforce/sf-plugins-core';
 import { getCoverageFormattersOptions } from '../../src/utils/coverage.js';
 import { DeployResultFormatter } from '../../src/formatters/deployResultFormatter.js';
 import { getDeployResult } from './deployResponses.js';
@@ -27,7 +27,7 @@ describe('deployResultFormatter', () => {
     let tableStub: sinon.SinonStub;
 
     beforeEach(() => {
-      tableStub = sandbox.stub(ux, 'table');
+      tableStub = sandbox.stub(Ux.prototype, 'table');
     });
 
     it('prints file responses, and messages from server', () => {
@@ -125,7 +125,7 @@ describe('deployResultFormatter', () => {
       it('will warn when code coverage warning present from server', () => {
         const deployResult = getDeployResult('codeCoverageWarning');
         const formatter = new DeployResultFormatter(deployResult, {});
-        const warnStub = sandbox.stub(ux, 'warn');
+        const warnStub = sandbox.stub(Ux.prototype, 'warn');
         formatter.display();
         expect(warnStub.callCount).to.equal(1);
         expect(warnStub.firstCall.args[0]).to.equal(
diff --git a/yarn.lock b/yarn.lock
