Merge pull request #16 from salesforcecli/sm/match-library-changes

WillieRuemmele · web-flow · commit 060ad12c2ee2 · 2021-03-03T16:38:08.000-07:00
fix: match library changes for deploy
diff --git a/package.json b/package.json
@@ -8,15 +8,15 @@
     "@oclif/config": "^1",
     "@salesforce/command": "^3.1.0",
     "@salesforce/core": "^2.19.1",
-    "@salesforce/source-deploy-retrieve": "^1.1.17",
+    "@salesforce/source-deploy-retrieve": "^1.1.19",
     "chalk": "^4.1.0",
     "tslib": "^2"
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1",
     "@oclif/plugin-command-snapshot": "^2.0.0",
-    "@salesforce/dev-config": "^2.1.0",
     "@salesforce/cli-plugins-testkit": "^0.0.8",
+    "@salesforce/dev-config": "^2.1.0",
     "@salesforce/dev-scripts": "^0.7.0",
     "@salesforce/plugin-command-reference": "^1.3.0",
     "@salesforce/prettier-config": "^0.0.2",
@@ -25,24 +25,24 @@
     "@typescript-eslint/parser": "^4.2.0",
     "chai": "^4.2.0",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^7.20.0",
+    "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-config-salesforce": "^0.1.0",
     "eslint-config-salesforce-license": "^0.1.0",
     "eslint-config-salesforce-typescript": "^0.2.0",
     "eslint-plugin-header": "^3.0.0",
     "eslint-plugin-import": "^2.20.2",
-    "eslint-plugin-jsdoc": "^32.0.2",
+    "eslint-plugin-jsdoc": "^27.0.3",
     "eslint-plugin-prettier": "^3.1.3",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.2",
-    "mocha": "^8.3.0",
+    "mocha": "^7.2.0",
     "nyc": "^15.1.0",
     "prettier": "^2.0.5",
-    "pretty-quick": "^3.1.0",
+    "pretty-quick": "^2.0.1",
     "shx": "0.3.3",
     "sinon": "^9.0.2",
-    "ts-node": "^9.1.1",
+    "ts-node": "^8.10.2",
     "typescript": "^4.1.3"
   },
   "config": {
diff --git a/src/commands/force/source/deploy.ts b/src/commands/force/source/deploy.ts
@@ -8,7 +8,7 @@ import * as os from 'os';
 import * as path from 'path';
 import { flags, FlagsConfig } from '@salesforce/command';
 import { Lifecycle, Messages } from '@salesforce/core';
-import { SourceDeployResult } from '@salesforce/source-deploy-retrieve';
+import { DeployResult } from '@salesforce/source-deploy-retrieve';
 import { Duration } from '@salesforce/kit';
 import { asString, asArray } from '@salesforce/ts-types';
 import * as chalk from 'chalk';
@@ -26,7 +26,6 @@ export class deploy extends SourceCommand {
     checkonly: flags.boolean({
       char: 'c',
       description: messages.getMessage('flags.checkonly'),
-      default: false,
     }),
     wait: flags.minutes({
       char: 'w',
@@ -48,12 +47,10 @@ export class deploy extends SourceCommand {
     ignoreerrors: flags.boolean({
       char: 'o',
       description: messages.getMessage('flags.ignoreErrors'),
-      default: false,
     }),
     ignorewarnings: flags.boolean({
       char: 'g',
       description: messages.getMessage('flags.ignoreWarnings'),
-      default: false,
     }),
     validateddeployrequestid: flags.id({
       char: 'q',
@@ -90,7 +87,7 @@ export class deploy extends SourceCommand {
   };
   protected readonly lifecycleEventNames = ['predeploy', 'postdeploy'];
 
-  public async run(): Promise<SourceDeployResult> {
+  public async run(): Promise<DeployResult> {
     if (this.flags.validatedeployrequestid) {
       // TODO: return this.doDeployRecentValidation();
     }
@@ -104,88 +101,82 @@ export class deploy extends SourceCommand {
 
     await hookEmitter.emit('predeploy', { packageXmlPath: cs.getPackageXml() });
 
-    const results = await cs.deploy(this.org.getUsername(), {
-      wait: (this.flags.wait as Duration).milliseconds,
-      apiOptions: {
-        // TODO: build out more api options
-        checkOnly: this.flags.checkonly as boolean,
-        ignoreWarnings: this.flags.ignorewarnings as boolean,
-        runTests: this.flags.runtests as string[],
-      },
-    });
-
+    const results = await cs
+      .deploy({
+        usernameOrConnection: this.org.getUsername(),
+      })
+      .start();
     await hookEmitter.emit('postdeploy', results);
 
-    this.print(results);
+    // skip a lot of steps that would do nothing
+    if (!this.flags.json) {
+      this.print(results);
+    }
 
     return results;
   }
 
-  private printComponentFailures(result: SourceDeployResult): void {
-    if (result.status === 'Failed' && result.components) {
+  private printComponentFailures(result: DeployResult): void {
+    if (result.response.status === 'Failed' && result.components) {
       // sort by filename then fullname
-      const failures = result.components.sort((i, j) => {
-        if (i.component.type.directoryName === j.component.type.directoryName) {
+      const failures = result.getFileResponses().sort((i, j) => {
+        if (i.filePath === j.filePath) {
           // if the have the same directoryName then sort by fullName
-          return i.component.fullName < j.component.fullName ? 1 : -1;
+          return i.fullName < j.fullName ? 1 : -1;
         }
-        return i.component.type.directoryName < j.component.type.directoryName ? 1 : -1;
+        return i.filePath < j.filePath ? 1 : -1;
       });
       this.ux.log('');
       this.ux.styledHeader(chalk.red(`Component Failures [${failures.length}]`));
       this.ux.table(failures, {
-        // TODO:  these accessors are temporary until library JSON fixes
         columns: [
-          { key: 'component.type.name', label: 'Type' },
-          { key: 'diagnostics[0].filePath', label: 'File' },
-          { key: 'component.name', label: 'Name' },
-          { key: 'diagnostics[0].message', label: 'Problem' },
+          { key: 'componentType', label: 'Type' },
+          { key: 'fileName', label: 'File' },
+          { key: 'fullName', label: 'Name' },
+          { key: 'problem', label: 'Problem' },
         ],
       });
       this.ux.log('');
     }
   }
 
-  private printComponentSuccess(result: SourceDeployResult): void {
-    if (result.success && result.components) {
-      if (result.components.length > 0) {
-        //  sort by type then filename then fullname
-        const files = result.components.sort((i, j) => {
-          if (i.component.type.name === j.component.type.name) {
-            // same metadata type, according to above comment sort on filename
-            if (i.component.type.directoryName === j.component.type.directoryName) {
-              // same filename's according to comment sort by fullName
-              return i.component.fullName < j.component.fullName ? 1 : -1;
-            }
-            return i.component.type.directoryName < j.component.type.directoryName ? 1 : -1;
+  private printComponentSuccess(result: DeployResult): void {
+    if (result.response.success && result.components?.size) {
+      //  sort by type then filename then fullname
+      const files = result.getFileResponses().sort((i, j) => {
+        if (i.fullName === j.fullName) {
+          // same metadata type, according to above comment sort on filename
+          if (i.filePath === j.filePath) {
+            // same filename's according to comment sort by fullName
+            return i.fullName < j.fullName ? 1 : -1;
           }
-          return i.component.type.name < j.component.type.name ? 1 : -1;
-        });
-        // get relative path for table output
-        files.forEach((file) => {
-          if (file.component.content) {
-            file.component.content = path.relative(process.cwd(), file.component.content);
-          }
-        });
-        this.ux.log('');
-        this.ux.styledHeader(chalk.blue('Deployed Source'));
-        this.ux.table(files, {
-          // TODO:  these accessors are temporary until library JSON fixes
-          columns: [
-            { key: 'component.name', label: 'FULL NAME' },
-            { key: 'component.type.name', label: 'TYPE' },
-            { key: 'component.content', label: 'PROJECT PATH' },
-          ],
-        });
-      }
+          return i.filePath < j.filePath ? 1 : -1;
+        }
+        return i.type < j.type ? 1 : -1;
+      });
+      // get relative path for table output
+      files.forEach((file) => {
+        if (file.filePath) {
+          file.filePath = path.relative(process.cwd(), file.filePath);
+        }
+      });
+      this.ux.log('');
+      this.ux.styledHeader(chalk.blue('Deployed Source'));
+      this.ux.table(files, {
+        columns: [
+          { key: 'fullName', label: 'FULL NAME' },
+          { key: 'type', label: 'TYPE' },
+          { key: 'filePath', label: 'PROJECT PATH' },
+        ],
+      });
     }
   }
 
-  private print(result: SourceDeployResult): SourceDeployResult {
+  private print(result: DeployResult): DeployResult {
     this.printComponentSuccess(result);
     this.printComponentFailures(result);
     // TODO: this.printTestResults(result); <- this has WI @W-8903671@
-    if (result.success && this.flags.checkonly) {
+    if (result.response.success && this.flags.checkonly) {
       this.log(messages.getMessage('checkOnlySuccess'));
     }
 
diff --git a/src/commands/force/source/retrieve.ts b/src/commands/force/source/retrieve.ts
@@ -5,13 +5,14 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import * as os from 'os';
-import * as path from 'path';
+
 import { flags, FlagsConfig } from '@salesforce/command';
 import { Lifecycle, Messages, SfdxError, SfdxProjectJson } from '@salesforce/core';
-import { SourceRetrieveResult } from '@salesforce/source-deploy-retrieve';
 import { Duration } from '@salesforce/kit';
 import { asArray, asString } from '@salesforce/ts-types';
-import { blue, yellow } from 'chalk';
+import { blue } from 'chalk';
+import { MetadataApiRetrieveStatus } from '@salesforce/source-deploy-retrieve';
+import { FileProperties } from '@salesforce/source-deploy-retrieve/lib/src/client/types';
 import { SourceCommand } from '../../../sourceCommand';
 
 Messages.importMessagesDirectory(__dirname);
@@ -51,7 +52,8 @@ export class retrieve extends SourceCommand {
   };
   protected readonly lifecycleEventNames = ['preretrieve', 'postretrieve'];
 
-  public async run(): Promise<SourceRetrieveResult> {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  public async run(): Promise<any> {
     const hookEmitter = Lifecycle.getInstance();
 
     const proj = await SfdxProjectJson.create({});
@@ -70,20 +72,27 @@ export class retrieve extends SourceCommand {
     // needs to be a path to the temp dir package.xml
     await hookEmitter.emit('preretrieve', { packageXmlPath: cs.getPackageXml() });
 
-    const results = await cs.retrieve(this.org.getUsername(), path.resolve(defaultPackage.path), {
-      merge: true,
-      // TODO: fix this once wait has been updated in library
-      wait: (this.flags.wait as Duration).milliseconds,
-      // TODO: implement retrieve via package name
-      // package: options.packagenames
-    });
+    const mdapiResult = await cs
+      .retrieve({
+        usernameOrConnection: this.org.getUsername(),
+        merge: true,
+        output: (this.flags.sourcepath as string) ?? defaultPackage.path,
+        packageNames: asArray<string>(this.flags.packagenames),
+      })
+      .start();
 
+    const results = mdapiResult.response;
     await hookEmitter.emit('postretrieve', results);
 
     if (results.status === 'InProgress') {
       throw new SfdxError(messages.getMessage('retrieveTimeout', [(this.flags.wait as Duration).minutes]));
     }
-    this.printTable(results, true);
+
+    if (this.flags.json) {
+      this.ux.logJson(mdapiResult.getFileResponses());
+    } else {
+      this.printTable(results, true);
+    }
 
     return results;
   }
@@ -94,28 +103,25 @@ export class retrieve extends SourceCommand {
    * @param results what the .deploy or .retrieve method returns
    * @param withoutState a boolean to add state, default to true
    */
-  public printTable(results: SourceRetrieveResult, withoutState?: boolean): void {
-    const stateCol = withoutState ? [] : [{ key: 'state', label: messages.getMessage('stateTableColumn') }];
+  public printTable(results: MetadataApiRetrieveStatus, withoutState?: boolean): void {
+    const stateCol = withoutState ? [] : [{ key: 'state', label: 'STATE' }];
 
     this.ux.styledHeader(blue(messages.getMessage('retrievedSourceHeader')));
-    if (results.success && results.successes.length) {
+    if (results.success) {
       const columns = [
-        { key: 'properties.fullName', label: messages.getMessage('fullNameTableColumn') },
-        { key: 'properties.type', label: messages.getMessage('typeTableColumn') },
-        {
-          key: 'properties.fileName',
-          label: messages.getMessage('workspacePathTableColumn'),
-        },
+        { key: 'fullName', label: 'FULL NAME' },
+        { key: 'type', label: 'TYPE' },
+        { key: 'fileName', label: 'PROJECT PATH' },
       ];
-      this.ux.table(results.successes, { columns: [...stateCol, ...columns] });
+      this.ux.table(results.fileProperties as FileProperties[], { columns: [...stateCol, ...columns] });
     } else {
       this.ux.log(messages.getMessage('NoResultsFound'));
     }
 
-    if (results.status === 'PartialSuccess' && results.successes.length && results.failures.length) {
-      this.ux.log('');
-      this.ux.styledHeader(yellow(messages.getMessage('metadataNotFoundWarning')));
-      results.failures.forEach((warning) => this.ux.log(warning.message));
-    }
+    // if (results.status === 'SucceededPartial' && results.successes.length && results.failures.length) {
+    //   this.ux.log('');
+    //   this.ux.styledHeader(yellow(messages.getMessage('metadataNotFoundWarning')));
+    //   results.failures.forEach((warning) => this.ux.log(warning.message));
+    // }
   }
 }
diff --git a/src/sourceCommand.ts b/src/sourceCommand.ts
@@ -42,8 +42,8 @@ export abstract class SourceCommand extends SfdxCommand {
     }
 
     if (options.packagenames) {
-      // retrieve only
-      // TODO: @W-8908888@
+      // return ComponentSet and use packageNames in the library via `.retrieve` options
+      setAggregator.push(...new ComponentSet([]));
     }
 
     if (options.manifest) {
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,8 @@ export abstract class SourceCommand extends SfdxCommand {`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`if (options.packagenames) {`
`45`		`- // retrieve only`
`46`		`- // TODO: @W-8908888@`
	`45`	+ // return ComponentSet and use packageNames in the library via `.retrieve` options
	`46`	`+ setAggregator.push(...new ComponentSet([]));`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`if (options.manifest) {`