@salesforce/plugin-deploy-retrieve 3.12.20-dev.0 → 3.13.0

package/lib/utils/progressBar.js

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2022, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { envVars as env, EnvironmentVariable, Lifecycle, Messages, Logger } from '@salesforce/core';
+import { Progress } from '@salesforce/sf-plugins-core';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const mdTransferMessages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'metadata.transfer');
+const showBar = Boolean(process.env.TERM !== 'dumb' && process.stdin.isTTY && env.getBoolean(EnvironmentVariable.SF_USE_PROGRESS_BAR, true));
+const logger = await Logger.child('deploy-progress');
+export class DeployProgress extends Progress {
+    deploy;
+    static OPTIONS = {
+        title: 'Status',
+        format: `%s: {status} ${showBar ? '| {bar} ' : ''}| {value}/{total} Components{errorInfo}{testInfo}{trackingInfo}`,
+        barCompleteChar: '\u2588',
+        barIncompleteChar: '\u2591',
+        linewrap: true,
+        // people really like to get text output in CI systems
+        // they won't get the "bar" but will get the remaining template bits this way
+        noTTYOutput: true,
+    };
+    lifecycle = Lifecycle.getInstance();
+    constructor(deploy, jsonEnabled = false) {
+        super(!jsonEnabled);
+        this.deploy = deploy;
+    }
+    start() {
+        super.start(0, { status: 'Waiting', trackingInfo: '', testInfo: '' }, DeployProgress.OPTIONS);
+        // for sourceMember polling events
+        this.lifecycle.on('sourceMemberPollingEvent', (event) => Promise.resolve(this.updateTrackingProgress(event)));
+        this.deploy.onUpdate((data) => this.updateProgress(data));
+        // any thing else should make one final update, then stop the progress bar
+        this.deploy.onFinish((data) => {
+            this.updateProgress(data.response);
+            this.finish({ status: mdTransferMessages.getMessage(data.response.status) });
+        });
+        this.deploy.onCancel(() => this.stop());
+        this.deploy.onError((error) => {
+            this.stop();
+            throw error;
+        });
+    }
+    updateTrackingProgress(data) {
+        const { remaining, original } = data;
+        this.update(0, {
+            status: 'Polling SourceMembers',
+            trackingInfo: ` | Tracking: ${original - remaining}/${original}`,
+        });
+    }
+    updateProgress(data) {
+        // the numCompTot. isn't computed right away, wait to start until we know how many we have
+        const testInfo = data.numberTestsTotal
+            ? ` | ${data.numberTestsCompleted ?? 0}/${data.numberTestsTotal ?? 0} Tests${data.numberTestErrors ? `(Errors:${data.numberTestErrors})` : ''}`
+            : '';
+        const errorInfo = data.numberComponentErrors > 0 ? ` | Errors: ${data.numberComponentErrors}` : '';
+        if (data.numberComponentsTotal) {
+            this.setTotal(data.numberComponentsTotal);
+            this.update(data.numberComponentsDeployed, {
+                errorInfo: data.numberComponentErrors > 0 ? ` | Errors: ${data.numberComponentErrors}` : '',
+                status: mdTransferMessages.getMessage(data.status),
+                testInfo,
+            });
+        }
+        else {
+            let status;
+            try {
+                status = mdTransferMessages.getMessage(data.status);
+            }
+            catch (e) {
+                logger.debug(`data.status message lookup failed for: ${data.status}`);
+                status = 'Waiting';
+            }
+            this.update(0, { errorInfo, testInfo, status });
+        }
+    }
+}
+//# sourceMappingURL=progressBar.js.map

package/lib/utils/progressBar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"progressBar.js","sourceRoot":"","sources":["../../src/utils/progressBar.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,mBAAmB,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAEpG,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAGvD,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,kBAAkB,GAAG,QAAQ,CAAC,YAAY,CAAC,oCAAoC,EAAE,mBAAmB,CAAC,CAAC;AAE5G,MAAM,OAAO,GAAG,OAAO,CACrB,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,CAAC,UAAU,CAAC,mBAAmB,CAAC,mBAAmB,EAAE,IAAI,CAAC,CACpH,CAAC;AAEF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;AAErD,MAAM,OAAO,cAAe,SAAQ,QAAQ;IAaf;IAZnB,MAAM,CAAC,OAAO,GAAG;QACvB,KAAK,EAAE,QAAQ;QACf,MAAM,EAAE,gBAAgB,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,iEAAiE;QAClH,eAAe,EAAE,QAAQ;QACzB,iBAAiB,EAAE,QAAQ;QAC3B,QAAQ,EAAE,IAAI;QACd,sDAAsD;QACtD,6EAA6E;QAC7E,WAAW,EAAE,IAAI;KAClB,CAAC;IACM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE5C,YAA2B,MAAyB,EAAE,WAAW,GAAG,KAAK;QACvE,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC;QADK,WAAM,GAAN,MAAM,CAAmB;IAEpD,CAAC;IAEM,KAAK;QACV,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;QAE9F,kCAAkC;QAClC,IAAI,CAAC,SAAS,CAAC,EAAE,CAA2B,0BAA0B,EAAE,CAAC,KAA+B,EAAE,EAAE,CAC1G,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CACpD,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAE1D,0EAA0E;QAC1E,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAExC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAY,EAAE,EAAE;YACnC,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,sBAAsB,CAAC,IAA8B;QAC3D,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE;YACb,MAAM,EAAE,uBAAuB;YAC/B,YAAY,EAAE,gBAAgB,QAAQ,GAAG,SAAS,IAAI,QAAQ,EAAE;SACjE,CAAC,CAAC;IACL,CAAC;IAEO,cAAc,CAAC,IAA6B;QAClD,0FAA0F;QAC1F,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB;YACpC,CAAC,CAAC,MAAM,IAAI,CAAC,oBAAoB,IAAI,CAAC,IAAI,IAAI,CAAC,gBAAgB,IAAI,CAAC,SAChE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC,EAChE,EAAE;YACJ,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,SAAS,GAAG,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAEnG,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE;gBACzC,SAAS,EAAE,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE;gBAC3F,MAAM,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;gBAClD,QAAQ;aACT,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,MAAM,CAAC;YACX,IAAI,CAAC;gBACH,MAAM,GAAG,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACtD,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,CAAC,KAAK,CAAC,0CAA0C,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;gBACtE,MAAM,GAAG,SAAS,CAAC;YACrB,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;QAClD,CAAC;IACH,CAAC"}

package/lib/utils/types.d.ts

@@ -21,6 +21,7 @@ export type AsyncDeployResultJson = Omit<Partial<MetadataApiDeployStatus>, 'stat
     files: FileResponse[];
     zipSize?: number;
     zipFileCount?: number;
+    deployUrl?: string;
 };
 type ConvertEntry = {
     fullName: string;
@@ -48,6 +49,7 @@ export type DeployResultJson = (MetadataApiDeployStatus & {
     replacements?: Record<string, string[]>;
     zipSize?: number;
     zipFileCount?: number;
+    deployUrl?: string;
 }) | AsyncDeployResultJson;
 export type MetadataRetrieveResultJson = Omit<MetadataApiRetrieveStatus, 'zipFile'> & {
     zipFilePath: string;

package/lib/utils/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,eAAe,GAShB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAE7D,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;AAEnE,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oDAAuC,CAAA;IACvC,4CAA+B,CAAA;IAC/B,kDAAqC,CAAA;AACvC,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAED,MAAM,CAAN,IAAY,GAGX;AAHD,WAAY,GAAG;IACb,oBAAa,CAAA;IACb,oBAAa,CAAA;AACf,CAAC,EAHW,GAAG,KAAH,GAAG,QAGd;AAiED,oEAAoE;AACpE,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,EAAiB,EAAyB,EAAE,CAC5E,QAAQ,CAAC,EAAE,CAAC;IACZ,MAAM,IAAI,EAAE;IACZ,OAAO,EAAE,CAAC,IAAI,KAAK,QAAQ;IAC3B,EAAE,CAAC,IAAI,KAAK,IAAI;IAChB,MAAM,IAAI,EAAE,CAAC,IAAI;IACjB,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ;IAChC,UAAU,IAAI,EAAE;IAChB,aAAa,IAAI,EAAE;IACnB,0EAA0E;IAC1E,OAAO,EAAE,CAAC,QAAQ,KAAK,QAAQ,CAAC;AAElC,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,EAAiB,EAA2C,EAAE,CACrG,iBAAiB,CAAC,EAAE,CAAC,IAAI,KAAK,IAAI,EAAE,IAAI,OAAO,EAAE,CAAC,GAAG,KAAK,QAAQ,CAAC;AAErE,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,YAA0B,EAAuC,EAAE,CAC9F,YAAY,CAAC,KAAK,KAAK,eAAe,CAAC,MAAM,CAAC;AAEhD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,YAA0B,EAAuC,EAAE,CAC9F,YAAY,CAAC,KAAK,KAAK,eAAe,CAAC,MAAM,CAAC;AAEhD,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,YAAiC,EAAW,EAAE,CAClF,YAAY,CAAC,KAAK,KAAK,eAAe,CAAC,OAAO,CAAC;AAEjD,MAAM,CAAC,MAAM,SAAS,GAAG,CAAI,KAAS,EAAc,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,eAAe,GAShB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAE7D,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;AAEnE,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oDAAuC,CAAA;IACvC,4CAA+B,CAAA;IAC/B,kDAAqC,CAAA;AACvC,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAED,MAAM,CAAN,IAAY,GAGX;AAHD,WAAY,GAAG;IACb,oBAAa,CAAA;IACb,oBAAa,CAAA;AACf,CAAC,EAHW,GAAG,KAAH,GAAG,QAGd;AAmED,oEAAoE;AACpE,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,EAAiB,EAAyB,EAAE,CAC5E,QAAQ,CAAC,EAAE,CAAC;IACZ,MAAM,IAAI,EAAE;IACZ,OAAO,EAAE,CAAC,IAAI,KAAK,QAAQ;IAC3B,EAAE,CAAC,IAAI,KAAK,IAAI;IAChB,MAAM,IAAI,EAAE,CAAC,IAAI;IACjB,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ;IAChC,UAAU,IAAI,EAAE;IAChB,aAAa,IAAI,EAAE;IACnB,0EAA0E;IAC1E,OAAO,EAAE,CAAC,QAAQ,KAAK,QAAQ,CAAC;AAElC,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,EAAiB,EAA2C,EAAE,CACrG,iBAAiB,CAAC,EAAE,CAAC,IAAI,KAAK,IAAI,EAAE,IAAI,OAAO,EAAE,CAAC,GAAG,KAAK,QAAQ,CAAC;AAErE,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,YAA0B,EAAuC,EAAE,CAC9F,YAAY,CAAC,KAAK,KAAK,eAAe,CAAC,MAAM,CAAC;AAEhD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,YAA0B,EAAuC,EAAE,CAC9F,YAAY,CAAC,KAAK,KAAK,eAAe,CAAC,MAAM,CAAC;AAEhD,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,YAAiC,EAAW,EAAE,CAClF,YAAY,CAAC,KAAK,KAAK,eAAe,CAAC,OAAO,CAAC;AAEjD,MAAM,CAAC,MAAM,SAAS,GAAG,CAAI,KAAS,EAAc,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC"}

package/messages/retrieve.start.md

@@ -145,6 +145,18 @@ Extract all files from the retrieved zip file.
 
 File name to use for the retrieved zip file.
 
+# spinner.start
+
+Preparing retrieve request
+
+# spinner.sending
+
+Sending request to org
+
+# spinner.polling
+
+Waiting for the org to respond
+
 # error.Conflicts
 
 There are changes in your local files that conflict with the org changes you're trying to retrieve.