weflayr 0.24.0 → 0.26.0

package/tests/instrumentation/openai/get_streaming_usage.test.js

@@ -1,105 +0,0 @@
-'use strict';
-
-// Tests for the OpenAI streamed token-usage complement. It wraps the primary
-// instrumentor's `_streamingWrapPromise` so the streamed usage chunk's counts land
-// on the span as gen_ai.usage.* attributes.
-
-const test = require('node:test');
-const assert = require('node:assert/strict');
-
-const {
-  OpenAIStreamingUsageInstrumentor,
-} = require('../../../src/instrumentation/openai/get_streaming_usage');
-
-function fakeSpan() {
-  const attrs = {};
-  return {
-    attrs,
-    isRecording: () => true,
-    setAttribute(key, value) {
-      attrs[key] = value;
-    },
-  };
-}
-
-test('backfills token usage from the streamed usage chunk', async () => {
-  const instrumentation = {
-    _streamingWrapPromise() {
-      return (async function* () {
-        yield { choices: [{ delta: { content: 'hi' } }] };
-        yield { usage: { prompt_tokens: 12, completion_tokens: 3, total_tokens: 15 } };
-      })();
-    },
-  };
-  new OpenAIStreamingUsageInstrumentor().instrument(instrumentation);
-
-  const span = fakeSpan();
-  const stream = instrumentation._streamingWrapPromise({ span });
-  for await (const _chunk of stream) {
-    void _chunk;
-  }
-
-  assert.equal(span.attrs['gen_ai.usage.input_tokens'], 12);
-  assert.equal(span.attrs['gen_ai.usage.output_tokens'], 3);
-  assert.equal(span.attrs['gen_ai.usage.total_tokens'], 15);
-});
-
-test('backfills cached-prompt tokens from the streamed usage chunk', async () => {
-  const instrumentation = {
-    _streamingWrapPromise() {
-      return (async function* () {
-        yield {
-          usage: {
-            prompt_tokens: 1600,
-            completion_tokens: 2,
-            total_tokens: 1602,
-            prompt_tokens_details: { cached_tokens: 1536 },
-          },
-        };
-      })();
-    },
-  };
-  new OpenAIStreamingUsageInstrumentor().instrument(instrumentation);
-
-  const span = fakeSpan();
-  for await (const _chunk of instrumentation._streamingWrapPromise({ span })) {
-    void _chunk;
-  }
-
-  assert.equal(span.attrs['gen_ai.usage.cache_read_input_tokens'], 1536);
-});
-
-test('re-yields every stream chunk unchanged — no telemetry collision with the payload', async () => {
-  const emitted = [
-    { choices: [{ delta: { content: 'hel' } }] },
-    { choices: [{ delta: { content: 'lo' } }] },
-    { usage: { prompt_tokens: 12, completion_tokens: 3, total_tokens: 15 } },
-  ];
-  const instrumentation = {
-    _streamingWrapPromise() {
-      return (async function* () {
-        for (const chunk of emitted) yield chunk;
-      })();
-    },
-  };
-  new OpenAIStreamingUsageInstrumentor().instrument(instrumentation);
-
-  const span = fakeSpan();
-  const collected = [];
-  for await (const chunk of instrumentation._streamingWrapPromise({ span })) {
-    collected.push(chunk);
-  }
-
-  // Same count, order, and object identity: backfillUsage re-yields each chunk by
-  // reference without copying or mutating it.
-  assert.equal(collected.length, emitted.length);
-  collected.forEach((chunk, index) => assert.equal(chunk, emitted[index]));
-  // …while still backfilling usage off the trailing chunk.
-  assert.equal(span.attrs['gen_ai.usage.output_tokens'], 3);
-});
-
-test('is a no-op when the instrumentor has no _streamingWrapPromise', () => {
-  const instrumentation = {};
-  new OpenAIStreamingUsageInstrumentor().instrument(instrumentation);
-  assert.equal(instrumentation._streamingWrapPromise, undefined);
-});

package/tests/instrumentation/vercel/full_instrumentation.test.js

@@ -1,16 +0,0 @@
-'use strict';
-
-const test = require('node:test');
-const assert = require('node:assert/strict');
-
-const {
-  VercelAiSdkInstrumentor,
-} = require('../../../src/instrumentation/vercel/full_instrumentation');
-
-// The `ai` / `@ai-sdk/otel` packages are app dependencies (not installed in
-// this repo), so instrument() must fail with an actionable install message.
-// The success path (registerTelemetry wiring) is covered by the vercel e2e
-// ingestion scenario.
-test('instrument() without the ai packages installed throws an install hint', () => {
-  assert.throws(() => new VercelAiSdkInstrumentor().instrument(), /npm install ai @ai-sdk\/otel/);
-});

package/tests/instrumentation/vercel/get_cache_creation_telemetry.test.js

@@ -1,96 +0,0 @@
-'use strict';
-
-// Tests for the ai >= 7 cache-write capture: the telemetry dispatcher's
-// onLanguageModelCallEnd reads the raw `usage.cache_creation` off the event's
-// raw provider usage and stamps it verbatim on the still-open model-call span
-// (reached through the integration's call state) before ending it.
-
-const test = require('node:test');
-const assert = require('node:assert/strict');
-
-const {
-  VercelCacheCreationInstrumentor,
-  cacheCreationFromRawUsage,
-} = require('../../../src/instrumentation/vercel/get_cache_creation_telemetry');
-
-const RAW_ANTHROPIC_USAGE = {
-  input_tokens: 7,
-  cache_creation_input_tokens: 6053,
-  cache_creation: { ephemeral_5m_input_tokens: 6053, ephemeral_1h_input_tokens: 0 },
-};
-
-function makeFakeSpan() {
-  const attributes = {};
-  return {
-    attributes,
-    setAttribute(key, value) {
-      attributes[key] = value;
-    },
-  };
-}
-
-function makeInstrumentedDispatcher() {
-  const span = makeFakeSpan();
-  const endedEvents = [];
-  const dispatcher = {
-    onLanguageModelCallEnd(event) {
-      endedEvents.push(event);
-    },
-    getCallState(callId) {
-      return callId === 'call-1' ? { inferenceSpan: span } : undefined;
-    },
-  };
-  const instrumentor = new VercelCacheCreationInstrumentor();
-  instrumentor.instrument(dispatcher);
-  return { dispatcher, span, endedEvents, instrumentor };
-}
-
-test('stamps the raw cache_creation from the provider usage on the model-call span', () => {
-  const { dispatcher, span, endedEvents } = makeInstrumentedDispatcher();
-
-  dispatcher.onLanguageModelCallEnd({
-    callId: 'call-1',
-    usage: { inputTokens: 6060, outputTokens: 5, raw: RAW_ANTHROPIC_USAGE },
-  });
-
-  assert.deepEqual(
-    JSON.parse(span.attributes['weflayr.cache.creation']),
-    RAW_ANTHROPIC_USAGE.cache_creation
-  );
-  // The original handler still runs (it ends the span).
-  assert.equal(endedEvents.length, 1);
-});
-
-test('stamps nothing without a cache_creation in the raw usage', () => {
-  const { dispatcher, span } = makeInstrumentedDispatcher();
-
-  dispatcher.onLanguageModelCallEnd({
-    callId: 'call-1',
-    usage: { inputTokens: 13, outputTokens: 5, raw: { input_tokens: 13 } },
-  });
-
-  assert.ok(!('weflayr.cache.creation' in span.attributes));
-});
-
-test('cacheCreationFromRawUsage drops an all-zero cache_creation', () => {
-  assert.deepEqual(
-    cacheCreationFromRawUsage({
-      cache_creation: { ephemeral_5m_input_tokens: 4000, ephemeral_1h_input_tokens: 1300 },
-    }),
-    { ephemeral_5m_input_tokens: 4000, ephemeral_1h_input_tokens: 1300 }
-  );
-  assert.equal(
-    cacheCreationFromRawUsage({
-      cache_creation: { ephemeral_5m_input_tokens: 0, ephemeral_1h_input_tokens: 0 },
-    }),
-    undefined
-  );
-  assert.equal(cacheCreationFromRawUsage(undefined), undefined);
-});
-
-test('uninstrument restores the original handler', () => {
-  const { dispatcher, instrumentor } = makeInstrumentedDispatcher();
-  assert.equal(dispatcher.onLanguageModelCallEnd.name, 'onLanguageModelCallEndWithCacheCreation');
-  instrumentor.uninstrument();
-  assert.equal(dispatcher.onLanguageModelCallEnd.name, 'onLanguageModelCallEnd');
-});

package/tests/otel/vercel-ai-sdk-span-filter.test.js

@@ -1,159 +0,0 @@
-'use strict';
-
-// The Vercel AI SDK emits aggregate spans around each model call (see
-// src/otel/vercel-ai-sdk-span-filter.js). These tests drive real spans through
-// the WeflayrSpanProcessor and assert exactly one span per model call is
-// exported, for both the ai >= 7 semconv shape and the legacy ai.* shape.
-
-const test = require('node:test');
-const assert = require('node:assert/strict');
-const { context, trace } = require('@opentelemetry/api');
-const { BasicTracerProvider, InMemorySpanExporter } = require('@opentelemetry/sdk-trace-base');
-
-const { WeflayrSpanProcessor } = require('../../src/otel/span-processor');
-
-function buildProviderWithExporter() {
-  const exporter = new InMemorySpanExporter();
-  const provider = new BasicTracerProvider({
-    spanProcessors: [new WeflayrSpanProcessor({ exporter, exportMode: 'immediate' })],
-  });
-  return { exporter, provider };
-}
-
-function startChildSpan(tracer, parentSpan, name, attributes) {
-  const parentContext = trace.setSpan(context.active(), parentSpan);
-  return tracer.startSpan(name, { attributes }, parentContext);
-}
-
-test('semconv shape: only the chat span is exported, not invoke_agent/step/tool', () => {
-  const { exporter, provider } = buildProviderWithExporter();
-  const tracer = provider.getTracer('gen_ai');
-
-  const invokeAgent = tracer.startSpan('invoke_agent openai/gpt-4o-mini', {
-    attributes: {
-      'gen_ai.operation.name': 'invoke_agent',
-      'gen_ai.usage.input_tokens': 50,
-      'gen_ai.usage.output_tokens': 15,
-    },
-  });
-  const step = startChildSpan(tracer, invokeAgent, 'step 1', {
-    'gen_ai.operation.name': 'agent_step',
-  });
-  const chat = startChildSpan(tracer, step, 'chat openai/gpt-4o-mini', {
-    'gen_ai.operation.name': 'chat',
-    'gen_ai.usage.input_tokens': 50,
-    'gen_ai.usage.output_tokens': 15,
-  });
-  const tool = startChildSpan(tracer, step, 'execute_tool get_weather', {
-    'gen_ai.operation.name': 'execute_tool',
-  });
-
-  chat.end();
-  tool.end();
-  step.end();
-  invokeAgent.end();
-
-  const exported = exporter.getFinishedSpans();
-  assert.equal(exported.length, 1);
-  assert.equal(exported[0].name, 'chat openai/gpt-4o-mini');
-});
-
-test('semconv shape: nested embeddings span is dropped, the outer one is exported', () => {
-  const { exporter, provider } = buildProviderWithExporter();
-  const tracer = provider.getTracer('gen_ai');
-
-  const outerEmbeddings = tracer.startSpan('embeddings openai/text-embedding-3-small', {
-    attributes: {
-      'gen_ai.operation.name': 'embeddings',
-      'gen_ai.usage.input_tokens': 2,
-    },
-  });
-  const modelCallEmbeddings = startChildSpan(
-    tracer,
-    outerEmbeddings,
-    'embeddings openai/text-embedding-3-small',
-    {
-      'gen_ai.operation.name': 'embeddings',
-      'gen_ai.usage.input_tokens': 2,
-    }
-  );
-
-  modelCallEmbeddings.end();
-  outerEmbeddings.end();
-
-  const exported = exporter.getFinishedSpans();
-  assert.equal(exported.length, 1);
-  assert.equal(exported[0].spanContext().spanId, outerEmbeddings.spanContext().spanId);
-});
-
-test('legacy shape: only ai.<fn>.do* spans are exported', () => {
-  const { exporter, provider } = buildProviderWithExporter();
-  const tracer = provider.getTracer('ai');
-
-  const outer = tracer.startSpan('ai.streamText', {
-    attributes: { 'ai.usage.inputTokens': 100 },
-  });
-  const doStream = startChildSpan(tracer, outer, 'ai.streamText.doStream', {
-    'gen_ai.usage.input_tokens': 100,
-  });
-  const toolCall = startChildSpan(tracer, outer, 'ai.toolCall', {});
-  const doEmbed = tracer.startSpan('ai.embed.doEmbed', {
-    attributes: { 'gen_ai.usage.input_tokens': 1 },
-  });
-
-  doStream.end();
-  toolCall.end();
-  doEmbed.end();
-  outer.end();
-
-  const exported = exporter.getFinishedSpans().map((span) => span.name);
-  assert.deepEqual(exported.sort(), ['ai.embed.doEmbed', 'ai.streamText.doStream']);
-});
-
-test('gateway provider id gets the weflayr override, direct providers do not', () => {
-  const { exporter, provider } = buildProviderWithExporter();
-  const tracer = provider.getTracer('gen_ai');
-
-  const gatewayChat = tracer.startSpan('chat openai/gpt-4o-mini', {
-    attributes: { 'gen_ai.operation.name': 'chat', 'gen_ai.provider.name': 'gateway' },
-  });
-  gatewayChat.end();
-  const directChat = tracer.startSpan('chat gpt-4o-mini', {
-    attributes: { 'gen_ai.operation.name': 'chat', 'gen_ai.provider.name': 'openai' },
-  });
-  directChat.end();
-
-  const [gatewayExported, directExported] = exporter.getFinishedSpans();
-  assert.equal(gatewayExported.attributes['weflayr.provider_name'], 'vercel_ai_gateway');
-  assert.equal(directExported.attributes['weflayr.provider_name'], undefined);
-});
-
-test('gateway provider id does not overwrite a propagateMetadata providerName', () => {
-  const { exporter, provider } = buildProviderWithExporter();
-  const tracer = provider.getTracer('gen_ai');
-
-  const chat = tracer.startSpan('chat openai/gpt-4o-mini', {
-    attributes: {
-      'gen_ai.operation.name': 'chat',
-      'gen_ai.provider.name': 'gateway',
-      'weflayr.provider_name': 'openai',
-    },
-  });
-  chat.end();
-
-  assert.equal(exporter.getFinishedSpans()[0].attributes['weflayr.provider_name'], 'openai');
-});
-
-test('non-Vercel scopes still go through the default export filter', () => {
-  const { exporter, provider } = buildProviderWithExporter();
-
-  const llmSpan = provider
-    .getTracer('@traceloop/instrumentation-openai')
-    .startSpan('openai.chat', { attributes: { 'gen_ai.system': 'openai' } });
-  llmSpan.end();
-  const unrelatedSpan = provider.getTracer('my-app').startSpan('http request');
-  unrelatedSpan.end();
-
-  const exported = exporter.getFinishedSpans().map((span) => span.name);
-  assert.deepEqual(exported, ['openai.chat']);
-});

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  // First TypeScript module of the SDK: only src/api is compiled (to dist/);
-  // the rest of src stays plain JavaScript until it is migrated.
-  "compilerOptions": {
-    "target": "ES2022",
-    "lib": ["ES2022", "DOM", "DOM.Iterable"],
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "rootDir": "src",
-    "outDir": "dist",
-    "declaration": true,
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "types": ["node"]
-  },
-  "include": ["src/api"]
-}