@configdirector/nuxt-sdk 1.2.0 → 1.3.0

package/dist/module.d.mts

@@ -1,6 +1,9 @@
 import * as _$_nuxt_schema0 from "@nuxt/schema";
 import { LogLevel } from "consola";
 
+//#region ../shared/src/types.d.ts
+type ConnectionMode = "streaming" | "polling";
+//#endregion
 //#region src/module.d.ts
 interface ConfigDirectorRuntimeConfig {
   /**
@@ -23,6 +26,40 @@ interface ConfigDirectorRuntimeConfig {
    * Can be set via the NUXT_CONFIGDIRECTOR_BASE_URL environment variable.
    */
   baseUrl?: string;
+  /**
+   * Connection options for the server SDK client used during SSR and in Nitro handlers.
+   */
+  connection?: {
+    /**
+     * The connection mode, one of `streaming` (default) or `polling`. In `streaming` mode the
+     * connection stays open and receives config updates as they happen. In `polling` mode configs
+     * are fetched once during initialization and then again on every `pollingInterval`.
+     * Can be set via the NUXT_CONFIGDIRECTOR_CONNECTION_MODE environment variable.
+     */
+    mode?: ConnectionMode;
+    /**
+     * The polling interval in seconds when `mode` is `polling`. Has no effect in `streaming` mode.
+     * When omitted (or `0`), the server SDK default is used.
+     * Can be set via the NUXT_CONFIGDIRECTOR_CONNECTION_POLLING_INTERVAL environment variable.
+     */
+    pollingInterval?: number;
+    /**
+     * How long, in milliseconds, the server SDK client waits for its initial config payload. Requests
+     * that arrive before the payload is received are held until it arrives or this timeout elapses,
+     * after which they render with default values. When omitted (or `0`), the server SDK default is used.
+     * Can be set via the NUXT_CONFIGDIRECTOR_CONNECTION_TIMEOUT environment variable.
+     */
+    timeout?: number;
+  };
+  /**
+   * Whether requests that arrive before the server SDK client received its initial config payload
+   * (for example right after the server starts) wait for it, for up to the connection `timeout`, before
+   * being handled. When disabled, such requests are handled immediately and evaluate configs to their
+   * default values until the payload arrives.
+   *
+   * Defaults to `true`. Can be set via the NUXT_CONFIGDIRECTOR_WAIT_FOR_INITIALIZATION environment variable.
+   */
+  waitForInitialization?: boolean;
 }
 interface ConfigDirectorPublicRuntimeConfig {
   /**

package/dist/module.json

@@ -4,5 +4,5 @@
   "compatibility": {
     "nuxt": ">=4.0.0"
   },
-  "version": "1.2.0"
+  "version": "1.3.0"
 }

package/dist/module.mjs

@@ -11,14 +11,20 @@ var module_default = defineNuxtModule({
 	setup(options, nuxt) {
 		const logger = useLogger("configdirector");
 		const resolver = createResolver(import.meta.url);
-		nuxt.options.runtimeConfig.configdirector = defu(nuxt.options.runtimeConfig.configdirector, options.logLevel !== void 0 ? {
-			serverSdkKey: "",
-			logLevel: options.logLevel,
-			baseUrl: ""
-		} : {
+		const serverDefaults = {
 			serverSdkKey: "",
-			baseUrl: ""
-		});
+			baseUrl: "",
+			connection: {
+				mode: "streaming",
+				pollingInterval: 0,
+				timeout: 0
+			},
+			waitForInitialization: true
+		};
+		nuxt.options.runtimeConfig.configdirector = defu(nuxt.options.runtimeConfig.configdirector, options.logLevel !== void 0 ? {
+			...serverDefaults,
+			logLevel: options.logLevel
+		} : serverDefaults);
 		nuxt.options.runtimeConfig.public.configdirector = defu(nuxt.options.runtimeConfig.public.configdirector, options.logLevel !== void 0 ? {
 			clientSdkKey: "",
 			logLevel: options.logLevel,

package/dist/runtime/nitro/middleware.d.mts

@@ -2,7 +2,7 @@ import * as _$h3 from "h3";
 import { ConfigDirectorClient } from "@configdirector/server-sdk";
 
 //#region src/runtime/nitro/middleware.d.ts
-declare const _default: _$h3.EventHandler<_$h3.EventHandlerRequest, void>;
+declare const _default: _$h3.EventHandler<_$h3.EventHandlerRequest, Promise<void>>;
 declare module "h3" {
   interface H3EventContext {
     configDirectorClient: ConfigDirectorClient;

package/dist/runtime/nitro/middleware.d.ts

@@ -2,7 +2,7 @@ import * as _$h3 from "h3";
 import { ConfigDirectorClient } from "@configdirector/server-sdk";
 
 //#region src/runtime/nitro/middleware.d.ts
-declare const _default: _$h3.EventHandler<_$h3.EventHandlerRequest, void>;
+declare const _default: _$h3.EventHandler<_$h3.EventHandlerRequest, Promise<void>>;
 declare module "h3" {
   interface H3EventContext {
     configDirectorClient: ConfigDirectorClient;

package/dist/runtime/nitro/middleware.mjs

@@ -1,8 +1,10 @@
-import { useNitroApp } from "nitropack/runtime";
+import { useNitroApp, useRuntimeConfig } from "nitropack/runtime";
 import { defineEventHandler } from "h3";
 //#region src/runtime/nitro/middleware.ts
-var middleware_default = defineEventHandler((event) => {
-	event.context.configDirectorClient = useNitroApp().configDirectorClient;
+var middleware_default = defineEventHandler(async (event) => {
+	const nitroApp = useNitroApp();
+	if (useRuntimeConfig(event).configdirector.waitForInitialization) await nitroApp.configDirectorInitialization;
+	event.context.configDirectorClient = nitroApp.configDirectorClient;
 });
 //#endregion
 export { middleware_default as default };

package/dist/runtime/nitro/plugin.d.mts

@@ -6,6 +6,7 @@ declare const _default: _$nitropack.NitroAppPlugin;
 declare module "nitropack" {
   interface NitroApp {
     configDirectorClient: ConfigDirectorClient;
+    configDirectorInitialization: Promise<void>;
   }
 }
 //#endregion

package/dist/runtime/nitro/plugin.d.ts

@@ -6,6 +6,7 @@ declare const _default: _$nitropack.NitroAppPlugin;
 declare module "nitropack" {
   interface NitroApp {
     configDirectorClient: ConfigDirectorClient;
+    configDirectorInitialization: Promise<void>;
   }
 }
 //#endregion

package/dist/runtime/nitro/plugin.mjs

@@ -7967,16 +7967,21 @@ var plugin_default = defineNitroPlugin((nitroApp) => {
 		throw new ConfigDirectorInitializationError(message);
 	}
 	logger.debug("Initializing ConfigDirector Nitro plugin");
-	const { serverSdkKey, baseUrl } = runtimeConfig.configdirector;
+	const { serverSdkKey, baseUrl, connection } = runtimeConfig.configdirector;
 	const client = new DefaultConfigDirectorClient(serverSdkKey, {
 		sdkName: "nuxt-sdk",
-		sdkVersion: "1.2.0"
+		sdkVersion: "1.3.0"
 	}, {
 		logger,
-		...baseUrl ? { connection: { url: baseUrl } } : {}
+		connection: {
+			url: baseUrl || void 0,
+			mode: connection?.mode || void 0,
+			pollingInterval: connection?.pollingInterval || void 0,
+			timeout: connection?.timeout || void 0
+		}
 	});
 	nitroApp.configDirectorClient = client;
-	client.initialize();
+	nitroApp.configDirectorInitialization = client.initialize();
 });
 //#endregion
 export { plugin_default as default };

package/dist/runtime/plugin.client.mjs

@@ -710,6 +710,91 @@ const generateInstanceId = () => {
 	});
 };
 //#endregion
+//#region ../js-client-core/src/instance-id.ts
+const STORAGE_KEY = "configdirector-sdk:instance-id";
+const RECORD_VERSION = 1;
+const MAX_AGE_MS = 360 * 60 * 1e3;
+const CHECKSUM_SALT = "configdirector.instanceId.v1";
+const UUID_V4_PATTERN = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/;
+const fnv1a = (input, offsetBasis) => {
+	let hash = offsetBasis;
+	for (let i = 0; i < input.length; i++) {
+		hash ^= input.charCodeAt(i);
+		hash = Math.imul(hash, 16777619);
+	}
+	return hash >>> 0;
+};
+const checksumFor = (id, createdAt) => {
+	const payload = `${CHECKSUM_SALT}|${id}|${createdAt}`;
+	const low = fnv1a(payload, 2166136261);
+	return fnv1a(`${low}|${payload}`, 16777619).toString(16).padStart(8, "0") + low.toString(16).padStart(8, "0");
+};
+const getLocalStorage = () => {
+	try {
+		return globalThis.localStorage ?? void 0;
+	} catch {
+		return;
+	}
+};
+const isUsableRecord = (record) => {
+	if (!record || typeof record !== "object") return false;
+	const { v, id, createdAt, checksum } = record;
+	if (v !== RECORD_VERSION || typeof id !== "string" || typeof checksum !== "string") return false;
+	if (typeof createdAt !== "number" || !Number.isInteger(createdAt) || createdAt <= 0) return false;
+	if (!UUID_V4_PATTERN.test(id)) return false;
+	return checksum === checksumFor(id, createdAt);
+};
+const readStoredInstanceId = (storage, logger) => {
+	let raw;
+	try {
+		raw = storage.getItem(STORAGE_KEY);
+	} catch (error) {
+		logger?.debug("[ConfigDirectorClient] Could not read the stored instance id, generating a new one", error);
+		return;
+	}
+	if (!raw) return;
+	let record;
+	try {
+		record = JSON.parse(raw);
+	} catch {
+		logger?.debug("[ConfigDirectorClient] The stored instance id is not valid JSON, generating a new one");
+		return;
+	}
+	if (!isUsableRecord(record)) {
+		logger?.debug("[ConfigDirectorClient] The stored instance id failed validation, generating a new one");
+		return;
+	}
+	const age = Date.now() - record.createdAt;
+	if (age < 0 || age >= MAX_AGE_MS) {
+		logger?.debug("[ConfigDirectorClient] The stored instance id has expired, generating a new one");
+		return;
+	}
+	return record.id;
+};
+const storeInstanceId = (storage, id, logger) => {
+	const createdAt = Date.now();
+	const record = {
+		v: RECORD_VERSION,
+		id,
+		createdAt,
+		checksum: checksumFor(id, createdAt)
+	};
+	try {
+		storage.setItem(STORAGE_KEY, JSON.stringify(record));
+	} catch (error) {
+		logger?.debug("[ConfigDirectorClient] Could not persist the instance id", error);
+	}
+};
+const resolveInstanceId = (logger) => {
+	const storage = getLocalStorage();
+	if (!storage) return generateInstanceId();
+	const storedInstanceId = readStoredInstanceId(storage, logger);
+	if (storedInstanceId) return storedInstanceId;
+	const instanceId = generateInstanceId();
+	storeInstanceId(storage, instanceId, logger);
+	return instanceId;
+};
+//#endregion
 //#region ../shared/src/transport/AbstractPollingTransport.ts
 var AbstractPollingTransport = class {
 	fatalError = false;
@@ -794,7 +879,9 @@ var PollingTransport = class extends AbstractPollingTransport {
 		this.options = options;
 		this.logger = options.logger;
 		this.url = options.resolveUrl("client/polling/v1", options.baseUrl);
-		this.pollingIntervalSeconds = options.pollingInterval ?? 60;
+		const requestedInterval = options.pollingInterval ?? 300;
+		if (requestedInterval < 60) this.logger.warn(`[PollingTransport] pollingInterval of ${requestedInterval} seconds is below the minimum of 60 seconds. Using 60 seconds.`);
+		this.pollingIntervalSeconds = Math.max(requestedInterval, 60);
 	}
 	async connect(context, timeout) {
 		this.clearPollingInterval();
@@ -852,6 +939,17 @@ var PollingTransport = class extends AbstractPollingTransport {
 	}
 };
 //#endregion
+//#region ../js-client-core/src/browser-globals.ts
+const read = (readValue) => {
+	try {
+		return readValue(globalThis);
+	} catch {
+		return;
+	}
+};
+const readUserAgent = () => read((globals) => globals.navigator?.userAgent);
+const readHost = () => read((globals) => globals.location?.host);
+//#endregion
 //#region ../js-client-core/src/DefaultConfigDirectorClient.ts
 const MAX_EXPONENTIAL_DELAY = 9;
 var DefaultConfigDirectorClient = class {
@@ -871,8 +969,8 @@ var DefaultConfigDirectorClient = class {
 	connectionMode;
 	instanceId;
 	constructor(telemetryClient, clientSdkKey, sdkOptions, clientOptions, internalClientOptions) {
-		this.instanceId = generateInstanceId();
 		this.logger = clientOptions?.logger ?? createDefaultLogger$1();
+		this.instanceId = resolveInstanceId(this.logger);
 		this.timeout = clientOptions?.connection?.timeout ?? 3e3;
 		this.validateSdkKeyPresence(clientSdkKey);
 		const urlFactory = internalClientOptions?.urlFactory ?? defaultUrlFactory;
@@ -889,7 +987,8 @@ var DefaultConfigDirectorClient = class {
 				...clientOptions?.metadata,
 				sdkName: sdkOptions.sdkName,
 				sdkVersion: sdkOptions.sdkVersion,
-				userAgent: navigator?.userAgent
+				userAgent: readUserAgent(),
+				host: readHost()
 			},
 			logger: this.logger,
 			fetch: internalClientOptions?.fetch,
@@ -1364,7 +1463,7 @@ var plugin_client_default = defineNuxtPlugin((nuxtApp) => {
 	const { clientSdkKey, appName, appVersion, baseUrl } = runtimeConfig.public.configdirector;
 	const client = createBrowserClient(clientSdkKey, {
 		sdkName: "nuxt-sdk",
-		sdkVersion: "1.2.0"
+		sdkVersion: "1.3.0"
 	}, {
 		metadata: {
 			appName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@configdirector/nuxt-sdk",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Nuxt SDK for ConfigDirector. ConfigDirector is a remote configuration and feature flag service.",
   "license": "MIT",
   "author": "ConfigDirector",