feat: display version in list

shetzel · web-flow · commit 0f4e1c80b15c · 2023-07-06T17:28:20.000-05:00
* chore: lint fixes

* chore: update schemas and snapshots

* fix: use latest packaging lib

* fix: no result mutation when fetching verbose data

* fix: reduce query size from test
diff --git a/command-snapshot.json b/command-snapshot.json
@@ -266,7 +266,7 @@
   {
     "command": "package:version:create:list",
     "plugin": "@salesforce/plugin-packaging",
-    "flags": ["api-version", "created-last-days", "json", "loglevel", "status", "target-dev-hub"],
+    "flags": ["api-version", "created-last-days", "json", "loglevel", "status", "target-dev-hub", "verbose"],
     "alias": ["force:package:version:create:list"],
     "flagChars": ["c", "s", "v"],
     "flagAliases": ["apiversion", "createdlastdays", "target-hub-org", "targetdevhubusername"]
diff --git a/messages/package_version_create_list.md b/messages/package_version_create_list.md
@@ -14,6 +14,10 @@ To get information about a specific request, run "<%= config.bin %> package vers
 
 Status of the version creation request, used to filter the list.
 
+# flags.verbose.summary
+
+Displays additional information at a slight performance cost, such as the version name and number for each package version create request.
+
 # examples
 
 - List all package version creation requests in your default Dev Hub org:
diff --git a/package.json b/package.json
@@ -6,11 +6,11 @@
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
-    "@oclif/core": "^2.8.2",
-    "@salesforce/core": "^4.2.1",
-    "@salesforce/kit": "^3.0.2",
-    "@salesforce/packaging": "^2.1.2",
-    "@salesforce/sf-plugins-core": "^3.0.4",
+    "@oclif/core": "^2.8.11",
+    "@salesforce/core": "^4.3.2",
+    "@salesforce/kit": "^3.0.3",
+    "@salesforce/packaging": "^2.2.0",
+    "@salesforce/sf-plugins-core": "^3.1.4",
     "chalk": "^4.1.2",
     "tslib": "^2"
   },
@@ -258,4 +258,4 @@
       "output": []
     }
   }
-}
+}
diff --git a/schemas/package-version-create-list.json b/schemas/package-version-create-list.json
@@ -5,61 +5,64 @@
     "CreateListCommandResult": {
       "type": "array",
       "items": {
-        "$ref": "#/definitions/PackageVersionCreateRequestResult"
-      }
-    },
-    "PackageVersionCreateRequestResult": {
-      "type": "object",
-      "properties": {
-        "Id": {
-          "type": "string"
-        },
-        "Status": {
-          "$ref": "#/definitions/PackagingSObjects.Package2VersionStatus"
-        },
-        "Package2Id": {
-          "type": "string"
-        },
-        "Package2VersionId": {
-          "type": "string"
-        },
-        "SubscriberPackageVersionId": {
-          "type": ["string", "null"]
-        },
-        "Tag": {
-          "type": "string"
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "VersionName": {
+            "type": "string"
+          },
+          "VersionNumber": {
+            "type": "string"
+          },
+          "Id": {
+            "type": "string"
+          },
+          "Status": {
+            "$ref": "#/definitions/PackagingSObjects.Package2VersionStatus"
+          },
+          "Package2Id": {
+            "type": "string"
+          },
+          "Package2VersionId": {
+            "type": "string"
+          },
+          "SubscriberPackageVersionId": {
+            "type": ["string", "null"]
+          },
+          "Tag": {
+            "type": "string"
+          },
+          "Branch": {
+            "type": "string"
+          },
+          "Error": {
+            "type": "array",
+            "items": {}
+          },
+          "CreatedDate": {
+            "type": "string"
+          },
+          "HasMetadataRemoved": {
+            "type": ["boolean", "null"]
+          },
+          "CreatedBy": {
+            "type": "string"
+          }
         },
-        "Branch": {
-          "type": "string"
-        },
-        "Error": {
-          "type": "array",
-          "items": {}
-        },
-        "CreatedDate": {
-          "type": "string"
-        },
-        "HasMetadataRemoved": {
-          "type": ["boolean", "null"]
-        },
-        "CreatedBy": {
-          "type": "string"
-        }
-      },
-      "required": [
-        "Id",
-        "Status",
-        "Package2Id",
-        "Package2VersionId",
-        "SubscriberPackageVersionId",
-        "Tag",
-        "Branch",
-        "Error",
-        "CreatedDate",
-        "HasMetadataRemoved",
-        "CreatedBy"
-      ],
-      "additionalProperties": false
+        "required": [
+          "Branch",
+          "CreatedBy",
+          "CreatedDate",
+          "Error",
+          "HasMetadataRemoved",
+          "Id",
+          "Package2Id",
+          "Package2VersionId",
+          "Status",
+          "SubscriberPackageVersionId",
+          "Tag"
+        ]
+      }
     },
     "PackagingSObjects.Package2VersionStatus": {
       "type": "string",
diff --git a/src/commands/package/version/create/list.ts b/src/commands/package/version/create/list.ts
@@ -6,16 +6,38 @@
  */
 
 import { Flags, loglevel, orgApiVersionFlagWithDeprecations, SfCommand } from '@salesforce/sf-plugins-core';
-import { Messages } from '@salesforce/core';
-import { PackageVersion, PackageVersionCreateRequestResult } from '@salesforce/packaging';
+import { Connection, Messages } from '@salesforce/core';
+import { PackageVersion, PackageVersionCreateRequestResult, getPackageVersionNumber } from '@salesforce/packaging';
 import * as chalk from 'chalk';
 import { requiredHubFlag } from '../../../../utils/hubFlag';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_version_create_list');
 const packaging = Messages.loadMessages('@salesforce/plugin-packaging', 'packaging');
 
-export type CreateListCommandResult = PackageVersionCreateRequestResult[];
+export type CreateListCommandResult = Array<
+  PackageVersionCreateRequestResult & {
+    VersionName?: string;
+    VersionNumber?: string;
+  }
+>;
+
+type ColumnDataHeader = {
+  header?: string;
+};
+type ColumnData = {
+  Id: ColumnDataHeader;
+  Status: ColumnDataHeader;
+  Package2Id: ColumnDataHeader;
+  Package2VersionId: ColumnDataHeader;
+  SubscriberPackageVersionId: ColumnDataHeader;
+  Tag: ColumnDataHeader;
+  Branch: ColumnDataHeader;
+  CreatedDate: ColumnDataHeader;
+  CreatedBy: ColumnDataHeader;
+  VersionName?: ColumnDataHeader;
+  VersionNumber?: ColumnDataHeader;
+};
 
 type Status = 'Queued' | 'InProgress' | 'Success' | 'Error';
 
@@ -41,21 +63,26 @@ export class PackageVersionCreateListCommand extends SfCommand<CreateListCommand
       char: 's',
       summary: messages.getMessage('flags.status.summary'),
     }),
+    verbose: Flags.boolean({
+      summary: messages.getMessage('flags.verbose.summary'),
+    }),
   };
 
+  private connection!: Connection;
+
   public async run(): Promise<CreateListCommandResult> {
     const { flags } = await this.parse(PackageVersionCreateListCommand);
-    const connection = flags['target-dev-hub'].getConnection(flags['api-version']);
-    const results = await PackageVersion.getPackageVersionCreateRequests(connection, {
+    this.connection = flags['target-dev-hub'].getConnection(flags['api-version']);
+    let results = (await PackageVersion.getPackageVersionCreateRequests(this.connection, {
       createdlastdays: flags['created-last-days'],
       status: flags.status,
-    });
+    })) as CreateListCommandResult;
 
     if (results.length === 0) {
       this.warn('No results found');
     } else {
       this.styledHeader(chalk.blue(`Package Version Create Requests  [${results.length}]`));
-      const columnData = {
+      const columnData: ColumnData = {
         Id: {},
         Status: {
           header: messages.getMessage('status'),
@@ -80,9 +107,53 @@ export class PackageVersionCreateListCommand extends SfCommand<CreateListCommand
           header: messages.getMessage('createdBy'),
         },
       };
+      if (flags.verbose) {
+        try {
+          results = await this.fetchVerboseData(results);
+          columnData.VersionName = { header: 'Version Name' };
+          columnData.VersionNumber = { header: 'Version Number' };
+        } catch (err) {
+          const errMsg = typeof err === 'string' ? err : err instanceof Error ? err.message : 'unknown error';
+          this.warn(`error when retrieving verbose data (package name and version) due to: ${errMsg}`);
+        }
+      }
       this.table(results, columnData, { 'no-truncate': true });
     }
 
     return results;
   }
+
+  // Queries Package2Version for the name and version number of the packages and adds that data
+  // to the results.
+  private async fetchVerboseData(results: CreateListCommandResult): Promise<CreateListCommandResult> {
+    type VersionDataMap = {
+      [id: string]: { name: string; version: string };
+    };
+    // Query for the version name and number data
+    const versionData = await PackageVersion.queryPackage2Version(this.connection, {
+      fields: ['Id', 'Name', 'MajorVersion', 'MinorVersion', 'PatchVersion', 'BuildNumber'],
+      whereClause: "WHERE Id IN ('%IDS%')",
+      whereClauseItems: results.map((pvcrr) => pvcrr.Package2VersionId).filter(Boolean),
+    });
+
+    const vDataMap: VersionDataMap = {};
+    versionData.map((vData) => {
+      if (vData) {
+        const version = getPackageVersionNumber(vData, true);
+        vDataMap[vData.Id] = { name: vData.Name, version };
+      }
+    });
+
+    return results.map((pvcrr) => {
+      if (vDataMap[pvcrr.Package2VersionId]) {
+        return {
+          ...pvcrr,
+          ...{
+            VersionName: vDataMap[pvcrr.Package2VersionId].name,
+            VersionNumber: vDataMap[pvcrr.Package2VersionId].version,
+          },
+        };
+      } else return pvcrr;
+    });
+  }
 }
diff --git a/test/commands/package/packageVersion.nut.ts b/test/commands/package/packageVersion.nut.ts
@@ -17,6 +17,7 @@ import {
   VersionNumber,
 } from '@salesforce/packaging';
 import { PackageVersionListCommandResult, PackageVersionListDetails } from '../../../src/commands/package/version/list';
+import { CreateListCommandResult } from '../../../src/commands/package/version/create/list';
 
 chaiConfig.truncateThreshold = 0;
 
@@ -181,15 +182,15 @@ describe('package:version:*', () => {
 
     it('should list all of the successful package versions created', async () => {
       const command = `package:version:create:list --status Success -v ${session.hubOrg.username} --json`;
-      const output = execCmd<[{ Status: string }]>(command, { ensureExitCode: 0 }).jsonOutput;
+      const output = execCmd<CreateListCommandResult>(command, { ensureExitCode: 0 }).jsonOutput;
       output?.result?.forEach((result) => {
         expect(result?.Status).to.equal('Success');
       });
     });
 
     it('should list all of the package versions created within the last 2 days', () => {
       const command = `package:version:create:list --created-last-days 2 -v ${session.hubOrg.username} --json`;
-      const output = execCmd<[{ CreatedDate: string }]>(command, { ensureExitCode: 0 }).jsonOutput;
+      const output = execCmd<CreateListCommandResult>(command, { ensureExitCode: 0 }).jsonOutput;
       const keys = [
         'Id',
         'Status',
@@ -221,7 +222,7 @@ describe('package:version:*', () => {
 
     it('should list the package versions created (json)', async () => {
       const command = `package:version:create:list -v ${session.hubOrg.username} --json`;
-      const output = execCmd<{ [key: string]: unknown }>(command, { ensureExitCode: 0 }).jsonOutput;
+      const output = execCmd<CreateListCommandResult>(command, { ensureExitCode: 0 }).jsonOutput;
       const keys = [
         'Id',
         'Status',
@@ -240,6 +241,30 @@ describe('package:version:*', () => {
       expect(output?.result).to.have.length.greaterThan(0);
       expect(output?.result[0]).to.have.keys(keys);
     });
+
+    it('should list the package versions created --verbose (json)', async () => {
+      const command = `package:version:create:list --status Success --created-last-days 10 -v ${session.hubOrg.username} --json --verbose`;
+      const output = execCmd<CreateListCommandResult>(command, { ensureExitCode: 0 }).jsonOutput;
+      const keys = [
+        'Id',
+        'Status',
+        'Package2Id',
+        'Package2VersionId',
+        'SubscriberPackageVersionId',
+        'Tag',
+        'Branch',
+        'Error',
+        'CreatedDate',
+        'HasMetadataRemoved',
+        'CreatedBy',
+        'VersionName',
+        'VersionNumber',
+      ];
+      expect(output).to.be.ok;
+      expect(output?.status).to.equal(0);
+      expect(output?.result).to.have.length.greaterThan(0);
+      expect(output?.result[0]).to.have.keys(keys);
+    });
   });
   describe('package:version:list', () => {
     it('should list package versions in dev hub - human readable results', () => {
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -266,7 +266,7 @@`
`266`	`266`	`{`
`267`	`267`	`"command": "package:version:create:list",`
`268`	`268`	`"plugin": "@salesforce/plugin-packaging",`
`269`		`- "flags": ["api-version", "created-last-days", "json", "loglevel", "status", "target-dev-hub"],`
	`269`	`+ "flags": ["api-version", "created-last-days", "json", "loglevel", "status", "target-dev-hub", "verbose"],`
`270`	`270`	`"alias": ["force:package:version:create:list"],`
`271`	`271`	`"flagChars": ["c", "s", "v"],`
`272`	`272`	`"flagAliases": ["apiversion", "createdlastdays", "target-hub-org", "targetdevhubusername"]`