fix: deletes singular CL when from CLs when specified

* fix: deletes singular CL when from CLs when specified

* test: fix logic caught by UT

* test: move NUT to it's own describe

* test: use TestSession

* test: create and set default SO

* test: devhub auth - auto

* test: if you're asserting on json, use the --json flag

* test: use my fork for consistency

* chore: nicely handle last CL delete, allow retrieve:start to only delete, print CL/line

* test: remove deprecated command from NUTs

* chore: use method in STLgp

* chore: consume new STL changes

* chore: optimize a bit more

* chore: qa package for STL

* chore: fix delete source output, errors

* chore: bump stl, consume label delete return type

* chore: bump stl

---------

Co-authored-by: mshanemc <[email protected]>

Author: WillieRuemmele

CHANGELOG.md

@@ -7,11 +7,11 @@
   "dependencies": {
     "@oclif/core": "^2.8.2",
     "@salesforce/apex-node": "^1.6.0",
-    "@salesforce/core": "^3.36.0",
+    "@salesforce/core": "^3.36.1",
     "@salesforce/kit": "^1.9.2",
     "@salesforce/sf-plugins-core": "^2.4.2",
-    "@salesforce/source-deploy-retrieve": "^8.0.2",
-    "@salesforce/source-tracking": "^3.1.0",
+    "@salesforce/source-deploy-retrieve": "^8.4.0",
+    "@salesforce/source-tracking": "^3.1.5",
     "chalk": "^4.1.2",
     "fs-extra": "^10.0.1",
     "shelljs": "^0.8.5",
@@ -270,4 +270,4 @@
       "output": []
     }
   }
-}
+}

package.json

@@ -22,7 +22,7 @@ import {
   SourceComponent,
 } from '@salesforce/source-deploy-retrieve';
 import { Duration } from '@salesforce/kit';
-import { ChangeResult, ConflictResponse, SourceTracking } from '@salesforce/source-tracking';
+import { ChangeResult, ConflictResponse, deleteCustomLabels, SourceTracking } from '@salesforce/source-tracking';
 import {
   arrayWithDeprecation,
   Flags,
@@ -341,7 +341,14 @@ export class Source extends SfCommand<DeleteSourceJson> {
 
   private async deleteFilesLocally(): Promise<void> {
     if (!this.flags['check-only'] && this.deployResult?.response?.status === RequestStatus.Succeeded) {
-      const promises: Array<Promise<void>> = [];
+      const promises: Array<Promise<void> | ReturnType<typeof deleteCustomLabels>> = [];
+      const customLabels = this.componentSet
+        .getSourceComponents()
+        .toArray()
+        .filter((comp) => comp.type.id === 'customlabel');
+      if (customLabels.length && customLabels[0].xml) {
+        promises.push(deleteCustomLabels(customLabels[0].xml, customLabels));
+      }
       this.components?.filter(isSourceComponent).map((component: SourceComponent) => {
         // mixed delete/deploy operations have already been deleted and stashed
         if (!this.mixedDeployDelete.delete.length) {
@@ -354,7 +361,10 @@ export class Source extends SfCommand<DeleteSourceJson> {
             }
           }
           if (component.xml) {
-            promises.push(fsPromises.unlink(component.xml));
+            if (component.type.id !== 'customlabel') {
+              // CustomLabels handled as a special case above
+              promises.push(fsPromises.unlink(component.xml));
+            }
           }
         }
       });
@@ -408,7 +418,12 @@ export class Source extends SfCommand<DeleteSourceJson> {
 
       this.components?.flatMap((component) => {
         if (component instanceof SourceComponent) {
-          local.push(component.xml as string, ...component.walkContent());
+          if (component.type.name === 'CustomLabel') {
+            // for custom labels, print each custom label to be deleted, not the whole file
+            local.push(`${component.type.name}:${component.fullName}`);
+          } else {
+            local.push(component.xml as string, ...component.walkContent());
+          }
         } else {
           // remote only metadata
           remote.push(`${component.type.name}:${component.fullName}`);

src/commands/project/delete/source.ts

@@ -15,6 +15,7 @@ import {
   RetrieveSetOptions,
   ComponentSet,
   FileResponse,
+  MetadataApiRetrieveStatus,
 } from '@salesforce/source-deploy-retrieve';
 import { SfCommand, toHelpSection, Flags } from '@salesforce/sf-plugins-core';
 import { getString } from '@salesforce/ts-types';
@@ -151,40 +152,45 @@ export default class RetrieveMetadata extends SfCommand<RetrieveResultJson> {
       componentSetFromNonDeletes.sourceApiVersion ?? componentSetFromNonDeletes.apiVersion,
     ]);
 
-    const retrieve = await componentSetFromNonDeletes.retrieve(retrieveOpts);
+    this.retrieveResult = new RetrieveResult({} as MetadataApiRetrieveStatus, componentSetFromNonDeletes);
 
-    this.spinner.status = messages.getMessage('spinner.polling');
+    if (componentSetFromNonDeletes.size !== 0) {
+      const retrieve = await componentSetFromNonDeletes.retrieve(retrieveOpts);
+      this.spinner.status = messages.getMessage('spinner.polling');
 
-    retrieve.onUpdate((data) => {
-      this.spinner.status = mdTransferMessages.getMessage(data.status);
-    });
-    // any thing else should stop the progress bar
-    retrieve.onFinish((data) => this.spinner.stop(mdTransferMessages.getMessage(data.response.status)));
-    retrieve.onCancel((data) => this.spinner.stop(mdTransferMessages.getMessage(data?.status ?? 'Canceled')));
-    retrieve.onError((error: Error) => {
-      this.spinner.stop(error.name);
-      throw error;
-    });
+      retrieve.onUpdate((data) => {
+        this.spinner.status = mdTransferMessages.getMessage(data.status);
+      });
+      // any thing else should stop the progress bar
+      retrieve.onFinish((data) => this.spinner.stop(mdTransferMessages.getMessage(data.response.status)));
+      retrieve.onCancel((data) => this.spinner.stop(mdTransferMessages.getMessage(data?.status ?? 'Canceled')));
+      retrieve.onError((error: Error) => {
+        this.spinner.stop(error.name);
+        throw error;
+      });
+
+      await retrieve.start();
+      this.retrieveResult = await retrieve.pollStatus(500, flags.wait.seconds);
+    }
 
-    await retrieve.start();
-    const result = await retrieve.pollStatus(500, flags.wait.seconds);
     this.spinner.stop();
 
     // reference the flag instead of `format` so we get correct type
     const formatter = flags['target-metadata-dir']
-      ? new MetadataRetrieveResultFormatter(result, {
+      ? new MetadataRetrieveResultFormatter(this.retrieveResult, {
           'target-metadata-dir': flags['target-metadata-dir'],
           'zip-file-name': zipFileName,
           unzip: flags.unzip,
         })
-      : new RetrieveResultFormatter(result, flags['package-name'], fileResponsesFromDelete);
+      : new RetrieveResultFormatter(this.retrieveResult, flags['package-name'], fileResponsesFromDelete);
     if (!this.jsonEnabled()) {
-      if (result.response.status === 'Succeeded') {
+      // in the case where we didn't retrieve anything, check if we have any deletes
+      if (this.retrieveResult.response.status === 'Succeeded' || fileResponsesFromDelete.length !== 0) {
         await formatter.display();
       } else {
         throw new SfError(
-          getString(result.response, 'errorMessage', result.response.status),
-          getString(result.response, 'errorStatusCode', 'unknown')
+          getString(this.retrieveResult.response, 'errorMessage', this.retrieveResult.response.status),
+          getString(this.retrieveResult.response, 'errorStatusCode', 'unknown')
         );
       }
     }

src/commands/project/retrieve/start.ts

@@ -6,8 +6,10 @@
  */
 import { ux } from '@oclif/core';
 import * as chalk from 'chalk';
-import { DeployResult, FileResponse } from '@salesforce/source-deploy-retrieve';
+import { DeployResult, FileResponse, RequestStatus } from '@salesforce/source-deploy-retrieve';
 import { ensureArray } from '@salesforce/kit';
+import { bold } from 'chalk';
+import { StandardColors } from '@salesforce/sf-plugins-core';
 import { DeleteSourceJson, Formatter } from '../utils/types';
 import { sortFileResponses, asRelativePaths } from '../utils/output';
 
@@ -74,6 +76,28 @@ export class DeleteResultFormatter implements Formatter<DeleteSourceJson> {
           filePath: { header: 'PROJECT PATH' },
         }
       );
+    } else {
+      this.displayFailures();
     }
   }
+
+  private displayFailures(): void {
+    if (this.result.response.status === RequestStatus.Succeeded) return;
+
+    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 = { title: StandardColors.error(bold(`Component Failures [${failures.length}]`)) };
+    ux.log();
+    ux.table(
+      failures.map((f) => ({ problemType: f.problemType, fullName: f.fullName, error: f.problem })),
+      columns,
+      options
+    );
+  }
 }

src/formatters/deleteResultFormatter.ts

@@ -0,0 +1,6 @@
+{
+  "orgName": "ACME",
+  "edition": "Developer",
+  "features": [],
+  "settings": {}
+}

test/nuts/customLabelProject/config/project-scratch-def.json

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomLabels xmlns="http://soap.sforce.com/2006/04/metadata">
+    <labels>
+        <fullName>DeleteMe</fullName>
+        <language>en_US</language>
+        <protected>true</protected>
+        <shortDescription>DeleteMe</shortDescription>
+        <value>Test</value>
+    </labels>
+    <labels>
+        <fullName>KeepMe1</fullName>
+        <language>en_US</language>
+        <protected>true</protected>
+        <shortDescription>KeepMe1</shortDescription>
+        <value>Test</value>
+    </labels>
+    <labels>
+        <fullName>KeepMe2</fullName>
+        <language>en_US</language>
+        <protected>true</protected>
+        <shortDescription>KeepMe2</shortDescription>
+        <value>Test</value>
+    </labels>
+</CustomLabels>

test/nuts/customLabelProject/force-app/main/default/labels/CustomLabels.labels-meta.xml

@@ -0,0 +1,11 @@
+{
+  "packageDirectories": [
+    {
+      "path": "force-app",
+      "default": true
+    }
+  ],
+  "namespace": "",
+  "sfdcLoginUrl": "https://login.salesforce.com",
+  "sourceApiVersion": "57.0"
+}

test/nuts/customLabelProject/sfdx-project.json

@@ -8,7 +8,7 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import { expect } from 'chai';
-import { execCmd } from '@salesforce/cli-plugins-testkit';
+import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
 import { SourceTestkit } from '@salesforce/source-testkit';
 import { exec } from 'shelljs';
 import { FileResponse } from '@salesforce/source-deploy-retrieve';
@@ -28,6 +28,62 @@ const isNameObsolete = async (username: string, memberType: string, memberName:
   return res.IsNameObsolete;
 };
 
+describe('CustomLabels', () => {
+  let testkit: TestSession;
+
+  before(async () => {
+    testkit = await TestSession.create({
+      project: {
+        gitClone: 'https://github.com/WillieRuemmele/sfdx-delete-customlabel',
+      },
+      scratchOrgs: [{ setDefault: true, config: path.join('config', 'project-scratch-def.json') }],
+      devhubAuthStrategy: 'AUTO',
+    });
+    execCmd('force:source:deploy --sourcepath force-app', { ensureExitCode: 0 });
+  });
+
+  after(async () => {
+    await testkit?.clean();
+  });
+  it('will not delete the entire .xml file', () => {
+    const clPath = path.join(
+      testkit.project.dir,
+      'force-app',
+      'main',
+      'default',
+      'labels',
+      'CustomLabels.labels-meta.xml'
+    );
+    const result = execCmd<DeleteSourceJson>(
+      'project:delete:source --json --no-prompt --metadata CustomLabel:DeleteMe',
+      {
+        ensureExitCode: 0,
+      }
+    ).jsonOutput?.result;
+    expect(fs.existsSync(clPath)).to.be.true;
+    expect(fs.readFileSync(clPath, 'utf8')).to.not.contain('<fullName>DeleteMe</fullName>');
+    expect(fs.readFileSync(clPath, 'utf8')).to.contain('<fullName>KeepMe1</fullName>');
+    expect(fs.readFileSync(clPath, 'utf8')).to.contain('<fullName>KeepMe2</fullName>');
+    expect(result?.deletedSource).to.have.length(1);
+  });
+
+  it('will delete the entire .xml file', () => {
+    const clPath = path.join(
+      testkit.project.dir,
+      'force-app',
+      'main',
+      'default',
+      'labels',
+      'CustomLabels.labels-meta.xml'
+    );
+    const result = execCmd<DeleteSourceJson>('project:delete:source --json --no-prompt --metadata CustomLabels', {
+      ensureExitCode: 0,
+    }).jsonOutput?.result;
+    expect(result?.deletedSource).to.have.length(3);
+    expect(fs.existsSync(clPath)).to.be.false;
+  });
+});
+
 describe('project delete source NUTs', () => {
   let testkit: SourceTestkit;