@bleedingdev/modern-js-bff-effect 3.9.3-ultramodern.2 → 3.9.3-ultramodern.3

package/dist/cjs/effect-client/index.js

@@ -91,12 +91,48 @@ function runEffectView(request, selection) {
         request.then((value)=>resolve(mask(value, selection)), (reason)=>reject(reason));
     });
 }
+const operationContextStringFields = [
+    'requestId',
+    'operationId',
+    'routePath',
+    'method',
+    'schemaHash',
+    'traceparent',
+    'traceId',
+    'spanId'
+];
+function operationContextHeaders(context) {
+    if (void 0 === context) return {};
+    const detail = {};
+    for (const field of operationContextStringFields){
+        const value = context[field];
+        if ('string' == typeof value && value.length > 0) detail[field] = value;
+    }
+    if ('number' == typeof context.operationVersion) detail.operationVersion = context.operationVersion;
+    if (0 === Object.keys(detail).length) return {};
+    return {
+        ...'string' == typeof detail.operationId ? {
+            [request_context_namespaceObject.BFF_OPERATION_CONTEXT_HEADER]: detail.operationId
+        } : {},
+        [request_context_namespaceObject.BFF_OPERATION_CONTEXT_DETAIL_HEADER]: JSON.stringify(detail)
+    };
+}
 function makeEffectHttpApiClient(api, options) {
-    const requestContextHeaders = (0, request_context_namespaceObject.createRequestContextHeaders)(options?.requestContext);
+    const requestContext = (0, request_context_namespaceObject.createRequestContextSnapshot)(options?.requestContext);
+    const defaultHeaders = {
+        ...Object.fromEntries(Object.entries(options?.headers ?? {}).flatMap(([header, value])=>void 0 === value ? [] : [
+                [
+                    header.toLowerCase(),
+                    value
+                ]
+            ])),
+        ...requestContext.headers,
+        ...operationContextHeaders(requestContext.operationContext)
+    };
     const transformClient = (client)=>{
-        const contextClient = 0 === Object.keys(requestContextHeaders).length ? client : client.pipe(http_namespaceObject.HttpClient.mapRequest((request)=>{
+        const contextClient = 0 === Object.keys(defaultHeaders).length ? client : client.pipe(http_namespaceObject.HttpClient.mapRequest((request)=>{
             let nextRequest = request;
-            for (const [header, value] of Object.entries(requestContextHeaders))if (void 0 === nextRequest.headers[header.toLowerCase()]) nextRequest = http_namespaceObject.HttpClientRequest.setHeader(nextRequest, header, value);
+            for (const [header, value] of Object.entries(defaultHeaders))if (void 0 === nextRequest.headers[header.toLowerCase()]) nextRequest = http_namespaceObject.HttpClientRequest.setHeader(nextRequest, header, value);
             return nextRequest;
         }));
         const policyClient = options?.crossProject !== void 0 ? (0, external_cross_project_js_namespaceObject.withCrossProjectPolicy)(api, options.crossProject, contextClient) : contextClient;

package/dist/esm/effect-client/index.mjs

@@ -1,4 +1,4 @@
-import { createRequestContextHeaders } from "@modern-js/runtime-extensions/request-context";
+import { BFF_OPERATION_CONTEXT_DETAIL_HEADER, BFF_OPERATION_CONTEXT_HEADER, createRequestContextSnapshot } from "@modern-js/runtime-extensions/request-context";
 import * as __rspack_external_effect_Effect_41060786 from "effect/Effect";
 import { FetchHttpClient, HttpClient, HttpClientRequest } from "effect/http";
 import { HttpApi, HttpApiClient, HttpApiEndpoint, HttpApiGroup, HttpApiSchema } from "effect/http-api";
@@ -39,12 +39,48 @@ function runEffectView(request, selection) {
         request.then((value)=>resolve(mask(value, selection)), (reason)=>reject(reason));
     });
 }
+const operationContextStringFields = [
+    'requestId',
+    'operationId',
+    'routePath',
+    'method',
+    'schemaHash',
+    'traceparent',
+    'traceId',
+    'spanId'
+];
+function operationContextHeaders(context) {
+    if (void 0 === context) return {};
+    const detail = {};
+    for (const field of operationContextStringFields){
+        const value = context[field];
+        if ('string' == typeof value && value.length > 0) detail[field] = value;
+    }
+    if ('number' == typeof context.operationVersion) detail.operationVersion = context.operationVersion;
+    if (0 === Object.keys(detail).length) return {};
+    return {
+        ...'string' == typeof detail.operationId ? {
+            [BFF_OPERATION_CONTEXT_HEADER]: detail.operationId
+        } : {},
+        [BFF_OPERATION_CONTEXT_DETAIL_HEADER]: JSON.stringify(detail)
+    };
+}
 function makeEffectHttpApiClient(api, options) {
-    const requestContextHeaders = createRequestContextHeaders(options?.requestContext);
+    const requestContext = createRequestContextSnapshot(options?.requestContext);
+    const defaultHeaders = {
+        ...Object.fromEntries(Object.entries(options?.headers ?? {}).flatMap(([header, value])=>void 0 === value ? [] : [
+                [
+                    header.toLowerCase(),
+                    value
+                ]
+            ])),
+        ...requestContext.headers,
+        ...operationContextHeaders(requestContext.operationContext)
+    };
     const transformClient = (client)=>{
-        const contextClient = 0 === Object.keys(requestContextHeaders).length ? client : client.pipe(HttpClient.mapRequest((request)=>{
+        const contextClient = 0 === Object.keys(defaultHeaders).length ? client : client.pipe(HttpClient.mapRequest((request)=>{
             let nextRequest = request;
-            for (const [header, value] of Object.entries(requestContextHeaders))if (void 0 === nextRequest.headers[header.toLowerCase()]) nextRequest = HttpClientRequest.setHeader(nextRequest, header, value);
+            for (const [header, value] of Object.entries(defaultHeaders))if (void 0 === nextRequest.headers[header.toLowerCase()]) nextRequest = HttpClientRequest.setHeader(nextRequest, header, value);
             return nextRequest;
         }));
         const policyClient = options?.crossProject !== void 0 ? withCrossProjectPolicy(api, options.crossProject, contextClient) : contextClient;

package/dist/esm-node/effect-client/index.mjs

@@ -1,5 +1,5 @@
 import "node:module";
-import { createRequestContextHeaders } from "@modern-js/runtime-extensions/request-context";
+import { BFF_OPERATION_CONTEXT_DETAIL_HEADER, BFF_OPERATION_CONTEXT_HEADER, createRequestContextSnapshot } from "@modern-js/runtime-extensions/request-context";
 import * as __rspack_external_effect_Effect_41060786 from "effect/Effect";
 import { FetchHttpClient, HttpClient, HttpClientRequest } from "effect/http";
 import { HttpApi, HttpApiClient, HttpApiEndpoint, HttpApiGroup, HttpApiSchema } from "effect/http-api";
@@ -40,12 +40,48 @@ function runEffectView(request, selection) {
         request.then((value)=>resolve(mask(value, selection)), (reason)=>reject(reason));
     });
 }
+const operationContextStringFields = [
+    'requestId',
+    'operationId',
+    'routePath',
+    'method',
+    'schemaHash',
+    'traceparent',
+    'traceId',
+    'spanId'
+];
+function operationContextHeaders(context) {
+    if (void 0 === context) return {};
+    const detail = {};
+    for (const field of operationContextStringFields){
+        const value = context[field];
+        if ('string' == typeof value && value.length > 0) detail[field] = value;
+    }
+    if ('number' == typeof context.operationVersion) detail.operationVersion = context.operationVersion;
+    if (0 === Object.keys(detail).length) return {};
+    return {
+        ...'string' == typeof detail.operationId ? {
+            [BFF_OPERATION_CONTEXT_HEADER]: detail.operationId
+        } : {},
+        [BFF_OPERATION_CONTEXT_DETAIL_HEADER]: JSON.stringify(detail)
+    };
+}
 function makeEffectHttpApiClient(api, options) {
-    const requestContextHeaders = createRequestContextHeaders(options?.requestContext);
+    const requestContext = createRequestContextSnapshot(options?.requestContext);
+    const defaultHeaders = {
+        ...Object.fromEntries(Object.entries(options?.headers ?? {}).flatMap(([header, value])=>void 0 === value ? [] : [
+                [
+                    header.toLowerCase(),
+                    value
+                ]
+            ])),
+        ...requestContext.headers,
+        ...operationContextHeaders(requestContext.operationContext)
+    };
     const transformClient = (client)=>{
-        const contextClient = 0 === Object.keys(requestContextHeaders).length ? client : client.pipe(HttpClient.mapRequest((request)=>{
+        const contextClient = 0 === Object.keys(defaultHeaders).length ? client : client.pipe(HttpClient.mapRequest((request)=>{
             let nextRequest = request;
-            for (const [header, value] of Object.entries(requestContextHeaders))if (void 0 === nextRequest.headers[header.toLowerCase()]) nextRequest = HttpClientRequest.setHeader(nextRequest, header, value);
+            for (const [header, value] of Object.entries(defaultHeaders))if (void 0 === nextRequest.headers[header.toLowerCase()]) nextRequest = HttpClientRequest.setHeader(nextRequest, header, value);
             return nextRequest;
         }));
         const policyClient = options?.crossProject !== void 0 ? withCrossProjectPolicy(api, options.crossProject, contextClient) : contextClient;

package/dist/types/effect-client/index.d.ts

@@ -14,6 +14,13 @@ export { HttpApi, HttpApiClient, HttpApiEndpoint, HttpApiGroup, HttpApiSchema, R
 export type EffectHttpApiClientOptions = {
     crossProject?: EffectCrossProjectClientOptions;
     baseUrl?: URL | string;
+    /** Headers for every request. A header the request already sets wins; undefined values are skipped. */
+    headers?: Readonly<Record<string, string | undefined>>;
+    /**
+     * Locale, trace and operation context for every request. An
+     * `operationContext` is sent as `x-operation-id` plus the
+     * `x-modernjs-bff-operation-context` detail the Effect BFF server reads.
+     */
     requestContext?: RequestContextInput;
     transformClient?: (client: HttpClient.HttpClient) => HttpClient.HttpClient;
     transformResponse?: ((effect: Effect.Effect<unknown, unknown, unknown>) => Effect.Effect<unknown, unknown, unknown>) | undefined;

package/package.json

@@ -18,7 +18,7 @@
     "modern.js",
     "ultramodern.js"
   ],
-  "version": "3.9.3-ultramodern.2",
+  "version": "3.9.3-ultramodern.3",
   "files": [
     "dist",
     "src"
@@ -121,10 +121,10 @@
     "node": ">=26.10.0"
   },
   "dependencies": {
-    "@modern-js/bff-core": "npm:@bleedingdev/modern-js-bff-core@3.9.3-ultramodern.2",
-    "@modern-js/create-request": "npm:@bleedingdev/modern-js-create-request@3.9.3-ultramodern.2",
-    "@modern-js/runtime-extensions": "npm:@bleedingdev/modern-js-runtime-extensions@3.9.3-ultramodern.2",
-    "@modern-js/server-runtime-extensions": "npm:@bleedingdev/modern-js-server-runtime-extensions@3.9.3-ultramodern.2",
+    "@modern-js/bff-core": "npm:@bleedingdev/modern-js-bff-core@3.9.3-ultramodern.3",
+    "@modern-js/create-request": "npm:@bleedingdev/modern-js-create-request@3.9.3-ultramodern.3",
+    "@modern-js/runtime-extensions": "npm:@bleedingdev/modern-js-runtime-extensions@3.9.3-ultramodern.3",
+    "@modern-js/server-runtime-extensions": "npm:@bleedingdev/modern-js-server-runtime-extensions@3.9.3-ultramodern.3",
     "@opentelemetry/api": "1.9.1",
     "@opentelemetry/api-logs": "0.222.0",
     "@opentelemetry/resources": "2.11.0",

package/src/effect-client/index.ts

@@ -1,6 +1,9 @@
 // @effect-diagnostics anyUnknownInErrorContext:off asyncFunction:off newPromise:off strictEffectProvide:off
 import {
-  createRequestContextHeaders,
+  BFF_OPERATION_CONTEXT_DETAIL_HEADER,
+  BFF_OPERATION_CONTEXT_HEADER,
+  createRequestContextSnapshot,
+  type OperationContext,
   type RequestContextInput,
 } from '@modern-js/runtime-extensions/request-context';
 import * as Data from 'effect/Data';
@@ -53,6 +56,13 @@ export {
 export type EffectHttpApiClientOptions = {
   crossProject?: EffectCrossProjectClientOptions;
   baseUrl?: URL | string;
+  /** Headers for every request. A header the request already sets wins; undefined values are skipped. */
+  headers?: Readonly<Record<string, string | undefined>>;
+  /**
+   * Locale, trace and operation context for every request. An
+   * `operationContext` is sent as `x-operation-id` plus the
+   * `x-modernjs-bff-operation-context` detail the Effect BFF server reads.
+   */
   requestContext?: RequestContextInput;
   transformClient?: (client: HttpClient.HttpClient) => HttpClient.HttpClient;
   transformResponse?:
@@ -199,6 +209,45 @@ export function runEffectView<
   });
 }
 
+const operationContextStringFields = [
+  'requestId',
+  'operationId',
+  'routePath',
+  'method',
+  'schemaHash',
+  'traceparent',
+  'traceId',
+  'spanId',
+] as const;
+
+/** The operation headers the server reads; scope, claims and attributes stay local. */
+function operationContextHeaders(
+  context: OperationContext | undefined,
+): Record<string, string> {
+  if (context === undefined) {
+    return {};
+  }
+  const detail: Record<string, string | number> = {};
+  for (const field of operationContextStringFields) {
+    const value = context[field];
+    if (typeof value === 'string' && value.length > 0) {
+      detail[field] = value;
+    }
+  }
+  if (typeof context.operationVersion === 'number') {
+    detail.operationVersion = context.operationVersion;
+  }
+  if (Object.keys(detail).length === 0) {
+    return {};
+  }
+  return {
+    ...(typeof detail.operationId === 'string'
+      ? { [BFF_OPERATION_CONTEXT_HEADER]: detail.operationId }
+      : {}),
+    [BFF_OPERATION_CONTEXT_DETAIL_HEADER]: JSON.stringify(detail),
+  };
+}
+
 export function makeEffectHttpApiClient<
   ApiId extends string,
   Groups extends HttpApiGroup.Constraint,
@@ -210,19 +259,25 @@ export function makeEffectHttpApiClient<
   never,
   HttpApiGroup.MiddlewareClient<Groups>
 > {
-  const requestContextHeaders = createRequestContextHeaders(
-    options?.requestContext,
-  );
+  const requestContext = createRequestContextSnapshot(options?.requestContext);
+  // Request-context headers are more specific than the generic headers.
+  const defaultHeaders: Record<string, string> = {
+    ...Object.fromEntries(
+      Object.entries(options?.headers ?? {}).flatMap(([header, value]) =>
+        value === undefined ? [] : [[header.toLowerCase(), value]],
+      ),
+    ),
+    ...requestContext.headers,
+    ...operationContextHeaders(requestContext.operationContext),
+  };
   const transformClient = (client: HttpClient.HttpClient) => {
     const contextClient =
-      Object.keys(requestContextHeaders).length === 0
+      Object.keys(defaultHeaders).length === 0
         ? client
         : client.pipe(
             HttpClient.mapRequest(request => {
               let nextRequest = request;
-              for (const [header, value] of Object.entries(
-                requestContextHeaders,
-              )) {
+              for (const [header, value] of Object.entries(defaultHeaders)) {
                 if (nextRequest.headers[header.toLowerCase()] === undefined) {
                   nextRequest = HttpClientRequest.setHeader(
                     nextRequest,