@configdirector/nuxt-sdk 1.9.1 → 1.10.0

package/dist/runtime/{types-CHmsCChN.d.mts → types-IPLvRsUO.d.mts}

@@ -22,27 +22,40 @@ type ConfigEvaluation = {
   context?: ConfigDirectorContext;
 };
 /**
- * The user's context to be sent to ConfigDirector. This context will be used for targeting
- * rules evaluation.
+ * The context to be sent to ConfigDirector: the user or other entity, such as a device or an
+ * organization, that configs are evaluated for. This context will be used for targeting rules
+ * evaluation.
  */
 type ConfigDirectorContext = {
   /**
-   * The user's identifier. This should be a value that uniquely identifies an application
-   * user.
+   * The context's identifier. This should be a value that uniquely identifies the user or other
+   * entity among contexts of the same {@link kind}.
    * In the case of anonymous users, you could generate a UUID or alternatively not provide
    * the {@link id} and the SDK will generate a random UUID. However, keep in mind that this
-   * value is used for segmenting users in percentage rollouts, and changes to the {@link id}
-   * could result in the user being assigned to a different percentile.
+   * value is used for segmenting contexts in percentage rollouts, and changes to the {@link id}
+   * could result in the context being assigned to a different percentile.
    */
   id?: string;
   /**
-   * The user's display name. This will be shown in the ConfigDirector dashboard and may be
+   * The kind of entity this context represents, such as `user`, `device`, `organization`,
+   * `tenant` or `listing`. You can use any other kind that fits your application. A kind has 1
+   * to 64 characters, using only lowercase letters (`a`-`z`), digits, `-` and `_`. It is used
+   * exactly as given, without trimming or changing its case.
+   *
+   * A context with an invalid kind is ignored as a whole: the SDK logs an error and evaluates
+   * as if no context had been provided.
+   *
+   * @default "user"
+   */
+  kind?: string;
+  /**
+   * The context's display name. This will be shown in the ConfigDirector dashboard and may be
    * used for targeting rules.
    */
   name?: string;
   /**
-   * Any arbitrary traits for the current user. They will be shown in the ConfigDirector
-   * dashboard and may be used for targeting rules.
+   * Any arbitrary traits for the context. They will be shown in the ConfigDirector dashboard
+   * and may be used for targeting rules.
    */
   traits?: {
     [key: string]: unknown;

package/dist/testing.d.mts

@@ -29,27 +29,40 @@ type ConfigEvaluation = {
   context?: ConfigDirectorContext;
 };
 /**
- * The user's context to be sent to ConfigDirector. This context will be used for targeting
- * rules evaluation.
+ * The context to be sent to ConfigDirector: the user or other entity, such as a device or an
+ * organization, that configs are evaluated for. This context will be used for targeting rules
+ * evaluation.
  */
 type ConfigDirectorContext = {
   /**
-   * The user's identifier. This should be a value that uniquely identifies an application
-   * user.
+   * The context's identifier. This should be a value that uniquely identifies the user or other
+   * entity among contexts of the same {@link kind}.
    * In the case of anonymous users, you could generate a UUID or alternatively not provide
    * the {@link id} and the SDK will generate a random UUID. However, keep in mind that this
-   * value is used for segmenting users in percentage rollouts, and changes to the {@link id}
-   * could result in the user being assigned to a different percentile.
+   * value is used for segmenting contexts in percentage rollouts, and changes to the {@link id}
+   * could result in the context being assigned to a different percentile.
    */
   id?: string;
   /**
-   * The user's display name. This will be shown in the ConfigDirector dashboard and may be
+   * The kind of entity this context represents, such as `user`, `device`, `organization`,
+   * `tenant` or `listing`. You can use any other kind that fits your application. A kind has 1
+   * to 64 characters, using only lowercase letters (`a`-`z`), digits, `-` and `_`. It is used
+   * exactly as given, without trimming or changing its case.
+   *
+   * A context with an invalid kind is ignored as a whole: the SDK logs an error and evaluates
+   * as if no context had been provided.
+   *
+   * @default "user"
+   */
+  kind?: string;
+  /**
+   * The context's display name. This will be shown in the ConfigDirector dashboard and may be
    * used for targeting rules.
    */
   name?: string;
   /**
-   * Any arbitrary traits for the current user. They will be shown in the ConfigDirector
-   * dashboard and may be used for targeting rules.
+   * Any arbitrary traits for the context. They will be shown in the ConfigDirector dashboard
+   * and may be used for targeting rules.
    */
   traits?: {
     [key: string]: unknown;
@@ -106,17 +119,25 @@ interface ConfigDirectorClient extends EventProvider<ClientEvents> {
    * not attempt to re-connect and an error will be logged to the console or the provided
    * logger.
    *
-   * @param context The current user's context to be used for evaluating targeting rules (optional).
+   * A context whose {@link ConfigDirectorContext.kind} is invalid is ignored as a whole: an error is
+   * logged, and the client connects as if no context had been provided.
+   *
+   * @param context The current context to be used for evaluating targeting rules (optional).
    */
   initialize(context?: ConfigDirectorContext): Promise<void>;
   /**
-   * Updates the user's context and re-evaluates all config and flag values based on the new context.
+   * Updates the context and re-evaluates all config and flag values based on the new context.
+   *
+   * A context whose {@link ConfigDirectorContext.kind} is invalid is ignored as a whole: an error is
+   * logged, the previous context is no longer used, and the client connects as if no context had been
+   * provided.
    *
-   * @param context The current user's context to be used for evaluating targeting rules (required).
+   * @param context The current context to be used for evaluating targeting rules (required).
    */
   updateContext(context: ConfigDirectorContext): Promise<void>;
   /**
-   * Returns the current context the client is configured with, or undefined if there is no context.
+   * Returns the current context the client is configured with, or undefined if there is no context,
+   * including after a context with an invalid kind was ignored.
    *
    * Note that the value returned does not updated immediately after calling {@link updateContext}. Only
    * once the underlying connection was successful or timed out, the current context is updated. This is
@@ -287,7 +308,8 @@ interface TestClient {
   failContextUpdate(): void;
   /**
    * The context of every `initialize` and `updateContext` call, in call order. `initialize` without
-   * a context records an empty context. Resumes are not recorded.
+   * a context records an empty context, and so does a call whose context has an invalid kind, since
+   * the client connects without it. Resumes are not recorded.
    */
   readonly contextUpdates: ConfigDirectorContext[];
 }

package/dist/testing.mjs

@@ -383,6 +383,7 @@ var StreamingTransport = class {
 	eventEmitter = new Emitter();
 	url;
 	timeoutTimer;
+	connectionGeneration = 0;
 	constructor(options) {
 		this.options = options;
 		this.options = options;
@@ -390,6 +391,9 @@ var StreamingTransport = class {
 		this.url = options.resolveUrl("client/sse/v1", options.baseUrl);
 	}
 	async connect(context, timeout) {
+		const generation = ++this.connectionGeneration;
+		const clientSession = await this.options.clientSession;
+		if (generation !== this.connectionGeneration) return this;
 		if (this.eventSource) this.close();
 		const eventSourcePromise = new Promise((resolve, reject) => {
 			this.eventSource = createEventSourceClient({
@@ -401,7 +405,8 @@ var StreamingTransport = class {
 					givenContext: context,
 					metaContext: this.options.metaContext,
 					clientSdkKey: this.options.clientSdkKey,
-					instanceId: this.options.instanceId
+					instanceId: clientSession.instanceId,
+					ephemeral: clientSession.ephemeral
 				}),
 				onMessage: ({ data }) => {
 					this.dispatchMessage(data);
@@ -466,6 +471,7 @@ var StreamingTransport = class {
 		this.eventEmitter.clear();
 	}
 	close() {
+		this.connectionGeneration++;
 		this.eventSource?.close();
 		clearTimeout(this.timeoutTimer);
 	}
@@ -722,10 +728,11 @@ const generateInstanceId = () => {
 	});
 };
 //#endregion
-//#region ../js-client-core/src/instance-id.ts
+//#region ../js-client-core/src/client-session.ts
 const STORAGE_KEY = "configdirector-sdk:instance-id";
 const RECORD_VERSION = 1;
 const MAX_AGE_MS = 360 * 60 * 1e3;
+const STORAGE_DEADLINE_MS = 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) => {
@@ -741,7 +748,7 @@ const checksumFor = (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 = () => {
+const localStorageIfAvailable = () => {
 	try {
 		return globalThis.localStorage ?? void 0;
 	} catch {
@@ -756,34 +763,37 @@ const isUsableRecord = (record) => {
 	if (!UUID_V4_PATTERN.test(id)) return false;
 	return checksum === checksumFor(id, createdAt);
 };
-const readStoredInstanceId = (storage, logger) => {
+const readStoredInstanceId = async (storage, logger) => {
 	let raw;
 	try {
-		raw = storage.getItem(STORAGE_KEY);
+		raw = await storage.getItem(STORAGE_KEY);
 	} catch (error) {
-		logger?.debug("[ConfigDirectorClient] Could not read the stored instance id, generating a new one", error);
-		return;
+		logger.debug("[ConfigDirectorClient] Could not read the stored instance id, using an ephemeral one", error);
+		return { outcome: "failed" };
 	}
-	if (!raw) return;
+	if (typeof raw !== "string" || raw === "") return { outcome: "nothing usable" };
 	let record;
 	try {
 		record = JSON.parse(raw);
 	} catch {
-		logger?.debug("[ConfigDirectorClient] The stored instance id is not valid JSON, generating a new one");
-		return;
+		logger.debug("[ConfigDirectorClient] The stored instance id is not valid JSON, generating a new one");
+		return { outcome: "nothing usable" };
 	}
 	if (!isUsableRecord(record)) {
-		logger?.debug("[ConfigDirectorClient] The stored instance id failed validation, generating a new one");
-		return;
+		logger.debug("[ConfigDirectorClient] The stored instance id failed validation, generating a new one");
+		return { outcome: "nothing usable" };
 	}
 	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;
+		logger.debug("[ConfigDirectorClient] The stored instance id has expired, generating a new one");
+		return { outcome: "nothing usable" };
 	}
-	return record.id;
+	return {
+		outcome: "stored",
+		instanceId: record.id
+	};
 };
-const storeInstanceId = (storage, id, logger) => {
+const persistInstanceId = async (storage, id, logger) => {
 	const createdAt = Date.now();
 	const record = {
 		v: RECORD_VERSION,
@@ -792,19 +802,54 @@ const storeInstanceId = (storage, id, logger) => {
 		checksum: checksumFor(id, createdAt)
 	};
 	try {
-		storage.setItem(STORAGE_KEY, JSON.stringify(record));
+		await storage.setItem(STORAGE_KEY, JSON.stringify(record));
+		return true;
 	} catch (error) {
-		logger?.debug("[ConfigDirectorClient] Could not persist the instance id", error);
+		logger.debug("[ConfigDirectorClient] Could not persist the instance id, using it as an ephemeral one", error);
+		return false;
+	}
+};
+const settleFromStorage = async (storage, provisionalId, deadline, logger) => {
+	const read = await readStoredInstanceId(storage, logger);
+	switch (read.outcome) {
+		case "stored": return { instanceId: read.instanceId };
+		case "failed": return {
+			instanceId: provisionalId,
+			ephemeral: true
+		};
+		case "nothing usable": break;
 	}
+	if (deadline.passed) return {
+		instanceId: provisionalId,
+		ephemeral: true
+	};
+	return await persistInstanceId(storage, provisionalId, logger) ? { instanceId: provisionalId } : {
+		instanceId: provisionalId,
+		ephemeral: true
+	};
 };
-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;
+const resolveClientSession = (logger, storage = localStorageIfAvailable()) => {
+	const provisionalId = generateInstanceId();
+	if (!storage) {
+		logger.debug("[ConfigDirectorClient] No instance id storage is available, using an ephemeral instance id");
+		return Promise.resolve({
+			instanceId: provisionalId,
+			ephemeral: true
+		});
+	}
+	const deadline = { passed: false };
+	let deadlineTimer;
+	const fallbackAtDeadline = new Promise((resolve) => {
+		deadlineTimer = setTimeout(() => {
+			deadline.passed = true;
+			logger.warn(`[ConfigDirectorClient] The instance id storage did not respond within ${STORAGE_DEADLINE_MS}ms, using an ephemeral instance id`);
+			resolve({
+				instanceId: provisionalId,
+				ephemeral: true
+			});
+		}, STORAGE_DEADLINE_MS);
+	});
+	return Promise.race([settleFromStorage(storage, provisionalId, deadline, logger), fallbackAtDeadline]).finally(() => clearTimeout(deadlineTimer));
 };
 //#endregion
 //#region ../shared/src/transport/AbstractPollingTransport.ts
@@ -885,6 +930,7 @@ var PollingTransport = class extends AbstractPollingTransport {
 	eventEmitter = new Emitter();
 	url;
 	lastUpdateTimestamp;
+	connectionGeneration = 0;
 	constructor(options) {
 		super();
 		this.options = options;
@@ -894,19 +940,26 @@ var PollingTransport = class extends AbstractPollingTransport {
 		this.pollingIntervalSeconds = options.pollingInterval ?? 60;
 	}
 	async connect(context, timeout) {
+		const generation = ++this.connectionGeneration;
 		this.clearPollingInterval();
+		const clientSession = await this.options.clientSession;
+		if (generation !== this.connectionGeneration) return this;
 		try {
-			await this.fetchConfigs(context, timeout);
+			await this.fetchConfigs(context, timeout, clientSession);
 		} finally {
 			if (!this.fatalError) this.schedulePollingInterval(() => {
-				this.fetchConfigs(context, timeout).catch((error) => {
+				this.fetchConfigs(context, timeout, clientSession).catch((error) => {
 					this.logger.error("[PollingTransport] Error during polling:", error);
 				});
 			});
 		}
 		return this;
 	}
-	async fetchConfigs(context, timeout) {
+	close() {
+		this.connectionGeneration++;
+		super.close();
+	}
+	async fetchConfigs(context, timeout, clientSession) {
 		if (this.fatalError) {
 			this.logger.warn("[PollingTransport] There was a prior unrecoverable error. Ignoring attempt to reconnect.");
 			return;
@@ -919,7 +972,8 @@ var PollingTransport = class extends AbstractPollingTransport {
 					givenContext: context,
 					metaContext: this.options.metaContext,
 					clientSdkKey: this.options.clientSdkKey,
-					instanceId: this.options.instanceId,
+					instanceId: clientSession.instanceId,
+					ephemeral: clientSession.ephemeral,
 					lastUpdateTimestamp: this.lastUpdateTimestamp
 				})
 			}, this.logger);
@@ -960,6 +1014,46 @@ const read = (readValue) => {
 const readUserAgent = () => read((globals) => globals.navigator?.userAgent);
 const readHost = () => read((globals) => globals.location?.host);
 //#endregion
+//#region ../shared/src/context-kind.ts
+const CONTEXT_KIND_MAXIMUM_LENGTH = 64;
+const KIND_SAMPLE_MAXIMUM_CHARACTERS = 128;
+const isContextKindCharacter = (character) => character >= "a" && character <= "z" || character >= "0" && character <= "9" || character === "-" || character === "_";
+const isValidContextKind = (kind) => {
+	if (kind.length < 1 || kind.length > CONTEXT_KIND_MAXIMUM_LENGTH) return false;
+	for (const character of kind) if (!isContextKindCharacter(character)) return false;
+	return true;
+};
+const isAcceptedKind = (kind) => kind === void 0 || kind === null || typeof kind === "string" && isValidContextKind(kind);
+const stringFormOf = (kind) => {
+	if (typeof kind === "string") return kind;
+	try {
+		return String(kind);
+	} catch {
+		return Object.prototype.toString.call(kind);
+	}
+};
+const firstCharactersOf = (text, maximumCharacters) => {
+	let sample = "";
+	let characterCount = 0;
+	for (const character of text) {
+		if (characterCount === maximumCharacters) break;
+		sample += character;
+		characterCount += 1;
+	}
+	return sample;
+};
+const admitContext = (context) => {
+	const kind = context?.kind;
+	if (isAcceptedKind(kind)) return {
+		outcome: "admitted",
+		context
+	};
+	return {
+		outcome: "ignored",
+		kindSample: firstCharactersOf(stringFormOf(kind), KIND_SAMPLE_MAXIMUM_CHARACTERS)
+	};
+};
+//#endregion
 //#region ../js-client-core/src/DefaultConfigDirectorClient.ts
 const MAX_EXPONENTIAL_DELAY = 9;
 var DefaultConfigDirectorClient = class {
@@ -978,10 +1072,10 @@ var DefaultConfigDirectorClient = class {
 	readyResolve;
 	currentContext;
 	connectionMode;
-	instanceId;
+	clientSession;
 	constructor(telemetryClient, clientSdkKey, sdkOptions, clientOptions, internalClientOptions) {
 		this.logger = clientOptions?.logger ?? createDefaultLogger();
-		this.instanceId = resolveInstanceId(this.logger);
+		this.clientSession = resolveClientSession(this.logger, internalClientOptions?.instanceIdStorage);
 		this.timeout = clientOptions?.connection?.timeout ?? 3e3;
 		this.validateSdkKeyPresence(clientSdkKey);
 		const urlFactory = internalClientOptions?.urlFactory ?? defaultUrlFactory;
@@ -1036,7 +1130,7 @@ var DefaultConfigDirectorClient = class {
 	}
 	buildTransport(clientSdkKey, sdkOptions, baseUrl, urlFactory, clientOptions, internalClientOptions) {
 		return new (this.getTransportConstructor(this.connectionMode))({
-			instanceId: this.instanceId,
+			clientSession: this.clientSession,
 			clientSdkKey,
 			baseUrl,
 			resolveUrl: urlFactory,
@@ -1063,10 +1157,23 @@ var DefaultConfigDirectorClient = class {
 	}
 	async initialize(context) {
 		if (!this.hasReceivedConfigSet) this.initializing = true;
-		await this.connectToTransport(context, "initialization");
+		await this.submitContext(context, "initialization");
 	}
 	async updateContext(context) {
-		await this.connectToTransport(context, "context update");
+		await this.submitContext(context, "context update");
+	}
+	async submitContext(context, submission) {
+		await this.connectToTransport(this.contextToConnectWith(context, submission), submission);
+	}
+	contextToConnectWith(suppliedContext, submission) {
+		const admission = admitContext(suppliedContext);
+		switch (admission.outcome) {
+			case "admitted": return admission.context;
+			case "ignored":
+				this.logger.error(`[ConfigDirectorClient] Ignored the context supplied for ${submission} because its kind '${admission.kindSample}' is invalid; connecting as if no context was supplied. A context kind has 1 to 64 characters, using only lowercase letters, digits, '-' and '_'.`);
+				this.telemetryClient.recordInvalidContext(admission.kindSample);
+				return;
+		}
 	}
 	get context() {
 		return this.currentContext;
@@ -1534,6 +1641,7 @@ const TEST_CLIENT_SDK_KEY = "test-client";
 const noopTelemetryClient = {
 	updateContext: async () => {},
 	evaluatedConfig: () => {},
+	recordInvalidContext: () => {},
 	close: async () => {}
 };
 var InMemoryTestClient = class {
@@ -1638,7 +1746,7 @@ const installTestClient = (testClient) => {
 const createTestClient = (options) => {
 	return createTestClient$1({
 		sdkName: "nuxt-sdk",
-		sdkVersion: "1.9.1"
+		sdkVersion: "1.10.0"
 	}, options);
 };
 //#endregion

package/package.json

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