Merge main into bugfix/unit-test-environment-slow-tests

clavery · clavery · commit c96fb5c74ef7 · 2026-01-15T00:51:33.000-05:00
Resolve conflict in base-command.test.ts by:
- Keeping test helper utilities (config-isolation, stub-parse) from feature branch
- Adding globalMiddlewareRegistry cleanup from main
- Adding extra-headers tests from main using feature branch patterns
diff --git a/.github/workflows/e2e-shell-tests.yml b/.github/workflows/e2e-shell-tests.yml
@@ -80,6 +80,8 @@ jobs:
           SFCC_SANDBOX_API_HOST: ${{ vars.SFCC_SANDBOX_API_HOST }}
           SFCC_SHORTCODE: ${{ vars.SFCC_SHORTCODE }}
           TEST_REALM: ${{ vars.TEST_REALM }}
+          SFCC_EXTRA_HEADERS: ${{ secrets.SFCC_EXTRA_HEADERS }}
+          CURL_EXTRA_HEADERS: ${{ secrets.CURL_EXTRA_HEADERS }}
         run: |
           echo "Running E2E shell tests with realm: ${TEST_REALM}"
           cd packages/b2c-cli
diff --git a/docs/api-readme.md b/docs/api-readme.md
@@ -1,3 +1,7 @@
+---
+description: API reference for the B2C Tooling SDK with typed WebDAV and OCAPI clients for programmatic B2C Commerce operations.
+---
+
 # API Reference
 
 The `@salesforce/b2c-tooling-sdk` package provides a programmatic API for interacting with Salesforce B2C Commerce instances.
diff --git a/docs/cli/auth.md b/docs/cli/auth.md
@@ -1,3 +1,7 @@
+---
+description: Authentication commands for obtaining OAuth tokens and configuring Account Manager API clients, OCAPI, and WebDAV access.
+---
+
 # Auth Commands
 
 Commands for authentication and token management.
diff --git a/docs/cli/code.md b/docs/cli/code.md
@@ -1,3 +1,7 @@
+---
+description: Commands for deploying cartridges, activating code versions, and watching for file changes on B2C Commerce instances.
+---
+
 # Code Commands
 
 Commands for managing cartridge code on B2C Commerce instances.
diff --git a/docs/cli/custom-apis.md b/docs/cli/custom-apis.md
@@ -1,3 +1,7 @@
+---
+description: Commands for managing SCAPI Custom API endpoints, checking registration status, and debugging endpoint configurations.
+---
+
 # Custom APIs
 
 Commands for managing SCAPI Custom API endpoints.
diff --git a/docs/cli/index.md b/docs/cli/index.md
@@ -1,3 +1,7 @@
+---
+description: B2C CLI command reference with global flags and authentication options for managing Salesforce Commerce Cloud instances.
+---
+
 # CLI Reference
 
 The `b2c` CLI provides commands for managing Salesforce B2C Commerce instances.
diff --git a/docs/cli/jobs.md b/docs/cli/jobs.md
@@ -1,3 +1,7 @@
+---
+description: Commands for executing jobs, importing and exporting site archives, and monitoring job execution status.
+---
+
 # Job Commands
 
 Commands for executing and monitoring jobs on B2C Commerce instances.
diff --git a/docs/cli/logging.md b/docs/cli/logging.md
@@ -1,3 +1,7 @@
+---
+description: Configure CLI logging with log levels, JSON output for CI/CD, and environment variables for debugging.
+---
+
 # Logging
 
 The CLI uses [pino](https://github.com/pinojs/pino) for structured logging with pretty-printed output by default.
diff --git a/docs/cli/mrt.md b/docs/cli/mrt.md
@@ -1,3 +1,7 @@
+---
+description: Commands for managing Managed Runtime projects, pushing bundles, creating environments, and configuring environment variables.
+---
+
 # MRT Commands
 
 Commands for managing Managed Runtime (MRT) projects, environments, and bundles.
diff --git a/docs/cli/ods.md b/docs/cli/ods.md
@@ -1,3 +1,7 @@
+---
+description: Commands for creating, managing, starting, stopping, and deleting On-Demand Sandboxes (ODS) for development.
+---
+
 # ODS Commands
 
 Commands for managing On-Demand Sandboxes (ODS).
diff --git a/docs/cli/sites.md b/docs/cli/sites.md
@@ -1,3 +1,7 @@
+---
+description: Commands for listing and managing storefront sites on B2C Commerce instances.
+---
+
 # Sites Commands
 
 Commands for managing sites on B2C Commerce instances.
diff --git a/docs/cli/slas.md b/docs/cli/slas.md
@@ -1,3 +1,7 @@
+---
+description: Commands for creating, updating, and managing Shopper Login and API Access Service (SLAS) clients.
+---
+
 # SLAS Commands
 
 Commands for managing Shopper Login and API Security (SLAS) clients.
diff --git a/docs/cli/webdav.md b/docs/cli/webdav.md
@@ -1,3 +1,7 @@
+---
+description: Commands for WebDAV file operations including listing, uploading, downloading, and managing files on B2C Commerce instances.
+---
+
 # WebDAV Commands
 
 Commands for file operations on B2C Commerce instance WebDAV.
diff --git a/docs/guide/agent-skills.md b/docs/guide/agent-skills.md
@@ -1,3 +1,7 @@
+---
+description: AI agent skills and plugins for Claude Code, Cursor, and GitHub Copilot that enhance B2C Commerce development.
+---
+
 # Agent Skills & Plugins
 
 The B2C Developer Tooling project provides agent skills that enhance the AI-assisted development experience when working with Salesforce B2C Commerce projects.
diff --git a/docs/guide/authentication.md b/docs/guide/authentication.md
@@ -1,3 +1,7 @@
+---
+description: Set up authentication for the B2C CLI including Account Manager API clients, OCAPI permissions, and WebDAV access keys.
+---
+
 # Authentication Setup
 
 This guide covers setting up authentication for the B2C CLI, including Account Manager API clients, OCAPI permissions, and WebDAV access.
diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md
@@ -1,3 +1,7 @@
+---
+description: Configure the B2C CLI with environment variables, dw.json files, and multi-instance setups for different environments.
+---
+
 # Configuration
 
 The B2C CLI automatically detects and uses available credentials. You can provide credentials via CLI flags, environment variables, or configuration files.
diff --git a/docs/guide/extending.md b/docs/guide/extending.md
@@ -1,3 +1,7 @@
+---
+description: Extend the B2C CLI with custom plugins, configuration sources, HTTP middleware, and lifecycle hooks.
+---
+
 # Extending the CLI
 
 The B2C CLI can be extended with custom plugins using the [oclif plugin system](https://oclif.io/docs/plugins). Plugins can add new commands, provide custom configuration sources, and integrate with external systems.
diff --git a/docs/guide/index.md b/docs/guide/index.md
@@ -1,3 +1,7 @@
+---
+description: Introduction to the B2C CLI and SDK for Salesforce Commerce Cloud B2C code deployment, site management, and sandbox operations.
+---
+
 # Introduction
 
 The B2C CLI is a command-line interface for Salesforce Commerce Cloud B2C. It provides tools for:
diff --git a/docs/guide/installation.md b/docs/guide/installation.md
@@ -1,3 +1,7 @@
+---
+description: Install the B2C CLI via Homebrew, npm, or GitHub releases, and optionally install the SDK for programmatic use.
+---
+
 # Installation
 
 ## Prerequisites
diff --git a/docs/guide/security.md b/docs/guide/security.md
@@ -1,3 +1,7 @@
+---
+description: Security practices for the B2C Developer Tooling project including supply chain protections and dependency management.
+---
+
 # Security
 
 This page covers security practices used in the B2C Developer Tooling project, with a focus on supply chain security.
diff --git a/docs/guide/third-party-plugins.md b/docs/guide/third-party-plugins.md
@@ -1,3 +1,7 @@
+---
+description: Community plugins for the B2C CLI including IntelliJ SFCC config integration and macOS Keychain credential storage.
+---
+
 # 3rd Party Plugins
 
 The B2C CLI can be extended with community-developed plugins that add new functionality or integrate with external tools.
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,5 @@
 ---
+description: Command line tools and SDK for Salesforce Commerce Cloud B2C - deploy code, manage sandboxes, run jobs, and automate operations.
 layout: home
 
 hero:
diff --git a/packages/b2c-cli/test/functional/e2e_cli_test.sh b/packages/b2c-cli/test/functional/e2e_cli_test.sh
@@ -198,8 +198,17 @@ SLAS_BASE="https://${SFCC_SHORTCODE}.api.commercecloud.salesforce.com"
 echo "  ORG ID: $ORG_ID"
 echo "  SLAS Base: $SLAS_BASE"
 
+# Build curl extra headers args if set (newline-separated, e.g. "X-Header: value")
+CURL_HEADER_ARGS=()
+if [ -n "$CURL_EXTRA_HEADERS" ]; then
+    while IFS= read -r header; do
+        [ -n "$header" ] && CURL_HEADER_ARGS+=(-H "$header")
+    done <<< "$CURL_EXTRA_HEADERS"
+fi
+
 # Get shopper token via client credentials (guest login)
 TOKEN_RESPONSE=$(curl -s "${SLAS_BASE}/shopper/auth/v1/organizations/${ORG_ID}/oauth2/token" \
+    "${CURL_HEADER_ARGS[@]}" \
     -u "${SLAS_CLIENT_ID}:${SLAS_SECRET}" \
     -d "grant_type=client_credentials&channel_id=${SITE_ID}")
 
@@ -220,6 +229,7 @@ echo ""
 echo "Step 8: Testing shopper product search..."
 
 SEARCH_RESPONSE=$(curl -s "${SLAS_BASE}/search/shopper-search/v1/organizations/${ORG_ID}/product-search?siteId=${SITE_ID}&limit=5&q=sample" \
+    "${CURL_HEADER_ARGS[@]}" \
     -H "Authorization: Bearer ${SHOPPER_TOKEN}")
 
 # Check if we got a valid response (should have a 'hits' array or 'total' field)
diff --git a/packages/b2c-tooling-sdk/src/cli/base-command.ts b/packages/b2c-tooling-sdk/src/cli/base-command.ts
@@ -14,7 +14,7 @@ import type {
 } from './hooks.js';
 import {setLanguage} from '../i18n/index.js';
 import {configureLogger, getLogger, type LogLevel, type Logger} from '../logging/index.js';
-import type {ExtraParamsConfig} from '../clients/middleware.js';
+import {createExtraParamsMiddleware, type ExtraParamsConfig} from '../clients/middleware.js';
 import type {ConfigSource} from '../config/types.js';
 import {globalMiddlewareRegistry} from '../clients/middleware-registry.js';
 
@@ -75,11 +75,19 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
     }),
     'extra-query': Flags.string({
       description: 'Extra query parameters as JSON (e.g., \'{"debug":"true"}\')',
+      env: 'SFCC_EXTRA_QUERY',
       helpGroup: 'GLOBAL',
       hidden: true,
     }),
     'extra-body': Flags.string({
       description: 'Extra body fields to merge as JSON (e.g., \'{"_internal":true}\')',
+      env: 'SFCC_EXTRA_BODY',
+      helpGroup: 'GLOBAL',
+      hidden: true,
+    }),
+    'extra-headers': Flags.string({
+      description: 'Extra HTTP headers as JSON (e.g., \'{"X-Custom-Header": "value"}\')',
+      env: 'SFCC_EXTRA_HEADERS',
       helpGroup: 'GLOBAL',
       hidden: true,
     }),
@@ -114,6 +122,10 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
 
     this.configureLogging();
 
+    // Register extra params middleware (from --extra-query, --extra-body, --extra-headers flags)
+    // This must happen before any API clients are created
+    this.registerExtraParamsMiddleware();
+
     // Collect middleware from plugins before any API clients are created
     await this.collectPluginHttpMiddleware();
 
@@ -307,16 +319,17 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
   }
 
   /**
-   * Parse extra params from --extra-query and --extra-body flags.
+   * Parse extra params from --extra-query, --extra-body, and --extra-headers flags.
    * Returns undefined if no extra params are specified.
    *
    * @returns ExtraParamsConfig or undefined
    */
   protected getExtraParams(): ExtraParamsConfig | undefined {
     const extraQuery = this.flags['extra-query'];
     const extraBody = this.flags['extra-body'];
+    const extraHeaders = this.flags['extra-headers'];
 
-    if (!extraQuery && !extraBody) {
+    if (!extraQuery && !extraBody && !extraHeaders) {
       return undefined;
     }
 
@@ -338,6 +351,30 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
       }
     }
 
+    if (extraHeaders) {
+      try {
+        config.headers = JSON.parse(extraHeaders) as Record<string, string>;
+      } catch {
+        this.error(`Invalid JSON for --extra-headers: ${extraHeaders}`);
+      }
+    }
+
     return config;
   }
+
+  /**
+   * Register extra params (query, body, headers) as global middleware.
+   * This applies to ALL HTTP clients created during command execution.
+   */
+  private registerExtraParamsMiddleware(): void {
+    const extraParams = this.getExtraParams();
+    if (!extraParams) return;
+
+    globalMiddlewareRegistry.register({
+      name: 'cli-extra-params',
+      getMiddleware() {
+        return createExtraParamsMiddleware(extraParams);
+      },
+    });
+  }
 }
diff --git a/packages/b2c-tooling-sdk/src/clients/middleware.ts b/packages/b2c-tooling-sdk/src/clients/middleware.ts
@@ -23,6 +23,8 @@ export interface ExtraParamsConfig {
   query?: Record<string, string | number | boolean | undefined>;
   /** Extra body fields to merge into JSON request bodies */
   body?: Record<string, unknown>;
+  /** Extra HTTP headers to add to all requests */
+  headers?: Record<string, string>;
 }
 
 /**
@@ -163,10 +165,14 @@ export function createLoggingMiddleware(config?: string | LoggingMiddlewareConfi
 
       const clonedResponse = response.clone();
       let responseBody: unknown;
+      // Read as text first, then try to parse as JSON.
+      // This avoids a bug where json() consumes the body stream even when parsing fails,
+      // making subsequent text() calls fail with "Body has already been read".
+      const text = await clonedResponse.text();
       try {
-        responseBody = await clonedResponse.json();
+        responseBody = JSON.parse(text);
       } catch {
-        responseBody = await clonedResponse.text();
+        responseBody = text;
       }
 
       // Mask sensitive/large body keys before logging
@@ -206,23 +212,40 @@ export function createExtraParamsMiddleware(config: ExtraParamsConfig): Middlewa
     async onRequest({request}) {
       let modifiedRequest = request;
 
+      // HTTP methods that don't allow a request body
+      const methodsWithoutBody = ['GET', 'HEAD'];
+      const canHaveBody = !methodsWithoutBody.includes(modifiedRequest.method.toUpperCase());
+
+      // Add extra headers first (before other modifications)
+      if (config.headers && Object.keys(config.headers).length > 0) {
+        const newHeaders = new Headers(modifiedRequest.headers);
+        for (const [key, value] of Object.entries(config.headers)) {
+          newHeaders.set(key, value);
+        }
+        logger.trace({extraHeaders: config.headers}, '[ExtraParams] Adding extra headers to request');
+        modifiedRequest = new Request(modifiedRequest.url, {
+          method: modifiedRequest.method,
+          headers: newHeaders,
+          ...(canHaveBody && modifiedRequest.body ? {body: modifiedRequest.body, duplex: 'half'} : {}),
+        } as RequestInit);
+      }
+
       // Add extra query parameters
       if (config.query && Object.keys(config.query).length > 0) {
-        const url = new URL(request.url);
+        const url = new URL(modifiedRequest.url);
         for (const [key, value] of Object.entries(config.query)) {
           if (value !== undefined) {
             url.searchParams.set(key, String(value));
           }
         }
         logger.trace(
-          {extraQuery: config.query, originalUrl: request.url, newUrl: url.toString()},
+          {extraQuery: config.query, originalUrl: modifiedRequest.url, newUrl: url.toString()},
           '[ExtraParams] Adding extra query params to URL',
         );
         modifiedRequest = new Request(url.toString(), {
-          method: request.method,
-          headers: request.headers,
-          body: request.body,
-          duplex: request.body ? 'half' : undefined,
+          method: modifiedRequest.method,
+          headers: modifiedRequest.headers,
+          ...(canHaveBody && modifiedRequest.body ? {body: modifiedRequest.body, duplex: 'half'} : {}),
         } as RequestInit);
       }
 
@@ -247,8 +270,8 @@ export function createExtraParamsMiddleware(config: ExtraParamsConfig): Middlewa
           } catch {
             logger.warn('[ExtraParams] Could not parse request body as JSON, skipping body merge');
           }
-        } else if (!modifiedRequest.body) {
-          // No existing body, create one with extra fields
+        } else if (!modifiedRequest.body && canHaveBody) {
+          // No existing body, create one with extra fields (only for methods that allow a body)
           logger.trace({body: config.body}, '[ExtraParams] Creating new body with extra fields');
           const headers = new Headers(modifiedRequest.headers);
           headers.set('content-type', 'application/json');
diff --git a/packages/b2c-tooling-sdk/test/cli/base-command.test.ts b/packages/b2c-tooling-sdk/test/cli/base-command.test.ts
diff --git a/packages/b2c-tooling-sdk/test/clients/middleware.test.ts b/packages/b2c-tooling-sdk/test/clients/middleware.test.ts
