@copilotkit/shared 2.0.0-next.1 → 2.0.0-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +93 -12
- package/dist/_virtual/_rolldown/runtime.cjs +29 -0
- package/dist/a2ui-envelope.cjs +154 -0
- package/dist/a2ui-envelope.cjs.map +1 -0
- package/dist/a2ui-envelope.d.cts +101 -0
- package/dist/a2ui-envelope.d.cts.map +1 -0
- package/dist/a2ui-envelope.d.mts +101 -0
- package/dist/a2ui-envelope.d.mts.map +1 -0
- package/dist/a2ui-envelope.mjs +151 -0
- package/dist/a2ui-envelope.mjs.map +1 -0
- package/dist/a2ui-prompts.cjs +259 -0
- package/dist/a2ui-prompts.cjs.map +1 -0
- package/dist/a2ui-prompts.d.cts +79 -0
- package/dist/a2ui-prompts.d.cts.map +1 -0
- package/dist/a2ui-prompts.d.mts +79 -0
- package/dist/a2ui-prompts.d.mts.map +1 -0
- package/dist/a2ui-prompts.mjs +251 -0
- package/dist/a2ui-prompts.mjs.map +1 -0
- package/dist/attachments/content.cjs +17 -0
- package/dist/attachments/content.cjs.map +1 -0
- package/dist/attachments/content.d.cts +9 -0
- package/dist/attachments/content.d.cts.map +1 -0
- package/dist/attachments/content.d.mts +9 -0
- package/dist/attachments/content.d.mts.map +1 -0
- package/dist/attachments/content.mjs +16 -0
- package/dist/attachments/content.mjs.map +1 -0
- package/dist/attachments/types.d.cts +64 -0
- package/dist/attachments/types.d.cts.map +1 -0
- package/dist/attachments/types.d.mts +64 -0
- package/dist/attachments/types.d.mts.map +1 -0
- package/dist/attachments/utils.cjs +137 -0
- package/dist/attachments/utils.cjs.map +1 -0
- package/dist/attachments/utils.d.cts +44 -0
- package/dist/attachments/utils.d.cts.map +1 -0
- package/dist/attachments/utils.d.mts +44 -0
- package/dist/attachments/utils.d.mts.map +1 -0
- package/dist/attachments/utils.mjs +129 -0
- package/dist/attachments/utils.mjs.map +1 -0
- package/dist/constants/index.cjs +25 -0
- package/dist/constants/index.cjs.map +1 -0
- package/dist/constants/index.d.cts +17 -0
- package/dist/constants/index.d.cts.map +1 -0
- package/dist/constants/index.d.mts +17 -0
- package/dist/constants/index.d.mts.map +1 -0
- package/dist/constants/index.mjs +17 -12
- package/dist/constants/index.mjs.map +1 -1
- package/dist/debug-event-envelope.d.cts +13 -0
- package/dist/debug-event-envelope.d.cts.map +1 -0
- package/dist/debug-event-envelope.d.mts +13 -0
- package/dist/debug-event-envelope.d.mts.map +1 -0
- package/dist/debug.cjs +38 -0
- package/dist/debug.cjs.map +1 -0
- package/dist/debug.d.cts +29 -0
- package/dist/debug.d.cts.map +1 -0
- package/dist/debug.d.mts +29 -0
- package/dist/debug.d.mts.map +1 -0
- package/dist/debug.mjs +37 -0
- package/dist/debug.mjs.map +1 -0
- package/dist/event-transforms/index.cjs +15 -0
- package/dist/event-transforms/index.d.cts +4 -0
- package/dist/event-transforms/index.d.mts +4 -0
- package/dist/event-transforms/index.mjs +5 -0
- package/dist/event-transforms/open-generative-ui-middleware.cjs +286 -0
- package/dist/event-transforms/open-generative-ui-middleware.cjs.map +1 -0
- package/dist/event-transforms/open-generative-ui-middleware.d.cts +60 -0
- package/dist/event-transforms/open-generative-ui-middleware.d.cts.map +1 -0
- package/dist/event-transforms/open-generative-ui-middleware.d.mts +60 -0
- package/dist/event-transforms/open-generative-ui-middleware.d.mts.map +1 -0
- package/dist/event-transforms/open-generative-ui-middleware.mjs +283 -0
- package/dist/event-transforms/open-generative-ui-middleware.mjs.map +1 -0
- package/dist/event-transforms/recorded-events.cjs +59 -0
- package/dist/event-transforms/recorded-events.cjs.map +1 -0
- package/dist/event-transforms/recorded-events.d.cts +23 -0
- package/dist/event-transforms/recorded-events.d.cts.map +1 -0
- package/dist/event-transforms/recorded-events.d.mts +23 -0
- package/dist/event-transforms/recorded-events.d.mts.map +1 -0
- package/dist/event-transforms/recorded-events.mjs +58 -0
- package/dist/event-transforms/recorded-events.mjs.map +1 -0
- package/dist/finalize-events.cjs +186 -0
- package/dist/finalize-events.cjs.map +1 -0
- package/dist/finalize-events.d.cts +40 -0
- package/dist/finalize-events.d.cts.map +1 -0
- package/dist/finalize-events.d.mts +40 -0
- package/dist/finalize-events.d.mts.map +1 -0
- package/dist/finalize-events.mjs +184 -0
- package/dist/finalize-events.mjs.map +1 -0
- package/dist/generative-ui/basic-functions.cjs +177 -0
- package/dist/generative-ui/basic-functions.cjs.map +1 -0
- package/dist/generative-ui/basic-functions.d.cts +108 -0
- package/dist/generative-ui/basic-functions.d.cts.map +1 -0
- package/dist/generative-ui/basic-functions.d.mts +108 -0
- package/dist/generative-ui/basic-functions.d.mts.map +1 -0
- package/dist/generative-ui/basic-functions.mjs +167 -0
- package/dist/generative-ui/basic-functions.mjs.map +1 -0
- package/dist/generative-ui/child-refs.cjs +161 -0
- package/dist/generative-ui/child-refs.cjs.map +1 -0
- package/dist/generative-ui/child-refs.d.cts +68 -0
- package/dist/generative-ui/child-refs.d.cts.map +1 -0
- package/dist/generative-ui/child-refs.d.mts +68 -0
- package/dist/generative-ui/child-refs.d.mts.map +1 -0
- package/dist/generative-ui/child-refs.mjs +152 -0
- package/dist/generative-ui/child-refs.mjs.map +1 -0
- package/dist/generative-ui/is-record.cjs +10 -0
- package/dist/generative-ui/is-record.cjs.map +1 -0
- package/dist/generative-ui/is-record.mjs +9 -0
- package/dist/generative-ui/is-record.mjs.map +1 -0
- package/dist/generative-ui/prompt.cjs +91 -0
- package/dist/generative-ui/prompt.cjs.map +1 -0
- package/dist/generative-ui/prompt.d.cts +13 -0
- package/dist/generative-ui/prompt.d.cts.map +1 -0
- package/dist/generative-ui/prompt.d.mts +13 -0
- package/dist/generative-ui/prompt.d.mts.map +1 -0
- package/dist/generative-ui/prompt.mjs +90 -0
- package/dist/generative-ui/prompt.mjs.map +1 -0
- package/dist/generative-ui/render-ui-args.cjs +160 -0
- package/dist/generative-ui/render-ui-args.cjs.map +1 -0
- package/dist/generative-ui/render-ui-args.d.cts +40 -0
- package/dist/generative-ui/render-ui-args.d.cts.map +1 -0
- package/dist/generative-ui/render-ui-args.d.mts +40 -0
- package/dist/generative-ui/render-ui-args.d.mts.map +1 -0
- package/dist/generative-ui/render-ui-args.mjs +159 -0
- package/dist/generative-ui/render-ui-args.mjs.map +1 -0
- package/dist/generative-ui/types.cjs +101 -0
- package/dist/generative-ui/types.cjs.map +1 -0
- package/dist/generative-ui/types.d.cts +270 -0
- package/dist/generative-ui/types.d.cts.map +1 -0
- package/dist/generative-ui/types.d.mts +270 -0
- package/dist/generative-ui/types.d.mts.map +1 -0
- package/dist/generative-ui/types.mjs +86 -0
- package/dist/generative-ui/types.mjs.map +1 -0
- package/dist/generative-ui/validate-operation.cjs +405 -0
- package/dist/generative-ui/validate-operation.cjs.map +1 -0
- package/dist/generative-ui/validate-operation.d.cts +86 -0
- package/dist/generative-ui/validate-operation.d.cts.map +1 -0
- package/dist/generative-ui/validate-operation.d.mts +86 -0
- package/dist/generative-ui/validate-operation.d.mts.map +1 -0
- package/dist/generative-ui/validate-operation.mjs +399 -0
- package/dist/generative-ui/validate-operation.mjs.map +1 -0
- package/dist/index.cjs +233 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +80 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.mts +80 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +78 -123
- package/dist/index.mjs.map +1 -1
- package/dist/index.umd.js +3979 -0
- package/dist/index.umd.js.map +1 -0
- package/dist/intelligence-routing-fields.cjs +35 -0
- package/dist/intelligence-routing-fields.cjs.map +1 -0
- package/dist/intelligence-routing-fields.d.cts +18 -0
- package/dist/intelligence-routing-fields.d.cts.map +1 -0
- package/dist/intelligence-routing-fields.d.mts +18 -0
- package/dist/intelligence-routing-fields.d.mts.map +1 -0
- package/dist/intelligence-routing-fields.mjs +34 -0
- package/dist/intelligence-routing-fields.mjs.map +1 -0
- package/dist/logger.cjs +7 -0
- package/dist/logger.cjs.map +1 -0
- package/dist/logger.d.cts +5 -0
- package/dist/logger.d.cts.map +1 -0
- package/dist/logger.d.mts +5 -0
- package/dist/logger.d.mts.map +1 -0
- package/dist/logger.mjs +6 -0
- package/dist/logger.mjs.map +1 -0
- package/dist/open-generative-ui-prompts.cjs +8 -0
- package/dist/open-generative-ui-prompts.cjs.map +1 -0
- package/dist/open-generative-ui-prompts.d.cts +6 -0
- package/dist/open-generative-ui-prompts.d.cts.map +1 -0
- package/dist/open-generative-ui-prompts.d.mts +6 -0
- package/dist/open-generative-ui-prompts.d.mts.map +1 -0
- package/dist/open-generative-ui-prompts.mjs +7 -0
- package/dist/open-generative-ui-prompts.mjs.map +1 -0
- package/dist/package.cjs +12 -0
- package/dist/package.cjs.map +1 -0
- package/dist/package.mjs +6 -0
- package/dist/package.mjs.map +1 -0
- package/dist/standard-schema.cjs +31 -0
- package/dist/standard-schema.cjs.map +1 -0
- package/dist/standard-schema.d.cts +33 -0
- package/dist/standard-schema.d.cts.map +1 -0
- package/dist/standard-schema.d.mts +33 -0
- package/dist/standard-schema.d.mts.map +1 -0
- package/dist/standard-schema.mjs +30 -0
- package/dist/standard-schema.mjs.map +1 -0
- package/dist/telemetry/events.d.cts +72 -0
- package/dist/telemetry/events.d.cts.map +1 -0
- package/dist/telemetry/events.d.mts +72 -0
- package/dist/telemetry/events.d.mts.map +1 -0
- package/dist/telemetry/index.cjs +18 -0
- package/dist/telemetry/index.d.cts +5 -0
- package/dist/telemetry/index.d.mts +5 -0
- package/dist/telemetry/index.mjs +6 -12
- package/dist/telemetry/lambda-client.cjs +91 -0
- package/dist/telemetry/lambda-client.cjs.map +1 -0
- package/dist/telemetry/lambda-client.d.cts +31 -0
- package/dist/telemetry/lambda-client.d.cts.map +1 -0
- package/dist/telemetry/lambda-client.d.mts +31 -0
- package/dist/telemetry/lambda-client.d.mts.map +1 -0
- package/dist/telemetry/lambda-client.mjs +87 -0
- package/dist/telemetry/lambda-client.mjs.map +1 -0
- package/dist/telemetry/model-host.cjs +104 -0
- package/dist/telemetry/model-host.cjs.map +1 -0
- package/dist/telemetry/model-host.d.cts +26 -0
- package/dist/telemetry/model-host.d.cts.map +1 -0
- package/dist/telemetry/model-host.d.mts +26 -0
- package/dist/telemetry/model-host.d.mts.map +1 -0
- package/dist/telemetry/model-host.mjs +102 -0
- package/dist/telemetry/model-host.mjs.map +1 -0
- package/dist/telemetry/sampling.cjs +50 -0
- package/dist/telemetry/sampling.cjs.map +1 -0
- package/dist/telemetry/sampling.d.cts +57 -0
- package/dist/telemetry/sampling.d.cts.map +1 -0
- package/dist/telemetry/sampling.d.mts +57 -0
- package/dist/telemetry/sampling.d.mts.map +1 -0
- package/dist/telemetry/sampling.mjs +44 -0
- package/dist/telemetry/sampling.mjs.map +1 -0
- package/dist/telemetry/telemetry-client.cjs +165 -0
- package/dist/telemetry/telemetry-client.cjs.map +1 -0
- package/dist/telemetry/telemetry-client.d.cts +87 -0
- package/dist/telemetry/telemetry-client.d.cts.map +1 -0
- package/dist/telemetry/telemetry-client.d.mts +87 -0
- package/dist/telemetry/telemetry-client.d.mts.map +1 -0
- package/dist/telemetry/telemetry-client.mjs +162 -9
- package/dist/telemetry/telemetry-client.mjs.map +1 -1
- package/dist/telemetry/telemetry-disabled.cjs +20 -0
- package/dist/telemetry/telemetry-disabled.cjs.map +1 -0
- package/dist/telemetry/telemetry-disabled.d.cts +16 -0
- package/dist/telemetry/telemetry-disabled.d.cts.map +1 -0
- package/dist/telemetry/telemetry-disabled.d.mts +16 -0
- package/dist/telemetry/telemetry-disabled.d.mts.map +1 -0
- package/dist/telemetry/telemetry-disabled.mjs +19 -0
- package/dist/telemetry/telemetry-disabled.mjs.map +1 -0
- package/dist/telemetry/utils.cjs +14 -0
- package/dist/telemetry/utils.cjs.map +1 -0
- package/dist/telemetry/utils.mjs +12 -8
- package/dist/telemetry/utils.mjs.map +1 -1
- package/dist/transcription-errors.cjs +84 -0
- package/dist/transcription-errors.cjs.map +1 -0
- package/dist/transcription-errors.d.cts +52 -0
- package/dist/transcription-errors.d.cts.map +1 -0
- package/dist/transcription-errors.d.mts +52 -0
- package/dist/transcription-errors.d.mts.map +1 -0
- package/dist/transcription-errors.mjs +82 -0
- package/dist/transcription-errors.mjs.map +1 -0
- package/dist/types/{action.d.ts → action.d.cts} +32 -32
- package/dist/types/action.d.cts.map +1 -0
- package/dist/types/action.d.mts +59 -0
- package/dist/types/action.d.mts.map +1 -0
- package/dist/types/copilot-cloud-config.d.cts +15 -0
- package/dist/types/copilot-cloud-config.d.cts.map +1 -0
- package/dist/types/copilot-cloud-config.d.mts +15 -0
- package/dist/types/copilot-cloud-config.d.mts.map +1 -0
- package/dist/types/error.d.cts +57 -0
- package/dist/types/error.d.cts.map +1 -0
- package/dist/types/error.d.mts +57 -0
- package/dist/types/error.d.mts.map +1 -0
- package/dist/types/message.d.cts +42 -0
- package/dist/types/message.d.cts.map +1 -0
- package/dist/types/message.d.mts +42 -0
- package/dist/types/message.d.mts.map +1 -0
- package/dist/types/openai-assistant.d.cts +55 -0
- package/dist/types/openai-assistant.d.cts.map +1 -0
- package/dist/types/openai-assistant.d.mts +55 -0
- package/dist/types/openai-assistant.d.mts.map +1 -0
- package/dist/types/utility.d.cts +6 -0
- package/dist/types/utility.d.cts.map +1 -0
- package/dist/types/utility.d.mts +6 -0
- package/dist/types/utility.d.mts.map +1 -0
- package/dist/utils/clipboard.cjs +28 -0
- package/dist/utils/clipboard.cjs.map +1 -0
- package/dist/utils/clipboard.d.cts +14 -0
- package/dist/utils/clipboard.d.cts.map +1 -0
- package/dist/utils/clipboard.d.mts +14 -0
- package/dist/utils/clipboard.d.mts.map +1 -0
- package/dist/utils/clipboard.mjs +27 -0
- package/dist/utils/clipboard.mjs.map +1 -0
- package/dist/utils/conditions.cjs +32 -0
- package/dist/utils/conditions.cjs.map +1 -0
- package/dist/utils/{conditions.d.ts → conditions.d.cts} +16 -11
- package/dist/utils/conditions.d.cts.map +1 -0
- package/dist/utils/conditions.d.mts +31 -0
- package/dist/utils/conditions.d.mts.map +1 -0
- package/dist/utils/conditions.mjs +30 -6
- package/dist/utils/conditions.mjs.map +1 -1
- package/dist/utils/console-styling.cjs +91 -0
- package/dist/utils/console-styling.cjs.map +1 -0
- package/dist/utils/console-styling.d.cts +65 -0
- package/dist/utils/console-styling.d.cts.map +1 -0
- package/dist/utils/console-styling.d.mts +65 -0
- package/dist/utils/console-styling.d.mts.map +1 -0
- package/dist/utils/console-styling.mjs +83 -15
- package/dist/utils/console-styling.mjs.map +1 -1
- package/dist/utils/dashboard-url.cjs +19 -0
- package/dist/utils/dashboard-url.cjs.map +1 -0
- package/dist/utils/dashboard-url.mjs +18 -0
- package/dist/utils/dashboard-url.mjs.map +1 -0
- package/dist/utils/errors.cjs +439 -0
- package/dist/utils/errors.cjs.map +1 -0
- package/dist/utils/{errors.d.ts → errors.d.cts} +188 -156
- package/dist/utils/errors.d.cts.map +1 -0
- package/dist/utils/errors.d.mts +312 -0
- package/dist/utils/errors.d.mts.map +1 -0
- package/dist/utils/errors.mjs +416 -63
- package/dist/utils/errors.mjs.map +1 -1
- package/dist/utils/index.cjs +105 -0
- package/dist/utils/index.cjs.map +1 -0
- package/dist/utils/index.d.cts +58 -0
- package/dist/utils/index.d.cts.map +1 -0
- package/dist/utils/index.d.mts +58 -0
- package/dist/utils/index.d.mts.map +1 -0
- package/dist/utils/index.mjs +97 -107
- package/dist/utils/index.mjs.map +1 -1
- package/dist/utils/inspector-learning.cjs +217 -0
- package/dist/utils/inspector-learning.cjs.map +1 -0
- package/dist/utils/inspector-learning.d.cts +104 -0
- package/dist/utils/inspector-learning.d.cts.map +1 -0
- package/dist/utils/inspector-learning.d.mts +104 -0
- package/dist/utils/inspector-learning.d.mts.map +1 -0
- package/dist/utils/inspector-learning.mjs +215 -0
- package/dist/utils/inspector-learning.mjs.map +1 -0
- package/dist/utils/inspector-metadata.cjs +146 -0
- package/dist/utils/inspector-metadata.cjs.map +1 -0
- package/dist/utils/inspector-metadata.d.cts +55 -0
- package/dist/utils/inspector-metadata.d.cts.map +1 -0
- package/dist/utils/inspector-metadata.d.mts +55 -0
- package/dist/utils/inspector-metadata.d.mts.map +1 -0
- package/dist/utils/inspector-metadata.mjs +146 -0
- package/dist/utils/inspector-metadata.mjs.map +1 -0
- package/dist/utils/inspector-visibility.cjs +13 -0
- package/dist/utils/inspector-visibility.cjs.map +1 -0
- package/dist/utils/inspector-visibility.d.cts +18 -0
- package/dist/utils/inspector-visibility.d.cts.map +1 -0
- package/dist/utils/inspector-visibility.d.mts +18 -0
- package/dist/utils/inspector-visibility.d.mts.map +1 -0
- package/dist/utils/inspector-visibility.mjs +12 -0
- package/dist/utils/inspector-visibility.mjs.map +1 -0
- package/dist/utils/json-schema.cjs +215 -0
- package/dist/utils/json-schema.cjs.map +1 -0
- package/dist/utils/{json-schema.d.ts → json-schema.d.cts} +20 -18
- package/dist/utils/json-schema.d.cts.map +1 -0
- package/dist/utils/json-schema.d.mts +36 -0
- package/dist/utils/json-schema.d.mts.map +1 -0
- package/dist/utils/json-schema.mjs +210 -12
- package/dist/utils/json-schema.mjs.map +1 -1
- package/dist/utils/random-id.cjs +38 -0
- package/dist/utils/random-id.cjs.map +1 -0
- package/dist/utils/{random-id.d.ts → random-id.d.cts} +3 -1
- package/dist/utils/random-id.d.cts.map +1 -0
- package/dist/utils/random-id.d.mts +8 -0
- package/dist/utils/random-id.d.mts.map +1 -0
- package/dist/utils/random-id.mjs +33 -12
- package/dist/utils/random-id.mjs.map +1 -1
- package/dist/utils/requests.cjs +58 -0
- package/dist/utils/requests.cjs.map +1 -0
- package/dist/utils/{requests.d.ts → requests.d.cts} +3 -1
- package/dist/utils/requests.d.cts.map +1 -0
- package/dist/utils/requests.d.mts +12 -0
- package/dist/utils/requests.d.mts.map +1 -0
- package/dist/utils/requests.mjs +56 -6
- package/dist/utils/requests.mjs.map +1 -1
- package/dist/utils/row-render-keys.cjs +206 -0
- package/dist/utils/row-render-keys.cjs.map +1 -0
- package/dist/utils/row-render-keys.d.cts +65 -0
- package/dist/utils/row-render-keys.d.cts.map +1 -0
- package/dist/utils/row-render-keys.d.mts +65 -0
- package/dist/utils/row-render-keys.d.mts.map +1 -0
- package/dist/utils/row-render-keys.mjs +201 -0
- package/dist/utils/row-render-keys.mjs.map +1 -0
- package/dist/utils/types.cjs +9 -0
- package/dist/utils/types.cjs.map +1 -0
- package/dist/utils/types.d.cts +122 -0
- package/dist/utils/types.d.cts.map +1 -0
- package/dist/utils/types.d.mts +122 -0
- package/dist/utils/types.d.mts.map +1 -0
- package/dist/utils/types.mjs +6 -1
- package/dist/utils/types.mjs.map +1 -1
- package/package.json +74 -40
- package/scripts/verify-cjs-exports.cjs +16 -0
- package/src/__tests__/a2ui-envelope.test.ts +434 -0
- package/src/__tests__/a2ui-prompts.test.ts +362 -0
- package/src/__tests__/debug.test.ts +116 -0
- package/src/__tests__/license-context.test.ts +253 -0
- package/src/__tests__/root-entry-browser-safety.test.ts +91 -0
- package/src/__tests__/standard-schema-types.test.ts +144 -0
- package/src/__tests__/standard-schema.test.ts +359 -0
- package/src/__tests__/zod-regression.test.ts +319 -0
- package/src/a2ui-envelope.ts +309 -0
- package/src/a2ui-prompts.ts +322 -0
- package/src/attachments/__tests__/utils.test.ts +214 -0
- package/src/attachments/content.test.ts +48 -0
- package/src/attachments/content.ts +16 -0
- package/src/attachments/index.ts +21 -0
- package/src/attachments/types.ts +77 -0
- package/src/attachments/utils.ts +169 -0
- package/src/constants/index.ts +14 -1
- package/src/debug-event-envelope.ts +9 -0
- package/src/debug.ts +55 -0
- package/src/event-transforms/index.ts +5 -0
- package/src/event-transforms/open-generative-ui-middleware.ts +392 -0
- package/src/event-transforms/recorded-events.test.ts +166 -0
- package/src/event-transforms/recorded-events.ts +74 -0
- package/src/finalize-events.test.ts +284 -0
- package/src/finalize-events.ts +260 -0
- package/src/generative-ui/__tests__/render-ui-args.test.ts +175 -0
- package/src/generative-ui/__tests__/validate-operation.test.ts +977 -0
- package/src/generative-ui/basic-functions.ts +282 -0
- package/src/generative-ui/child-refs.ts +210 -0
- package/src/generative-ui/index.ts +6 -0
- package/src/generative-ui/is-record.ts +4 -0
- package/src/generative-ui/prompt.ts +174 -0
- package/src/generative-ui/render-ui-args.ts +199 -0
- package/src/generative-ui/types.ts +314 -0
- package/src/generative-ui/validate-operation.ts +723 -0
- package/src/index.ts +190 -1
- package/src/intelligence-routing-fields.test.ts +51 -0
- package/src/intelligence-routing-fields.ts +40 -0
- package/src/logger.ts +1 -0
- package/src/open-generative-ui-prompts.ts +20 -0
- package/src/standard-schema.ts +82 -0
- package/src/telemetry/events.ts +37 -10
- package/src/telemetry/index.ts +8 -0
- package/src/telemetry/lambda-client.test.ts +446 -0
- package/src/telemetry/lambda-client.ts +194 -0
- package/src/telemetry/model-host.test.ts +145 -0
- package/src/telemetry/model-host.ts +156 -0
- package/src/telemetry/sampling.test.ts +65 -0
- package/src/telemetry/sampling.ts +103 -0
- package/src/telemetry/telemetry-blank-license-identity.test.ts +128 -0
- package/src/telemetry/telemetry-client.test.ts +798 -0
- package/src/telemetry/telemetry-client.ts +223 -37
- package/src/telemetry/telemetry-disabled.ts +22 -0
- package/src/telemetry/utils.ts +0 -24
- package/src/transcription-errors.ts +99 -0
- package/src/types/__tests__/message.test.ts +62 -0
- package/src/types/action.ts +9 -5
- package/src/types/error.ts +11 -2
- package/src/types/message.ts +33 -5
- package/src/types/openai-assistant.ts +6 -2
- package/src/utils/__tests__/clipboard.test.ts +87 -0
- package/src/utils/__tests__/conditions.test.ts +161 -0
- package/src/utils/__tests__/json-schema.test.ts +812 -0
- package/src/utils/__tests__/row-render-keys.test.ts +388 -0
- package/src/utils/clipboard.ts +23 -0
- package/src/utils/conditions.ts +27 -9
- package/src/utils/console-styling.ts +10 -8
- package/src/utils/dashboard-url.ts +17 -0
- package/src/utils/errors.ts +55 -22
- package/src/utils/index.ts +70 -1
- package/src/utils/inspector-learning.test.ts +423 -0
- package/src/utils/inspector-learning.ts +523 -0
- package/src/utils/inspector-metadata.test.ts +743 -0
- package/src/utils/inspector-metadata.ts +263 -0
- package/src/utils/inspector-visibility.test.ts +43 -0
- package/src/utils/inspector-visibility.ts +17 -0
- package/src/utils/json-schema.ts +156 -12
- package/src/utils/random-id.ts +5 -2
- package/src/utils/requests.ts +3 -1
- package/src/utils/row-render-keys.ts +263 -0
- package/src/utils/types.ts +128 -1
- package/src/utils.test.ts +137 -0
- package/tsconfig.json +10 -2
- package/tsdown.config.ts +49 -0
- package/vitest.config.mjs +11 -0
- package/CHANGELOG.md +0 -1817
- package/dist/chunk-2OJ5OJ2D.mjs +0 -1
- package/dist/chunk-2OJ5OJ2D.mjs.map +0 -1
- package/dist/chunk-64DYJ27R.mjs +0 -201
- package/dist/chunk-64DYJ27R.mjs.map +0 -1
- package/dist/chunk-6QGXWNS5.mjs +0 -34
- package/dist/chunk-6QGXWNS5.mjs.map +0 -1
- package/dist/chunk-6W2UEO2M.mjs +0 -94
- package/dist/chunk-6W2UEO2M.mjs.map +0 -1
- package/dist/chunk-7DJDTRNX.mjs +0 -426
- package/dist/chunk-7DJDTRNX.mjs.map +0 -1
- package/dist/chunk-A66772CV.mjs +0 -107
- package/dist/chunk-A66772CV.mjs.map +0 -1
- package/dist/chunk-BOKE4OKY.mjs +0 -41
- package/dist/chunk-BOKE4OKY.mjs.map +0 -1
- package/dist/chunk-FCCOSO5L.mjs +0 -1
- package/dist/chunk-FCCOSO5L.mjs.map +0 -1
- package/dist/chunk-GYZIHHE6.mjs +0 -13
- package/dist/chunk-GYZIHHE6.mjs.map +0 -1
- package/dist/chunk-IAFBVORQ.mjs +0 -1
- package/dist/chunk-IAFBVORQ.mjs.map +0 -1
- package/dist/chunk-JAAUCDUR.mjs +0 -38
- package/dist/chunk-JAAUCDUR.mjs.map +0 -1
- package/dist/chunk-MSUB6DGR.mjs +0 -1
- package/dist/chunk-MSUB6DGR.mjs.map +0 -1
- package/dist/chunk-N5EP5OD5.mjs +0 -1
- package/dist/chunk-N5EP5OD5.mjs.map +0 -1
- package/dist/chunk-NAFEBKSO.mjs +0 -1
- package/dist/chunk-NAFEBKSO.mjs.map +0 -1
- package/dist/chunk-P7STFMPO.mjs +0 -1
- package/dist/chunk-P7STFMPO.mjs.map +0 -1
- package/dist/chunk-PL5WNHFZ.mjs +0 -50
- package/dist/chunk-PL5WNHFZ.mjs.map +0 -1
- package/dist/chunk-UYARLQNA.mjs +0 -1
- package/dist/chunk-UYARLQNA.mjs.map +0 -1
- package/dist/chunk-XEMZTHQZ.mjs +0 -67
- package/dist/chunk-XEMZTHQZ.mjs.map +0 -1
- package/dist/chunk-XTHC46M2.mjs +0 -1
- package/dist/chunk-XTHC46M2.mjs.map +0 -1
- package/dist/constants/index.d.ts +0 -6
- package/dist/constants/index.js +0 -40
- package/dist/constants/index.js.map +0 -1
- package/dist/index.d.ts +0 -25
- package/dist/index.js +0 -1098
- package/dist/index.js.map +0 -1
- package/dist/telemetry/events.d.ts +0 -45
- package/dist/telemetry/events.js +0 -19
- package/dist/telemetry/events.js.map +0 -1
- package/dist/telemetry/events.mjs +0 -1
- package/dist/telemetry/events.mjs.map +0 -1
- package/dist/telemetry/index.d.ts +0 -3
- package/dist/telemetry/index.js +0 -188
- package/dist/telemetry/index.js.map +0 -1
- package/dist/telemetry/index.mjs.map +0 -1
- package/dist/telemetry/scarf-client.d.ts +0 -7
- package/dist/telemetry/scarf-client.js +0 -59
- package/dist/telemetry/scarf-client.js.map +0 -1
- package/dist/telemetry/scarf-client.mjs +0 -7
- package/dist/telemetry/scarf-client.mjs.map +0 -1
- package/dist/telemetry/security-check.d.ts +0 -2
- package/dist/telemetry/security-check.js +0 -2
- package/dist/telemetry/security-check.js.map +0 -1
- package/dist/telemetry/security-check.mjs +0 -1
- package/dist/telemetry/security-check.mjs.map +0 -1
- package/dist/telemetry/telemetry-client.d.ts +0 -40
- package/dist/telemetry/telemetry-client.js +0 -186
- package/dist/telemetry/telemetry-client.js.map +0 -1
- package/dist/telemetry/utils.d.ts +0 -8
- package/dist/telemetry/utils.js +0 -69
- package/dist/telemetry/utils.js.map +0 -1
- package/dist/types/action.js +0 -19
- package/dist/types/action.js.map +0 -1
- package/dist/types/action.mjs +0 -2
- package/dist/types/action.mjs.map +0 -1
- package/dist/types/copilot-cloud-config.d.ts +0 -13
- package/dist/types/copilot-cloud-config.js +0 -19
- package/dist/types/copilot-cloud-config.js.map +0 -1
- package/dist/types/copilot-cloud-config.mjs +0 -2
- package/dist/types/copilot-cloud-config.mjs.map +0 -1
- package/dist/types/error.d.ts +0 -55
- package/dist/types/error.js +0 -19
- package/dist/types/error.js.map +0 -1
- package/dist/types/error.mjs +0 -2
- package/dist/types/error.mjs.map +0 -1
- package/dist/types/index.d.ts +0 -7
- package/dist/types/index.js +0 -19
- package/dist/types/index.js.map +0 -1
- package/dist/types/index.mjs +0 -8
- package/dist/types/index.mjs.map +0 -1
- package/dist/types/message.d.ts +0 -26
- package/dist/types/message.js +0 -19
- package/dist/types/message.js.map +0 -1
- package/dist/types/message.mjs +0 -2
- package/dist/types/message.mjs.map +0 -1
- package/dist/types/openai-assistant.d.ts +0 -53
- package/dist/types/openai-assistant.js +0 -19
- package/dist/types/openai-assistant.js.map +0 -1
- package/dist/types/openai-assistant.mjs +0 -2
- package/dist/types/openai-assistant.mjs.map +0 -1
- package/dist/types/utility.d.ts +0 -6
- package/dist/types/utility.js +0 -19
- package/dist/types/utility.js.map +0 -1
- package/dist/types/utility.mjs +0 -2
- package/dist/types/utility.mjs.map +0 -1
- package/dist/utils/conditions.js +0 -74
- package/dist/utils/conditions.js.map +0 -1
- package/dist/utils/console-styling.d.ts +0 -84
- package/dist/utils/console-styling.js +0 -123
- package/dist/utils/console-styling.js.map +0 -1
- package/dist/utils/errors.js +0 -443
- package/dist/utils/errors.js.map +0 -1
- package/dist/utils/index.d.ts +0 -32
- package/dist/utils/index.js +0 -927
- package/dist/utils/index.js.map +0 -1
- package/dist/utils/json-schema.js +0 -228
- package/dist/utils/json-schema.js.map +0 -1
- package/dist/utils/random-id.js +0 -68
- package/dist/utils/random-id.js.map +0 -1
- package/dist/utils/requests.js +0 -91
- package/dist/utils/requests.js.map +0 -1
- package/dist/utils/types.d.ts +0 -20
- package/dist/utils/types.js +0 -19
- package/dist/utils/types.js.map +0 -1
- package/jest.config.js +0 -5
- package/src/telemetry/scarf-client.ts +0 -39
- package/src/telemetry/security-check.ts +0 -0
- package/src/utils/json-schema.test.ts +0 -383
- package/tsup.config.ts +0 -11
|
@@ -0,0 +1,798 @@
|
|
|
1
|
+
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
|
|
2
|
+
import type { MockInstance } from "vitest";
|
|
3
|
+
import { lambdaClient } from "./lambda-client";
|
|
4
|
+
import { TelemetryClient, isTelemetryDisabled } from "./telemetry-client";
|
|
5
|
+
|
|
6
|
+
// Module mock so constructing TelemetryClient doesn't spin up segment's
|
|
7
|
+
// internal flush queue. Class-based (not vi.fn) so `vi.restoreAllMocks()`
|
|
8
|
+
// between tests doesn't wipe the `track` binding on subsequent `new
|
|
9
|
+
// Analytics(...)` calls.
|
|
10
|
+
const { segmentTrackMock } = vi.hoisted(() => ({
|
|
11
|
+
segmentTrackMock: vi.fn(),
|
|
12
|
+
}));
|
|
13
|
+
vi.mock("@segment/analytics-node", () => ({
|
|
14
|
+
Analytics: class {
|
|
15
|
+
track = segmentTrackMock;
|
|
16
|
+
},
|
|
17
|
+
}));
|
|
18
|
+
|
|
19
|
+
function jwtWith(payload: {
|
|
20
|
+
telemetry_id?: string;
|
|
21
|
+
license_id?: string;
|
|
22
|
+
}): string {
|
|
23
|
+
const b64 = Buffer.from(JSON.stringify(payload)).toString("base64url");
|
|
24
|
+
return `header.${b64}.sig`;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/** Builds a token whose payload contains an illegal base64url character. */
|
|
28
|
+
function malformedJwtWithTelemetryId(telemetryId: string): string {
|
|
29
|
+
const payload = Buffer.from(JSON.stringify({ telemetry_id: telemetryId }))
|
|
30
|
+
.toString("base64url")
|
|
31
|
+
.concat("$");
|
|
32
|
+
return `header.${payload}.sig`;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
type TelemetryIdentityMode =
|
|
36
|
+
| { label: "standalone"; telemetryId: string }
|
|
37
|
+
| { label: "legacy license"; licenseToken: string }
|
|
38
|
+
| { label: "anonymous" };
|
|
39
|
+
|
|
40
|
+
/** Applies the identity path under test without conflating legacy and standalone APIs. */
|
|
41
|
+
function applyTelemetryIdentity(
|
|
42
|
+
client: TelemetryClient,
|
|
43
|
+
identity: TelemetryIdentityMode,
|
|
44
|
+
) {
|
|
45
|
+
if ("telemetryId" in identity) {
|
|
46
|
+
client.setTelemetryIdentity({ telemetryId: identity.telemetryId });
|
|
47
|
+
return;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
if ("licenseToken" in identity) {
|
|
51
|
+
client.setLicenseToken(identity.licenseToken);
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
const telemetryIdentityModes = [
|
|
56
|
+
{
|
|
57
|
+
label: "standalone",
|
|
58
|
+
telemetryId: "standalone-telemetry-id",
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
label: "legacy license",
|
|
62
|
+
licenseToken: jwtWith({ telemetry_id: "legacy-telemetry-id" }),
|
|
63
|
+
},
|
|
64
|
+
{ label: "anonymous" },
|
|
65
|
+
] satisfies readonly TelemetryIdentityMode[];
|
|
66
|
+
|
|
67
|
+
const telemetryOptOuts = [
|
|
68
|
+
{ environmentVariable: "COPILOTKIT_TELEMETRY_DISABLED", value: "true" },
|
|
69
|
+
{ environmentVariable: "DO_NOT_TRACK", value: "1" },
|
|
70
|
+
] as const;
|
|
71
|
+
|
|
72
|
+
const telemetryOptOutCases = telemetryOptOuts.flatMap((optOut) =>
|
|
73
|
+
telemetryIdentityModes.map((identity) => ({ identity, optOut })),
|
|
74
|
+
);
|
|
75
|
+
const callerSampleRate = process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE;
|
|
76
|
+
|
|
77
|
+
beforeEach(() => {
|
|
78
|
+
delete process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE;
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
afterEach(() => {
|
|
82
|
+
if (callerSampleRate === undefined) {
|
|
83
|
+
delete process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE;
|
|
84
|
+
} else {
|
|
85
|
+
process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE = callerSampleRate;
|
|
86
|
+
}
|
|
87
|
+
});
|
|
88
|
+
|
|
89
|
+
describe("v1 TelemetryClient", () => {
|
|
90
|
+
let lambdaSpy: MockInstance<typeof lambdaClient.send>;
|
|
91
|
+
|
|
92
|
+
beforeEach(() => {
|
|
93
|
+
lambdaSpy = vi.spyOn(lambdaClient, "send").mockResolvedValue(undefined);
|
|
94
|
+
segmentTrackMock.mockReset();
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
afterEach(() => {
|
|
98
|
+
vi.restoreAllMocks();
|
|
99
|
+
vi.unstubAllEnvs();
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
function makeClient(
|
|
103
|
+
overrides: Partial<ConstructorParameters<typeof TelemetryClient>[0]> = {},
|
|
104
|
+
): TelemetryClient {
|
|
105
|
+
return new TelemetryClient({
|
|
106
|
+
packageName: "@copilotkit/shared",
|
|
107
|
+
packageVersion: "1.0.0",
|
|
108
|
+
sampleRate: 1,
|
|
109
|
+
...overrides,
|
|
110
|
+
});
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
const baseInstanceEvent = {
|
|
114
|
+
actionsAmount: 0,
|
|
115
|
+
endpointsAmount: 0,
|
|
116
|
+
endpointTypes: [],
|
|
117
|
+
"cloud.api_key_provided": false,
|
|
118
|
+
} as const;
|
|
119
|
+
const flattenedBaseInstanceEvent = {
|
|
120
|
+
actionsAmount: 0,
|
|
121
|
+
endpointsAmount: 0,
|
|
122
|
+
"cloud.api_key_provided": false,
|
|
123
|
+
} as const;
|
|
124
|
+
|
|
125
|
+
/** The block every unsampled wire carries, whatever the configured rate. */
|
|
126
|
+
const unsampledMeta = {
|
|
127
|
+
sampleRate: 1,
|
|
128
|
+
sampleRateAdjustmentFactor: 0,
|
|
129
|
+
sampleWeight: 1,
|
|
130
|
+
} as const;
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* Verifies the shared event shape and per-wire sampling metadata.
|
|
134
|
+
*
|
|
135
|
+
* The two wires are gated separately, so they carry different sampling
|
|
136
|
+
* blocks for the same capture: the lambda copy is never sampled, while the
|
|
137
|
+
* Segment copy reports the rate its own gate used.
|
|
138
|
+
*
|
|
139
|
+
* @param expectedIdentity - Identity fields expected only on the Lambda send.
|
|
140
|
+
* @param segmentSamplingMeta - Sampling metadata expected on the Segment copy.
|
|
141
|
+
* @param telemetryIdentified - Whether a license-derived identity was present.
|
|
142
|
+
* @param identityValues - Raw identity values that must not leak into payloads.
|
|
143
|
+
*/
|
|
144
|
+
function expectBothSinksReceivedEvent(
|
|
145
|
+
expectedIdentity: Pick<
|
|
146
|
+
Parameters<typeof lambdaClient.send>[0],
|
|
147
|
+
"licenseToken" | "telemetryId"
|
|
148
|
+
>,
|
|
149
|
+
segmentSamplingMeta: {
|
|
150
|
+
sampleRate: number;
|
|
151
|
+
sampleRateAdjustmentFactor: number;
|
|
152
|
+
sampleWeight: number;
|
|
153
|
+
},
|
|
154
|
+
telemetryIdentified: boolean,
|
|
155
|
+
identityValues: readonly string[],
|
|
156
|
+
): void {
|
|
157
|
+
expect(lambdaSpy).toHaveBeenCalledTimes(1);
|
|
158
|
+
const lambdaEvent = lambdaSpy.mock.calls[0][0];
|
|
159
|
+
expect(lambdaEvent).toMatchObject({
|
|
160
|
+
...expectedIdentity,
|
|
161
|
+
globalProperties: unsampledMeta,
|
|
162
|
+
});
|
|
163
|
+
expect(lambdaEvent.properties).toEqual(flattenedBaseInstanceEvent);
|
|
164
|
+
expect(lambdaEvent.globalProperties).toEqual({
|
|
165
|
+
"copilotkit.package.name": "@copilotkit/shared",
|
|
166
|
+
"copilotkit.package.version": "1.0.0",
|
|
167
|
+
...unsampledMeta,
|
|
168
|
+
telemetry_emitter: "v1-shared",
|
|
169
|
+
telemetry_surface: "v1",
|
|
170
|
+
telemetry_event_id: expect.any(String),
|
|
171
|
+
telemetry_identified: telemetryIdentified,
|
|
172
|
+
telemetry_transport: "lambda",
|
|
173
|
+
});
|
|
174
|
+
|
|
175
|
+
expect(segmentTrackMock).toHaveBeenCalledTimes(1);
|
|
176
|
+
const segmentEvent = segmentTrackMock.mock.calls[0][0];
|
|
177
|
+
expect(segmentEvent).toEqual({
|
|
178
|
+
anonymousId: expect.stringMatching(/^anon_/),
|
|
179
|
+
event: "oss.runtime.instance_created",
|
|
180
|
+
properties: {
|
|
181
|
+
...flattenedBaseInstanceEvent,
|
|
182
|
+
"copilotkit.package.name": "@copilotkit/shared",
|
|
183
|
+
"copilotkit.package.version": "1.0.0",
|
|
184
|
+
...segmentSamplingMeta,
|
|
185
|
+
telemetry_emitter: "v1-shared",
|
|
186
|
+
telemetry_surface: "v1",
|
|
187
|
+
telemetry_event_id: expect.any(String),
|
|
188
|
+
telemetry_identified: telemetryIdentified,
|
|
189
|
+
telemetry_transport: "segment",
|
|
190
|
+
},
|
|
191
|
+
});
|
|
192
|
+
expect(segmentEvent).not.toHaveProperty("userId");
|
|
193
|
+
|
|
194
|
+
const transportPayload = JSON.stringify({
|
|
195
|
+
lambdaGlobalProperties: lambdaEvent.globalProperties,
|
|
196
|
+
lambdaProperties: lambdaEvent.properties,
|
|
197
|
+
segmentEvent,
|
|
198
|
+
});
|
|
199
|
+
for (const identityValue of identityValues) {
|
|
200
|
+
expect(transportPayload).not.toContain(identityValue);
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
test("capture sends to both sinks when the anonymous Segment gate opens", async () => {
|
|
205
|
+
vi.spyOn(Math, "random").mockReturnValue(0);
|
|
206
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
207
|
+
|
|
208
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
209
|
+
|
|
210
|
+
expect(lambdaSpy).toHaveBeenCalledTimes(1);
|
|
211
|
+
expect(segmentTrackMock).toHaveBeenCalledTimes(1);
|
|
212
|
+
expect(segmentTrackMock.mock.calls[0][0]).toMatchObject({
|
|
213
|
+
event: "oss.runtime.instance_created",
|
|
214
|
+
});
|
|
215
|
+
});
|
|
216
|
+
|
|
217
|
+
test("an opt-out set after the client is created stops both sinks", async () => {
|
|
218
|
+
// e.g. dotenv.config() placed below the import that creates the client.
|
|
219
|
+
vi.stubEnv("COPILOTKIT_TELEMETRY_DISABLED", "");
|
|
220
|
+
vi.stubEnv("DO_NOT_TRACK", "");
|
|
221
|
+
try {
|
|
222
|
+
vi.spyOn(Math, "random").mockReturnValue(0);
|
|
223
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
224
|
+
vi.stubEnv("DO_NOT_TRACK", "1");
|
|
225
|
+
|
|
226
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
227
|
+
|
|
228
|
+
expect(lambdaSpy).not.toHaveBeenCalled();
|
|
229
|
+
expect(segmentTrackMock).not.toHaveBeenCalled();
|
|
230
|
+
} finally {
|
|
231
|
+
vi.unstubAllEnvs();
|
|
232
|
+
}
|
|
233
|
+
});
|
|
234
|
+
|
|
235
|
+
test("an anonymous event sampled out of Segment still reaches the lambda sink", async () => {
|
|
236
|
+
// Math.random=0.99 vs sampleRate=0.05. The gate is Segment's alone now:
|
|
237
|
+
// the lambda sink is ours and takes every event, so a rate that drops
|
|
238
|
+
// 95% of the Segment copies must drop none of the lambda copies. This is
|
|
239
|
+
// the whole point of the change — if it ever reverts, this fails first.
|
|
240
|
+
vi.spyOn(Math, "random").mockReturnValue(0.99);
|
|
241
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
242
|
+
|
|
243
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
244
|
+
|
|
245
|
+
expect(lambdaSpy).toHaveBeenCalledTimes(1);
|
|
246
|
+
expect(segmentTrackMock).not.toHaveBeenCalled();
|
|
247
|
+
});
|
|
248
|
+
|
|
249
|
+
test("the lambda copy reports rate 1 while the Segment copy of the same capture reports the gated rate", async () => {
|
|
250
|
+
// One capture, two wires, two different weights. A shared block would
|
|
251
|
+
// make the unsampled lambda copy claim it stands for 20 events.
|
|
252
|
+
vi.spyOn(Math, "random").mockReturnValue(0);
|
|
253
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
254
|
+
|
|
255
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
256
|
+
|
|
257
|
+
expect(lambdaSpy.mock.calls[0][0].globalProperties).toMatchObject({
|
|
258
|
+
sampleRate: 1,
|
|
259
|
+
sampleRateAdjustmentFactor: 0,
|
|
260
|
+
sampleWeight: 1,
|
|
261
|
+
});
|
|
262
|
+
expect(segmentTrackMock.mock.calls[0][0]).toMatchObject({
|
|
263
|
+
properties: expect.objectContaining({
|
|
264
|
+
sampleRate: 0.05,
|
|
265
|
+
sampleRateAdjustmentFactor: 0.95,
|
|
266
|
+
sampleWeight: 20,
|
|
267
|
+
}),
|
|
268
|
+
});
|
|
269
|
+
});
|
|
270
|
+
|
|
271
|
+
test("COPILOTKIT_TELEMETRY_SAMPLE_RATE=0 silences Segment without silencing the lambda sink", async () => {
|
|
272
|
+
// The env var survives as a Segment-only lever. Setting it to 0 is the
|
|
273
|
+
// strongest form of that lever and still must not be mistaken for an
|
|
274
|
+
// opt-out: COPILOTKIT_TELEMETRY_DISABLED is the opt-out.
|
|
275
|
+
vi.spyOn(Math, "random").mockReturnValue(0);
|
|
276
|
+
process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE = "0";
|
|
277
|
+
const client = makeClient();
|
|
278
|
+
|
|
279
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
280
|
+
|
|
281
|
+
expect(lambdaSpy).toHaveBeenCalledTimes(1);
|
|
282
|
+
expect(segmentTrackMock).not.toHaveBeenCalled();
|
|
283
|
+
});
|
|
284
|
+
|
|
285
|
+
test.each([
|
|
286
|
+
{ label: "configured directly", priorLicenseToken: undefined },
|
|
287
|
+
{
|
|
288
|
+
label: "replacing a legacy license identity",
|
|
289
|
+
priorLicenseToken: jwtWith({ telemetry_id: "legacy-telemetry-id" }),
|
|
290
|
+
},
|
|
291
|
+
])(
|
|
292
|
+
"standalone identity stays behind the Segment gate when $label",
|
|
293
|
+
async ({ priorLicenseToken }) => {
|
|
294
|
+
const randomSpy = vi.spyOn(Math, "random").mockReturnValue(0.99);
|
|
295
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
296
|
+
if (priorLicenseToken !== undefined) {
|
|
297
|
+
client.setLicenseToken(priorLicenseToken);
|
|
298
|
+
}
|
|
299
|
+
client.setTelemetryIdentity({
|
|
300
|
+
telemetryId: "standalone-telemetry-id",
|
|
301
|
+
});
|
|
302
|
+
|
|
303
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
304
|
+
|
|
305
|
+
expect(randomSpy).toHaveBeenCalledTimes(1);
|
|
306
|
+
expect(lambdaSpy).toHaveBeenCalledTimes(1);
|
|
307
|
+
expect(segmentTrackMock).not.toHaveBeenCalled();
|
|
308
|
+
},
|
|
309
|
+
);
|
|
310
|
+
|
|
311
|
+
test("standalone identity remains a transport claim with anonymous Segment sampling metadata", async () => {
|
|
312
|
+
const randomSpy = vi.spyOn(Math, "random").mockReturnValue(0);
|
|
313
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
314
|
+
client.setTelemetryIdentity({
|
|
315
|
+
telemetryId: "standalone-telemetry-id",
|
|
316
|
+
});
|
|
317
|
+
|
|
318
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
319
|
+
|
|
320
|
+
expect(randomSpy).toHaveBeenCalledTimes(1);
|
|
321
|
+
expectBothSinksReceivedEvent(
|
|
322
|
+
{ telemetryId: "standalone-telemetry-id" },
|
|
323
|
+
{
|
|
324
|
+
sampleRate: 0.05,
|
|
325
|
+
sampleRateAdjustmentFactor: 0.95,
|
|
326
|
+
sampleWeight: 20,
|
|
327
|
+
},
|
|
328
|
+
false,
|
|
329
|
+
["standalone-telemetry-id"],
|
|
330
|
+
);
|
|
331
|
+
});
|
|
332
|
+
|
|
333
|
+
test("standalone identity is stored without surrounding HTTP whitespace", async () => {
|
|
334
|
+
const randomSpy = vi.spyOn(Math, "random").mockReturnValue(0);
|
|
335
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
336
|
+
client.setTelemetryIdentity({
|
|
337
|
+
telemetryId: "\t standalone-telemetry-id \t",
|
|
338
|
+
});
|
|
339
|
+
|
|
340
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
341
|
+
|
|
342
|
+
expect(randomSpy).toHaveBeenCalledTimes(1);
|
|
343
|
+
expect(lambdaSpy).toHaveBeenCalledWith(
|
|
344
|
+
expect.objectContaining({
|
|
345
|
+
telemetryId: "standalone-telemetry-id",
|
|
346
|
+
}),
|
|
347
|
+
);
|
|
348
|
+
expect(segmentTrackMock).toHaveBeenCalledTimes(1);
|
|
349
|
+
});
|
|
350
|
+
|
|
351
|
+
test.each(["bad\nid", "bad\u0000id", "tenant-🚀"])(
|
|
352
|
+
"header-invalid standalone identity %j stays anonymously sampled",
|
|
353
|
+
async (invalidTelemetryId) => {
|
|
354
|
+
const randomSpy = vi.spyOn(Math, "random").mockReturnValue(0);
|
|
355
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
356
|
+
client.setTelemetryIdentity({
|
|
357
|
+
telemetryId: invalidTelemetryId,
|
|
358
|
+
});
|
|
359
|
+
|
|
360
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
361
|
+
|
|
362
|
+
expect(randomSpy).toHaveBeenCalledTimes(1);
|
|
363
|
+
expect(lambdaSpy).toHaveBeenCalledWith(
|
|
364
|
+
expect.objectContaining({
|
|
365
|
+
licenseToken: undefined,
|
|
366
|
+
telemetryId: undefined,
|
|
367
|
+
}),
|
|
368
|
+
);
|
|
369
|
+
expect(segmentTrackMock).toHaveBeenCalledTimes(1);
|
|
370
|
+
},
|
|
371
|
+
);
|
|
372
|
+
|
|
373
|
+
test("legacy license identity bypasses the Segment gate and weighs 1 on both wires", async () => {
|
|
374
|
+
const telemetryId = "legacy-telemetry-id";
|
|
375
|
+
const licenseToken = jwtWith({ telemetry_id: telemetryId });
|
|
376
|
+
const randomSpy = vi.spyOn(Math, "random").mockReturnValue(0.99);
|
|
377
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
378
|
+
client.setTelemetryIdentity({ licenseToken });
|
|
379
|
+
|
|
380
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
381
|
+
|
|
382
|
+
expect(randomSpy).not.toHaveBeenCalled();
|
|
383
|
+
expectBothSinksReceivedEvent(
|
|
384
|
+
{ licenseToken },
|
|
385
|
+
{
|
|
386
|
+
sampleRate: 1,
|
|
387
|
+
sampleRateAdjustmentFactor: 0,
|
|
388
|
+
sampleWeight: 1,
|
|
389
|
+
},
|
|
390
|
+
true,
|
|
391
|
+
[telemetryId, licenseToken],
|
|
392
|
+
);
|
|
393
|
+
});
|
|
394
|
+
|
|
395
|
+
test("clearing telemetry identity restores the anonymous Segment decision", async () => {
|
|
396
|
+
const randomSpy = vi.spyOn(Math, "random").mockReturnValue(0);
|
|
397
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
398
|
+
client.setTelemetryIdentity({ telemetryId: "standalone-telemetry-id" });
|
|
399
|
+
client.setTelemetryIdentity({});
|
|
400
|
+
|
|
401
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
402
|
+
|
|
403
|
+
expect(randomSpy).toHaveBeenCalledTimes(1);
|
|
404
|
+
expect(lambdaSpy).toHaveBeenCalledTimes(1);
|
|
405
|
+
expect(lambdaSpy.mock.calls[0][0]).toMatchObject({
|
|
406
|
+
licenseToken: undefined,
|
|
407
|
+
telemetryId: undefined,
|
|
408
|
+
globalProperties: unsampledMeta,
|
|
409
|
+
});
|
|
410
|
+
expect(segmentTrackMock).toHaveBeenCalledTimes(1);
|
|
411
|
+
expect(segmentTrackMock.mock.calls[0][0]).toMatchObject({
|
|
412
|
+
properties: expect.objectContaining({
|
|
413
|
+
sampleRate: 0.05,
|
|
414
|
+
sampleRateAdjustmentFactor: 0.95,
|
|
415
|
+
sampleWeight: 20,
|
|
416
|
+
}),
|
|
417
|
+
});
|
|
418
|
+
});
|
|
419
|
+
|
|
420
|
+
test.each(["", " \t "])(
|
|
421
|
+
"blank standalone identity %j falls through to a supplied legacy identity",
|
|
422
|
+
async (blankTelemetryId) => {
|
|
423
|
+
const randomSpy = vi.spyOn(Math, "random").mockReturnValue(0.99);
|
|
424
|
+
const licenseToken = jwtWith({ telemetry_id: "legacy-telemetry-id" });
|
|
425
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
426
|
+
client.setTelemetryIdentity({
|
|
427
|
+
telemetryId: blankTelemetryId,
|
|
428
|
+
licenseToken,
|
|
429
|
+
});
|
|
430
|
+
|
|
431
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
432
|
+
|
|
433
|
+
expect(randomSpy).not.toHaveBeenCalled();
|
|
434
|
+
expect(lambdaSpy).toHaveBeenCalledWith(
|
|
435
|
+
expect.objectContaining({
|
|
436
|
+
licenseToken,
|
|
437
|
+
telemetryId: undefined,
|
|
438
|
+
globalProperties: expect.objectContaining({ sampleRate: 1 }),
|
|
439
|
+
}),
|
|
440
|
+
);
|
|
441
|
+
},
|
|
442
|
+
);
|
|
443
|
+
|
|
444
|
+
test.each(["", " \t "])(
|
|
445
|
+
"blank standalone identity %j without a legacy identity stays anonymous",
|
|
446
|
+
async (blankTelemetryId) => {
|
|
447
|
+
const randomSpy = vi.spyOn(Math, "random").mockReturnValue(0);
|
|
448
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
449
|
+
client.setTelemetryIdentity({ telemetryId: blankTelemetryId });
|
|
450
|
+
|
|
451
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
452
|
+
|
|
453
|
+
expect(randomSpy).toHaveBeenCalledTimes(1);
|
|
454
|
+
expect(lambdaSpy).toHaveBeenCalledWith(
|
|
455
|
+
expect.objectContaining({
|
|
456
|
+
licenseToken: undefined,
|
|
457
|
+
telemetryId: undefined,
|
|
458
|
+
globalProperties: expect.objectContaining({
|
|
459
|
+
sampleRate: 1,
|
|
460
|
+
telemetry_identified: false,
|
|
461
|
+
}),
|
|
462
|
+
}),
|
|
463
|
+
);
|
|
464
|
+
expect(segmentTrackMock.mock.calls[0][0]).toMatchObject({
|
|
465
|
+
properties: expect.objectContaining({ sampleRate: 0.05 }),
|
|
466
|
+
});
|
|
467
|
+
},
|
|
468
|
+
);
|
|
469
|
+
|
|
470
|
+
test("identified callers bypass the Segment gate (both wires fire even when Math.random would fail)", async () => {
|
|
471
|
+
vi.spyOn(Math, "random").mockReturnValue(0.99);
|
|
472
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
473
|
+
client.setLicenseToken(jwtWith({ telemetry_id: "abc-123" }));
|
|
474
|
+
|
|
475
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
476
|
+
|
|
477
|
+
expect(lambdaSpy).toHaveBeenCalledTimes(1);
|
|
478
|
+
expect(segmentTrackMock).toHaveBeenCalledTimes(1);
|
|
479
|
+
});
|
|
480
|
+
|
|
481
|
+
test("identified callers send to both sinks on every capture", async () => {
|
|
482
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
483
|
+
client.setLicenseToken(jwtWith({ telemetry_id: "abc-123" }));
|
|
484
|
+
|
|
485
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
486
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
487
|
+
|
|
488
|
+
expect(lambdaSpy).toHaveBeenCalledTimes(2);
|
|
489
|
+
expect(segmentTrackMock).toHaveBeenCalledTimes(2);
|
|
490
|
+
});
|
|
491
|
+
|
|
492
|
+
test("capture short-circuits both sinks when telemetryDisabled is true", async () => {
|
|
493
|
+
const client = makeClient({ telemetryDisabled: true });
|
|
494
|
+
|
|
495
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
496
|
+
|
|
497
|
+
expect(lambdaSpy).not.toHaveBeenCalled();
|
|
498
|
+
expect(segmentTrackMock).not.toHaveBeenCalled();
|
|
499
|
+
});
|
|
500
|
+
|
|
501
|
+
test.each(telemetryOptOutCases)(
|
|
502
|
+
"$optOut.environmentVariable disables both sinks for $identity.label telemetry",
|
|
503
|
+
async ({ identity, optOut }) => {
|
|
504
|
+
vi.stubEnv(optOut.environmentVariable, optOut.value);
|
|
505
|
+
const client = makeClient();
|
|
506
|
+
applyTelemetryIdentity(client, identity);
|
|
507
|
+
|
|
508
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
509
|
+
|
|
510
|
+
expect(lambdaSpy).not.toHaveBeenCalled();
|
|
511
|
+
expect(segmentTrackMock).not.toHaveBeenCalled();
|
|
512
|
+
},
|
|
513
|
+
);
|
|
514
|
+
|
|
515
|
+
test("setLicenseToken forwards the token in subsequent capture", async () => {
|
|
516
|
+
const token = jwtWith({ telemetry_id: "abc-123" });
|
|
517
|
+
const client = makeClient();
|
|
518
|
+
client.setLicenseToken(token);
|
|
519
|
+
|
|
520
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
521
|
+
|
|
522
|
+
expect(lambdaSpy).toHaveBeenCalledTimes(1);
|
|
523
|
+
expect(lambdaSpy.mock.calls[0][0].licenseToken).toBe(token);
|
|
524
|
+
});
|
|
525
|
+
|
|
526
|
+
test("capture sends licenseToken=undefined when setLicenseToken was never called", async () => {
|
|
527
|
+
vi.spyOn(Math, "random").mockReturnValue(0);
|
|
528
|
+
const client = makeClient();
|
|
529
|
+
|
|
530
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
531
|
+
|
|
532
|
+
expect(lambdaSpy.mock.calls[0][0].licenseToken).toBeUndefined();
|
|
533
|
+
});
|
|
534
|
+
|
|
535
|
+
test("setLicenseToken warns once when the token has no telemetry_id", () => {
|
|
536
|
+
const warn = vi.spyOn(console, "warn").mockImplementation(() => undefined);
|
|
537
|
+
const client = makeClient();
|
|
538
|
+
|
|
539
|
+
client.setLicenseToken(jwtWith({ license_id: "x" }));
|
|
540
|
+
|
|
541
|
+
expect(warn).toHaveBeenCalledTimes(1);
|
|
542
|
+
expect(warn.mock.calls[0][0]).toMatch(/telemetry_id/);
|
|
543
|
+
});
|
|
544
|
+
|
|
545
|
+
test("setLicenseToken does not warn when the token carries telemetry_id", () => {
|
|
546
|
+
const warn = vi.spyOn(console, "warn").mockImplementation(() => undefined);
|
|
547
|
+
const client = makeClient();
|
|
548
|
+
|
|
549
|
+
client.setLicenseToken(jwtWith({ telemetry_id: "abc-123" }));
|
|
550
|
+
|
|
551
|
+
expect(warn).not.toHaveBeenCalled();
|
|
552
|
+
});
|
|
553
|
+
|
|
554
|
+
test("Segment keeps sampleWeight=1/sampleRate for anonymous events and 1 for identified ones", async () => {
|
|
555
|
+
// On the Segment wire the weight still has work to do: anonymous events
|
|
556
|
+
// stand for 1 / sampleRate of them, identified events stand for
|
|
557
|
+
// themselves. The lambda wire is unsampled, so its weight is always 1.
|
|
558
|
+
vi.spyOn(Math, "random").mockReturnValue(0);
|
|
559
|
+
const anonClient = makeClient({ sampleRate: 0.05 });
|
|
560
|
+
await anonClient.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
561
|
+
expect(lambdaSpy.mock.calls[0][0].globalProperties).toMatchObject({
|
|
562
|
+
sampleRate: 1,
|
|
563
|
+
sampleWeight: 1,
|
|
564
|
+
});
|
|
565
|
+
expect(segmentTrackMock.mock.calls[0][0]).toMatchObject({
|
|
566
|
+
properties: expect.objectContaining({
|
|
567
|
+
sampleRate: 0.05,
|
|
568
|
+
sampleWeight: 20,
|
|
569
|
+
}),
|
|
570
|
+
});
|
|
571
|
+
|
|
572
|
+
lambdaSpy.mockClear();
|
|
573
|
+
segmentTrackMock.mockReset();
|
|
574
|
+
|
|
575
|
+
const idClient = makeClient({ sampleRate: 0.05 });
|
|
576
|
+
idClient.setLicenseToken(jwtWith({ telemetry_id: "abc-123" }));
|
|
577
|
+
await idClient.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
578
|
+
expect(lambdaSpy.mock.calls[0][0].globalProperties).toMatchObject({
|
|
579
|
+
sampleRate: 1,
|
|
580
|
+
sampleWeight: 1,
|
|
581
|
+
});
|
|
582
|
+
expect(segmentTrackMock.mock.calls[0][0]).toMatchObject({
|
|
583
|
+
properties: expect.objectContaining({ sampleRate: 1, sampleWeight: 1 }),
|
|
584
|
+
});
|
|
585
|
+
});
|
|
586
|
+
|
|
587
|
+
test("malformed license token stays anonymous and stays behind the Segment gate", async () => {
|
|
588
|
+
// parseTelemetryIdFromLicense returns null for any of: empty token,
|
|
589
|
+
// wrong-shape (not three dot-separated segments), base64/JSON parse
|
|
590
|
+
// failure. A misconfigured customer must not flip to identified-bypass.
|
|
591
|
+
vi.spyOn(Math, "random").mockReturnValue(0.99);
|
|
592
|
+
vi.spyOn(console, "warn").mockImplementation(() => undefined);
|
|
593
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
594
|
+
|
|
595
|
+
client.setLicenseToken("not-a-jwt");
|
|
596
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
597
|
+
|
|
598
|
+
expect(segmentTrackMock).not.toHaveBeenCalled();
|
|
599
|
+
expect(lambdaSpy.mock.calls[0][0].globalProperties).toMatchObject({
|
|
600
|
+
telemetry_identified: false,
|
|
601
|
+
});
|
|
602
|
+
});
|
|
603
|
+
|
|
604
|
+
test("illegal base64url license payload cannot bypass Segment sampleRate 0", async () => {
|
|
605
|
+
const randomSpy = vi.spyOn(Math, "random").mockReturnValue(0);
|
|
606
|
+
vi.spyOn(console, "warn").mockImplementation(() => undefined);
|
|
607
|
+
const client = makeClient({ sampleRate: 0 });
|
|
608
|
+
|
|
609
|
+
client.setLicenseToken(malformedJwtWithTelemetryId("legacy-telemetry-id"));
|
|
610
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
611
|
+
|
|
612
|
+
expect(randomSpy).toHaveBeenCalledTimes(1);
|
|
613
|
+
expect(segmentTrackMock).not.toHaveBeenCalled();
|
|
614
|
+
// The lambda copy still goes, and still says it is anonymous: an
|
|
615
|
+
// unparseable token must not buy identified status on either wire.
|
|
616
|
+
expect(lambdaSpy.mock.calls[0][0].globalProperties).toMatchObject({
|
|
617
|
+
telemetry_identified: false,
|
|
618
|
+
});
|
|
619
|
+
});
|
|
620
|
+
|
|
621
|
+
test("setLicenseToken cache is overwritable (good token replaced by bad → back to anonymous gate)", async () => {
|
|
622
|
+
// Pins the cache as last-write-wins so a refactor to first-write-wins
|
|
623
|
+
// (e.g. `this.telemetryId ??= parseAndWarnTelemetryId(...)`) doesn't
|
|
624
|
+
// leak identified-bypass status across license replacements.
|
|
625
|
+
vi.spyOn(Math, "random").mockReturnValue(0.99);
|
|
626
|
+
vi.spyOn(console, "warn").mockImplementation(() => undefined);
|
|
627
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
628
|
+
|
|
629
|
+
client.setLicenseToken(jwtWith({ telemetry_id: "abc-123" }));
|
|
630
|
+
client.setLicenseToken(jwtWith({ license_id: "no-telemetry-id" }));
|
|
631
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
632
|
+
|
|
633
|
+
expect(segmentTrackMock).not.toHaveBeenCalled();
|
|
634
|
+
expect(lambdaSpy.mock.calls[0][0].globalProperties).toMatchObject({
|
|
635
|
+
telemetry_identified: false,
|
|
636
|
+
});
|
|
637
|
+
});
|
|
638
|
+
|
|
639
|
+
test("setCloudConfiguration writes cloud keys into globalProperties for both sinks", async () => {
|
|
640
|
+
vi.spyOn(Math, "random").mockReturnValue(0);
|
|
641
|
+
const client = makeClient({ sampleRate: 1 });
|
|
642
|
+
client.setCloudConfiguration({
|
|
643
|
+
publicApiKey: "ck_live_test.secret",
|
|
644
|
+
baseUrl: "https://api.cloud.copilotkit.ai",
|
|
645
|
+
});
|
|
646
|
+
|
|
647
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
648
|
+
|
|
649
|
+
// v1 still ships cloud.publicApiKey through globalProperties — the
|
|
650
|
+
// lambda-client.send sanitization strips it at the wire (covered in
|
|
651
|
+
// lambda-client.test.ts), and Segment retains it intentionally for
|
|
652
|
+
// existing CopilotCloud user analytics.
|
|
653
|
+
expect(lambdaSpy.mock.calls[0][0].globalProperties).toMatchObject({
|
|
654
|
+
"cloud.publicApiKey": "ck_live_test.secret",
|
|
655
|
+
"cloud.baseUrl": "https://api.cloud.copilotkit.ai",
|
|
656
|
+
});
|
|
657
|
+
expect(segmentTrackMock.mock.calls[0][0]).toMatchObject({
|
|
658
|
+
properties: expect.objectContaining({
|
|
659
|
+
"cloud.publicApiKey": "ck_live_test.secret",
|
|
660
|
+
"cloud.baseUrl": "https://api.cloud.copilotkit.ai",
|
|
661
|
+
}),
|
|
662
|
+
});
|
|
663
|
+
});
|
|
664
|
+
|
|
665
|
+
test("constructor rejects sampleRate outside [0, 1]", () => {
|
|
666
|
+
expect(() => makeClient({ sampleRate: 1.5 })).toThrow(
|
|
667
|
+
"Sample rate must be between 0 and 1",
|
|
668
|
+
);
|
|
669
|
+
expect(() => makeClient({ sampleRate: -0.1 })).toThrow(
|
|
670
|
+
"Sample rate must be between 0 and 1",
|
|
671
|
+
);
|
|
672
|
+
});
|
|
673
|
+
|
|
674
|
+
test("constructor rejects NaN sampleRate from a malformed env override", () => {
|
|
675
|
+
// parseFloat('nonsense') = NaN; without the explicit guard, NaN slips
|
|
676
|
+
// past the range check (all NaN comparisons are false) and produces a
|
|
677
|
+
// silent always-drop. Guard the validator with Number.isNaN.
|
|
678
|
+
process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE = "not-a-number";
|
|
679
|
+
|
|
680
|
+
expect(() => makeClient()).toThrow("Sample rate must be between 0 and 1");
|
|
681
|
+
});
|
|
682
|
+
|
|
683
|
+
test("both copies of one capture share a telemetry_event_id and differ only by transport", async () => {
|
|
684
|
+
// The dual-write is the whole of OSS-1019: one request, two rows, and
|
|
685
|
+
// before this nothing on either row said they were the same event.
|
|
686
|
+
// Consumers had to infer it from $lib, which is incidental.
|
|
687
|
+
vi.spyOn(Math, "random").mockReturnValue(0);
|
|
688
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
689
|
+
|
|
690
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
691
|
+
|
|
692
|
+
const lambdaGlobals = lambdaSpy.mock.calls[0][0].globalProperties as Record<
|
|
693
|
+
string,
|
|
694
|
+
unknown
|
|
695
|
+
>;
|
|
696
|
+
const segmentProps = segmentTrackMock.mock.calls[0][0].properties as Record<
|
|
697
|
+
string,
|
|
698
|
+
unknown
|
|
699
|
+
>;
|
|
700
|
+
|
|
701
|
+
expect(lambdaGlobals.telemetry_event_id).toEqual(expect.any(String));
|
|
702
|
+
expect(segmentProps.telemetry_event_id).toBe(
|
|
703
|
+
lambdaGlobals.telemetry_event_id,
|
|
704
|
+
);
|
|
705
|
+
expect(lambdaGlobals.telemetry_transport).toBe("lambda");
|
|
706
|
+
expect(segmentProps.telemetry_transport).toBe("segment");
|
|
707
|
+
});
|
|
708
|
+
|
|
709
|
+
test("each capture gets its own telemetry_event_id", async () => {
|
|
710
|
+
// A per-client id would collapse every event from one process into a
|
|
711
|
+
// single row under a dedupe-by-id rule.
|
|
712
|
+
vi.spyOn(Math, "random").mockReturnValue(0);
|
|
713
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
714
|
+
|
|
715
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
716
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
717
|
+
|
|
718
|
+
const first = (
|
|
719
|
+
lambdaSpy.mock.calls[0][0].globalProperties as Record<string, unknown>
|
|
720
|
+
).telemetry_event_id;
|
|
721
|
+
const second = (
|
|
722
|
+
lambdaSpy.mock.calls[1][0].globalProperties as Record<string, unknown>
|
|
723
|
+
).telemetry_event_id;
|
|
724
|
+
|
|
725
|
+
expect(first).not.toBe(second);
|
|
726
|
+
});
|
|
727
|
+
|
|
728
|
+
test("both copies are stamped as emitted by the v1 client, on the v1 surface", async () => {
|
|
729
|
+
// telemetry_emitter names the client library; telemetry_surface names
|
|
730
|
+
// the API the developer built against. They are separate because six
|
|
731
|
+
// emitters across four languages report only two surfaces, and the
|
|
732
|
+
// question anyone asks of this data is how much traffic is still v1.
|
|
733
|
+
vi.spyOn(Math, "random").mockReturnValue(0);
|
|
734
|
+
const client = makeClient({ sampleRate: 0.05 });
|
|
735
|
+
|
|
736
|
+
await client.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
737
|
+
|
|
738
|
+
expect(lambdaSpy.mock.calls[0][0].globalProperties).toMatchObject({
|
|
739
|
+
telemetry_emitter: "v1-shared",
|
|
740
|
+
telemetry_surface: "v1",
|
|
741
|
+
});
|
|
742
|
+
expect(segmentTrackMock.mock.calls[0][0]).toMatchObject({
|
|
743
|
+
properties: expect.objectContaining({
|
|
744
|
+
telemetry_emitter: "v1-shared",
|
|
745
|
+
telemetry_surface: "v1",
|
|
746
|
+
}),
|
|
747
|
+
});
|
|
748
|
+
});
|
|
749
|
+
|
|
750
|
+
test("telemetry_identified rides on both copies and tracks the gate branch", async () => {
|
|
751
|
+
vi.spyOn(Math, "random").mockReturnValue(0);
|
|
752
|
+
const anonClient = makeClient({ sampleRate: 0.05 });
|
|
753
|
+
await anonClient.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
754
|
+
expect(lambdaSpy.mock.calls[0][0].globalProperties).toMatchObject({
|
|
755
|
+
telemetry_identified: false,
|
|
756
|
+
});
|
|
757
|
+
expect(segmentTrackMock.mock.calls[0][0]).toMatchObject({
|
|
758
|
+
properties: expect.objectContaining({ telemetry_identified: false }),
|
|
759
|
+
});
|
|
760
|
+
|
|
761
|
+
lambdaSpy.mockClear();
|
|
762
|
+
segmentTrackMock.mockReset();
|
|
763
|
+
|
|
764
|
+
const idClient = makeClient({ sampleRate: 0.05 });
|
|
765
|
+
idClient.setLicenseToken(jwtWith({ telemetry_id: "abc-123" }));
|
|
766
|
+
await idClient.capture("oss.runtime.instance_created", baseInstanceEvent);
|
|
767
|
+
expect(lambdaSpy.mock.calls[0][0].globalProperties).toMatchObject({
|
|
768
|
+
telemetry_identified: true,
|
|
769
|
+
});
|
|
770
|
+
expect(segmentTrackMock.mock.calls[0][0]).toMatchObject({
|
|
771
|
+
properties: expect.objectContaining({ telemetry_identified: true }),
|
|
772
|
+
});
|
|
773
|
+
});
|
|
774
|
+
});
|
|
775
|
+
|
|
776
|
+
describe("isTelemetryDisabled", () => {
|
|
777
|
+
const originalEnv = { ...process.env };
|
|
778
|
+
|
|
779
|
+
afterEach(() => {
|
|
780
|
+
process.env = { ...originalEnv };
|
|
781
|
+
});
|
|
782
|
+
|
|
783
|
+
test.each([
|
|
784
|
+
["COPILOTKIT_TELEMETRY_DISABLED", "true"],
|
|
785
|
+
["COPILOTKIT_TELEMETRY_DISABLED", "1"],
|
|
786
|
+
["DO_NOT_TRACK", "true"],
|
|
787
|
+
["DO_NOT_TRACK", "1"],
|
|
788
|
+
])("returns true when %s=%s", (key, val) => {
|
|
789
|
+
process.env[key] = val;
|
|
790
|
+
expect(isTelemetryDisabled()).toBe(true);
|
|
791
|
+
});
|
|
792
|
+
|
|
793
|
+
test("returns false when no opt-out env var is set", () => {
|
|
794
|
+
delete process.env.COPILOTKIT_TELEMETRY_DISABLED;
|
|
795
|
+
delete process.env.DO_NOT_TRACK;
|
|
796
|
+
expect(isTelemetryDisabled()).toBe(false);
|
|
797
|
+
});
|
|
798
|
+
});
|