Merge branch 'main' into W-21766828-storage-multi-realm-usage-support

Author: charithaT07

.changeset/code-deploy-activate-flag.md

@@ -0,0 +1,6 @@
+---
+'@salesforce/b2c-cli': patch
+'@salesforce/b2c-tooling-sdk': patch
+---
+
+Add `--activate` flag to `code deploy` for activating a code version after deploy without the toggle behavior of `--reload`. Both `--activate` and `--reload` now error on failure instead of silently continuing.

actions/README.md

@@ -47,7 +47,7 @@ GitHub Actions for automating Salesforce B2C Commerce operations with the [`@sal
     client-secret: ${{ secrets.SFCC_CLIENT_SECRET }}
     server: ${{ vars.SFCC_SERVER }}
     code-version: ${{ vars.SFCC_CODE_VERSION }}
-    reload: true
+    activate: true
     cartridges: 'app_storefront_base,app_custom'
 ```
 

actions/code-deploy/action.yml

@@ -9,10 +9,14 @@ inputs:
     description: 'Path to cartridge source directory'
     required: false
     default: '.'
+  activate:
+    description: 'Activate the code version after deploy'
+    required: false
+    default: 'false'
   reload:
-    description: 'Activate/reload the code version after deploy'
+    description: 'Alias for activate (deprecated)'
     required: false
-    default: 'true'
+    default: 'false'
   code-version:
     description: 'Code version to deploy to (overrides SFCC_CODE_VERSION env var)'
     required: false
@@ -81,7 +85,9 @@ runs:
       run: |
         CMD="code deploy ${{ inputs.cartridge-path }}"
 
-        if [ "${{ inputs.reload }}" = "true" ]; then
+        if [ "${{ inputs.activate }}" = "true" ]; then
+          CMD="$CMD --activate"
+        elif [ "${{ inputs.reload }}" = "true" ]; then
           CMD="$CMD --reload"
         fi
 

actions/workflow-templates/b2c-code-deploy.yml

@@ -18,4 +18,4 @@ jobs:
           username: ${{ secrets.SFCC_USERNAME }}
           password: ${{ secrets.SFCC_PASSWORD }}
           code-version: ${{ vars.SFCC_CODE_VERSION }}
-          reload: true
+          activate: true

docs/cli/code.md

@@ -113,7 +113,8 @@ In addition to [global flags](./index#global-flags):
 
 | Flag | Description | Default |
 |------|-------------|---------|
-| `--reload`, `-r` | Reload (re-activate) code version after deploy | `false` |
+| `--activate`, `-a` | Activate code version after deploy | `false` |
+| `--reload`, `-r` | Reload (toggle activation to force reload) code version after deploy | `false` |
 | `--delete` | Delete existing cartridges before upload | `false` |
 | `--cartridge`, `-c` | Include specific cartridge(s) (can be repeated) | |
 | `--exclude-cartridge`, `-x` | Exclude specific cartridge(s) (can be repeated) | |
@@ -127,8 +128,8 @@ b2c code deploy --server my-sandbox.demandware.net --code-version v1
 # Deploy from a specific directory
 b2c code deploy ./my-project --server my-sandbox.demandware.net --code-version v1
 
-# Deploy and reload the code version
-b2c code deploy --reload
+# Deploy and activate the code version
+b2c code deploy --activate
 
 # Deploy specific cartridges only
 b2c code deploy -c app_storefront_base -c plugin_applepay
@@ -139,8 +140,8 @@ b2c code deploy -x test_cartridge -x int_debug
 # Delete existing cartridges before upload
 b2c code deploy --delete
 
-# Delete and reload
-b2c code deploy --delete --reload
+# Delete and activate
+b2c code deploy --delete --activate
 
 # Using environment variables
 export SFCC_SERVER=my-sandbox.demandware.net

docs/guide/ci-cd.md

@@ -8,7 +8,7 @@ The official actions handle CLI installation, credential configuration, and Node
 
 The actions are available from the `SalesforceCommerceCloud/b2c-developer-tooling` repository and support:
 
-- **Code deployment** — deploy cartridges with reload
+- **Code deployment** — deploy and activate cartridges
 - **Data import** — import site archives in a single step
 - **MRT deployment** — push and deploy MRT storefront bundles
 - **Job execution** — run B2C jobs with wait and timeout
@@ -80,7 +80,7 @@ jobs:
       - uses: SalesforceCommerceCloud/b2c-developer-tooling/actions/code-deploy@v1
         with:
           code-version: ${{ steps.version.outputs.code-version }}
-          reload: true
+          activate: true
 ```
 
 The **setup** step installs the CLI and configures credentials for all subsequent steps. Everything after that — your build, version calculation, and deploy — can focus on your project's needs.
@@ -169,7 +169,7 @@ Deploy cartridges with typed inputs.
 | Input | Default | Description |
 |-------|---------|-------------|
 | `cartridge-path` | `.` | Path to cartridge source directory |
-| `reload` | `true` | Activate code version after deploy |
+| `activate` | `false` | Activate code version after deploy |
 | `code-version` | — | Code version (overrides env) |
 | `cartridges` | — | Comma-separated cartridges to include |
 | `exclude-cartridges` | — | Comma-separated cartridges to exclude |

packages/b2c-cli/src/commands/code/deploy.ts

@@ -8,6 +8,7 @@ import {
   uploadCartridges,
   deleteCartridges,
   getActiveCodeVersion,
+  activateCodeVersion,
   reloadCodeVersion,
   type DeployResult,
 } from '@salesforce/b2c-tooling-sdk/operations/code';
@@ -32,19 +33,27 @@ export default class CodeDeploy extends CartridgeCommand<typeof CodeDeploy> {
     '<%= config.bin %> <%= command.id %>',
     '<%= config.bin %> <%= command.id %> ./my-cartridges',
     '<%= config.bin %> <%= command.id %> --server my-sandbox.demandware.net --code-version v1',
+    '<%= config.bin %> <%= command.id %> --activate',
+    '<%= config.bin %> <%= command.id %> --delete --activate',
     '<%= config.bin %> <%= command.id %> --reload',
-    '<%= config.bin %> <%= command.id %> --delete --reload',
     '<%= config.bin %> <%= command.id %> -c app_storefront_base -c plugin_applepay',
     '<%= config.bin %> <%= command.id %> -x test_cartridge',
   ];
 
   static flags = {
     ...CartridgeCommand.baseFlags,
     ...CartridgeCommand.cartridgeFlags,
+    activate: Flags.boolean({
+      char: 'a',
+      description: 'Activate code version after deploy',
+      default: false,
+      exclusive: ['reload'],
+    }),
     reload: Flags.boolean({
       char: 'r',
-      description: 'Reload (re-activate) code version after deploy',
+      description: 'Reload (toggle activation to force reload) code version after deploy',
       default: false,
+      exclusive: ['activate'],
     }),
     delete: Flags.boolean({
       description: 'Delete existing cartridges before upload',
@@ -56,6 +65,7 @@ export default class CodeDeploy extends CartridgeCommand<typeof CodeDeploy> {
     uploadCartridges,
     deleteCartridges,
     getActiveCodeVersion,
+    activateCodeVersion,
     reloadCodeVersion,
   };
 
@@ -65,15 +75,15 @@ export default class CodeDeploy extends CartridgeCommand<typeof CodeDeploy> {
     const hostname = this.resolvedConfig.values.hostname!;
     let version = this.resolvedConfig.values.codeVersion;
 
-    // OAuth is only required if:
+    // OAuth is required if:
     // 1. No code version specified (need to auto-discover via OCAPI)
-    // 2. --reload flag is set (need to call OCAPI to reload)
-    const needsOAuth = !version || this.flags.reload;
+    // 2. --activate or --reload flag is set (need to call OCAPI)
+    const needsOAuth = !version || this.flags.activate || this.flags.reload;
     if (needsOAuth && !this.hasOAuthCredentials()) {
       const reason = version
         ? t(
-            'commands.code.deploy.oauthRequiredForReload',
-            'The --reload flag requires OAuth credentials to reload the code version via OCAPI.',
+            'commands.code.deploy.oauthRequiredForActivate',
+            'The --activate/--reload flag requires OAuth credentials to manage the code version via OCAPI.',
           )
         : t(
             'commands.code.deploy.oauthRequiredForDiscovery',
@@ -109,6 +119,7 @@ export default class CodeDeploy extends CartridgeCommand<typeof CodeDeploy> {
       cartridgePath: this.cartridgePath,
       hostname,
       codeVersion: version,
+      activate: this.flags.activate,
       reload: this.flags.reload,
       delete: this.flags.delete,
       ...this.cartridgeOptions,
@@ -125,6 +136,7 @@ export default class CodeDeploy extends CartridgeCommand<typeof CodeDeploy> {
       return {
         cartridges: [],
         codeVersion: version,
+        activated: false,
         reloaded: false,
       };
     }
@@ -159,20 +171,33 @@ export default class CodeDeploy extends CartridgeCommand<typeof CodeDeploy> {
       // Upload cartridges
       await this.operations.uploadCartridges(this.instance, cartridges);
 
-      // Optionally reload code version
+      // Optionally activate or reload code version
+      let activated = false;
       let reloaded = false;
-      if (this.flags.reload) {
-        try {
+      try {
+        if (this.flags.activate) {
+          await this.operations.activateCodeVersion(this.instance, version);
+          activated = true;
+        } else if (this.flags.reload) {
           await this.operations.reloadCodeVersion(this.instance, version);
+          activated = true;
           reloaded = true;
-        } catch (error) {
-          this.logger?.debug(`Could not reload code version: ${error instanceof Error ? error.message : error}`);
         }
+      } catch (error) {
+        const clientId = this.resolvedConfig.values.clientId ?? 'unknown';
+        this.error(
+          t(
+            'commands.code.deploy.activateFailed',
+            'Failed to activate code version "{{version}}": {{message}}\n\nEnsure your OCAPI client ({{clientId}}) is configured with Data API permissions.\nSee: https://salesforcecommercecloud.github.io/b2c-developer-tooling/guide/authentication.html#ocapi-configuration',
+            {version, message: error instanceof Error ? error.message : String(error), clientId},
+          ),
+        );
       }
 
       const result: DeployResult = {
         cartridges,
         codeVersion: version,
+        activated,
         reloaded,
       };
 
@@ -187,8 +212,12 @@ export default class CodeDeploy extends CartridgeCommand<typeof CodeDeploy> {
         ),
       );
 
-      if (result.reloaded) {
-        this.log(t('commands.code.deploy.reloaded', 'Code version reloaded'));
+      if (result.activated) {
+        this.log(
+          result.reloaded
+            ? t('commands.code.deploy.reloaded', 'Code version reloaded')
+            : t('commands.code.deploy.activated', 'Code version activated'),
+        );
       }
 
       // Run afterOperation hooks with success

packages/b2c-cli/test/commands/code/deploy.test.ts

@@ -42,7 +42,7 @@ describe('code deploy', () => {
 
     const result = await command.run();
 
-    expect(result).to.deep.equal({cartridges: [], codeVersion: 'v1', reloaded: false});
+    expect(result).to.deep.equal({cartridges: [], codeVersion: 'v1', activated: false, reloaded: false});
   });
 
   it('errors when no cartridges are found', async () => {
@@ -90,11 +90,60 @@ describe('code deploy', () => {
     expect(uploadStub.calledOnceWithExactly(instance, cartridges)).to.equal(true);
     expect(reloadStub.calledOnceWithExactly(instance, 'v1')).to.equal(true);
 
-    expect(result).to.deep.include({codeVersion: 'v1', reloaded: true});
+    expect(result).to.deep.include({codeVersion: 'v1', activated: true, reloaded: true});
     expect(afterHooksStub.calledOnce).to.equal(true);
   });
 
-  it('swallows reload errors and still succeeds', async () => {
+  it('calls activate after deploy when --activate is set', async () => {
+    const command: any = await createCommand({activate: true}, {cartridgePath: '.'});
+    const instance = stubCommon(command);
+
+    sinon.stub(command, 'runBeforeHooks').resolves({skip: false});
+    sinon.stub(command, 'runAfterHooks').resolves(void 0);
+
+    const cartridges = [{name: 'c1', src: '/tmp/c1', dest: 'c1'}];
+    sinon.stub(command, 'findCartridgesWithProviders').resolves(cartridges);
+
+    const uploadStub = sinon.stub().resolves(void 0);
+    const activateStub = sinon.stub().resolves(void 0);
+    command.operations = {...command.operations, uploadCartridges: uploadStub, activateCodeVersion: activateStub};
+
+    const result = await command.run();
+
+    expect(activateStub.calledOnceWithExactly(instance, 'v1')).to.equal(true);
+    expect(result).to.deep.include({codeVersion: 'v1', activated: true, reloaded: false});
+  });
+
+  it('errors when activate fails', async () => {
+    const command: any = await createCommand({activate: true}, {cartridgePath: '.'});
+    stubCommon(command);
+
+    sinon.stub(command, 'runBeforeHooks').resolves({skip: false});
+    sinon.stub(command, 'runAfterHooks').resolves(void 0);
+
+    const cartridges = [{name: 'c1', src: '/tmp/c1', dest: 'c1'}];
+    sinon.stub(command, 'findCartridgesWithProviders').resolves(cartridges);
+
+    const uploadStub = sinon.stub().resolves(void 0);
+    const activateStub = sinon.stub().rejects(new Error('activate failed'));
+    command.operations = {...command.operations, uploadCartridges: uploadStub, activateCodeVersion: activateStub};
+
+    const errorStub = sinon.stub(command, 'error').throws(new Error('Expected error'));
+
+    try {
+      await command.run();
+      expect.fail('Should have thrown');
+    } catch {
+      // expected
+    }
+
+    expect(errorStub.called).to.equal(true);
+    const errorMessage = errorStub.firstCall.args[0];
+    expect(errorMessage).to.include('activate failed');
+    expect(errorMessage).to.include('OCAPI');
+  });
+
+  it('errors when reload fails', async () => {
     const command: any = await createCommand({reload: true}, {cartridgePath: '.'});
     stubCommon(command);
 
@@ -108,9 +157,19 @@ describe('code deploy', () => {
     const reloadStub = sinon.stub().rejects(new Error('reload failed'));
     command.operations = {...command.operations, uploadCartridges: uploadStub, reloadCodeVersion: reloadStub};
 
-    const result = await command.run();
+    const errorStub = sinon.stub(command, 'error').throws(new Error('Expected error'));
 
-    expect(result.reloaded).to.equal(false);
+    try {
+      await command.run();
+      expect.fail('Should have thrown');
+    } catch {
+      // expected
+    }
+
+    expect(errorStub.called).to.equal(true);
+    const errorMessage = errorStub.firstCall.args[0];
+    expect(errorMessage).to.include('reload failed');
+    expect(errorMessage).to.include('OCAPI');
   });
 
   it('errors when no code version and no OAuth credentials', async () => {
@@ -156,7 +215,30 @@ describe('code deploy', () => {
 
     expect(errorStub.calledOnce).to.equal(true);
     const errorMessage = errorStub.firstCall.args[0];
-    expect(errorMessage).to.include('reload');
+    expect(errorMessage).to.include('activate');
+  });
+
+  it('errors when --activate flag set but no OAuth credentials', async () => {
+    const command: any = await createCommand({activate: true}, {cartridgePath: '.'});
+
+    sinon.stub(command, 'requireWebDavCredentials').returns(void 0);
+    sinon.stub(command, 'hasOAuthCredentials').returns(false);
+    sinon.stub(command, 'log').returns(void 0);
+    sinon.stub(command, 'warn').returns(void 0);
+    sinon.stub(command, 'resolvedConfig').get(() => ({values: {hostname: 'example.com', codeVersion: 'v1'}}));
+
+    const errorStub = sinon.stub(command, 'error').throws(new Error('OAuth required'));
+
+    try {
+      await command.run();
+      expect.fail('Should have thrown');
+    } catch {
+      // expected
+    }
+
+    expect(errorStub.calledOnce).to.equal(true);
+    const errorMessage = errorStub.firstCall.args[0];
+    expect(errorMessage).to.include('activate');
   });
 
   it('uses active code version when resolvedConfig is missing codeVersion', async () => {