@lwrjs/shared-utils 0.17.2-alpha.14 → 0.17.2-alpha.16

package/build/cjs/env.cjs

@@ -8,6 +8,9 @@ var __export = (target, all) => {
 // packages/@lwrjs/shared-utils/src/env.ts
 __markAsModule(exports);
 __export(exports, {
+  B3_PARENT_ID: () => B3_PARENT_ID,
+  B3_SAMPLED: () => B3_SAMPLED,
+  B3_SPAN_ID: () => B3_SPAN_ID,
   B3_TRACE_ID: () => B3_TRACE_ID,
   CORRELATION_ID: () => CORRELATION_ID,
   MRT_REQUEST_CLASS: () => MRT_REQUEST_CLASS,
@@ -16,6 +19,7 @@ __export(exports, {
   TRUE_CLIENT_IP: () => TRUE_CLIENT_IP,
   buildEnvironmentContext: () => buildEnvironmentContext,
   getFeatureFlags: () => getFeatureFlags,
+  getTraceHeaders: () => getTraceHeaders,
   isLambdaEnv: () => isLambdaEnv,
   isLocalDev: () => isLocalDev,
   parseRequestDepth: () => parseRequestDepth
@@ -31,6 +35,7 @@ function getFeatureFlags() {
     EXPERIMENTAL_UNVERSIONED_ALIASES: parseBooleanFlag("EXPERIMENTAL_UNVERSIONED_ALIASES"),
     LEGACY_LOADER: parseBooleanFlag("LEGACY_LOADER"),
     LWR_TRACING: parseTracingFlag(),
+    DISABLE_B3_TRACING: parseBooleanFlag("DISABLE_B3_TRACING"),
     MAX_VIEW_CACHE_TTL: parseStringFlag("MAX_VIEW_CACHE_TTL"),
     REEVALUATE_MODULES: parseBooleanFlag("REEVALUATE_MODULES"),
     SSR_COMPILER_ENABLED: parseBooleanFlag("SSR_COMPILER_ENABLED"),
@@ -69,8 +74,11 @@ function buildEnvironmentContext(runtimeParams) {
   };
 }
 var TRUE_CLIENT_IP = "true-client-ip";
-var B3_TRACE_ID = "x-b3-traceid";
 var CORRELATION_ID = "x-correlation-id";
+var B3_TRACE_ID = "x-b3-traceid";
+var B3_SPAN_ID = "x-b3-spandid";
+var B3_PARENT_ID = "x-b3-parentid";
+var B3_SAMPLED = "x-b3-sampled";
 var MRT_REQUEST_CLASS = "x-mobify-request-class";
 var ROUTE_CORE_HEADER = "x-sfdc-route-core";
 var REQUEST_DEPTH_HEADER = "x-sfdc-request-depth";
@@ -102,3 +110,21 @@ function parseRequestDepth(headers = {}, query = {}) {
   }
   return maxDepth;
 }
+function getTraceHeaders(runtimeParams, span) {
+  const headers = {};
+  if (runtimeParams.trueClientIP)
+    headers[TRUE_CLIENT_IP] = runtimeParams.trueClientIP;
+  if (runtimeParams.correlationID)
+    headers[CORRELATION_ID] = runtimeParams.correlationID;
+  if (!getFeatureFlags().DISABLE_B3_TRACING) {
+    if (span?.traceId) {
+      headers[B3_TRACE_ID] = span.traceId;
+      headers[B3_SAMPLED] = parseTracingFlag() ? "1" : "0";
+    }
+    if (span?.spanId)
+      headers[B3_SPAN_ID] = span.spanId;
+    if (span?.parentSpanId)
+      headers[B3_PARENT_ID] = span.parentSpanId;
+  }
+  return headers;
+}

package/build/cjs/serialize.cjs

@@ -24,11 +24,14 @@ var __toModule = (module2) => {
 // packages/@lwrjs/shared-utils/src/serialize.ts
 __markAsModule(exports);
 __export(exports, {
+  addHeadMarkup: () => addHeadMarkup,
+  createHeadMarkup: () => createHeadMarkup,
   replaceStringFromLocation: () => replaceStringFromLocation,
   serializeModuleToJson: () => serializeModuleToJson,
   shortestTtl: () => shortestTtl
 });
 var import_ms = __toModule(require("ms"));
+var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 async function createJsonModule(moduleId, moduleRegistry, runtimeEnvironment, runtimeParams) {
   const {
     ownHash,
@@ -84,3 +87,52 @@ function shortestTtl(newTtl, oldTtl, maxTtl) {
   }
   return shortest;
 }
+function createMetaTags(meta) {
+  return meta.reduce((metaStr, {name, content, httpEquiv}) => {
+    if (!name && !content && !httpEquiv)
+      return metaStr;
+    const nameStr = name ? ` name="${name}"` : "", httpEquivStr = httpEquiv ? ` http-equiv="${httpEquiv}"` : "", contentStr = content ? ` content="${content}"` : "";
+    return metaStr + `<meta${nameStr}${httpEquivStr}${contentStr}>
+`;
+  }, "");
+}
+function createScriptTags(scripts) {
+  return scripts.reduce((scriptStr, {body}) => scriptStr + `<script type="application/ld+json">${body}</script>
+`, "");
+}
+function createLinkTags(links) {
+  return links.reduce((linkStr, {href, rel, as, fetchpriority}) => {
+    const relStr = rel ? ` rel="${rel}"` : "", asStr = as ? ` as="${as}"` : "", fetchStr = fetchpriority ? ` fetchpriority="${fetchpriority}"` : "";
+    return linkStr + `<link href="${href}"${relStr}${asStr}${fetchStr}>
+`;
+  }, "");
+}
+function createStyleTags(styles) {
+  return styles.reduce((styleStr, {body, id}) => {
+    const idStr = id ? ` id="${id}"` : "";
+    return styleStr + `<style type="text/css"${idStr}>${body}</style>
+`;
+  }, "");
+}
+function createHeadMarkup(markup) {
+  let hasTitle = false;
+  return markup.reduce((str, {title, scripts = [], meta = [], links = [], styles = []} = {}) => {
+    if (title && !hasTitle) {
+      hasTitle = true;
+      str += `<title>${title}</title>
+`;
+    }
+    return str + createMetaTags(meta) + createScriptTags(scripts) + createLinkTags(links) + createStyleTags(styles);
+  }, "");
+}
+function addHeadMarkup(markup, stringBuilder) {
+  const headMarkup = createHeadMarkup(markup);
+  if (headMarkup) {
+    const headIndex = stringBuilder.original.indexOf("</head>");
+    if (headIndex >= 0) {
+      stringBuilder.prependLeft(headIndex, headMarkup);
+    } else {
+      import_diagnostics.logger.error("Adding head markup failed. Could not find the </head> tag.");
+    }
+  }
+}

package/build/es/env.d.ts

@@ -17,10 +17,18 @@ export declare function isLocalDev(): boolean;
  */
 export declare function buildEnvironmentContext(runtimeParams: RuntimeParams): EnvironmentContext;
 export declare const TRUE_CLIENT_IP = "true-client-ip";
-export declare const B3_TRACE_ID = "x-b3-traceid";
 export declare const CORRELATION_ID = "x-correlation-id";
+export declare const B3_TRACE_ID = "x-b3-traceid";
+export declare const B3_SPAN_ID = "x-b3-spandid";
+export declare const B3_PARENT_ID = "x-b3-parentid";
+export declare const B3_SAMPLED = "x-b3-sampled";
 export declare const MRT_REQUEST_CLASS = "x-mobify-request-class";
 export declare const ROUTE_CORE_HEADER = "x-sfdc-route-core";
 export declare const REQUEST_DEPTH_HEADER = "x-sfdc-request-depth";
 export declare function parseRequestDepth(headers?: Headers, query?: Record<string, string>): number;
+export declare function getTraceHeaders(runtimeParams: RuntimeParams, span?: {
+    traceId: string;
+    spanId: string;
+    parentSpanId?: string;
+}): HeadersInit;
 //# sourceMappingURL=env.d.ts.map

package/build/es/env.js

@@ -14,6 +14,8 @@ export function getFeatureFlags() {
         LEGACY_LOADER: parseBooleanFlag('LEGACY_LOADER'),
         // Enable metrics log level 'off', 'default' or 'verbose'
         LWR_TRACING: parseTracingFlag(),
+        // Turn off distributed tracing (B3 headers, traceparent meta tag, MRT span exporting)
+        DISABLE_B3_TRACING: parseBooleanFlag('DISABLE_B3_TRACING'),
         // Max size of ViewDefinition time to live
         MAX_VIEW_CACHE_TTL: parseStringFlag('MAX_VIEW_CACHE_TTL'),
         // Forces SSR to re-evaluate modules for every page render. By default, modules are evaluated only once.
@@ -91,8 +93,11 @@ export function buildEnvironmentContext(runtimeParams) {
 }
 // headers used by LWR-Node and LWR@MRT
 export const TRUE_CLIENT_IP = 'true-client-ip'; // public IP of the original request source, eg: 13.123.12.3
-export const B3_TRACE_ID = 'x-b3-traceid'; // trace ID shared across service boundaries for a page request, eg: 463ac35c9f6413ad48485a3953bb6124
 export const CORRELATION_ID = 'x-correlation-id'; // shared correlation ID for the request
+export const B3_TRACE_ID = 'x-b3-traceid'; // trace ID shared across service boundaries for a page request, set to inbound B3 header || lwr.handle.view trace ID
+export const B3_SPAN_ID = 'x-b3-spandid'; // span ID for a trace
+export const B3_PARENT_ID = 'x-b3-parentid'; // parent span ID for a trace
+export const B3_SAMPLED = 'x-b3-sampled'; // "0" = tracing is off, "1" = tracing is on
 export const MRT_REQUEST_CLASS = 'x-mobify-request-class'; // contains the site base path, eg: basePath=/mysite
 export const ROUTE_CORE_HEADER = 'x-sfdc-route-core'; // helps route requests to Core efficiently, value: true
 export const REQUEST_DEPTH_HEADER = 'x-sfdc-request-depth'; // tracks the request depth to prevent cycles to the LWR server, eg: 2
@@ -126,4 +131,22 @@ export function parseRequestDepth(headers = {}, query = {}) {
     }
     return maxDepth;
 }
+export function getTraceHeaders(runtimeParams, span) {
+    const headers = {};
+    if (runtimeParams.trueClientIP)
+        headers[TRUE_CLIENT_IP] = runtimeParams.trueClientIP;
+    if (runtimeParams.correlationID)
+        headers[CORRELATION_ID] = runtimeParams.correlationID;
+    if (!getFeatureFlags().DISABLE_B3_TRACING) {
+        if (span?.traceId) {
+            headers[B3_TRACE_ID] = span.traceId;
+            headers[B3_SAMPLED] = parseTracingFlag() ? '1' : '0';
+        }
+        if (span?.spanId)
+            headers[B3_SPAN_ID] = span.spanId;
+        if (span?.parentSpanId)
+            headers[B3_PARENT_ID] = span.parentSpanId;
+    }
+    return headers;
+}
 //# sourceMappingURL=env.js.map

package/build/es/serialize.d.ts

@@ -1,4 +1,4 @@
-import type { LinkedModuleDefinition, ModuleJsonDefinition, ModuleRegistry, RuntimeParams } from '@lwrjs/types';
+import type { HeadMarkup, LinkedModuleDefinition, LwrStringBuilder, ModuleJsonDefinition, ModuleRegistry, RuntimeParams } from '@lwrjs/types';
 /**
  * Take a Module Definition and return its JSON serialization
  *
@@ -26,4 +26,16 @@ export declare function replaceStringFromLocation(src: string, { startOffset, en
  * @returns - the shorter of the two TTLs IN SECONDS, undefined if both TTLs are missing
  */
 export declare function shortestTtl(newTtl?: string | number, oldTtl?: string | number, maxTtl?: string | number): number | undefined;
+/**
+ * Serialize head markup metadata into an HTML string
+ * @param markup An array of markup metadata objects
+ * @returns A string of HTML generated from markup metadata
+ */
+export declare function createHeadMarkup(markup: (HeadMarkup | undefined)[]): string;
+/**
+ * Serialize HeadMarkup config into HTML, then add it to the <head> of a base doc
+ * @param markup An array of markup metadata objects
+ * @param stringBuilder The string builder for a base document
+ */
+export declare function addHeadMarkup(markup: (HeadMarkup | undefined)[], stringBuilder: LwrStringBuilder): void;
 //# sourceMappingURL=serialize.d.ts.map

package/build/es/serialize.js

@@ -1,4 +1,5 @@
 import ms from 'ms';
+import { logger } from '@lwrjs/diagnostics';
 // Given a Module Identifier, return a JSON entry
 async function createJsonModule(moduleId, moduleRegistry, runtimeEnvironment, runtimeParams) {
     const { ownHash, moduleEntry: { version }, } = await moduleRegistry.getModule(moduleId, runtimeParams);
@@ -67,4 +68,69 @@ export function shortestTtl(newTtl, oldTtl, maxTtl) {
     }
     return shortest;
 }
+/** HEAD MARKUP UTILS */
+function createMetaTags(meta) {
+    return meta.reduce((metaStr, { name, content, httpEquiv }) => {
+        if (!name && !content && !httpEquiv)
+            return metaStr; // do not create empty <meta> tags
+        const nameStr = name ? ` name="${name}"` : '', httpEquivStr = httpEquiv ? ` http-equiv="${httpEquiv}"` : '', contentStr = content ? ` content="${content}"` : '';
+        return metaStr + `<meta${nameStr}${httpEquivStr}${contentStr}>\n`;
+    }, '');
+}
+function createScriptTags(scripts) {
+    return scripts.reduce((scriptStr, { body }) => scriptStr + `<script type="application/ld+json">${body}</script>\n`, '');
+}
+function createLinkTags(links) {
+    return links.reduce((linkStr, { href, rel, as, fetchpriority }) => {
+        const relStr = rel ? ` rel="${rel}"` : '', asStr = as ? ` as="${as}"` : '', fetchStr = fetchpriority ? ` fetchpriority="${fetchpriority}"` : '';
+        return linkStr + `<link href="${href}"${relStr}${asStr}${fetchStr}>\n`;
+    }, '');
+}
+function createStyleTags(styles) {
+    return styles.reduce((styleStr, { body, id }) => {
+        const idStr = id ? ` id="${id}"` : '';
+        return styleStr + `<style type="text/css"${idStr}>${body}</style>\n`;
+    }, '');
+}
+/**
+ * Serialize head markup metadata into an HTML string
+ * @param markup An array of markup metadata objects
+ * @returns A string of HTML generated from markup metadata
+ */
+export function createHeadMarkup(markup) {
+    // Loop through the <title>, <script>, <meta>, and <link> tag information
+    // Create an HTML string for each tag
+    let hasTitle = false;
+    return markup.reduce((str, { title, scripts = [], meta = [], links = [], styles = [] } = {}) => {
+        if (title && !hasTitle) {
+            // first <title> wins
+            hasTitle = true;
+            str += `<title>${title}</title>\n`;
+        }
+        return (str +
+            createMetaTags(meta) +
+            createScriptTags(scripts) +
+            createLinkTags(links) +
+            createStyleTags(styles));
+    }, '');
+}
+/**
+ * Serialize HeadMarkup config into HTML, then add it to the <head> of a base doc
+ * @param markup An array of markup metadata objects
+ * @param stringBuilder The string builder for a base document
+ */
+export function addHeadMarkup(markup, stringBuilder) {
+    // Create HTML tags for each item in the SsrDataResponse.markup bag
+    const headMarkup = createHeadMarkup(markup);
+    if (headMarkup) {
+        // Add all the links to the <head> section of the base document
+        const headIndex = stringBuilder.original.indexOf('</head>');
+        if (headIndex >= 0) {
+            stringBuilder.prependLeft(headIndex, headMarkup);
+        }
+        else {
+            logger.error('Adding head markup failed. Could not find the </head> tag.');
+        }
+    }
+}
 //# sourceMappingURL=serialize.js.map

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.17.2-alpha.14",
+    "version": "0.17.2-alpha.16",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -37,7 +37,7 @@
         "build/**/*.d.ts"
     ],
     "dependencies": {
-        "@lwrjs/diagnostics": "0.17.2-alpha.14",
+        "@lwrjs/diagnostics": "0.17.2-alpha.16",
         "es-module-lexer": "^1.5.4",
         "fast-json-stable-stringify": "^2.1.0",
         "magic-string": "^0.30.9",
@@ -50,7 +50,7 @@
         "slugify": "^1.4.5"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.17.2-alpha.14",
+        "@lwrjs/types": "0.17.2-alpha.16",
         "@types/mime-types": "2.1.4",
         "@types/path-to-regexp": "^1.7.0",
         "memfs": "^4.13.0"
@@ -58,5 +58,5 @@
     "engines": {
         "node": ">=20.0.0"
     },
-    "gitHead": "a7d6d67f5453787a8b2428bd11546c334af3f77b"
+    "gitHead": "5a6b24c265145652f9dda60d1d2cb405148c71f3"
 }