feat: make project optional (#771)

* feat: no project required * test: fix stubs * fix: manually resolve project * fix: package version list too * chore: pr review * ci: disable package1 nuts * fix: empty alias when if no project * test: update for error change from lib --------- Co-authored-by: mshanemc <shane.mclaughlin@salesforce.com>
salesforcecli · Aug 15, 2024 · 5f674ee · 5f674ee
1 parent ec7758b
commit 5f674ee
Show file tree

Hide file tree

Showing 13 changed files with 446 additions and 403 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -26,7 +26,7 @@ jobs:
         os: [ubuntu-latest, windows-latest]
         command:
           - 'yarn test:nuts:package'
-          - 'yarn test:nuts:package1'
+          # - 'yarn test:nuts:package1' disable because of the long-standing ORA bug
       fail-fast: false
     with:
       os: ${{ matrix.os }}

diff --git a/package.json b/package.json
@@ -6,18 +6,18 @@
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
     "@oclif/core": "^4",
-    "@salesforce/core": "^8.0.1",
+    "@salesforce/core": "^8.4.0",
     "@salesforce/kit": "^3.1.6",
-    "@salesforce/packaging": "^4.1.0",
-    "@salesforce/sf-plugins-core": "^11.1.2",
+    "@salesforce/packaging": "^4.2.0",
+    "@salesforce/sf-plugins-core": "^11.3.2",
     "chalk": "^5.3.0"
   },
   "devDependencies": {
     "@oclif/plugin-command-snapshot": "^5.2.3",
-    "@salesforce/cli-plugins-testkit": "^5.3.15",
-    "@salesforce/dev-scripts": "^10.2.7",
+    "@salesforce/cli-plugins-testkit": "^5.3.25",
+    "@salesforce/dev-scripts": "^10.2.9",
     "@salesforce/plugin-command-reference": "^3.1.5",
-    "eslint-plugin-sf-plugin": "^1.18.8",
+    "eslint-plugin-sf-plugin": "^1.20.4",
     "oclif": "^4.10.11",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.4"

diff --git a/src/commands/package/delete.ts b/src/commands/package/delete.ts
@@ -9,6 +9,7 @@ import { Flags, loglevel, orgApiVersionFlagWithDeprecations, SfCommand } from '@
 import { Messages } from '@salesforce/core/messages';
 import { Package, PackageSaveResult } from '@salesforce/packaging';
 import { requiredHubFlag } from '../../utils/hubFlag.js';
+import { maybeGetProject } from '../../utils/getProject.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_delete');
@@ -19,7 +20,6 @@ export class PackageDeleteCommand extends SfCommand<PackageSaveResult> {
   public static readonly examples = messages.getMessages('examples');
   public static readonly deprecateAliases = true;
   public static readonly aliases = ['force:package:delete'];
-  public static readonly requiresProject = true;
   public static readonly flags = {
     loglevel,
     'target-dev-hub': requiredHubFlag,
@@ -52,7 +52,7 @@ export class PackageDeleteCommand extends SfCommand<PackageSaveResult> {
 
     const pkg = new Package({
       connection: flags['target-dev-hub'].getConnection(flags['api-version']),
-      project: this.project!,
+      project: await maybeGetProject(),
       packageAliasOrId: flags.package,
     });
     const result = flags.undelete ? await pkg.undelete() : await pkg.delete();

diff --git a/src/commands/package/update.ts b/src/commands/package/update.ts
@@ -9,6 +9,7 @@ import { Flags, loglevel, orgApiVersionFlagWithDeprecations, SfCommand } from '@
 import { Messages } from '@salesforce/core/messages';
 import { Package, PackageSaveResult } from '@salesforce/packaging';
 import { requiredHubFlag } from '../../utils/hubFlag.js';
+import { maybeGetProject } from '../../utils/getProject.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_update');
@@ -20,7 +21,6 @@ export class PackageUpdateCommand extends SfCommand<PackageSaveResult> {
   public static readonly examples = messages.getMessages('examples');
   public static readonly deprecateAliases = true;
   public static readonly aliases = ['force:package:update'];
-  public static readonly requiresProject = true;
   public static readonly flags = {
     loglevel,
     'target-dev-hub': requiredHubFlag,
@@ -54,10 +54,11 @@ export class PackageUpdateCommand extends SfCommand<PackageSaveResult> {
 
   public async run(): Promise<PackageSaveResult> {
     const { flags } = await this.parse(PackageUpdateCommand);
+
     const pkg = new Package({
       packageAliasOrId: flags.package,
       connection: flags['target-dev-hub'].getConnection(flags['api-version']),
-      project: this.project!,
+      project: await maybeGetProject(),
     });
 
     const result = await pkg.update({

diff --git a/src/commands/package/version/delete.ts b/src/commands/package/version/delete.ts
@@ -9,6 +9,7 @@ import { Flags, loglevel, orgApiVersionFlagWithDeprecations, SfCommand } from '@
 import { Messages } from '@salesforce/core/messages';
 import { PackageSaveResult, PackageVersion } from '@salesforce/packaging';
 import { requiredHubFlag } from '../../../utils/hubFlag.js';
+import { maybeGetProject } from '../../../utils/getProject.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_version_delete');
@@ -19,7 +20,6 @@ export class PackageVersionDeleteCommand extends SfCommand<PackageSaveResult> {
   public static readonly examples = messages.getMessages('examples');
   public static readonly deprecateAliases = true;
   public static readonly aliases = ['force:package:version:delete'];
-  public static readonly requiresProject = true;
   public static readonly flags = {
     loglevel,
     'target-dev-hub': requiredHubFlag,
@@ -45,7 +45,7 @@ export class PackageVersionDeleteCommand extends SfCommand<PackageSaveResult> {
     const { flags } = await this.parse(PackageVersionDeleteCommand);
     const packageVersion = new PackageVersion({
       connection: flags['target-dev-hub'].getConnection(flags['api-version']),
-      project: this.project!,
+      project: await maybeGetProject(),
       idOrAlias: flags.package,
     });
     await this.confirmDelete(flags['no-prompt'], flags.undelete);

diff --git a/src/commands/package/version/displayancestry.ts b/src/commands/package/version/displayancestry.ts
@@ -9,6 +9,7 @@ import { Flags, loglevel, orgApiVersionFlagWithDeprecations, SfCommand } from '@
 import { Messages } from '@salesforce/core/messages';
 import { Package, PackageAncestryNodeData } from '@salesforce/packaging';
 import { requiredHubFlag } from '../../../utils/hubFlag.js';
+import { maybeGetProject } from '../../../utils/getProject.js';
 
 // Import i18n messages
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
@@ -21,7 +22,6 @@ export class PackageVersionDisplayAncestryCommand extends SfCommand<DisplayAnces
   public static readonly examples = messages.getMessages('examples');
   public static readonly deprecateAliases = true;
   public static readonly aliases = ['force:package:version:displayancestry'];
-  public static readonly requiresProject = true;
 
   public static readonly flags = {
     loglevel,
@@ -48,7 +48,7 @@ export class PackageVersionDisplayAncestryCommand extends SfCommand<DisplayAnces
     const { flags } = await this.parse(PackageVersionDisplayAncestryCommand);
     const packageAncestry = await Package.getAncestry(
       flags.package,
-      this.project!,
+      await maybeGetProject(),
       flags['target-dev-hub'].getConnection(flags['api-version'])
     );
     const jsonProducer = packageAncestry.getJsonProducer();

diff --git a/src/commands/package/version/list.ts b/src/commands/package/version/list.ts
@@ -6,7 +6,7 @@
  */
 
 import { Flags, loglevel, orgApiVersionFlagWithDeprecations, SfCommand, Ux } from '@salesforce/sf-plugins-core';
-import { Messages, SfProject } from '@salesforce/core';
+import { Messages } from '@salesforce/core';
 import {
   getContainerOptions,
   getPackageVersionStrings,
@@ -15,6 +15,7 @@ import {
   PackageVersionListResult,
 } from '@salesforce/packaging';
 import { requiredHubFlag } from '../../../utils/hubFlag.js';
+import { maybeGetProject } from '../../../utils/getProject.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_version_list');
@@ -105,7 +106,7 @@ export class PackageVersionListCommand extends SfCommand<PackageVersionListComma
   public async run(): Promise<PackageVersionListCommandResult> {
     const { flags } = await this.parse(PackageVersionListCommand);
     const connection = flags['target-dev-hub'].getConnection(flags['api-version']);
-    const project = SfProject.getInstance();
+    const project = await maybeGetProject();
 
     const records = await Package.listVersions(connection, project, {
       createdLastDays: flags['created-last-days'],
@@ -135,8 +136,8 @@ export class PackageVersionListCommand extends SfCommand<PackageVersionListComma
 
       records.forEach((record) => {
         const ids = [record.Id, record.SubscriberPackageVersionId];
-        const aliases = ids.map((id) => project.getAliasesFromPackageId(id)).flat();
-        const AliasStr = aliases.length > 0 ? aliases.join() : '';
+        const aliases = ids.map((id) => (project ? project.getAliasesFromPackageId(id) : id)).flat();
+        const AliasStr = project ? (aliases.length > 0 ? aliases.join() : '') : '';
 
         // set Ancestor display values
         let ancestorVersion: string | undefined;

diff --git a/src/commands/package/version/promote.ts b/src/commands/package/version/promote.ts
@@ -9,6 +9,7 @@ import { Flags, loglevel, orgApiVersionFlagWithDeprecations, SfCommand } from '@
 import { Messages, SfError } from '@salesforce/core';
 import { PackageSaveResult, PackageVersion } from '@salesforce/packaging';
 import { requiredHubFlag } from '../../../utils/hubFlag.js';
+import { maybeGetProject } from '../../../utils/getProject.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_version_promote');
@@ -19,7 +20,6 @@ export class PackageVersionPromoteCommand extends SfCommand<PackageSaveResult> {
   public static readonly deprecateAliases = true;
   public static readonly aliases = ['force:package:version:promote'];
   public static readonly examples = messages.getMessages('examples');
-  public static readonly requiresProject = true;
   public static readonly flags = {
     loglevel,
     'target-dev-hub': requiredHubFlag,
@@ -41,7 +41,7 @@ export class PackageVersionPromoteCommand extends SfCommand<PackageSaveResult> {
     const { flags } = await this.parse(PackageVersionPromoteCommand);
     const packageVersion = new PackageVersion({
       connection: flags['target-dev-hub'].getConnection(flags['api-version']),
-      project: this.project!,
+      project: await maybeGetProject(),
       idOrAlias: flags.package,
     });
     const packageVersionData = await packageVersion.getData();

diff --git a/src/commands/package/version/report.ts b/src/commands/package/version/report.ts
@@ -16,6 +16,7 @@ import {
 } from '@salesforce/packaging';
 import chalk from 'chalk';
 import { requiredHubFlag } from '../../../utils/hubFlag.js';
+import { maybeGetProject } from '../../../utils/getProject.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_version_report');
@@ -39,7 +40,6 @@ export class PackageVersionReportCommand extends SfCommand<PackageVersionReportR
   public static readonly examples = messages.getMessages('examples');
   public static readonly deprecateAliases = true;
   public static readonly aliases = ['force:package:version:report'];
-  public static readonly requiresProject = true;
   public static readonly flags = {
     loglevel,
     'target-dev-hub': requiredHubFlag,
@@ -59,7 +59,7 @@ export class PackageVersionReportCommand extends SfCommand<PackageVersionReportR
     const { flags } = await this.parse(PackageVersionReportCommand);
     const packageVersion = new PackageVersion({
       connection: flags['target-dev-hub'].getConnection(flags['api-version']),
-      project: this.project!,
+      project: await maybeGetProject(),
       idOrAlias: flags.package,
     });
     const results = await packageVersion.report(flags.verbose);

diff --git a/src/utils/getProject.ts b/src/utils/getProject.ts
@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2022, 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 { SfProject } from '@salesforce/core';
+
+/*
+ * Get the sfdx project from the current dir.
+ * It will return `undefined` if there's no project.
+ * */
+export async function maybeGetProject(): Promise<SfProject | undefined> {
+  try {
+    return await SfProject.resolve();
+  } catch {
+    return undefined;
+  }
+}
diff --git a/test/commands/package/packageVersionCreate.test.ts b/test/commands/package/packageVersionCreate.test.ts
@@ -15,36 +15,46 @@ import { env } from '@salesforce/kit';
 import { PackageVersionCreateCommand } from '../../../src/commands/package/version/create.js';
 import Package2VersionStatus = PackagingSObjects.Package2VersionStatus;
 
-const pkgVersionCreateErrorResult: Partial<PackageVersionCreateRequestResult> = {
+const pkgVersionCreateErrorResult: PackageVersionCreateRequestResult = {
   Id: '08c3i000000fylXXXX',
   Status: Package2VersionStatus.error,
   Package2Id: '0Ho3i000000TNHXXXX',
-  Package2VersionId: undefined,
-  SubscriberPackageVersionId: undefined,
-  Tag: undefined,
-  Branch: undefined,
+  Package2VersionId: '',
+  SubscriberPackageVersionId: '',
+  Tag: '',
+  Branch: '',
   Error: [
     'PropertyController: Invalid type: Schema.Property__c',
     'SampleDataController: Invalid type: Schema.Property__c',
     'SampleDataController: Invalid type: Schema.Broker__c',
   ],
   CreatedDate: '2022-11-03 09:21',
-  HasMetadataRemoved: undefined,
+  HasMetadataRemoved: null,
   CreatedBy: '0053i000001ZIyXXXX',
+  Package2Name: null,
+  HasPassedCodeCoverageCheck: null,
+  CodeCoverage: null,
+  VersionNumber: null,
+  ConvertedFromVersionId: null,
 };
 
-const pkgVersionCreateSuccessResult: Partial<PackageVersionCreateRequestResult> = {
+const pkgVersionCreateSuccessResult: PackageVersionCreateRequestResult = {
   Id: '08c3i000000fylgAAA',
   Status: Package2VersionStatus.success,
   Package2Id: '0Ho3i000000TNHYCA4',
   Package2VersionId: '05i3i000000fxw1AAA',
   SubscriberPackageVersionId: '04t3i000002eya2AAA',
-  Tag: undefined,
-  Branch: undefined,
+  Tag: '',
+  Branch: '',
   Error: [],
   CreatedDate: '2022-11-03 09:46',
   HasMetadataRemoved: false,
   CreatedBy: '0053i000001ZIyGAAW',
+  Package2Name: null,
+  HasPassedCodeCoverageCheck: null,
+  CodeCoverage: null,
+  VersionNumber: null,
+  ConvertedFromVersionId: null,
 };
 
 describe('package:version:create - tests', () => {
@@ -84,7 +94,7 @@ describe('package:version:create - tests', () => {
       const res = await cmd.run();
       expect(envSpy.calledOnce).to.equal(true);
       expect(res).to.deep.equal({
-        Branch: undefined,
+        Branch: '',
         CreatedBy: '0053i000001ZIyGAAW',
         CreatedDate: '2022-11-03 09:46',
         Error: [],
@@ -94,7 +104,12 @@ describe('package:version:create - tests', () => {
         Package2VersionId: '05i3i000000fxw1AAA',
         Status: 'Success',
         SubscriberPackageVersionId: '04t3i000002eya2AAA',
-        Tag: undefined,
+        Tag: '',
+        Package2Name: null,
+        HasPassedCodeCoverageCheck: null,
+        CodeCoverage: null,
+        VersionNumber: null,
+        ConvertedFromVersionId: null,
       });
       expect(logStub.callCount).to.equal(1);
       expect(logStub.args[0]).to.deep.equal([
@@ -115,7 +130,7 @@ describe('package:version:create - tests', () => {
       const res = await cmd.run();
       expect(envSpy.calledOnce).to.equal(true);
       expect(res).to.deep.equal({
-        Branch: undefined,
+        Branch: '',
         CreatedBy: '0053i000001ZIyGAAW',
         CreatedDate: '2022-11-03 09:46',
         Error: [],
@@ -125,7 +140,12 @@ describe('package:version:create - tests', () => {
         Package2VersionId: '05i3i000000fxw1AAA',
         Status: 'Success',
         SubscriberPackageVersionId: '04t3i000002eya2AAA',
-        Tag: undefined,
+        Tag: '',
+        Package2Name: null,
+        HasPassedCodeCoverageCheck: null,
+        CodeCoverage: null,
+        VersionNumber: null,
+        ConvertedFromVersionId: null,
       });
       expect(logStub.callCount).to.equal(1);
       expect(logStub.args[0]).to.deep.equal([

diff --git a/test/commands/package/version.delete.test.ts b/test/commands/package/version.delete.test.ts
@@ -76,7 +76,7 @@ describe('package:version:delete', () => {
       expect(false, 'Expected invalid id error').to.be.true;
     } catch (err) {
       const error = err as Error;
-      expect(error.name).to.equal('ErrorInvalidPackageVersionIdError');
+      expect(error.name).to.equal('PackageAliasNotFoundError');
     }
   });
   it('should delete a package version', async () => {