Merge branch 'main' into mdonnalley/ink

mdonnalley · mdonnalley · commit 770110ff4b53 · 2024-08-16T11:15:42.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,57 @@
+## [4.4.6](https://github.com/salesforcecli/plugin-org/compare/4.4.5...4.4.6) (2024-08-11)
+
+### Bug Fixes
+
+- **deps:** bump @salesforce/sf-plugins-core from 11.2.4 to 11.3.0 ([d6871e5](https://github.com/salesforcecli/plugin-org/commit/d6871e5a30d9e6d9aced3b1ba6c1d8fd234d1f6a))
+
+## [4.4.5](https://github.com/salesforcecli/plugin-org/compare/4.4.4...4.4.5) (2024-08-04)
+
+### Bug Fixes
+
+- **deps:** bump @salesforce/source-deploy-retrieve ([2a86eed](https://github.com/salesforcecli/plugin-org/commit/2a86eed0749b21184a47acca64f09e9b77959e48))
+
+## [4.4.4](https://github.com/salesforcecli/plugin-org/compare/4.4.3...4.4.4) (2024-08-04)
+
+### Bug Fixes
+
+- **deps:** bump @salesforce/kit from 3.1.6 to 3.2.0 ([a9cd786](https://github.com/salesforcecli/plugin-org/commit/a9cd78624d2612fa426d10d516ca9b283db8efc6))
+
+## [4.4.3](https://github.com/salesforcecli/plugin-org/compare/4.4.2...4.4.3) (2024-07-30)
+
+### Bug Fixes
+
+- **deps:** devScripts update ([#1155](https://github.com/salesforcecli/plugin-org/issues/1155)) ([aa294cd](https://github.com/salesforcecli/plugin-org/commit/aa294cd8a4177baf8434555c69a2a957b6893d4c))
+
+## [4.4.2](https://github.com/salesforcecli/plugin-org/compare/4.4.1...4.4.2) (2024-07-28)
+
+### Bug Fixes
+
+- **deps:** bump @oclif/core from 4.0.12 to 4.0.16 ([ba59c66](https://github.com/salesforcecli/plugin-org/commit/ba59c66287433b0dfd2c79a29f573fb060e648eb))
+
+## [4.4.1](https://github.com/salesforcecli/plugin-org/compare/4.4.0...4.4.1) (2024-07-28)
+
+### Bug Fixes
+
+- **flags:** no `dependsOn` boolean flags ([#1145](https://github.com/salesforcecli/plugin-org/issues/1145)) ([8c0e74e](https://github.com/salesforcecli/plugin-org/commit/8c0e74e67bf47d6cdaa48330e6f19a2d6a623172))
+
+# [4.4.0](https://github.com/salesforcecli/plugin-org/compare/4.3.7...4.4.0) (2024-07-23)
+
+### Features
+
+- list metadata/-types stdout is table ([#1141](https://github.com/salesforcecli/plugin-org/issues/1141)) ([361fb6c](https://github.com/salesforcecli/plugin-org/commit/361fb6c75af2e450bc56f376c00657f32cc8f4bd))
+
+## [4.3.7](https://github.com/salesforcecli/plugin-org/compare/4.3.6...4.3.7) (2024-07-23)
+
+### Bug Fixes
+
+- nullish-linter ([#1134](https://github.com/salesforcecli/plugin-org/issues/1134)) ([48a7b8c](https://github.com/salesforcecli/plugin-org/commit/48a7b8c4f385967c891f79afb14cb3022418096e))
+
+## [4.3.6](https://github.com/salesforcecli/plugin-org/compare/4.3.5...4.3.6) (2024-07-21)
+
+### Bug Fixes
+
+- **deps:** bump @salesforce/sf-plugins-core from 11.2.0 to 11.2.1 ([2c73d48](https://github.com/salesforcecli/plugin-org/commit/2c73d484af266d6676e335f4c531a0bb5d7be0cc))
+
 ## [4.3.5](https://github.com/salesforcecli/plugin-org/compare/4.3.4...4.3.5) (2024-07-14)
 
 ### Bug Fixes
diff --git a/README.md b/README.md
@@ -99,20 +99,29 @@ the [SandboxNuts](https://github.com/salesforcecli/plugin-org/actions/workflows/
 
 <!-- commands -->
 
-- [`sf org create sandbox`](#sf-org-create-sandbox)
-- [`sf org create scratch`](#sf-org-create-scratch)
-- [`sf org delete sandbox`](#sf-org-delete-sandbox)
-- [`sf org delete scratch`](#sf-org-delete-scratch)
-- [`sf org disable tracking`](#sf-org-disable-tracking)
-- [`sf org display`](#sf-org-display)
-- [`sf org enable tracking`](#sf-org-enable-tracking)
-- [`sf org list`](#sf-org-list)
-- [`sf org list metadata`](#sf-org-list-metadata)
-- [`sf org list metadata-types`](#sf-org-list-metadata-types)
-- [`sf org open`](#sf-org-open)
-- [`sf org refresh sandbox`](#sf-org-refresh-sandbox)
-- [`sf org resume sandbox`](#sf-org-resume-sandbox)
-- [`sf org resume scratch`](#sf-org-resume-scratch)
+- [plugin-org](#plugin-org)
+  - [About Salesforce CLI plugins](#about-salesforce-cli-plugins)
+  - [Install](#install)
+  - [Issues](#issues)
+  - [Contributing](#contributing)
+    - [CLA](#cla)
+    - [Build](#build)
+    - [Sandbox NUTs](#sandbox-nuts)
+  - [Commands](#commands)
+  - [`sf org create sandbox`](#sf-org-create-sandbox)
+  - [`sf org create scratch`](#sf-org-create-scratch)
+  - [`sf org delete sandbox`](#sf-org-delete-sandbox)
+  - [`sf org delete scratch`](#sf-org-delete-scratch)
+  - [`sf org disable tracking`](#sf-org-disable-tracking)
+  - [`sf org display`](#sf-org-display)
+  - [`sf org enable tracking`](#sf-org-enable-tracking)
+  - [`sf org list`](#sf-org-list)
+  - [`sf org list metadata`](#sf-org-list-metadata)
+  - [`sf org list metadata-types`](#sf-org-list-metadata-types)
+  - [`sf org open`](#sf-org-open)
+  - [`sf org refresh sandbox`](#sf-org-refresh-sandbox)
+  - [`sf org resume sandbox`](#sf-org-resume-sandbox)
+  - [`sf org resume scratch`](#sf-org-resume-scratch)
 
 ## `sf org create sandbox`
 
@@ -607,7 +616,7 @@ List all orgs you’ve created or authenticated to.
 
 ```
 USAGE
-  $ sf org list [--json] [--flags-dir <value>] [--verbose] [--all] [-p --clean] [--skip-connection-status]
+  $ sf org list [--json] [--flags-dir <value>] [--verbose] [--all] [--clean] [-p] [--skip-connection-status]
 
 FLAGS
   -p, --no-prompt               Don't prompt for confirmation.
diff --git a/package.json b/package.json
@@ -1,34 +1,33 @@
 {
   "name": "@salesforce/plugin-org",
   "description": "Commands to interact with Salesforce orgs",
-  "version": "4.3.6-dev.2",
+  "version": "4.4.6",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
-    "@oclif/core": "^4.0.17",
+    "@oclif/core": "^4.0.16",
     "@oclif/multi-stage-output": "^0.2.0",
-    "@salesforce/core": "^8.4.0",
-    "@salesforce/kit": "^3.1.6",
-    "@salesforce/sf-plugins-core": "^11.3.2",
-    "@salesforce/source-deploy-retrieve": "^12.0.1",
+    "@salesforce/core": "^8.2.7",
+    "@salesforce/kit": "^3.2.0",
+    "@salesforce/sf-plugins-core": "^11.3.0",
+    "@salesforce/source-deploy-retrieve": "^12.1.12",
     "ansis": "^3.2.0",
     "change-case": "^5.4.4",
     "is-wsl": "^3.1.0",
     "open": "^10.1.0",
     "terminal-link": "^3.0.0"
   },
   "devDependencies": {
-    "@oclif/plugin-command-snapshot": "^5.2.6",
-    "@salesforce/cli-plugins-testkit": "^5.3.15",
-    "@salesforce/dev-scripts": "^10.2.2",
-    "@salesforce/plugin-command-reference": "^3.1.9",
-    "@salesforce/ts-sinon": "1.4.22",
-    "@types/react": "^18.3.3",
-    "eslint-plugin-sf-plugin": "^1.18.11",
+    "@oclif/plugin-command-snapshot": "^5.2.7",
+    "@salesforce/cli-plugins-testkit": "^5.3.25",
+    "@salesforce/dev-scripts": "^10.2.9",
+    "@salesforce/plugin-command-reference": "^3.1.15",
+    "@salesforce/ts-sinon": "^1.4.23",
+    "eslint-plugin-sf-plugin": "^1.20.1",
     "moment": "^2.30.1",
-    "oclif": "^4.13.9",
+    "oclif": "^4.14.17",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.4"
   },
   "engines": {
     "node": ">=18.0.0"
diff --git a/src/commands/force/org/create.ts b/src/commands/force/org/create.ts
@@ -295,8 +295,8 @@ export class Create extends SfCommand<CreateResult> {
 
     await Lifecycle.getInstance().emit('scratchOrgInfo', scratchOrgInfo);
 
-    this.logger.debug(`orgConfig.loginUrl: ${authFields?.loginUrl}`);
-    this.logger.debug(`orgConfig.instanceUrl: ${authFields?.instanceUrl}`);
+    this.logger.debug(`orgConfig.loginUrl: ${authFields?.loginUrl ?? '<not found>'}`);
+    this.logger.debug(`orgConfig.instanceUrl: ${authFields?.instanceUrl ?? '<not found>'}`);
 
     this.log(messages.getMessage('scratchOrgCreateSuccess', [authFields?.orgId, username]));
 
diff --git a/src/commands/org/create/sandbox.ts b/src/commands/org/create/sandbox.ts
@@ -8,7 +8,6 @@
 import { Duration } from '@salesforce/kit';
 import { Flags } from '@salesforce/sf-plugins-core';
 import { Lifecycle, Messages, SandboxEvents, SandboxRequest, SfError } from '@salesforce/core';
-import { Ux } from '@salesforce/sf-plugins-core';
 import { Interfaces } from '@oclif/core';
 import requestFunctions from '../../../shared/sandboxRequest.js';
 import { SandboxCommandBase, SandboxCommandResponse } from '../../../shared/sandboxCommandBase.js';
@@ -215,14 +214,12 @@ export default class CreateSandbox extends SandboxCommandBase<SandboxCommandResp
   private async confirmSandboxReq(sandboxReq: SandboxConfirmData): Promise<void> {
     if (this.flags['no-prompt'] || this.jsonEnabled()) return;
 
-    const columns: Ux.Table.Columns<{ key: string; value: unknown }> = {
-      key: { header: 'Field' },
-      value: { header: 'Value' },
-    };
-
     const data = Object.entries(sandboxReq).map(([key, value]) => ({ key, value }));
     this.styledHeader('Config Sandbox Request');
-    this.table(data, columns, {});
+    this.table(data, {
+      key: { header: 'Field' },
+      value: { header: 'Value' },
+    });
 
     if (
       !(await this.confirm({
diff --git a/src/commands/org/list.ts b/src/commands/org/list.ts
@@ -48,7 +48,12 @@ export class OrgListCommand extends SfCommand<OrgListResult> {
     'no-prompt': Flags.boolean({
       char: 'p',
       summary: messages.getMessage('flags.no-prompt.summary'),
-      dependsOn: ['clean'],
+      relationships: [
+        {
+          type: 'some',
+          flags: [{ name: 'clean', when: async (flags): Promise<boolean> => Promise.resolve(flags['clean'] === true) }],
+        },
+      ],
       aliases: ['noprompt'],
       deprecateAliases: true,
     }),
diff --git a/src/commands/org/list/metadata-types.ts b/src/commands/org/list/metadata-types.ts
@@ -7,7 +7,7 @@
 import fs from 'node:fs';
 
 import { Messages } from '@salesforce/core';
-import type { DescribeMetadataResult } from '@jsforce/jsforce-node/lib/api/metadata.js';
+import type { DescribeMetadataObject, DescribeMetadataResult } from '@jsforce/jsforce-node/lib/api/metadata.js';
 import { RegistryAccess } from '@salesforce/source-deploy-retrieve';
 import { Flags, loglevel, requiredOrgFlagWithDeprecations, SfCommand } from '@salesforce/sf-plugins-core';
 
@@ -68,7 +68,29 @@ export class ListMetadataTypes extends SfCommand<DescribeMetadataResult> {
       await fs.promises.writeFile(flags['output-file'], JSON.stringify(describeResult, null, 2));
       this.logSuccess(`Wrote result file to ${flags['output-file']}.`);
     } else {
-      this.styledJSON(describeResult);
+      this.table(
+        describeResult.metadataObjects,
+        {
+          xmlName: { header: 'Xml Names' },
+          childXmlNames: {
+            header: 'Child Xml Names',
+            get: (row: DescribeMetadataObject) =>
+              row.childXmlNames.length ? `[ ${row.childXmlNames.join('\n')} ]` : '',
+          },
+          directoryName: { header: 'Directory Name' },
+          inFolder: { header: 'In Folder' },
+          metaFile: { header: 'Meta File' },
+          suffix: { header: 'Suffix' },
+        },
+        {
+          'no-truncate': true,
+          title: 'Metadata',
+          sort: 'Xml Names',
+        }
+      );
+      this.log(`Organizational Namespace: ${describeResult.organizationNamespace}`);
+      this.log(`Partial Save Allowed: ${describeResult.partialSaveAllowed}`);
+      this.log(`Test Required: ${describeResult.testRequired}`);
     }
     return describeResult;
   }
diff --git a/src/commands/org/list/metadata.ts b/src/commands/org/list/metadata.ts
@@ -62,7 +62,29 @@ export class ListMetadata extends SfCommand<ListMetadataCommandResult> {
       fs.writeFileSync(flags['output-file'], JSON.stringify(listResult, null, 2));
       this.logSuccess(`Wrote result file to ${flags['output-file']}.`);
     } else if (listResult?.length) {
-      this.styledJSON(listResult);
+      this.table(
+        listResult,
+        {
+          createdByName: { header: 'Created By' },
+          createdDate: {
+            header: 'Created Date',
+            get: (row: FileProperties) => row.createdDate.split('T')[0],
+          },
+          fullName: { header: 'Full Name' },
+          id: { header: 'Id' },
+          lastModifiedByName: { header: 'Last Modified By' },
+          lastModifiedDate: {
+            header: 'Last Modified',
+            get: (row: FileProperties) => row.createdDate.split('T')[0],
+          },
+          manageableState: { header: 'Manageable State' },
+          namespacePrefix: { header: 'Namespace Prefix' },
+        },
+        {
+          title: flags['metadata-type'],
+          sort: 'Manageable State',
+        }
+      );
     } else {
       this.warn(messages.getMessage('noMatchingMetadata', [flags['metadata-type'], conn.getUsername()]));
     }
diff --git a/src/commands/org/open.ts b/src/commands/org/open.ts
@@ -115,18 +115,7 @@ export class OrgOpenCommand extends SfCommand<OrgOpenOutput> {
       await new SfdcUrl(url).checkLightningDomain();
       this.spinner.stop();
     } catch (err) {
-      if (err instanceof Error) {
-        if (err.message.includes('timeout')) {
-          const domain = `https://${/https?:\/\/([^.]*)/.exec(url)?.[1]}.lightning.force.com`;
-          const domainRetryTimeout = env.getNumber('SF_DOMAIN_RETRY') ?? env.getNumber('SFDX_DOMAIN_RETRY', 240);
-          const timeout = new Duration(domainRetryTimeout, Duration.Unit.SECONDS);
-          const logger = await Logger.child(this.constructor.name);
-          logger.debug(`Did not find IP for ${domain} after ${timeout.seconds} seconds`);
-          throw new SfError(messages.getMessage('domainTimeoutError'), 'domainTimeoutError');
-        }
-        throw SfError.wrap(err);
-      }
-      throw err;
+      handleDomainError(err, url, env);
     }
 
     // create a local html file that contains the POST stuff.
@@ -173,8 +162,10 @@ const fileCleanup = (tempFilePath: string): void =>
 const buildFrontdoorUrl = async (org: Org, conn: Connection): Promise<string> => {
   await org.refreshAuth(); // we need a live accessToken for the frontdoor url
   const accessToken = conn.accessToken;
-  const instanceUrl = org.getField<string>(Org.Fields.INSTANCE_URL);
-  const instanceUrlClean = instanceUrl.replace(/\/$/, '');
+  if (!accessToken) {
+    throw new SfError('NoAccessToken', 'NoAccessToken');
+  }
+  const instanceUrlClean = org.getField<string>(Org.Fields.INSTANCE_URL).replace(/\/$/, '');
   return `${instanceUrlClean}/secur/frontdoor.jsp?sid=${accessToken}`;
 };
 
@@ -241,3 +232,22 @@ const getFileContents = (
     </form>
   </body>
 </html>`;
+
+const handleDomainError = (err: unknown, url: string, env: Env): string => {
+  if (err instanceof Error) {
+    if (err.message.includes('timeout')) {
+      const host = /https?:\/\/([^.]*)/.exec(url)?.[1];
+      if (!host) {
+        throw new SfError('InvalidUrl', 'InvalidUrl');
+      }
+      const domain = `https://${host}.lightning.force.com`;
+      const domainRetryTimeout = env.getNumber('SF_DOMAIN_RETRY') ?? env.getNumber('SFDX_DOMAIN_RETRY', 240);
+      const timeout = new Duration(domainRetryTimeout, Duration.Unit.SECONDS);
+      const logger = Logger.childFromRoot('org:open');
+      logger.debug(`Did not find IP for ${domain} after ${timeout.seconds} seconds`);
+      throw new SfError(messages.getMessage('domainTimeoutError'), 'domainTimeoutError');
+    }
+    throw SfError.wrap(err);
+  }
+  throw err;
+};
diff --git a/src/commands/org/refresh/sandbox.ts b/src/commands/org/refresh/sandbox.ts
@@ -7,8 +7,7 @@
 
 import { Duration, omit } from '@salesforce/kit';
 import { Flags } from '@salesforce/sf-plugins-core';
-import { Lifecycle, Messages, SandboxInfo, SandboxEvents, SfError } from '@salesforce/core';
-import { Ux } from '@salesforce/sf-plugins-core';
+import { Lifecycle, Messages, SandboxEvents, SandboxInfo, SfError } from '@salesforce/core';
 import { Interfaces } from '@oclif/core';
 import requestFunctions from '../../../shared/sandboxRequest.js';
 import { SandboxCommandBase, SandboxCommandResponse } from '../../../shared/sandboxCommandBase.js';
@@ -249,14 +248,12 @@ export default class RefreshSandbox extends SandboxCommandBase<SandboxCommandRes
   private async confirmSandboxRefresh(sandboxInfo: SandboxInfo): Promise<void> {
     if (this.flags['no-prompt'] || this.jsonEnabled()) return;
 
-    const columns: Ux.Table.Columns<{ key: string; value: unknown }> = {
-      key: { header: 'Field' },
-      value: { header: 'Value' },
-    };
-
     const data = Object.entries(sandboxInfo).map(([key, value]) => ({ key, value: value ?? 'null' }));
     this.styledHeader('Config Sandbox Refresh');
-    this.table(data, columns, {});
+    this.table(data, {
+      key: { header: 'Field' },
+      value: { header: 'Value' },
+    });
 
     if (
       !(await this.confirm({
diff --git a/src/commands/org/resume/sandbox.ts b/src/commands/org/resume/sandbox.ts
@@ -236,7 +236,7 @@ const getSandboxProcessObject = async (
   sandboxName?: string,
   jobId?: string
 ): Promise<SandboxProcessObject> => {
-  const where = jobId ? `Id='${jobId}'` : `SandboxName='${sandboxName}'`;
+  const where = getWhere(sandboxName, jobId);
   const queryStr = `SELECT Id, Status, SandboxName, SandboxInfoId, LicenseType, CreatedDate, CopyProgress, SandboxOrganization, SourceId, Description, EndDate FROM SandboxProcess WHERE ${where} AND Status != 'D'`;
   try {
     return await prodOrg.getConnection().singleRecordQuery(queryStr, {
@@ -246,3 +246,9 @@ const getSandboxProcessObject = async (
     throw messages.createError('error.NoSandboxRequestFound');
   }
 };
+
+const getWhere = (sandboxName?: string, jobId?: string): string => {
+  if (jobId) return `Id='${jobId}'`;
+  if (sandboxName) return `SandboxName='${sandboxName}'`;
+  throw new SfError('There must be a sandbox name or job id to query for the sandbox process object');
+};
diff --git a/src/shared/orgListUtil.ts b/src/shared/orgListUtil.ts
diff --git a/src/shared/sandboxProgress.ts b/src/shared/sandboxProgress.ts
diff --git a/src/shared/sandboxReporter.ts b/src/shared/sandboxReporter.ts
diff --git a/test/unit/org/open.test.ts b/test/unit/org/open.test.ts
diff --git a/yarn.lock b/yarn.lock
