@configdirector/nuxt-sdk 1.9.1 → 1.10.0

package/dist/module.json

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

package/dist/runtime/app/composables/useConfigDirectorClient.d.mts

@@ -1,4 +1,4 @@
-import { n as ConfigDirectorClient } from "../../types-CvmjergQ.mjs";
+import { n as ConfigDirectorClient } from "../../types-DQhBe4Ei.mjs";
 
 //#region src/runtime/app/composables/useConfigDirectorClient.d.ts
 declare const useConfigDirectorClient: () => {

package/dist/runtime/app/composables/useConfigDirectorClient.d.ts

@@ -1,4 +1,4 @@
-import { n as ConfigDirectorClient } from "../../types-CvmjergQ.mjs";
+import { n as ConfigDirectorClient } from "../../types-DQhBe4Ei.mjs";
 
 //#region src/runtime/app/composables/useConfigDirectorClient.d.ts
 declare const useConfigDirectorClient: () => {

package/dist/runtime/app/composables/useConfigDirectorClientHooks.d.mts

@@ -1,4 +1,4 @@
-import { t as ClientHooks } from "../../types-CvmjergQ.mjs";
+import { t as ClientHooks } from "../../types-DQhBe4Ei.mjs";
 
 //#region src/runtime/app/composables/useConfigDirectorClientHooks.d.ts
 declare const useConfigDirectorClientHooks: (hooks: ClientHooks) => void;

package/dist/runtime/app/composables/useConfigDirectorClientHooks.d.ts

@@ -1,4 +1,4 @@
-import { t as ClientHooks } from "../../types-CvmjergQ.mjs";
+import { t as ClientHooks } from "../../types-DQhBe4Ei.mjs";
 
 //#region src/runtime/app/composables/useConfigDirectorClientHooks.d.ts
 declare const useConfigDirectorClientHooks: (hooks: ClientHooks) => void;

package/dist/runtime/app/composables/useConfigDirectorContext.d.mts

@@ -1,4 +1,4 @@
-import { t as ConfigDirectorContext } from "../../types-CHmsCChN.mjs";
+import { t as ConfigDirectorContext } from "../../types-IPLvRsUO.mjs";
 import { Ref } from "vue";
 
 //#region src/runtime/app/composables/useConfigDirectorContext.d.ts

package/dist/runtime/app/composables/useConfigDirectorContext.d.ts

@@ -1,4 +1,4 @@
-import { t as ConfigDirectorContext } from "../../types-CHmsCChN.mjs";
+import { t as ConfigDirectorContext } from "../../types-IPLvRsUO.mjs";
 import { Ref } from "vue";
 
 //#region src/runtime/app/composables/useConfigDirectorContext.d.ts

package/dist/runtime/app/composables/useConfigDirectorContext.mjs

@@ -1,4 +1,5 @@
 import { useConfigDirectorClient } from "./useConfigDirectorClient.mjs";
+import { n as admittedContextOrNone } from "../../context-kind-D6YBNij2.mjs";
 import { useState } from "#app";
 import { readonly, toRaw } from "vue";
 //#region src/runtime/app/composables/useConfigDirectorContext.ts
@@ -13,7 +14,7 @@ const useConfigDirectorContext = () => {
 		const rawContext = toRaw(context);
 		const oldContext = JSON.stringify(state.value);
 		const newContext = JSON.stringify(rawContext);
-		state.value = rawContext;
+		state.value = admittedContextOrNone(rawContext);
 		if (oldContext != newContext) {
 			const timeout = getEffectiveTimeout(options?.timeoutMilliseconds);
 			let timer;

package/dist/runtime/app/composables/useConfigDirectorStatus.d.mts

@@ -1,4 +1,4 @@
-import { t as ClientStatus } from "../../types-CkzBXJwA.mjs";
+import { t as ClientStatus } from "../../types-F0fKKk6-.mjs";
 import { Ref, ShallowRef } from "vue";
 
 //#region src/runtime/app/composables/useConfigDirectorStatus.d.ts

package/dist/runtime/app/composables/useConfigDirectorStatus.d.ts

@@ -1,4 +1,4 @@
-import { t as ClientStatus } from "../../types-CkzBXJwA.mjs";
+import { t as ClientStatus } from "../../types-F0fKKk6-.mjs";
 import { Ref, ShallowRef } from "vue";
 
 //#region src/runtime/app/composables/useConfigDirectorStatus.d.ts

package/dist/runtime/app/composables/useConfigDirectorValue.d.mts

@@ -1,5 +1,5 @@
-import { i as ConfigValueType } from "../../types-CHmsCChN.mjs";
-import { t as ClientStatus } from "../../types-CkzBXJwA.mjs";
+import { i as ConfigValueType } from "../../types-IPLvRsUO.mjs";
+import { t as ClientStatus } from "../../types-F0fKKk6-.mjs";
 import { DeepReadonly, Ref, ShallowRef } from "vue";
 
 //#region src/runtime/app/composables/useConfigDirectorValue.d.ts

package/dist/runtime/app/composables/useConfigDirectorValue.d.ts

@@ -1,5 +1,5 @@
-import { i as ConfigValueType } from "../../types-CHmsCChN.mjs";
-import { t as ClientStatus } from "../../types-CkzBXJwA.mjs";
+import { i as ConfigValueType } from "../../types-IPLvRsUO.mjs";
+import { t as ClientStatus } from "../../types-F0fKKk6-.mjs";
 import { DeepReadonly, Ref, ShallowRef } from "vue";
 
 //#region src/runtime/app/composables/useConfigDirectorValue.d.ts

package/dist/runtime/context-kind-D6YBNij2.mjs

@@ -0,0 +1,45 @@
+//#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 admittedContextOrNone = (context) => {
+	const admission = admitContext(context);
+	return admission.outcome === "admitted" ? admission.context : void 0;
+};
+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
+export { admittedContextOrNone as n, admitContext as t };

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

@@ -1,4 +1,4 @@
-import { n as ConfigDirectorClient } from "../types-Bgx2-3dY.mjs";
+import { n as ConfigDirectorClient } from "../types-B9_4pADA.mjs";
 import * as _$nitropack from "nitropack";
 
 //#region src/runtime/nitro/plugin.d.ts

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

@@ -1,4 +1,4 @@
-import { n as ConfigDirectorClient } from "../types-Bgx2-3dY.mjs";
+import { n as ConfigDirectorClient } from "../types-B9_4pADA.mjs";
 import * as _$nitropack from "nitropack";
 
 //#region src/runtime/nitro/plugin.d.ts

package/dist/runtime/nitro/plugin.mjs

@@ -1,3 +1,4 @@
+import { t as admitContext } from "../context-kind-D6YBNij2.mjs";
 import EventEmitter, { EventEmitter as EventEmitter$1 } from "node:events";
 import { createHash, randomUUID } from "node:crypto";
 import * as semver from "semver";
@@ -7017,6 +7018,7 @@ const compareArray = (givenValue, operator, targetValues) => {
 		default: return false;
 	}
 };
+const effectiveContextKind = (context) => context?.context?.kind ?? "user";
 //#endregion
 //#region ../config-evaluator/src/ConditionEvaluator.ts
 var ConditionEvaluator = class {
@@ -7065,6 +7067,7 @@ var ConditionEvaluator = class {
 		switch (condition.attribute) {
 			case "identifier": return orAbsent(context?.context?.id);
 			case "name": return orAbsent(context?.context?.name);
+			case "kind": return effectiveContextKind(context);
 			case "appName": return orAbsent(context?.metadata?.appName);
 			case "appVersion": return orAbsent(context?.metadata?.appVersion);
 			case "traits":
@@ -7112,9 +7115,9 @@ const holdsAttributeConditionsOnly = (segment) => (segment.groups ?? []).every((
 //#endregion
 //#region ../config-evaluator/src/percent-hashing.ts
 const SEED = 15426857351n;
-const assignPercentage = (data) => {
-	const value = `${data.contextIdentifier}-${data.configId}`;
-	return Number(rapidhash(value, { seed: SEED }) % 1000n) / 10;
+const assignPercentage = ({ configId, contextIdentifier, contextKind }) => {
+	const hashInput = contextKind === "user" ? `${contextIdentifier}-${configId}` : `${contextIdentifier}-${configId}:${contextKind}`;
+	return Number(rapidhash(hashInput, { seed: SEED }) % 1000n) / 10;
 };
 //#endregion
 //#region ../config-evaluator/src/ConfigEvaluator.ts
@@ -7208,7 +7211,8 @@ var ConfigEvaluator = class {
 		const identifier = context?.context?.id ?? void 0;
 		const assignedPercentage = identifier === void 0 ? 0 : assignPercentage({
 			configId: config.id,
-			contextIdentifier: identifier
+			contextIdentifier: identifier,
+			contextKind: effectiveContextKind(context)
 		});
 		const shares = [];
 		let sum = 0;
@@ -7511,6 +7515,59 @@ const resolvePollingInterval = (configuredSeconds, defaults) => {
 		warning: `pollingInterval of ${configuredSeconds} seconds is below the minimum of ${defaults.minimumSeconds} seconds. Using ${defaults.minimumSeconds} seconds.`
 	};
 };
+var InvalidContextSubmissions = class {
+	countsByKindSample = /* @__PURE__ */ new Map();
+	countBeyondSampleLimit = 0;
+	startTime;
+	record(kindSample) {
+		this.startTime ??= /* @__PURE__ */ new Date();
+		return this.add(kindSample, 1);
+	}
+	absorb(entries) {
+		for (const entry of entries) {
+			if (this.startTime === void 0 || entry.startTime < this.startTime) this.startTime = entry.startTime;
+			this.add(entry.event.kindSample, entry.count);
+		}
+	}
+	add(kindSample, count) {
+		if (kindSample !== void 0) {
+			const knownCount = this.countsByKindSample.get(kindSample);
+			if (knownCount !== void 0) {
+				this.countsByKindSample.set(kindSample, knownCount + count);
+				return "known-kind-sample";
+			}
+			if (this.countsByKindSample.size < 20) {
+				this.countsByKindSample.set(kindSample, count);
+				return "new-kind-sample";
+			}
+		}
+		const firstBeyondSampleLimit = this.countBeyondSampleLimit === 0;
+		this.countBeyondSampleLimit += count;
+		return firstBeyondSampleLimit ? "first-beyond-sample-limit" : "beyond-sample-limit";
+	}
+	takeSnapshot() {
+		const endTime = /* @__PURE__ */ new Date();
+		const startTime = this.startTime ?? endTime;
+		const entryOf = (count, kindSample) => ({
+			startTime,
+			endTime,
+			count,
+			event: {
+				reason: "invalid-context-kind",
+				kindSample
+			}
+		});
+		const sampledEntries = Array.from(this.countsByKindSample, ([kindSample, count]) => entryOf(count, kindSample));
+		const entries = this.countBeyondSampleLimit > 0 ? [...sampledEntries, entryOf(this.countBeyondSampleLimit)] : sampledEntries;
+		this.clear();
+		return entries;
+	}
+	clear() {
+		this.countsByKindSample.clear();
+		this.countBeyondSampleLimit = 0;
+		this.startTime = void 0;
+	}
+};
 //#endregion
 //#region ../shared/src/telemetry/utils.ts
 const CONFIG_VALUE_MAX_LENGTH = 500;
@@ -7821,6 +7878,7 @@ var ServerTelemetryEventCollector = class extends TelemetryEventCollector {
 	reporter;
 	_context;
 	contexts;
+	invalidContextSubmissions = new InvalidContextSubmissions();
 	constructor(options) {
 		super(options);
 		this.reporter = new ServerEventReporter(options);
@@ -7829,13 +7887,23 @@ var ServerTelemetryEventCollector = class extends TelemetryEventCollector {
 	}
 	evaluatedConfig(payload) {
 		if (!this.collectEvents) return;
-		if (payload.context?.id && !payload.context.anonymous) this.contexts.set(payload.context.id, payload.context);
+		const context = payload.context ?? void 0;
+		const contextKind = effectiveContextKind({ context });
+		const contextId = context?.anonymous ? void 0 : context?.id;
+		if (contextId) this.contexts.set(`${contextKind}:${contextId}`, {
+			...context,
+			kind: contextKind
+		});
 		const event = {
 			...payload.evaluation,
-			contextId: payload.context?.anonymous ? void 0 : payload.context?.id
+			contextId,
+			contextKind: contextId === void 0 ? void 0 : contextKind
 		};
 		this.evaluationEventQueue.push(this.sanitizeEvaluatedConfigEvent(event));
 	}
+	recordInvalidContext(kindSample) {
+		return this.invalidContextSubmissions.record(kindSample);
+	}
 	sanitizeEvaluatedConfigEvent(event) {
 		return {
 			...event,
@@ -7869,7 +7937,10 @@ var ServerTelemetryEventCollector = class extends TelemetryEventCollector {
 		return await this.reporter?.report({
 			context: this._context,
 			discreteEvents: { capturedContexts: contextsSnapshot.contexts },
-			aggregatedEvents: { evaluatedConfig: this.aggregator.aggregate(evaluationSnapshot) },
+			aggregatedEvents: {
+				evaluatedConfig: this.aggregator.aggregate(evaluationSnapshot),
+				invalidContext: this.invalidContextSubmissions.takeSnapshot()
+			},
 			droppedEvents: {
 				evaluatedConfig: evaluationSnapshot.droppedCount,
 				capturedContexts: contextsSnapshot.droppedCount
@@ -7903,6 +7974,13 @@ const generateValueId = async (v) => {
 const defaultBaseUrl = new URL("https://server-sdk-api.configdirector.com");
 const DEFAULT_FLUSH_INTERVAL = 3e4;
 const DEFAULT_EVENT_QUEUE_LIMIT = 5e3;
+const logInvalidContext = {
+	"new-kind-sample": (logger, kindSample) => logger.error(`[ConfigDirectorClient] Ignored a context with the invalid kind '${kindSample}' and evaluated as if no context was supplied. A context kind has 1 to 64 characters, using only lowercase letters, digits, '-' and '_'.`),
+	"known-kind-sample": () => {},
+	"first-beyond-sample-limit": (logger) => logger.error(`[ConfigDirectorClient] Ignored a context with another invalid kind and evaluated as if no context was supplied. 20 different invalid kinds were logged recently, so further invalid kinds are not logged individually.`),
+	"beyond-sample-limit": () => {}
+};
+const usesAnySegment = (definition, segmentIds) => (definition.target?.rules ?? []).some((rule) => rule.type === "conditional" && (rule.conditions ?? []).some((condition) => condition.kind === "segment" && segmentIds.has(condition.segmentId)));
 var DefaultConfigDirectorClient = class {
 	logger;
 	usageEventCollector;
@@ -7942,7 +8020,7 @@ var DefaultConfigDirectorClient = class {
 					...configBundle.segments
 				};
 			}
-			const keys = Object.keys(configBundle.configs);
+			const keys = this.findKeysUpdatedBy(configBundle);
 			this.eventEmitter.emit("configsUpdated", {
 				keys,
 				removedKeys
@@ -8044,6 +8122,11 @@ var DefaultConfigDirectorClient = class {
 		if (!this.configSet || configBundle.kind != "full") return [];
 		return Object.keys(this.configSet.configs).filter((key) => !Object.prototype.hasOwnProperty.call(configBundle.configs, key));
 	}
+	findKeysUpdatedBy(configBundle) {
+		const carriedSegmentIds = new Set(Object.keys(configBundle.segments ?? {}));
+		const keysUsingCarriedSegments = Object.entries(this.configSet?.configs ?? {}).filter(([, definition]) => usesAnySegment(definition, carriedSegmentIds)).map(([key]) => key);
+		return [...new Set([...Object.keys(configBundle.configs), ...keysUsingCarriedSegments])];
+	}
 	updateWatchers(configKeys) {
 		configKeys.forEach((configKey) => this.updateWatchersForConfig(configKey));
 	}
@@ -8080,7 +8163,8 @@ var DefaultConfigDirectorClient = class {
 		const configDefinition = this.configSet?.configs[configKey];
 		return this.getValueFromConfigDefinition(configKey, configDefinition, defaultValue, context);
 	}
-	getValueFromConfigDefinition(configKey, configDefinition, defaultValue, context) {
+	getValueFromConfigDefinition(configKey, configDefinition, defaultValue, suppliedContext) {
+		const context = this.contextToEvaluate(suppliedContext);
 		if (configDefinition) {
 			const configState = this.configEvaluator.evaluate(configDefinition, {
 				context,
@@ -8134,6 +8218,15 @@ var DefaultConfigDirectorClient = class {
 			return defaultValue;
 		}
 	}
+	contextToEvaluate(suppliedContext) {
+		const admission = admitContext(suppliedContext);
+		switch (admission.outcome) {
+			case "admitted": return admission.context;
+			case "ignored":
+				logInvalidContext[this.usageEventCollector.recordInvalidContext(admission.kindSample)](this.logger, admission.kindSample);
+				return;
+		}
+	}
 	dispatchEvaluationEvent(event) {
 		setTimeout(() => this.eventEmitter.emit("configEvaluated", { evaluation: event }), 0);
 	}
@@ -8171,11 +8264,12 @@ var DefaultConfigDirectorClient = class {
 		this.handlersMap.clear();
 	}
 	getAllConfigs(options) {
+		const context = this.contextToEvaluate(options?.context);
 		if (!this.configSet) return {};
 		const entries = Object.entries(this.configSet.configs);
 		const filtered = options?.configKeys ? entries.filter(([key]) => options.configKeys?.includes(key)) : entries;
 		return Object.fromEntries(filtered.map(([key, config]) => [key, this.configEvaluator.evaluate(config, {
-			context: options?.context,
+			context,
 			metadata: this.metaContext
 		}, this.configSet?.segments)]));
 	}
@@ -8219,7 +8313,7 @@ var plugin_default = defineNitroPlugin((nitroApp) => {
 	const { serverSdkKey, baseUrl, connection } = runtimeConfig.configdirector;
 	const client = new DefaultConfigDirectorClient(serverSdkKey, {
 		sdkName: "nuxt-sdk",
-		sdkVersion: "1.9.1"
+		sdkVersion: "1.10.0"
 	}, {
 		logger,
 		connection: {