-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
feat(deno): add aws integration #22465
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-orchestrion-integrations-graphql
from
isaacs/deno-orchestrion-integrations-aws
+134
−0
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
127 changes: 127 additions & 0 deletions
127
dev-packages/deno-integration-tests/suites/orchestrion-aws/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,127 @@ | ||
| // <reference lib="deno.ns" /> | ||
|
|
||
| import { tracingChannel } from 'node:diagnostics_channel'; | ||
| import type { Span, TransactionEvent } from '@sentry/core'; | ||
| import type { DenoClient } from '@sentry/deno'; | ||
| import { getCurrentScope, getGlobalScope, getIsolationScope, init, spanToJSON, 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('aws-sdk 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('Aws'), `Aws should be in defaults, got ${names.join(', ')}`); | ||
| }); | ||
|
|
||
| // Drives the `orchestrion:@smithy/smithy-client:send` channel — the same events | ||
| // the orchestrion transform publishes around the AWS SDK v3 `Client.prototype.send` | ||
| // — so no live AWS client is needed. The subscriber reads the command and client | ||
| // config off the channel context and opens an `rpc` span. The span end is deferred | ||
| // until the client's async `region()` backfill settles (see the integration), so | ||
| // the parent span is held open until the `spanEnd` hook reports the child ended. | ||
| Deno.test('aws-sdk instrumentation: orchestrion @smithy/smithy-client:send channel produces a nested rpc span', async () => { | ||
| resetGlobals(); | ||
| const sink = transactionSink(); | ||
| const client = init({ | ||
| dsn: 'https://username@domain/123', | ||
| tracesSampleRate: 1, | ||
| beforeSendTransaction: sink.beforeSendTransaction, | ||
| }) as DenoClient; | ||
|
|
||
| // The rpc span ends only after the deferred region backfill settles. Wait on the | ||
| // concrete `spanEnd` signal rather than a timer, so the parent stays open until the | ||
| // child has actually ended and can be captured on the transaction. | ||
| const rpcSpanEnded = new Promise<void>(resolve => { | ||
| client.on('spanEnd', (span: Span) => { | ||
| if (spanToJSON(span).op === 'rpc') { | ||
| resolve(); | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| const channel = tracingChannel('orchestrion:@smithy/smithy-client:send'); | ||
|
|
||
| // The shape the transform attaches: `arguments[0]` is the v3 command, `self` the | ||
| // client. `serviceId` names the service; the command constructor name (minus the | ||
| // `Command` suffix) names the operation. `region()` resolves the client region. | ||
| const command = { input: {}, constructor: { name: 'DescribeAlarmsCommand' } }; | ||
| const ctx: Record<string, unknown> = { | ||
| arguments: [command], | ||
| self: { config: { serviceId: 'CloudWatch', region: () => 'us-east-1' }, constructor: { name: 'CloudWatchClient' } }, | ||
| }; | ||
|
|
||
| await startSpan({ name: 'parent', op: 'test' }, async () => { | ||
| channel.start.runStores(ctx, () => undefined); | ||
| // `send` returns a promise, so `tracePromise` publishes `end` before it settles | ||
| // (no `result` yet — the `end` subscriber is a no-op then), then `asyncEnd` once | ||
| // the promise resolves with the result. Mirror that order so the span closes on | ||
| // `asyncEnd` alone, as it does in production. | ||
| channel.end.publish(ctx); | ||
| ctx.result = { $metadata: { requestId: 'req-123', httpStatusCode: 200 } }; | ||
| channel.asyncEnd.publish(ctx); | ||
| await rpcSpanEnded; | ||
| }); | ||
|
|
||
| const parent = await withTimeout( | ||
| sink.waitFor(t => t.transaction === 'parent'), | ||
| 5000, | ||
| "'parent' transaction", | ||
| ); | ||
|
|
||
| const awsSpan = parent.spans?.find(s => s.op === 'rpc'); | ||
| assertExists(awsSpan, `expected an rpc child span, got ops: ${parent.spans?.map(s => s.op).join(', ')}`); | ||
| assertEquals(awsSpan!.description, 'CloudWatch.DescribeAlarms'); | ||
| assertEquals(awsSpan!.data?.['rpc.system'], 'aws-api'); | ||
| assertEquals(awsSpan!.data?.['rpc.service'], 'CloudWatch'); | ||
| assertEquals(awsSpan!.data?.['rpc.method'], 'DescribeAlarms'); | ||
| assertEquals(awsSpan!.data?.['cloud.region'], 'us-east-1'); | ||
| assertEquals(awsSpan!.data?.['sentry.origin'], 'auto.aws.orchestrion.aws_sdk'); | ||
| }); | ||
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
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.