@decocms/apps-salesforce 7.31.6 → 7.32.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decocms/apps-salesforce",
-  "version": "7.31.6",
+  "version": "7.32.0",
   "type": "module",
   "description": "Deco commerce app: Salesforce Commerce Cloud integration",
   "repository": {
@@ -22,8 +22,8 @@
     "lint:unused": "knip"
   },
   "dependencies": {
-    "@decocms/blocks": "7.31.6",
-    "@decocms/apps-commerce": "7.31.6"
+    "@decocms/blocks": "7.32.0",
+    "@decocms/apps-commerce": "7.32.0"
   },
   "peerDependencies": {
     "@tanstack/react-start": ">=1.0.0",

package/src/index.ts

@@ -25,6 +25,10 @@ export type {
 	SalesforceProduct,
 } from "./types";
 export { createHttpClient, type HttpClientOptions } from "./utils/httpClient";
+export {
+	type CreateSalesforceFetchOptions,
+	createSalesforceFetch,
+} from "./utils/instrumentedFetch";
 export { parseUserCookie } from "./utils/parseUserCookie";
 export {
 	createProductTransformer,

package/src/utils/httpClient.ts

@@ -16,6 +16,8 @@
  * loaders that call `.then(res => res.json())` keep working).
  */
 
+import { createSalesforceFetch } from "./instrumentedFetch";
+
 export interface HttpClientOptions {
 	base: string;
 	headers?: Record<string, string> | Headers;
@@ -29,9 +31,22 @@ interface IndexedRouteResponse {
 	headers: Headers;
 }
 
+// Lazily-created, module-shared instrumented fetch used as the default
+// transport. Every Salesforce loader instantiates its own `createHttpClient`
+// inline, so defaulting the `fetcher` here is the single chokepoint that
+// instruments ALL Salesforce egress (upstream latency/status → ClickHouse,
+// `provider:"salesforce"`) without touching each loader. Sites that pass an
+// explicit `fetcher` opt out; wrap it with `createSalesforceFetch({ baseFetch })`
+// to keep instrumentation.
+let _defaultFetch: typeof fetch | undefined;
+function defaultInstrumentedFetch(): typeof fetch {
+	if (!_defaultFetch) _defaultFetch = createSalesforceFetch();
+	return _defaultFetch;
+}
+
 export function createHttpClient<_Routes = unknown>(options: HttpClientOptions) {
 	const base = options.base.replace(/\/$/, "");
-	const fetchImpl = options.fetcher ?? fetch;
+	const fetchImpl = options.fetcher ?? defaultInstrumentedFetch();
 	const defaultHeaders: Record<string, string> =
 		options.headers instanceof Headers
 			? Object.fromEntries(options.headers.entries())

package/src/utils/instrumentedFetch.ts

@@ -0,0 +1,41 @@
+/**
+ * Pre-wired instrumented fetch factory for Salesforce Commerce Cloud.
+ *
+ * Mirrors `vtex` / `shopify` / `magento`. Bundles `createInstrumentedFetch`
+ * (spans, traceparent, URL redaction), the `salesforceOperationRouter`, and an
+ * `onComplete` that records `http.client.request.duration` with
+ * `provider: "salesforce"`.
+ *
+ * Salesforce has no module-global `_fetch`; instead `createHttpClient` defaults
+ * its `fetcher` to {@link createSalesforceFetch}, so EVERY loader's egress is
+ * instrumented automatically without per-loader wiring. Sites can still pass an
+ * explicit `fetcher` to `createHttpClient` (e.g. for cookie passthrough) — wrap
+ * it with `createSalesforceFetch({ baseFetch })` to keep the instrumentation.
+ */
+
+import {
+  createInstrumentedFetch,
+  type InstrumentedFetch,
+} from "@decocms/blocks/sdk/instrumentedFetch";
+import { recordCommerceMetric, statusClassFor } from "@decocms/blocks/sdk/observability";
+import { salesforceOperationRouter } from "./operationRouter";
+
+export interface CreateSalesforceFetchOptions {
+  /** Underlying fetch to wrap. Defaults to `globalThis.fetch`. */
+  baseFetch?: typeof fetch;
+  /** Disable the histogram (spans + logs still emit). Default: false. */
+  disableHistogram?: boolean;
+}
+
+export function createSalesforceFetch(
+  options: CreateSalesforceFetchOptions = {},
+): InstrumentedFetch {
+  const { baseFetch, disableHistogram = false } = options;
+  return createInstrumentedFetch({
+    name: "salesforce",
+    baseFetch,
+    resolveOperation: salesforceOperationRouter,
+    onComplete: disableHistogram ? undefined : (r) =>
+      recordCommerceMetric(r.durationMs, { provider: "salesforce", operation: r.operation, status_class: statusClassFor(r.status), cached: r.cached }),
+  });
+}

package/src/utils/operationRouter.ts

@@ -0,0 +1,25 @@
+/**
+ * URL-derived operation name router for Salesforce Commerce Cloud calls.
+ *
+ * Plugged into `@decocms/blocks/sdk/instrumentedFetch`'s `resolveOperation`.
+ * SFCC's OCAPI/SCAPI surface is wide; naming by the first meaningful path
+ * segment keeps the histogram label low-cardinality without hand-listing every
+ * endpoint. Returns `undefined` when nothing meaningful is found, so the
+ * framework falls back to `salesforce.fetch`.
+ */
+
+import { extractPathname } from "@decocms/blocks/sdk/urlUtils";
+
+export function salesforceOperationRouter(url: string, _method: string): string | undefined {
+  const pathname = extractPathname(url);
+
+  // SCAPI: /shopper/<api>/v1/... ; OCAPI: /s/<site>/dw/shop/<version>/<resource>/...
+  const scapi = pathname.match(/\/shopper\/([^/]+)/);
+  if (scapi) return `scapi.${scapi[1]}`;
+  const ocapi = pathname.match(/\/dw\/(?:shop|data)\/[^/]+\/([^/?#]+)/);
+  if (ocapi) return `ocapi.${ocapi[1]}`;
+
+  // Fallback: first non-empty path segment.
+  const seg = pathname.split("/").find(Boolean);
+  return seg ? `path.${seg}` : undefined;
+}