Skip to content

feat(deno): add google-genai integration #22469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
isaacs wants to merge 1 commit into from
+114 −0
Open

feat(deno): add google-genai integration #22469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 107 additions & 0 deletions dev-packages/deno-integration-tests/suites/orchestrion-google-genai/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
// <reference lib="deno.ns" />

import { tracingChannel } from 'node:diagnostics_channel';
import type { TransactionEvent } from '@sentry/core';
import type { DenoClient } from '@sentry/deno';
import { getCurrentScope, getGlobalScope, getIsolationScope, init, startSpan } from '@sentry/deno';
import { assert } from 'https://deno.land/std@0.212.0/assert/assert.ts';
import { assertExists } from 'https://deno.land/std@0.212.0/assert/assert_exists.ts';
import { assertEquals } from 'https://deno.land/std@0.212.0/assert/assert_equals.ts';

function resetGlobals(): void {
getCurrentScope().clear();
getCurrentScope().setClient(undefined);
getIsolationScope().clear();
getGlobalScope().clear();
}

/** See deno-redis.test.ts — same sink shape, deduped for clarity. */
function transactionSink(): {
beforeSendTransaction: (event: TransactionEvent) => null;
waitFor: (predicate: (event: TransactionEvent) => boolean) => Promise<TransactionEvent>;
} {
const transactions: TransactionEvent[] = [];
const waiters: { predicate: (e: TransactionEvent) => boolean; resolve: (e: TransactionEvent) => void }[] = [];
return {
beforeSendTransaction(event) {
transactions.push(event);
for (let i = waiters.length - 1; i >= 0; i--) {
const w = waiters[i]!;
if (w.predicate(event)) {
waiters.splice(i, 1);
w.resolve(event);
}
}
return null;
},
waitFor(predicate) {
const already = transactions.find(predicate);
if (already) return Promise.resolve(already);
return new Promise<TransactionEvent>(resolve => {
waiters.push({ predicate, resolve });
});
},
};
}

function withTimeout<T>(p: Promise<T>, ms: number, what: string): Promise<T> {
let timer: ReturnType<typeof setTimeout> | undefined;
const timeout = new Promise<T>((_, reject) => {
timer = setTimeout(() => reject(new Error(`Timed out waiting for ${what} after ${ms}ms`)), ms);
});
return Promise.race([p, timeout]).finally(() => {
if (timer !== undefined) clearTimeout(timer);
});
}

Deno.test('google-genai instrumentation: included in default integrations (Deno 2.8.0+)', () => {
resetGlobals();
const client = init({ dsn: 'https://username@domain/123' }) as DenoClient;
const names = client.getOptions().integrations.map(i => i.name);
assert(names.includes('Google_GenAI'), `Google_GenAI should be in defaults, got ${names.join(', ')}`);
});

Deno.test('google-genai instrumentation: orchestrion @google/genai:generate-content channel produces a nested gen_ai span', async () => {
resetGlobals();
const sink = transactionSink();
init({
Comment on lines +64 to +67

@sentry sentry Bot Jul 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: A module-level installedIntegrations array is not cleared between tests, causing subsequent init() calls to skip setup and leading to test failures.
Severity: MEDIUM

Suggested Fix

The installedIntegrations array should be cleared between tests. This can be done by exporting a reset function from @sentry/core that clears the array and then calling this new function within resetGlobals(). This will ensure each test runs in a clean state.

Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location:
dev-packages/deno-integration-tests/suites/orchestrion-google-genai/test.ts#L69-L72

Potential issue: A module-level array, `installedIntegrations`, is not cleared between
tests, even when `resetGlobals()` is called. When a second test in the same file calls
`init()`, the integration's `setupOnce()` function is skipped because the integration
name is already present in the array from the first test's execution. This prevents
diagnostic channel subscriptions from being set up for the second test. Consequently,
the test times out waiting for a transaction that is never created, causing a test
failure.

Also affects:

  • packages/core/src/integration.ts:10
  • packages/core/src/integration.ts:117~119

Did we get this right? 👍 / 👎 to inform future reviews.

dsn: 'https://username@domain/123',
tracesSampleRate: 1,
beforeSendTransaction: sink.beforeSendTransaction,
});

Comment on lines +64 to +72

@sentry sentry Bot Jul 22, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Module-level state in installedIntegrations is not reset between tests, causing subsequent calls to init() in the same process to skip the setupOnce() logic for integrations.
Severity: MEDIUM

Suggested Fix

To ensure test isolation, implement a mechanism to reset the module-level state between tests. Export a reset function from the SDK's core integration module that clears the installedIntegrations array. This function should be called in a beforeEach or afterEach hook within the test suite to guarantee each test starts with a clean state.

Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location:
dev-packages/deno-integration-tests/suites/orchestrion-google-genai/test.ts#L64-L72

Potential issue: The `installedIntegrations` array is a module-level variable that
persists for the lifetime of a process. When tests run in the same process, the first
test adds the 'Google_GenAI' integration name to this array. The second test calls
`init()` again, but because the integration name is already present in
`installedIntegrations`, the `setupOnce()` function is skipped. This prevents the
diagnostic channel subscription from being established in the second test, causing it to
fail when it asserts the existence of an expected span. This behavior could also occur
in production if `init()` is called multiple times in the same process, causing
instrumentation to silently fail.

const channel = tracingChannel('orchestrion:@google/genai:generate-content');

// `arguments[0]` is the request params passed to `generateContent(params)`.
const params = { model: 'gemini-1.5-flash', contents: 'hi' };
const ctx: Record<string, unknown> = { arguments: [params] };

startSpan({ name: 'parent', op: 'test' }, () => {
channel.start.runStores(ctx, () => undefined);
channel.end.publish(ctx);
ctx.result = {
modelVersion: 'gemini-1.5-flash-002',
usageMetadata: { promptTokenCount: 10, candidatesTokenCount: 5, totalTokenCount: 15 },
};
channel.asyncEnd.publish(ctx);
});

const parent = await withTimeout(
sink.waitFor(t => t.transaction === 'parent'),
5000,
"'parent' transaction",
);

const aiSpan = parent.spans?.find(s => s.op === 'gen_ai.generate_content');
assertExists(
aiSpan,
`expected a gen_ai.generate_content child span, got ops: ${parent.spans?.map(s => s.op).join(', ')}`,
);
assertEquals(aiSpan!.description, 'generate_content gemini-1.5-flash');
assertEquals(aiSpan!.data?.['gen_ai.system'], 'google_genai');
assertEquals(aiSpan!.data?.['gen_ai.operation.name'], 'generate_content');
assertEquals(aiSpan!.data?.['gen_ai.request.model'], 'gemini-1.5-flash');
assertEquals(aiSpan!.data?.['gen_ai.response.model'], 'gemini-1.5-flash-002');
assertEquals(aiSpan!.data?.['gen_ai.usage.total_tokens'], 15);
assertEquals(aiSpan!.data?.['sentry.origin'], 'auto.ai.orchestrion.google_genai');
});
1 change: 1 addition & 0 deletions packages/deno/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ export {
expressChannelIntegration,
firebaseChannelIntegration,
genericPoolChannelIntegration,
googleGenAIChannelIntegration,
graphqlDiagnosticsChannelIntegration,
hapiChannelIntegration,
kafkajsChannelIntegration,
Expand Down
2 changes: 2 additions & 0 deletions packages/deno/src/sdk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
expressChannelIntegration,
firebaseChannelIntegration,
genericPoolChannelIntegration,
googleGenAIChannelIntegration,
graphqlDiagnosticsChannelIntegration,
hapiChannelIntegration,
kafkajsChannelIntegration,
Expand Down Expand Up @@ -95,6 +96,7 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
expressChannelIntegration(),
firebaseChannelIntegration(),
genericPoolChannelIntegration(),
googleGenAIChannelIntegration(),
hapiChannelIntegration(),
kafkajsChannelIntegration(),
koaChannelIntegration(),
Expand Down
4 changes: 4 additions & 0 deletions packages/deno/test/__snapshots__/mod.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ snapshot[`captureException 1`] = `
"Express",
"Firebase",
"GenericPool",
"Google_GenAI",
"Hapi",
"Kafka",
"Koa",
Expand Down Expand Up @@ -216,6 +217,7 @@ snapshot[`captureMessage 1`] = `
"Express",
"Firebase",
"GenericPool",
"Google_GenAI",
"Hapi",
"Kafka",
"Koa",
Expand Down Expand Up @@ -317,6 +319,7 @@ snapshot[`captureMessage twice 1`] = `
"Express",
"Firebase",
"GenericPool",
"Google_GenAI",
"Hapi",
"Kafka",
"Koa",
Expand Down Expand Up @@ -425,6 +428,7 @@ snapshot[`captureMessage twice 2`] = `
"Express",
"Firebase",
"GenericPool",
"Google_GenAI",
"Hapi",
"Kafka",
"Koa",
Expand Down
Loading