@salesforce/plugin-devops-center 0.1.0-beta.1

package/lib/streamer/doceStream.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (c) 2023, 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
+ */
+const core_1 = require("@salesforce/core");
+/**
+ * Common base class for DOCe monitor that use the streaming api to listen to a streaming channel (CDC).
+ */
+class DOCeStreaming {
+    constructor(org, wait) {
+        this.doceOrg = org;
+        this.wait = wait;
+    }
+    /**
+     * This creates the streaming client and starts listening the desired streaming channel.
+     *
+     * @param channel The channel we want to listen (CDC)
+     * @param processor The specific processor we want to use for the event
+     */
+    async startStream(channel, processor) {
+        const options = new core_1.StreamingClient.DefaultOptions(this.doceOrg, channel, processor);
+        options.setSubscribeTimeout(this.wait);
+        const streamClient = await core_1.StreamingClient.create(options);
+        await streamClient.handshake();
+        await streamClient.subscribe();
+    }
+}
+exports.default = DOCeStreaming;
+//# sourceMappingURL=doceStream.js.map

package/lib/streamer/doceStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doceStream.js","sourceRoot":"","sources":["../../src/streamer/doceStream.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,2CAAsE;AAKtE;;GAEG;AACH,MAA8B,aAAa;IAIzC,YAAmB,GAAQ,EAAE,IAAc;QACzC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,SAA6C;QACxF,MAAM,OAAO,GAAG,IAAI,sBAAe,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;QACrF,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEvC,MAAM,YAAY,GAAG,MAAM,sBAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC3D,MAAM,YAAY,CAAC,SAAS,EAAE,CAAC;QAC/B,MAAM,YAAY,CAAC,SAAS,EAAE,CAAC;IACjC,CAAC;CAGF;AAzBD,gCAyBC"}

package/lib/streamer/processors/asyncOpStream.d.ts

@@ -0,0 +1,20 @@
+import { Org, StatusResult } from '@salesforce/core';
+import { Duration } from '@salesforce/kit';
+import { AnyJson, JsonMap } from '@salesforce/ts-types';
+import SObjectStreaming from '../sObjectStream';
+import { AorOutputService } from '../../common/outputService';
+export default class AsyncOpStreaming extends SObjectStreaming {
+    private outputService;
+    constructor(org: Org, wait: Duration, idToInspect: string, outputService: AorOutputService);
+    /**
+     * Connects to the AsyncOperationResults CDC channel and begins to monit for changes to the AOR we are monitoring.  If the AOR......
+     */
+    monitor(): Promise<void | AnyJson>;
+    /**
+     * This is the processor for the AOR. While InProgress we print the message from the AOR. We finish the stream after completed or errored.
+     *
+     * @param payload The payload from the CDC event
+     * @returns StatusResult Completed: true => will end the stream.
+     */
+    protected asyncOpStreamProcessor(payload: JsonMap): StatusResult;
+}

package/lib/streamer/processors/asyncOpStream.js

@@ -0,0 +1,48 @@
+"use strict";
+/*
+ * Copyright (c) 2023, 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const ts_types_1 = require("@salesforce/ts-types");
+const sObjectStream_1 = require("../sObjectStream");
+const constants_1 = require("../../common/constants");
+class AsyncOpStreaming extends sObjectStream_1.default {
+    constructor(org, wait, idToInspect, outputService) {
+        super(org, wait, new Array(idToInspect), constants_1.ASYNC_OPERATION_CDC);
+        this.outputService = outputService;
+    }
+    /**
+     * Connects to the AsyncOperationResults CDC channel and begins to monit for changes to the AOR we are monitoring.  If the AOR......
+     */
+    async monitor() {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        return this.watchForSObject(this.asyncOpStreamProcessor.bind(this));
+    }
+    /**
+     * This is the processor for the AOR. While InProgress we print the message from the AOR. We finish the stream after completed or errored.
+     *
+     * @param payload The payload from the CDC event
+     * @returns StatusResult Completed: true => will end the stream.
+     */
+    // eslint-disable-next-line class-methods-use-this
+    asyncOpStreamProcessor(payload) {
+        const jsonPayload = (0, ts_types_1.ensureJsonMap)(payload);
+        // We build an aor given the payload
+        const asyncOpResult = jsonPayload;
+        // Print the aor status
+        this.outputService.printAorStatus(asyncOpResult);
+        // In a future we want to test !Is_Completed__c instead of Status != In Progress
+        if (asyncOpResult.sf_devops__Status__c && asyncOpResult.sf_devops__Status__c !== 'In Progress') {
+            return {
+                completed: true,
+                payload: jsonPayload,
+            };
+        }
+        return { completed: false };
+    }
+}
+exports.default = AsyncOpStreaming;
+//# sourceMappingURL=asyncOpStream.js.map

package/lib/streamer/processors/asyncOpStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncOpStream.js","sourceRoot":"","sources":["../../../src/streamer/processors/asyncOpStream.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAMH,mDAAuE;AACvE,oDAAgD;AAChD,sDAA6D;AAI7D,MAAqB,gBAAiB,SAAQ,uBAAgB;IAG5D,YAAmB,GAAQ,EAAE,IAAc,EAAE,WAAmB,EAAE,aAA+B;QAC/F,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,KAAK,CAAC,WAAW,CAAC,EAAE,+BAAmB,CAAC,CAAC;QAC9D,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO;QAClB,iEAAiE;QACjE,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACH,kDAAkD;IACxC,sBAAsB,CAAC,OAAgB;QAC/C,MAAM,WAAW,GAAG,IAAA,wBAAa,EAAC,OAAO,CAAC,CAAC;QAE3C,oCAAoC;QACpC,MAAM,aAAa,GAAyB,WAAmC,CAAC;QAEhF,uBAAuB;QACvB,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAEjD,gFAAgF;QAChF,IAAI,aAAa,CAAC,oBAAoB,IAAI,aAAa,CAAC,oBAAoB,KAAK,aAAa,EAAE;YAC9F,OAAO;gBACL,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,WAAW;aACrB,CAAC;SACH;QACD,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IAC9B,CAAC;CACF;AAzCD,mCAyCC"}

package/lib/streamer/sObjectStream.d.ts

@@ -0,0 +1,22 @@
+import { Org, StatusResult } from '@salesforce/core';
+import { Duration } from '@salesforce/kit';
+import { AnyJson, JsonMap } from '@salesforce/ts-types';
+import DOCeStreaming from './doceStream';
+export default abstract class SObjectStreaming extends DOCeStreaming {
+    private idsToInspect;
+    private channelName;
+    protected constructor(org: Org, wait: Duration, idsToInspect: string[], channelName: string);
+    /**
+     * This method sets the processor we will need inside the matchingProcessor and will start the stream.
+     *
+     * @param matchProcessor This processor will be used in the matchingProcessor, it's provided by each implementation.
+     */
+    protected watchForSObject(matchProcessor: (message: JsonMap) => StatusResult): Promise<void | AnyJson>;
+    /**
+     * This method processes if the event is valid for the IDs we want to monitor.
+     *
+     * @param event JsonMap containing the event from the streaming channel.
+     * @returns If the event is valid, the matchProcessor will handle the response. If it's not valid, we continue listening.
+     */
+    protected matchingProcessor(event: JsonMap, matchProcessor: (message: JsonMap) => StatusResult): StatusResult;
+}

package/lib/streamer/sObjectStream.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ts_types_1 = require("@salesforce/ts-types");
+const utils_1 = require("../common/utils");
+const doceStream_1 = require("./doceStream");
+class SObjectStreaming extends doceStream_1.default {
+    constructor(org, wait, idsToInspect, channelName) {
+        super(org, wait);
+        this.idsToInspect = idsToInspect;
+        this.channelName = channelName;
+    }
+    /**
+     * This method sets the processor we will need inside the matchingProcessor and will start the stream.
+     *
+     * @param matchProcessor This processor will be used in the matchingProcessor, it's provided by each implementation.
+     */
+    async watchForSObject(matchProcessor) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        return this.startStream(this.channelName, (event) => this.matchingProcessor(event, matchProcessor));
+    }
+    /**
+     * This method processes if the event is valid for the IDs we want to monitor.
+     *
+     * @param event JsonMap containing the event from the streaming channel.
+     * @returns If the event is valid, the matchProcessor will handle the response. If it's not valid, we continue listening.
+     */
+    matchingProcessor(event, matchProcessor) {
+        const jsonPayload = (0, ts_types_1.ensureJsonMap)(event.payload);
+        const changeEventHeader = (0, ts_types_1.ensureJsonMap)(jsonPayload.ChangeEventHeader);
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        if (changeEventHeader.recordIds != null && (0, utils_1.containsSfId)(this.idsToInspect, changeEventHeader.recordIds[0])) {
+            return matchProcessor(jsonPayload);
+        }
+        else {
+            return { completed: false };
+        }
+    }
+}
+exports.default = SObjectStreaming;
+//# sourceMappingURL=sObjectStream.js.map

package/lib/streamer/sObjectStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sObjectStream.js","sourceRoot":"","sources":["../../src/streamer/sObjectStream.ts"],"names":[],"mappings":";;AAQA,mDAAuE;AACvE,2CAA+C;AAC/C,6CAAyC;AAEzC,MAA8B,gBAAiB,SAAQ,oBAAa;IAIlE,YAAsB,GAAQ,EAAE,IAAc,EAAE,YAAsB,EAAE,WAAmB;QACzF,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACjB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,eAAe,CAAC,cAAkD;QAChF,iEAAiE;QACjE,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC;IAC/G,CAAC;IAED;;;;;OAKG;IACO,iBAAiB,CAAC,KAAc,EAAE,cAAkD;QAC5F,MAAM,WAAW,GAAG,IAAA,wBAAa,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACjD,MAAM,iBAAiB,GAAG,IAAA,wBAAa,EAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;QAEvE,iEAAiE;QACjE,IAAI,iBAAiB,CAAC,SAAS,IAAI,IAAI,IAAI,IAAA,oBAAY,EAAC,IAAI,CAAC,YAAY,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE;YAC1G,OAAO,cAAc,CAAC,WAAW,CAAC,CAAC;SACpC;aAAM;YACL,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;SAC7B;IACH,CAAC;CACF;AArCD,mCAqCC"}

package/messages/aorOperations.output.md

@@ -0,0 +1,8 @@
+# output.aor-error-status
+
+%s
+Error details: %s
+
+# output.aor-id
+
+Job ID: %s

package/messages/cache.md

@@ -0,0 +1,3 @@
+# error.NoRecentAorId
+
+Can't find the job ID. Verify that a pipeline promotion has been started.

package/messages/commonErrors.md

@@ -0,0 +1,31 @@
+# error.NoTestsSpecified
+
+You must specify tests using the --tests flag if the --test-level flag is set to RunSpecifiedTests.
+
+# error.InvalidRunTests
+
+runTests can be used only with a testLevel of RunSpecifiedTests.
+
+# error.BranchNotFound
+
+The %s branch doesn't exist in %s project. Specify a valid branch name and try again.
+
+# error.ProjectNotFound
+
+The %s project doesn't exist. Specify a valid project name and try again.
+
+# error.DevopsAppNotInstalled
+
+The DevOps Center app wasn't found in the specified org. Verify the org username and try again.
+
+# error.InvalidAorId
+
+No job found for ID: %s.
+
+# error.JobNotResumable
+
+Job ID %s is not resumable with status %s.
+
+# error.ClientTimeout
+
+The command has timed out, although it's still running. To check the status of the current operation, run "%s %s report".

package/messages/commonFlags.md

@@ -0,0 +1,53 @@
+# flags.devops-center-project-name.summary
+
+Name of the DevOps Center project.
+
+# flags.devops-center-username.summary
+
+Username or alias for the DevOps Center org.
+
+# flags.wait.description
+
+If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run "<%= config.bin %> <%= command.id %> report".
+
+# flags.wait.summary
+
+Number of minutes to wait for command to complete and display results.
+
+# flags.targetDoceOrg.summary
+
+Username or alias of the DevOps Center org.
+
+# flags.job-id.summary
+
+Job ID of the pipeline deploy operation you want to resume.
+
+# flags.job-id.description
+
+These commands return a job ID if they time out or you specified the --async flag:
+
+- sf deploy pipeline
+- sf deploy pipeline validate
+- sf deploy pipeline quick
+
+The job ID is valid for 10 days from when you started the deploy operation.
+
+# flags.use-most-recent.summary
+
+Use the job ID of the most recent deploy operation.
+
+# flags.use-most-recent.description
+
+For performance reasons, this flag uses job IDs for operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find a job ID.
+
+# flags.verbose.summary
+
+Show verbose output of the command result.
+
+# flags.concise.summary
+
+Show concise output of the command result.
+
+# errors.NoDefaultDoceEnv
+
+You must specify the DevOps Center org username by indicating the -c flag on the command line or by setting the target-devops-center configuration variable.

package/messages/config.md

@@ -0,0 +1,3 @@
+# target-devops-center
+
+Username or alias of the DevOps Center org.

package/messages/deploy.output.md

@@ -0,0 +1,31 @@
+# output.async-run-info
+
+Deploy has been queued.
+Run "sf deploy pipeline resume --job-id %s to resume watching the deploy.
+Run "sf deploy pipeline report --job-id %s to get the latest status.
+
+# output.item
+
+item
+
+# output.items
+
+items
+
+# output.adhoc-deploy-summary
+
+DevOps Center pipeline stage %s being updated with metadata associated with work %s %s.
+Deploying metadata from %s branch to target org %s.
+
+# output.version-or-soup-deploy-summary-wis
+
+work %s %s in bundle %s
+
+# output.version-or-soup-deploy-summary
+
+DevOps Center pipeline stage %s being updated with metadata associated with %s.
+Deploying metadata from %s branch to target org %s.
+
+# output.concise.summary
+
+DevOps Center pipeline stage %s being updated. Deploying metadata from %s branch to target org %s.

package/messages/deploy.pipeline.md

@@ -0,0 +1,37 @@
+# summary
+
+Deploy changes from a branch to the pipeline stage’s org.
+
+# description
+
+Before you run this command, changes in the branch must be merged in the source control repository.
+
+# examples
+
+- Deploy changes in the Staging branch to the Staging environment (sandbox), if the previous stage is the bundling stage:
+
+  <%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox --bundle-version-name 1.0
+
+- Deploy all changes in the main branch to the release environment:
+
+  <%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all
+
+# deployComponent.operation.column
+
+Operation
+
+# deployComponent.name.column
+
+Name
+
+# deployComponent.type.column
+
+Type
+
+# deployComponent.path.column
+
+Path
+
+# deployComponent.table.title
+
+Deployed Source

package/messages/deploy.pipeline.report.md

@@ -0,0 +1,49 @@
+# summary
+
+Check the status of a pipeline deploy operation.
+
+# description
+
+Run this command by either passing it a job ID or specifying the —use-most-recent flag to use the job ID of the most recent deploy operation.
+
+# examples
+
+- Check the status using a job ID:
+
+      <%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --job-id 0Af0x000017yLUFCA2
+
+- Check the status of the most recent deploy operation:
+
+      <%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --use-most-recent
+
+# flags.job-id.summary
+
+Job ID of the pipeline deployment you want to check the status of.
+
+# flags.job-id.description
+
+The job ID is valid for 10 days from when you started the deploy operation.
+
+# flags.use-most-recent.summary
+
+Use the job ID of the most recent deploy operation.
+
+# flags.use-most-recent.description
+
+For performance reasons, this flag uses job IDs for deploy operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find a job ID.
+
+# report.key.created-by-name
+
+CreatedByName
+
+# report.key.column
+
+Key
+
+# report.value.column
+
+Value
+
+# report.info.header
+
+Info

package/messages/deploy.pipeline.resume.md

@@ -0,0 +1,23 @@
+# summary
+
+Resume watching a pipeline deploy operation.
+
+# description
+
+Use this command to resume watching a pipeline deploy operation if the original command times out or you specified the --async flag.
+
+Run this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.
+
+# examples
+
+- Resume watching a deploy operation using a job ID:
+
+      <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2
+
+- Resume watching the most recent deploy operation:
+
+      <%= config.bin %> <%= command.id %> --use-most-recent
+
+# error.ClientTimeout
+
+The command has timed out, although it is still running. To check the status of the deploy operation, run "sf deploy pipeline report".

package/messages/promoteFlags.md

@@ -0,0 +1,53 @@
+# promote.branch-name.summary
+
+Name of the branch in the source control repository from which to deploy changes to the stage’s org.
+
+# promote.deploy-all.summary
+
+Deploy all metadata in branch.
+
+# promote.deploy-all.description
+
+If you don’t specify this flag, only changes in the stage’s branch are deployed.
+
+# promote.bundle-version-name.summary
+
+Version name of the bundle.
+
+# promote.bundle-version-name.description
+
+You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.
+
+# promote.tests.summary
+
+Apex tests to run when --test-level is RunSpecifiedTests.
+
+# promote.tests.description
+
+Separate multiple test names with commas, and enclose the entire flag value in double quotes if a test name contains a space.
+
+# promote.test-level.summary
+
+Deployment Apex testing level.
+
+# promote.test-level.description
+
+Valid values are:
+
+- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.
+
+- RunSpecifiedTests — Runs only the tests that you specify with the --run-tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.
+
+- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.
+
+- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
+
+If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the "Metadata API Developer Guide".
+
+# promote.async.description
+
+The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run "sf deploy pipeline resume". To check the status of the deployment, run "sf deploy pipeline report".
+
+# promote.async.summary
+
+Run the command asynchronously.

package/messages/resume.output.md

@@ -0,0 +1,4 @@
+# output.summary
+
+<!-- prettier-ignore -->
+*** Resuming %s ***