weflayr 0.22.0 → 0.22.2

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

@@ -0,0 +1,159 @@
+'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

@@ -0,0 +1,18 @@
+{
+  // 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"]
+}