-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
feat(deno): add postgresjs integration #22448
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.
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
isaacs/deno-auto-ingest-orchestrion-integrations
from
isaacs/deno-orchestrion-integrations-postgresjs
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
106 changes: 106 additions & 0 deletions
106
dev-packages/deno-integration-tests/suites/orchestrion-postgresjs/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| // <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('postgres.js 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('PostgresJs'), `PostgresJs should be in defaults, got ${names.join(', ')}`); | ||
| }); | ||
|
|
||
| Deno.test('postgres.js instrumentation: orchestrion:postgres:handle channel produces a nested db span', async () => { | ||
| resetGlobals(); | ||
| const sink = transactionSink(); | ||
| init({ | ||
| dsn: 'https://username@domain/123', | ||
| tracesSampleRate: 1, | ||
| beforeSendTransaction: sink.beforeSendTransaction, | ||
| }); | ||
|
|
||
| const channel = tracingChannel('orchestrion:postgres:handle'); | ||
|
|
||
| // `self` is the postgres.js `Query`; `strings` is its tagged-template SQL parts. | ||
| // The span ends when postgres.js calls `query.resolve`, which the subscriber wraps. | ||
| const query = { | ||
| strings: ['SELECT name FROM users'], | ||
| executed: false, | ||
| resolve: (..._args: unknown[]) => undefined, | ||
| reject: (..._args: unknown[]) => undefined, | ||
| }; | ||
| const ctx = { self: query }; | ||
|
|
||
| startSpan({ name: 'parent', op: 'test' }, () => { | ||
| // `start` creates the span and wraps `query.resolve`/`query.reject`. | ||
| channel.start.runStores(ctx, () => undefined); | ||
| // postgres.js signals completion by calling `resolve`; the wrapper ends the span. | ||
| query.resolve({ command: 'SELECT' }); | ||
| }); | ||
|
|
||
| const parent = await withTimeout( | ||
| sink.waitFor(t => t.transaction === 'parent'), | ||
| 5000, | ||
| "'parent' transaction", | ||
| ); | ||
|
|
||
| const pgSpan = parent.spans?.find(s => s.op === 'db'); | ||
| assertExists(pgSpan, `expected a db child span, got ops: ${parent.spans?.map(s => s.op).join(', ')}`); | ||
| assertEquals(pgSpan!.description, 'SELECT name FROM users'); | ||
| assertEquals(pgSpan!.data?.['db.system.name'], 'postgres'); | ||
| assertEquals(pgSpan!.data?.['db.query.text'], 'SELECT name FROM users'); | ||
| // Set by the resolve wrapper from the `command` passed to `query.resolve`. | ||
| assertEquals(pgSpan!.data?.['db.operation.name'], 'SELECT'); | ||
| assertEquals(pgSpan!.data?.['sentry.origin'], 'auto.db.orchestrion.postgresjs'); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.