Skip to content
Merged
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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import * as Sentry from '@sentry/node';
import amqp from 'amqplib/callback_api.js';

const queueName = 'callback-queue';
const queueName = process.env.AMQP_QUEUE_NAME;
const amqpUsername = 'sentry';
const amqpPassword = 'sentry';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import amqp from 'amqplib';

// A topic exchange, so the routing key and the queue name differ.
const exchangeName = 'orders';
const queueName = 'orders-worker';
const routingKey = 'order.created.12345';
const amqpUsername = 'sentry';
const amqpPassword = 'sentry';
Expand All @@ -16,8 +15,12 @@ const NO_ACKNOWLEDGEMENT = { noAck: true };
(async () => {
const { connection, channel } = await connectToRabbitMQ();

await channel.assertExchange(exchangeName, 'topic', { durable: false, autoDelete: true });
await channel.assertQueue(queueName, { durable: false, exclusive: true });
// The ESM and CJS runs of all versions share the exchange, so it must not go away with the queue
// of an earlier run.
await channel.assertExchange(exchangeName, 'topic', { durable: false });
// An exclusive queue stays locked until the broker has cleaned up its connection, which can be
// after the next run starts. The broker names the queue, so no two runs share one.
const { queue: queueName } = await channel.assertQueue('', { durable: false, exclusive: true });
await channel.bindQueue(queueName, exchangeName, 'order.created.#');

// Publish before consuming, so the broker sends `BasicConsumeOk` and the delivery back to back.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
URL_FULL,
} from '@sentry/conventions/attributes';
import { QUEUE_PROCESS, QUEUE_PUBLISH } from '@sentry/conventions/op';
import { randomUUID } from 'crypto';
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests, describeWithDockerCompose } from '../../../utils/runner';

Expand Down Expand Up @@ -201,18 +202,22 @@ describeWithDockerCompose('amqplib auto-instrumentation', { workingDirectory: [_

createEsmAndCjsTests(__dirname, 'scenario-callback-api.mjs', 'instrument.mjs', (createTestRunner, test) => {
test('instruments publish and noAck consume on the callback API', { timeout: 60_000 }, async () => {
// The queue is exclusive, and the broker can still hold the lock of the previous run.
const queueName = `callback-queue-${randomUUID()}`;

await createTestRunner()
.withEnv({ AMQP_QUEUE_NAME: queueName })
.expect({
span: container => {
const producerSpan = container.items.find(
span => span.attributes[SENTRY_ORIGIN]?.value === 'auto.queue.amqplib.publisher',
);
expect(producerSpan?.name).toBe('send callback-queue');
expect(producerSpan?.name).toBe(`send ${queueName}`);

const consumerSpan = container.items.find(
span => span.attributes[SENTRY_ORIGIN]?.value === 'auto.queue.amqplib.consumer',
);
expect(consumerSpan?.name).toBe('process callback-queue');
expect(consumerSpan?.name).toBe(`process ${queueName}`);
expect(consumerSpan?.status).toBe('ok');
},
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-int
import Dataloader from 'dataloader';
import express from 'express';

const PORT = 8008;

const batchLoadFn = async keys => keys.map((_, idx) => idx);

const run = async () => {
Expand Down Expand Up @@ -35,7 +33,7 @@ const run = async () => {
res.send({ user });
});

startExpressServerAndSendPortToRunner(app, PORT);
startExpressServerAndSendPortToRunner(app);
};

run();
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@ import Boom from '@hapi/boom';
import Hapi from '@hapi/hapi';
import { sendPortToRunner } from '@sentry-internal/node-integration-tests';

const port = 5999;

const run = async () => {
const server = Hapi.server({
host: 'localhost',
port,
port: 0,

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Port 0 tells it to pick a free port

});

server.route({
Expand Down Expand Up @@ -88,7 +86,7 @@ const run = async () => {

await server.start();

sendPortToRunner(port);
sendPortToRunner(server.info.port);
};

run();
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ import Router from '@koa/router';
import { sendPortToRunner } from '@sentry-internal/node-integration-tests';
import Koa from 'koa';

const port = 5698;

const app = new Koa();

// The error handler is auto-registered by the koa instrumentation on app start,
Expand All @@ -30,6 +28,6 @@ router.get('/error', () => {

app.use(router.routes()).use(router.allowedMethods());

app.listen(port, () => {
sendPortToRunner(port);
const server = app.listen(0, () => {
sendPortToRunner(server.address().port);
});
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ import {
SENTRY_TRACE_LIFECYCLE,
} from '@sentry/conventions/attributes';
import { DB } from '@sentry/conventions/op';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import type { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { createMongoMemoryServer } from '../../../utils/mongoMemoryServer';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

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

beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
mongoServer = await createMongoMemoryServer('mongodb-v4');
process.env.MONGO_URL = mongoServer.getUri();
}, 30000);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ import {
SENTRY_TRACE_LIFECYCLE,
} from '@sentry/conventions/attributes';
import { DB } from '@sentry/conventions/op';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import type { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { createMongoMemoryServer } from '../../../utils/mongoMemoryServer';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

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

beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
mongoServer = await createMongoMemoryServer('mongodb-v5');
process.env.MONGO_URL = mongoServer.getUri();
}, 30000);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ import {
SENTRY_TRACE_LIFECYCLE,
} from '@sentry/conventions/attributes';
import { DB } from '@sentry/conventions/op';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import type { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { createMongoMemoryServer } from '../../../utils/mongoMemoryServer';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

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

beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
mongoServer = await createMongoMemoryServer('mongodb-v6');
process.env.MONGO_URL = mongoServer.getUri();
}, 30000);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ import {
SENTRY_TRACE_LIFECYCLE,
} from '@sentry/conventions/attributes';
import { DB } from '@sentry/conventions/op';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import type { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { createMongoMemoryServer } from '../../../utils/mongoMemoryServer';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Pins mongodb 7 so the >= 6.4 promise-based `Connection.prototype.command`
Expand All @@ -20,7 +21,7 @@ describe('MongoDB v7 auto-instrumentation', () => {
let mongoServer: MongoMemoryServer;

beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
mongoServer = await createMongoMemoryServer('mongodb-v7');
process.env.MONGO_URL = mongoServer.getUri();
}, 30000);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,17 @@ import {
SERVER_PORT,
} from '@sentry/conventions/attributes';
import { DB } from '@sentry/conventions/op';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import type { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { createMongoMemoryServer } from '../../../utils/mongoMemoryServer';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

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

beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
mongoServer = await createMongoMemoryServer('mongodb');
process.env.MONGO_URL = mongoServer.getUri();
}, 10000);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ import {
SERVER_PORT,
} from '@sentry/conventions/attributes';
import { DB } from '@sentry/conventions/op';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import type { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { createMongoMemoryServer } from '../../../utils/mongoMemoryServer';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// mongoose >= 9.7.0 publishes its operations via `node:diagnostics_channel`, so the SDK subscribes
Expand All @@ -26,7 +27,7 @@ describe('Mongoose tracing channel Test', () => {
let mongoServer: MongoMemoryServer;

beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
mongoServer = await createMongoMemoryServer('mongoose-tracing-channel');
process.env.MONGO_URL = mongoServer.getUri();
}, 30000);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ import {
SENTRY_TRACE_LIFECYCLE,
} from '@sentry/conventions/attributes';
import { DB } from '@sentry/conventions/op';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import type { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { createMongoMemoryServer } from '../../../utils/mongoMemoryServer';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Pins mongoose 5.9.7
Expand All @@ -19,7 +20,7 @@ describe('Mongoose v5 Test', () => {
let mongoServer: MongoMemoryServer;

beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
mongoServer = await createMongoMemoryServer('mongoose-v5');
process.env.MONGO_URL = mongoServer.getUri();
}, 30000);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ import {
SENTRY_TRACE_LIFECYCLE,
} from '@sentry/conventions/attributes';
import { DB } from '@sentry/conventions/op';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import type { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { createMongoMemoryServer } from '../../../utils/mongoMemoryServer';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Pins mongoose 7 so the `contextCaptureFunctions7` version branch is exercised against a real mongoose.
Expand All @@ -17,7 +18,7 @@ describe('Mongoose v7 Test', () => {
let mongoServer: MongoMemoryServer;

beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
mongoServer = await createMongoMemoryServer('mongoose-v7');
process.env.MONGO_URL = mongoServer.getUri();
}, 30000);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ import {
SENTRY_TRACE_LIFECYCLE,
} from '@sentry/conventions/attributes';
import { DB } from '@sentry/conventions/op';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import type { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { createMongoMemoryServer } from '../../../utils/mongoMemoryServer';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Pins mongoose 8 (>= 8.21) so the document `updateOne`/`deleteOne` lazy-Query path is exercised
Expand All @@ -18,7 +19,7 @@ describe('Mongoose v8 Test', () => {
let mongoServer: MongoMemoryServer;

beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
mongoServer = await createMongoMemoryServer('mongoose-v8');
process.env.MONGO_URL = mongoServer.getUri();
}, 30000);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ import {
SENTRY_TRACE_LIFECYCLE,
} from '@sentry/conventions/attributes';
import { DB } from '@sentry/conventions/op';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import type { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { createMongoMemoryServer } from '../../../utils/mongoMemoryServer';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Pins the highest mongoose 9 below 9.7, the top of the IITM patcher's `>=5.9.7 <9.7.0` range, so the
Expand All @@ -19,7 +20,7 @@ describe('Mongoose v9 Test', () => {
let mongoServer: MongoMemoryServer;

beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
mongoServer = await createMongoMemoryServer('mongoose-v9');
process.env.MONGO_URL = mongoServer.getUri();
}, 30000);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ import {
SENTRY_TRACE_LIFECYCLE,
} from '@sentry/conventions/attributes';
import { DB } from '@sentry/conventions/op';
import { MongoMemoryServer } from 'mongodb-memory-server-global';
import type { MongoMemoryServer } from 'mongodb-memory-server-global';
import { afterAll, beforeAll, describe, expect } from 'vitest';
import { createMongoMemoryServer } from '../../../utils/mongoMemoryServer';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('Mongoose experimental Test', () => {
Expand All @@ -18,7 +19,7 @@ describe('Mongoose experimental Test', () => {
let mongoServer: MongoMemoryServer;

beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
mongoServer = await createMongoMemoryServer('mongoose');
process.env.MONGO_URL = mongoServer.getUri();
}, 10000);

Expand Down
26 changes: 26 additions & 0 deletions dev-packages/node-integration-tests/utils/mongoMemoryServer.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { MongoMemoryServer } from 'mongodb-memory-server-global';

// `MongoMemoryServer` finds a free port and starts `mongod` on it afterwards. With a port that the
// OS assigns, another process can get the same port in between, and `mongod` fails with "Port
// already in use". The OS does not assign ports below its ephemeral range (32768 on Linux), so each
// suite has its own port there. The suites run in parallel, so no two suites can share a port.
const MONGO_PORTS = {
mongodb: 27101,
'mongodb-v4': 27102,
'mongodb-v5': 27103,
'mongodb-v6': 27104,
'mongodb-v7': 27105,
mongoose: 27106,
'mongoose-v5': 27107,
'mongoose-v7': 27108,
'mongoose-v8': 27109,
'mongoose-v9': 27110,
'mongoose-tracing-channel': 27111,
} as const;

/**
* Starts a `MongoMemoryServer` on the port of the given suite.
*/
export function createMongoMemoryServer(suite: keyof typeof MONGO_PORTS): Promise<MongoMemoryServer> {
return MongoMemoryServer.create({ instance: { port: MONGO_PORTS[suite] } });
}
Loading
Loading