fix: always send deploy event and fix telemetry for mdapi deploy (#797)

* fix: always send deploy event and fix telemetry for mdapi deploy

* test: record perf

Co-authored-by: svc-cli-bot <svc_cli_bot@salesforce.com>
Co-authored-by: Shane McLaughlin <shane.mclaughlin@salesforce.com>

src/client/index.ts

@@ -46,4 +46,6 @@ export {
   PackageOption,
   PackageOptions,
   RetrieveOptions,
+  DeployVersionData,
+  RetrieveVersionData,
 } from './types';

src/client/metadataApiDeploy.ts

@@ -5,6 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { basename, dirname, extname, join, posix, sep } from 'path';
+import { format } from 'util';
 import { isString } from '@salesforce/ts-types';
 import { create as createArchive } from 'archiver';
 import * as fs from 'graceful-fs';
@@ -353,14 +354,13 @@ export class MetadataApiDeploy extends MetadataTransfer<MetadataApiDeployStatus,
     // SDR modifies what the mdapi expects by adding a rest param
     const { rest, ...optionsWithoutRest } = this.options.apiOptions;
 
-    // Debug output for API version and source API version used for deploy
-    if (this.components?.apiVersion) {
-      const manifestVersion = this.components?.sourceApiVersion ?? apiVersion;
-      const webService = rest ? 'REST' : 'SOAP';
-
-      this.logger.debug(`Deploying metadata source in v${manifestVersion} shape using ${webService} v${apiVersion}`);
-      await LifecycleInstance.emit('apiVersionDeploy', { webService, manifestVersion, apiVersion });
-    }
+    // Event and Debug output for API version and source API version used for deploy
+    const manifestVersion = this.components?.sourceApiVersion;
+    const webService = rest ? 'REST' : 'SOAP';
+    const manifestMsg = manifestVersion ? ` in v${manifestVersion} shape` : '';
+    const debugMsg = format(`Deploying metadata source%s using ${webService} v${apiVersion}`, manifestMsg);
+    this.logger.debug(debugMsg);
+    await LifecycleInstance.emit('apiVersionDeploy', { webService, manifestVersion, apiVersion });
 
     return this.isRestDeploy
       ? connection.metadata.deployRest(zipBuffer, optionsWithoutRest)
@@ -371,15 +371,27 @@ export class MetadataApiDeploy extends MetadataTransfer<MetadataApiDeployStatus,
   protected async post(result: MetadataApiDeployStatus): Promise<DeployResult> {
     const lifecycle = Lifecycle.getInstance();
     try {
+      const connection = await this.getConnection();
+      const apiVersion = connection.getApiVersion();
       // Creates an array of unique metadata types that were deployed, uses Set to avoid duplicates.
-      const listOfMetadataTypesDeployed = Array.from(new Set(this.options.components.map((c) => c.type.name)));
+      let listOfMetadataTypesDeployed: string[];
+      if (this.options.components) {
+        listOfMetadataTypesDeployed = Array.from(new Set(this.options.components.map((c) => c.type.name)));
+      } else {
+        // mdapi deploys don't have a ComponentSet, so using the result
+        const types = new Set<string>();
+        const successes = ensureArray(result.details?.componentSuccesses);
+        const failures = ensureArray(result.details?.componentFailures);
+        [...successes, ...failures].forEach((c) => c.componentType && types.add(c.componentType));
+        listOfMetadataTypesDeployed = Array.from(types);
+      }
 
       void lifecycle.emitTelemetry({
         eventName: 'metadata_api_deploy_result',
         library: 'SDR',
         status: result.status,
-        apiVersion: this.options.apiVersion,
-        sourceApiVersion: this.options.components?.sourceApiVersion,
+        apiVersion,
+        sourceApiVersion: this.components?.sourceApiVersion,
         createdDate: result.createdDate,
         startDate: result.startDate,
         completedDate: result.completedDate,

src/client/types.ts

@@ -356,3 +356,14 @@ export interface ListMetadataQuery {
   type: string;
   folder?: string;
 }
+
+export interface DeployVersionData {
+  apiVersion: string;
+  manifestVersion: string | undefined;
+  webService: 'SOAP' | 'REST';
+}
+
+export interface RetrieveVersionData {
+  apiVersion: string;
+  manifestVersion: string;
+}

src/index.ts

@@ -41,6 +41,8 @@ export {
   PackageOption,
   PackageOptions,
   RetrieveOptions,
+  DeployVersionData,
+  RetrieveVersionData,
 } from './client';
 export {
   MetadataConverter,

test/nuts/perfResults/x64-linux-2xIntel-Xeon-Platinum-8370C-CPU-2-80GHz/lotsOfClassesOneDir.json

@@ -1,18 +1,18 @@
 [
   {
     "name": "componentSetCreate",
-    "duration": 664.222689999995
+    "duration": 681.3880480000225
   },
   {
     "name": "sourceToMdapi",
-    "duration": 11668.923317000008
+    "duration": 10064.488008000015
   },
   {
     "name": "sourceToZip",
-    "duration": 9924.087503000017
+    "duration": 9558.054119999986
   },
   {
     "name": "mdapiToSource",
-    "duration": 8384.765007000009
+    "duration": 7265.46645700000
   }
 ]