fix: set sourceApiVersion on the ComponentSet (#147)

* fix: set sourceApiVersion on the ComponentSet

* fix: convert now supports sourceApiVersion

* fix: update with latest SDR release

Author: shetzel

package.json

@@ -8,7 +8,7 @@
     "@oclif/config": "^1",
     "@salesforce/command": "^3.1.3",
     "@salesforce/core": "^2.23.4",
-    "@salesforce/source-deploy-retrieve": "^3.1.1",
+    "@salesforce/source-deploy-retrieve": "^4.0.0",
     "chalk": "^4.1.0",
     "cli-ux": "^5.5.1",
     "tslib": "^2"

src/commands/force/source/convert.ts

@@ -81,6 +81,7 @@ export class Convert extends SourceCommand {
     }
 
     this.componentSet = await ComponentSetBuilder.build({
+      sourceapiversion: await this.getSourceApiVersion(),
       sourcepath: paths,
       manifest: manifest && {
         manifestPath: this.getFlag<string>('manifest'),
@@ -93,7 +94,7 @@ export class Convert extends SourceCommand {
     });
 
     const converter = new MetadataConverter();
-    this.convertResult = await converter.convert(this.componentSet.getSourceComponents().toArray(), 'metadata', {
+    this.convertResult = await converter.convert(this.componentSet, 'metadata', {
       type: 'directory',
       outputDirectory: this.getFlag<string>('outputdir'),
       packageName: this.getFlag<string>('packagename'),

src/commands/force/source/deploy.ts

@@ -127,6 +127,7 @@ export class Deploy extends DeployCommand {
     } else {
       this.componentSet = await ComponentSetBuilder.build({
         apiversion: this.getFlag<string>('apiversion'),
+        sourceapiversion: await this.getSourceApiVersion(),
         sourcepath: this.getFlag<string[]>('sourcepath'),
         manifest: this.flags.manifest && {
           manifestPath: this.getFlag<string>('manifest'),

src/commands/force/source/retrieve.ts

@@ -71,6 +71,7 @@ export class Retrieve extends SourceCommand {
   protected async retrieve(): Promise<void> {
     this.componentSet = await ComponentSetBuilder.build({
       apiversion: this.getFlag<string>('apiversion'),
+      sourceapiversion: await this.getSourceApiVersion(),
       packagenames: this.getFlag<string[]>('packagenames'),
       sourcepath: this.getFlag<string[]>('sourcepath'),
       manifest: this.flags.manifest && {
@@ -89,7 +90,7 @@ export class Retrieve extends SourceCommand {
       usernameOrConnection: this.org.getUsername(),
       merge: true,
       output: this.project.getDefaultPackage().fullPath,
-      packageNames: this.getFlag<string[]>('packagenames'),
+      packageOptions: this.getFlag<string[]>('packagenames'),
     });
 
     this.retrieveResult = await mdapiRetrieve.pollStatus(1000, this.getFlag<Duration>('wait').seconds);

src/componentSetBuilder.ts

@@ -24,6 +24,7 @@ export type ComponentSetOptions = {
   manifest?: ManifestOption;
   metadata?: MetadataOption;
   apiversion?: string;
+  sourceapiversion?: string;
 };
 
 export class ComponentSetBuilder {
@@ -39,7 +40,7 @@ export class ComponentSetBuilder {
     const logger = Logger.childFromRoot('createComponentSet');
     const csAggregator: ComponentLike[] = [];
 
-    const { sourcepath, manifest, metadata, packagenames, apiversion } = options;
+    const { sourcepath, manifest, metadata, packagenames, apiversion, sourceapiversion } = options;
 
     if (sourcepath) {
       logger.debug(`Building ComponentSet from sourcepath: ${sourcepath.toString()}`);
@@ -122,6 +123,10 @@ export class ComponentSetBuilder {
       componentSet.apiVersion = apiversion;
     }
 
+    if (sourceapiversion) {
+      componentSet.sourceApiVersion = sourceapiversion;
+    }
+
     return componentSet;
   }
 }

src/sourceCommand.ts

@@ -8,7 +8,7 @@
 import { SfdxCommand } from '@salesforce/command';
 import { Lifecycle } from '@salesforce/core';
 import { ComponentSet } from '@salesforce/source-deploy-retrieve';
-import { get, getBoolean } from '@salesforce/ts-types';
+import { get, getBoolean, getString, Optional } from '@salesforce/ts-types';
 import cli from 'cli-ux';
 
 export type ProgressBar = {
@@ -58,6 +58,11 @@ export abstract class SourceCommand extends SfdxCommand {
     return this.project.getUniquePackageDirectories().map((pDir) => pDir.fullPath);
   }
 
+  protected async getSourceApiVersion(): Promise<Optional<string>> {
+    const projectConfig = await this.project.resolveProjectConfig();
+    return getString(projectConfig, 'sourceApiVersion');
+  }
+
   /**
    * Inspects the command response to determine success.
    *

test/commands/source/componentSetBuilder.test.ts

@@ -104,6 +104,24 @@ describe('ComponentSetBuilder', () => {
       expect(compSet.apiVersion).to.equal(options.apiversion);
     });
 
+    it('should create ComponentSet with sourceApiVersion', async () => {
+      fileExistsSyncStub.returns(true);
+      fromSourceStub.returns(componentSet);
+      const sourcepath = ['force-app'];
+      const options = {
+        sourcepath,
+        manifest: undefined,
+        metadata: undefined,
+        sourceapiversion: '50.0',
+      };
+
+      const compSet = await ComponentSetBuilder.build(options);
+      const expectedPath = path.resolve(sourcepath[0]);
+      expect(fromSourceStub.calledOnceWith(expectedPath)).to.equal(true);
+      expect(compSet.size).to.equal(0);
+      expect(compSet.sourceApiVersion).to.equal(options.sourceapiversion);
+    });
+
     it('should throw with an invalid sourcepath', async () => {
       fileExistsSyncStub.returns(false);
       const sourcepath = ['nonexistent'];

test/commands/source/convert.test.ts

@@ -24,6 +24,7 @@ describe('force:source:convert', () => {
   const myApp = join('new', 'package', 'directory');
   const packageXml = 'package.xml';
   const oclifConfigStub = fromStub(stubInterface<IConfig>(sandbox));
+  let resolveProjectConfigStub: sinon.SinonStub;
 
   class TestConvert extends Convert {
     public async runIt() {
@@ -42,6 +43,7 @@ describe('force:source:convert', () => {
         stubInterface<SfdxProject>(sandbox, {
           getDefaultPackage: () => ({ path: defaultDir }),
           getUniquePackageDirectories: () => [{ fullPath: defaultDir }],
+          resolveProjectConfig: resolveProjectConfigStub,
         })
       );
       cmd.setProject(sfdxProjectStub);
@@ -56,6 +58,7 @@ describe('force:source:convert', () => {
       sourcepath: [],
       manifest: undefined,
       metadata: undefined,
+      sourceapiversion: undefined,
     };
     const expectedArgs = { ...defaultArgs, ...overrides };
 
@@ -64,15 +67,11 @@ describe('force:source:convert', () => {
   };
 
   beforeEach(() => {
+    resolveProjectConfigStub = sandbox.stub();
     sandbox.stub(MetadataConverter.prototype, 'convert').resolves({ packagePath: 'temp' });
     buildComponentSetStub = stubMethod(sandbox, ComponentSetBuilder, 'build').resolves({
       deploy: sinon.stub(),
       getPackageXml: () => packageXml,
-      getSourceComponents: () => {
-        return {
-          toArray: () => {},
-        };
-      },
     });
   });
 
@@ -87,6 +86,17 @@ describe('force:source:convert', () => {
     ensureCreateComponentSetArgs({ sourcepath: [sourcepath] });
   });
 
+  it('should pass along sourceApiVersion', async () => {
+    const sourceApiVersion = '50.0';
+    resolveProjectConfigStub.resolves({ sourceApiVersion });
+    const result = await runConvertCmd(['--json']);
+    expect(result).to.deep.equal({ location: resolve('temp') });
+    ensureCreateComponentSetArgs({
+      sourcepath: [defaultDir],
+      sourceapiversion: sourceApiVersion,
+    });
+  });
+
   it('should call default package dir if no args', async () => {
     const result = await runConvertCmd(['--json']);
     expect(result).to.deep.equal({ location: resolve('temp') });

test/commands/source/deploy.test.ts

@@ -62,6 +62,7 @@ describe('force:source:deploy', () => {
   let pollStub: sinon.SinonStub;
   let lifecycleEmitStub: sinon.SinonStub;
   let formatterDisplayStub: sinon.SinonStub;
+  let resolveProjectConfigStub: sinon.SinonStub;
 
   class TestDeploy extends Deploy {
     public async runIt() {
@@ -82,6 +83,7 @@ describe('force:source:deploy', () => {
       const sfdxProjectStub = fromStub(
         stubInterface<SfdxProject>(sandbox, {
           getUniquePackageDirectories: () => [{ fullPath: defaultDir }],
+          resolveProjectConfig: resolveProjectConfigStub,
         })
       );
       cmd.setProject(sfdxProjectStub);
@@ -103,6 +105,7 @@ describe('force:source:deploy', () => {
   };
 
   beforeEach(() => {
+    resolveProjectConfigStub = sandbox.stub();
     pollStub = sandbox.stub().resolves(deployResult);
     deployStub = sandbox.stub().resolves({
       pollStatus: pollStub,
@@ -129,6 +132,7 @@ describe('force:source:deploy', () => {
       manifest: undefined,
       metadata: undefined,
       apiversion: undefined,
+      sourceapiversion: undefined,
     };
     const expectedArgs = { ...defaultArgs, ...overrides };
 
@@ -229,6 +233,24 @@ describe('force:source:deploy', () => {
     ensureProgressBar(0);
   });
 
+  it('should pass along sourceapiversion', async () => {
+    const sourceApiVersion = '50.0';
+    resolveProjectConfigStub.resolves({ sourceApiVersion });
+    const manifest = 'package.xml';
+    const result = await runDeployCmd(['--manifest', manifest, '--json']);
+    expect(result).to.deep.equal(expectedResults);
+    ensureCreateComponentSetArgs({
+      sourceapiversion: sourceApiVersion,
+      manifest: {
+        manifestPath: manifest,
+        directoryPaths: [defaultDir],
+      },
+    });
+    ensureDeployArgs();
+    ensureHookArgs();
+    ensureProgressBar(0);
+  });
+
   it('should pass along all deploy options', async () => {
     const manifest = 'package.xml';
     const runTests = ['MyClassTest'];

test/commands/source/retrieve.test.ts

@@ -39,9 +39,7 @@ describe('force:source:retrieve', () => {
   let retrieveStub: sinon.SinonStub;
   let pollStub: sinon.SinonStub;
   let lifecycleEmitStub: sinon.SinonStub;
-  // TODO: remove the next two stubs when reverting back to SDR polling
-  let checkStatusStub: sinon.SinonStub;
-  let postStub: sinon.SinonStub;
+  let resolveProjectConfigStub: sinon.SinonStub;
 
   class TestRetrieve extends Retrieve {
     public async runIt() {
@@ -63,6 +61,7 @@ describe('force:source:retrieve', () => {
         stubInterface<SfdxProject>(sandbox, {
           getDefaultPackage: () => ({ fullPath: defaultPackagePath }),
           getUniquePackageDirectories: () => [{ fullPath: defaultPackagePath }],
+          resolveProjectConfig: resolveProjectConfigStub,
         })
       );
       cmd.setProject(sfdxProjectStub);
@@ -80,14 +79,11 @@ describe('force:source:retrieve', () => {
   };
 
   beforeEach(() => {
+    resolveProjectConfigStub = sandbox.stub();
     pollStub = sandbox.stub().resolves(retrieveResult);
-    checkStatusStub = sandbox.stub().resolves(retrieveResult);
-    postStub = sandbox.stub().resolves(retrieveResult);
     retrieveStub = sandbox.stub().resolves({
       pollStatus: pollStub,
       retrieveId: retrieveResult.response.id,
-      checkStatus: checkStatusStub,
-      post: postStub,
     });
     buildComponentSetStub = stubMethod(sandbox, ComponentSetBuilder, 'build').resolves({
       retrieve: retrieveStub,
@@ -111,6 +107,7 @@ describe('force:source:retrieve', () => {
       manifest: undefined,
       metadata: undefined,
       apiversion: undefined,
+      sourceapiversion: undefined,
     };
     const expectedArgs = { ...defaultArgs, ...overrides };
 
@@ -124,7 +121,7 @@ describe('force:source:retrieve', () => {
       usernameOrConnection: username,
       merge: true,
       output: defaultPackagePath,
-      packageNames: undefined,
+      packageOptions: undefined,
     };
     const expectedRetrieveArgs = { ...defaultRetrieveArgs, ...overrides };
 
@@ -195,6 +192,23 @@ describe('force:source:retrieve', () => {
     ensureHookArgs();
   });
 
+  it('should pass along sourceapiversion', async () => {
+    const sourceApiVersion = '50.0';
+    resolveProjectConfigStub.resolves({ sourceApiVersion });
+    const manifest = 'package.xml';
+    const result = await runRetrieveCmd(['--manifest', manifest, '--json']);
+    expect(result).to.deep.equal(expectedResults);
+    ensureCreateComponentSetArgs({
+      sourceapiversion: sourceApiVersion,
+      manifest: {
+        manifestPath: manifest,
+        directoryPaths: [defaultPackagePath],
+      },
+    });
+    ensureRetrieveArgs();
+    ensureHookArgs();
+  });
+
   it('should pass along packagenames', async () => {
     const manifest = 'package.xml';
     const packagenames = ['package1'];
@@ -207,7 +221,7 @@ describe('force:source:retrieve', () => {
         directoryPaths: [defaultPackagePath],
       },
     });
-    ensureRetrieveArgs({ packageNames: packagenames });
+    ensureRetrieveArgs({ packageOptions: packagenames });
     ensureHookArgs();
   });