@equinor/fusion-framework-vite-plugin-spa 5.1.0 → 5.2.2

package/README.md

@@ -345,6 +345,15 @@ FUSION_SPA_TELEMETRY_CONSOLE_LEVEL=2  # Warning and above
 
 For advanced telemetry (e.g. Application Insights), provide a [custom bootstrap file](#providing-custom-bootstrap).
 
+When used by `@equinor/fusion-framework-dev-server`, the default bootstrap also supports
+OTLP logs through the telemetry module's public `OtlpAdapter`, plus standard OpenTelemetry
+browser request tracing and W3C propagation. Set
+`FUSION_DEV_SERVER_OTLP_ENDPOINT` in the app's dev-server process; no app code change is required.
+The dev server owns the environment bridge and same-origin collection route. The bootstrap
+checks only whether an endpoint is configured; the serve-only dev-server bridge controls
+activation. Explicitly configured app adapters and existing global tracer providers take
+precedence. See [dev-server telemetry configuration](../../dev-server/docs/configuration.md#send-telemetry-to-an-otlp-endpoint).
+
 ## Configuring through `.env` Files
 
 The plugin reads environment variables from `.env` files (via Vite's `loadEnv`) and **merges them on top of** values from `generateTemplateEnv`. This lets you keep secrets and per-environment values out of source code.
@@ -392,7 +401,7 @@ FUSION_SPA_MSAL_TENANT_ID=my-tenant-id
 FUSION_SPA_MSAL_CLIENT_ID=my-client-id
 FUSION_SPA_MSAL_REDIRECT_URI=https://my-app.com/auth-callback
 FUSION_SPA_MSAL_REQUIRES_AUTH=true
-# Set to skip Entra ID and sign in a mock user instead — for CI/Playwright runs
+# Set to skip Entra ID and sign in a mock user instead — use together with a mock server (see below)
 FUSION_SPA_MSAL_MOCK=true
 # Optional: standalone mock-server origin used for session-scoped token acquisition
 FUSION_SPA_MSAL_MOCK_SERVER_URL=http://localhost:4010
@@ -412,15 +421,30 @@ FUSION_SPA_SERVICE_WORKER_RESOURCES=[{"url":"/app-proxy","rewrite":"/@fusion-api
 
 ## Running Against a Mock Client (CI / Playwright)
 
+Run CI and Playwright suites against the standalone mock server, so both authentication and
+service discovery stay local:
+
+```sh
+ffc mock-server ./mocks --port 4010
+ffc app dev --mock http://localhost:4010
+```
+
 Setting `FUSION_SPA_MSAL_MOCK=true` swaps the real MSAL client for
 `@equinor/fusion-framework-module-msal/mock`, which signs in a default mock user with no
-Entra ID redirects, popups, or network calls. This is the recommended way to run the dev
-server headlessly in GitHub Actions or a Playwright suite.
+Entra ID redirects or popups. Mock tokens are unsigned, so real Fusion services reject them.
+`ffc app dev` and `ffc app serve` therefore also send service discovery to the mock server
+whenever mock auth is on — `FUSION_SPA_MSAL_MOCK_SERVER_URL`, or `http://localhost:4010` when
+only `FUSION_SPA_MSAL_MOCK` is set.
 
 ```sh
 FUSION_SPA_MSAL_MOCK=true
 ```
 
+> [!IMPORTANT]
+> A direct Vite setup must point `FUSION_SPA_SERVICE_DISCOVERY_URL` (or the dev server's
+> service discovery URL) at the mock server too. Otherwise every page load sends a mock token
+> to real service discovery and fails with `401`.
+
 By default the mock signs in a generic `Test User`. To select and switch users at runtime, start
 the standalone mock server with the browser origin explicitly allowed, then point the app at it:
 

package/dist/TelemetryAdapter-B6JH_RXA.js

@@ -0,0 +1,91 @@
+/**
+ * Abstract base class for telemetry adapters.
+ *
+ * Provides a common implementation for filtering telemetry items before processing.
+ * Subclasses must implement the `_processItem` method to define how telemetry items are handled.
+ *
+ * @template TelemetryItem - The type representing a telemetry item.
+ * @implements {ITelemetryAdapter}
+ *
+ * @remarks
+ * - An optional filter function can be provided to determine which telemetry items should be processed.
+ *
+ * @example
+ * class MyTelemetryAdapter extends BaseTelemetryAdapter {
+ *   protected _processItem(item: TelemetryItem): void {
+ *     // Custom processing logic
+ *   }
+ * }
+ */
+class BaseTelemetryAdapter {
+    #filter;
+    #initialized = false;
+    /**
+     * Creates a new instance of the TelemetryAdapter.
+     *
+     * @param filter - An optional function to filter telemetry items. If provided, only items for which the function returns true will be processed.
+     */
+    constructor(filter) {
+        this.#filter = filter;
+    }
+    /**
+     * Processes a telemetry item by applying an optional filter before handling it.
+     *
+     * If a filter is defined and the item does not pass the filter, the method returns early.
+     * Otherwise, it delegates the processing of the item to the internal `_processItem` method.
+     *
+     * @param item - The telemetry item to be processed.
+     */
+    processItem(item) {
+        // If the adapter is not initialized, do not process the item
+        if (!this.#initialized) {
+            return;
+        }
+        // If a filter is defined and the item does not pass the filter, do not process the item
+        if (this.#filter && !this.#filter(item)) {
+            return;
+        }
+        // Delegate the processing of the item to the internal `_processItem` method
+        this._processItem(item);
+    }
+    /**
+     * Initializes the telemetry adapter asynchronously.
+     *
+     * This method can only be called once. Subsequent calls will return immediately
+     * without performing any initialization. It calls the protected `_initialize` method which
+     * subclasses can override to provide custom initialization logic.
+     *
+     * TODO(#5112): Consider changing return type from Promise<void> to Promise<TelemetryItem[]>
+     * to allow adapters to return telemetry items (errors/warnings) that occurred during
+     * initialization, eliminating the chicken-and-egg problem with reporting init errors.
+     *
+     * @returns A promise that resolves when initialization is complete.
+     * @sealed
+     */
+    async initialize() {
+        // If the adapter is already initialized, do not initialize it again
+        if (this.#initialized) {
+            return;
+        }
+        // Initialize the adapter
+        await this._initialize();
+        // Mark the adapter as initialized
+        this.#initialized = true;
+    }
+    /**
+     * Protected initialization method that subclasses can override.
+     *
+     * This method is called only once during the adapter's lifetime.
+     * Subclasses should override this method to perform any necessary async setup.
+     * The base implementation is a no-op for adapters that don't need initialization.
+     *
+     * @returns A promise that resolves when initialization is complete.
+     * @protected
+     */
+    async _initialize() {
+        // Default implementation - no-op for adapters that don't need initialization
+    }
+}
+
+export { BaseTelemetryAdapter as B };
+//# sourceMappingURL=TelemetryAdapter-B6JH_RXA.js.map

package/dist/TelemetryAdapter-B6JH_RXA.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TelemetryAdapter-B6JH_RXA.js","sources":["../../../modules/telemetry/dist/esm/TelemetryAdapter.js"],"sourcesContent":["/**\n * Abstract base class for telemetry adapters.\n *\n * Provides a common implementation for filtering telemetry items before processing.\n * Subclasses must implement the `_processItem` method to define how telemetry items are handled.\n *\n * @template TelemetryItem - The type representing a telemetry item.\n * @implements {ITelemetryAdapter}\n *\n * @remarks\n * - An optional filter function can be provided to determine which telemetry items should be processed.\n *\n * @example\n * class MyTelemetryAdapter extends BaseTelemetryAdapter {\n *   protected _processItem(item: TelemetryItem): void {\n *     // Custom processing logic\n *   }\n * }\n */\nexport class BaseTelemetryAdapter {\n    #filter;\n    #initialized = false;\n    /**\n     * Creates a new instance of the TelemetryAdapter.\n     *\n     * @param filter - An optional function to filter telemetry items. If provided, only items for which the function returns true will be processed.\n     */\n    constructor(filter) {\n        this.#filter = filter;\n    }\n    /**\n     * Processes a telemetry item by applying an optional filter before handling it.\n     *\n     * If a filter is defined and the item does not pass the filter, the method returns early.\n     * Otherwise, it delegates the processing of the item to the internal `_processItem` method.\n     *\n     * @param item - The telemetry item to be processed.\n     */\n    processItem(item) {\n        // If the adapter is not initialized, do not process the item\n        if (!this.#initialized) {\n            return;\n        }\n        // If a filter is defined and the item does not pass the filter, do not process the item\n        if (this.#filter && !this.#filter(item)) {\n            return;\n        }\n        // Delegate the processing of the item to the internal `_processItem` method\n        this._processItem(item);\n    }\n    /**\n     * Initializes the telemetry adapter asynchronously.\n     *\n     * This method can only be called once. Subsequent calls will return immediately\n     * without performing any initialization. It calls the protected `_initialize` method which\n     * subclasses can override to provide custom initialization logic.\n     *\n     * TODO(#5112): Consider changing return type from Promise<void> to Promise<TelemetryItem[]>\n     * to allow adapters to return telemetry items (errors/warnings) that occurred during\n     * initialization, eliminating the chicken-and-egg problem with reporting init errors.\n     *\n     * @returns A promise that resolves when initialization is complete.\n     * @sealed\n     */\n    async initialize() {\n        // If the adapter is already initialized, do not initialize it again\n        if (this.#initialized) {\n            return;\n        }\n        // Initialize the adapter\n        await this._initialize();\n        // Mark the adapter as initialized\n        this.#initialized = true;\n    }\n    /**\n     * Protected initialization method that subclasses can override.\n     *\n     * This method is called only once during the adapter's lifetime.\n     * Subclasses should override this method to perform any necessary async setup.\n     * The base implementation is a no-op for adapters that don't need initialization.\n     *\n     * @returns A promise that resolves when initialization is complete.\n     * @protected\n     */\n    async _initialize() {\n        // Default implementation - no-op for adapters that don't need initialization\n    }\n}\n//# sourceMappingURL=TelemetryAdapter.js.map"],"names":[],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAM,oBAAoB,CAAC;AAClC,IAAI,OAAO;AACX,IAAI,YAAY,GAAG,KAAK;AACxB;AACA;AACA;AACA;AACA;AACA,IAAI,WAAW,CAAC,MAAM,EAAE;AACxB,QAAQ,IAAI,CAAC,OAAO,GAAG,MAAM;AAC7B,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,IAAI,WAAW,CAAC,IAAI,EAAE;AACtB;AACA,QAAQ,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;AAChC,YAAY;AACZ,QAAQ;AACR;AACA,QAAQ,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;AACjD,YAAY;AACZ,QAAQ;AACR;AACA,QAAQ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;AAC/B,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,IAAI,MAAM,UAAU,GAAG;AACvB;AACA,QAAQ,IAAI,IAAI,CAAC,YAAY,EAAE;AAC/B,YAAY;AACZ,QAAQ;AACR;AACA,QAAQ,MAAM,IAAI,CAAC,WAAW,EAAE;AAChC;AACA,QAAQ,IAAI,CAAC,YAAY,GAAG,IAAI;AAChC,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,IAAI,MAAM,WAAW,GAAG;AACxB;AACA,IAAI;AACJ;;"}