Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 0 additions & 11 deletions dev-packages/node-integration-tests/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,17 +56,6 @@ export function getPortAppIsRunningOn(app: Express): number | undefined {
return app.port;
}

/**
* Whether channel-based (orchestrion diagnostics-channel) instrumentation is active.
*
* Channel-based instrumentation is the default in v11, so this is always `true`. Kept as a helper
* (rather than inlining `true`) so the suites' origin/shape selectors read intentionally; the OTel
* branches they still contain are dead and get removed alongside the vendored OTel code (JS-3074).
*/
export function isOrchestrionEnabled(): boolean {
return true;
}

/**
* Retries `probe` until it resolves, or throws once `timeout` ms elapse.
*
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import type { SerializedStreamedSpanContainer } from '@sentry/core';
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// See the non-streamed `aws-integration` suite: only the origin differs between the OTel and
// orchestrion diagnostics-channel runs.
const ORIGIN = isOrchestrionEnabled() ? 'auto.aws.aws_sdk' : 'auto.otel.aws';
const ORIGIN = 'auto.aws.aws_sdk';

// The aws-sdk instrumentation creates spans by patching the underlying smithy middleware stack. The
// patch target differs between aws-sdk versions, so we run the exact same assertions against both:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
import type { TransactionEvent } from '@sentry/core';
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// The suite runs twice on CI: once with the OTel `Aws` integration (default) and once with the
// orchestrion diagnostics-channel integration auto-injected (`INJECT_ORCHESTRION`). Both emit the
// same spans; only the origin differs.
const ORIGIN = isOrchestrionEnabled() ? 'auto.aws.aws_sdk' : 'auto.otel.aws';
const ORIGIN = 'auto.aws.aws_sdk';

// The aws-sdk instrumentation creates spans by patching the underlying smithy middleware stack. The
// patch target differs between aws-sdk versions, so we run the exact same assertions against both:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { afterAll, describe, expect } from 'vitest';
import { assertSentryTransaction } from '../../../utils/assertions';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';
import { isOrchestrionEnabled } from '../../../utils';

describe('express tracing', () => {
afterAll(() => {
Expand Down Expand Up @@ -98,15 +97,9 @@ describe('express tracing', () => {
// The handler delays its response by ~100ms (see scenario).
const routerDurationMs = ((routerSpan?.timestamp ?? 0) - (routerSpan?.start_timestamp ?? 0)) * 1000;

if (isOrchestrionEnabled()) {
// The orchestrion router span stays open until the response finishes, so
// it spans the whole sub-stack it dispatched (~the 100ms handler delay).
expect(routerDurationMs).toBeGreaterThan(50);
} else {
// The OTel integration ends router spans immediately, so the router span
// is a ~0ms marker regardless of how long its sub-stack runs.
expect(routerDurationMs).toBeLessThan(50);
}
// The router span stays open until the response finishes, so it spans the
// whole sub-stack it dispatched (~the 100ms handler delay).
expect(routerDurationMs).toBeGreaterThan(50);
},
})
.start();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,13 @@ import {
GEN_AI_USAGE_TOTAL_TOKENS,
} from '@sentry/conventions/attributes';
import { GEN_AI_REQUEST_STREAM_ATTRIBUTE } from '../../../../../packages/server-utils/src/ai/core/gen-ai-attributes';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('Anthropic integration', () => {
afterAll(() => {
cleanupChildProcesses();
});

const EXPECTED_MODEL_ERROR = {
exception: {
values: [
{
type: 'Error',
value: '404 Model not found',
},
],
},
};

const EXPECTED_STREAM_EVENT_HANDLER_MESSAGE = {
message: 'stream event from user-added event listener captured',
};
Expand Down Expand Up @@ -83,12 +71,6 @@ describe('Anthropic integration', () => {
test('creates anthropic related spans with genAI recording disabled', async () => {
const runner = createRunner();

// The orchestrion path only marks the errored span; unlike the OTel path it does not
// capture the handled `error-model` rejection as an event.
if (!isOrchestrionEnabled()) {
runner.expect({ event: EXPECTED_MODEL_ERROR });
}

await runner
.expect({ transaction: { transaction: 'main' } })
.expect({
Expand Down Expand Up @@ -124,12 +106,6 @@ describe('Anthropic integration', () => {
test('creates anthropic related spans with genAI recording enabled', async () => {
const runner = createRunner();

// The orchestrion path only marks the errored span; unlike the OTel path it does not
// capture the handled `error-model` rejection as an event.
if (!isOrchestrionEnabled()) {
runner.expect({ event: EXPECTED_MODEL_ERROR });
}

await runner
.expect({ transaction: { transaction: 'main' } })
.expect({
Expand Down Expand Up @@ -194,12 +170,6 @@ describe('Anthropic integration', () => {
test('creates anthropic related spans with custom options', async () => {
const runner = createRunner();

// The orchestrion path only marks the errored span; unlike the OTel path it does not
// capture the handled `error-model` rejection as an event.
if (!isOrchestrionEnabled()) {
runner.expect({ event: EXPECTED_MODEL_ERROR });
}

await runner
.expect({ transaction: { transaction: 'main' } })
.expect({
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Server start transaction (Apollo Server v5 no longer runs introspection query on start)
const EXPECTED_START_SERVER_TRANSACTION = {
transaction: 'Test Server Start',
};

// apollo uses graphql v16, so the default run instruments it via the vendored OTel patcher and the
// orchestrion run (auto-injected on CI) via the diagnostics-channel path. Both emit the same span
// name/status; the origin and the document attribute (`graphql.source` vs `graphql.document`) differ.
const orchestrion = isOrchestrionEnabled();
const ORIGIN = orchestrion ? 'auto.graphql.diagnostic_channel' : 'auto.graphql.otel.graphql';
const ORIGIN = 'auto.graphql.diagnostic_channel';

function graphqlExecuteSpan(opts: {
description: string;
Expand All @@ -28,7 +23,7 @@ function graphqlExecuteSpan(opts: {
data: expect.objectContaining({
'graphql.operation.type': operationType,
...(operationName ? { 'graphql.operation.name': operationName } : {}),
[orchestrion ? 'graphql.document' : 'graphql.source']: document,
'graphql.document': document,
'sentry.origin': ORIGIN,
}),
});
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// The span origin depends on which instrumentation is active. When the generic orchestrion run is
// enabled (via INJECT_ORCHESTRION) the OTel `Dataloader` integration is swapped for the
// diagnostics-channel one, which stamps a different origin.
const ORIGIN = isOrchestrionEnabled() ? 'auto.db.dataloader' : 'auto.db.otel.dataloader';
const ORIGIN = 'auto.db.dataloader';
const CACHE_GET_OP = 'cache.get';
const CACHE_MUTATION_OPS = { prime: 'cache.put', clear: 'cache.remove', clearAll: 'cache.remove' } as const;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('hapi auto-instrumentation', () => {
afterAll(async () => {
cleanupChildProcesses();
});

// `createEsmAndCjsTests` auto-runs this suite with orchestrion on CI. The
// orchestrion path keeps span ops/attributes identical to the OTel path; only
// the origin differs to signal the injection mechanism, so we branch on
// `isOrchestrionEnabled()`.
const origin = isOrchestrionEnabled() ? 'auto.http.hapi' : 'auto.http.otel.hapi';
const origin = 'auto.http.hapi';

const EXPECTED_TRANSACTION = {
transaction: 'GET /',
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import type { TransactionEvent } from '@sentry/core';
import { afterAll, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests, describeWithDockerCompose } from '../../../utils/runner';

const producerOrigin = isOrchestrionEnabled() ? 'auto.kafkajs.producer' : 'auto.kafkajs.otel.producer';
const consumerOrigin = isOrchestrionEnabled() ? 'auto.kafkajs.consumer' : 'auto.kafkajs.otel.consumer';
const producerOrigin = 'auto.kafkajs.producer';
const consumerOrigin = 'auto.kafkajs.consumer';

describeWithDockerCompose('kafkajs', { workingDirectory: [__dirname] }, () => {
afterAll(() => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import { describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../../utils';
import { createEsmAndCjsTests, describeWithDockerCompose } from '../../../../utils/runner';

describeWithDockerCompose('knex auto instrumentation', { workingDirectory: [__dirname] }, () => {
// Update this if another knex version is installed
const KNEX_VERSION = '2.5.1';
const ORIGIN = isOrchestrionEnabled() ? 'auto.db.knex' : 'auto.db.otel.knex';
const ORIGIN = 'auto.db.knex';

describe('with `mysql2` client', () => {
createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import { describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../../utils';
import { createEsmAndCjsTests, describeWithDockerCompose } from '../../../../utils/runner';

describe('knex auto instrumentation', () => {
// Update this if another knex version is installed
const KNEX_VERSION = '2.5.1';
const ORIGIN = isOrchestrionEnabled() ? 'auto.db.knex' : 'auto.db.otel.knex';
const ORIGIN = 'auto.db.knex';

describeWithDockerCompose('with `pg` client', { workingDirectory: [__dirname] }, () => {
createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('koa auto-instrumentation', () => {
afterAll(async () => {
cleanupChildProcesses();
});

// `createEsmAndCjsTests` auto-runs this suite with orchestrion on CI. The
// orchestrion path keeps span ops/attributes identical to the OTel path; only
// the origin differs to signal the injection mechanism, so we branch on
// `isOrchestrionEnabled()`.
const origin = isOrchestrionEnabled() ? 'auto.http.koa' : 'auto.http.otel.koa';
const origin = 'auto.http.koa';

const EXPECTED_ERROR_EVENT = {
exception: {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,41 +1,34 @@
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';
import { createCjsTests } from '../../../utils/runner/createEsmAndCjsTests';
import { isOrchestrionEnabled } from '../../../utils';

describe('lru-memoizer', () => {
afterAll(() => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.expect({
transaction: {
transaction: 'test-name',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.expect({
transaction: {
transaction: 'test-name',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
},
}),
},
})
.start()
.completed();
});
},
{ failsOnEsm: !isOrchestrionEnabled() },
);
},
})
.start()
.completed();
});
});

// CJS-only: the parallel scenario is flaky in ESM (see #21729).
createCjsTests(__dirname, 'scenario-parallel.mjs', 'instrument.mjs', (createTestRunner, test) => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import type { TransactionEvent } from '@sentry/core';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Pins mongodb 4 so the = 4.0 <6.4 callback-based command band and the
Expand All @@ -21,7 +20,7 @@ describe('MongoDB v4 auto-instrumentation', () => {
cleanupChildProcesses();
});

const origin = isOrchestrionEnabled() ? 'auto.db.mongo' : 'auto.db.otel.mongo';
const origin = 'auto.db.mongo';

const spanFor = (operation: string): unknown =>
expect.objectContaining({
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import type { TransactionEvent } from '@sentry/core';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Pins mongodb 5 so the >= 4.0 < 6.4 callback-based command band and the
Expand All @@ -21,7 +20,7 @@ describe('MongoDB v5 auto-instrumentation', () => {
cleanupChildProcesses();
});

const origin = isOrchestrionEnabled() ? 'auto.db.mongo' : 'auto.db.otel.mongo';
const origin = 'auto.db.mongo';

const spanFor = (operation: string): unknown =>
expect.objectContaining({
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import type { TransactionEvent } from '@sentry/core';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Pins mongodb 6 so the >= 6.4 promise-based `Connection.prototype.command`
Expand All @@ -21,7 +20,7 @@ describe('MongoDB v6 auto-instrumentation', () => {
cleanupChildProcesses();
});

const origin = isOrchestrionEnabled() ? 'auto.db.mongo' : 'auto.db.otel.mongo';
const origin = 'auto.db.mongo';

// `db.statement` (scrubbed full command doc) and `db.connection_string` vary
// by driver version, so assert their presence rather than exact content;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { TransactionEvent } from '@sentry/core';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, expect } from 'vitest';
import { conditionalTest, isOrchestrionEnabled } from '../../../utils';
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Pins mongodb 7 so the >= 6.4 promise-based `Connection.prototype.command`
Expand All @@ -22,7 +22,7 @@ conditionalTest({ min: 20 })('MongoDB v7 auto-instrumentation', () => {
cleanupChildProcesses();
});

const origin = isOrchestrionEnabled() ? 'auto.db.mongo' : 'auto.db.otel.mongo';
const origin = 'auto.db.mongo';

// `db.statement` (scrubbed full command doc) and `db.connection_string` vary
// by driver version, so assert their presence rather than exact content;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@ import type { TransactionEvent } from '@sentry/core';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { assertSentryTransaction } from '../../../utils/assertions';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('MongoDB auto-instrumentation', () => {
const origin = isOrchestrionEnabled() ? 'auto.db.mongo' : 'auto.db.otel.mongo';
const origin = 'auto.db.mongo';
let mongoServer: MongoMemoryServer;

beforeAll(async () => {
Expand Down
Loading
Loading