autotel-mongoose 10.1.1 → 12.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autotel-mongoose",
-  "version": "10.1.1",
+  "version": "12.0.0",
   "description": "OpenTelemetry instrumentation for Mongoose with db.query.text capture and automatic redaction",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,7 +15,6 @@
   },
   "files": [
     "dist",
-    "src",
     "README.md",
     "skills"
   ],
@@ -46,7 +45,7 @@
     "tsdown": "^0.22.2",
     "typescript": "^6.0.3",
     "vitest": "^4.1.8",
-    "autotel": "4.0.0"
+    "autotel": "4.2.0"
   },
   "repository": {
     "type": "git",

package/src/config-custom.integration.test.ts

@@ -1,91 +0,0 @@
-import { describe, it, expect, beforeAll, afterAll, beforeEach } from 'vitest';
-import mongoose from 'mongoose';
-import { MongoMemoryServer } from 'mongodb-memory-server';
-import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
-import {
-  InMemorySpanExporter,
-  SimpleSpanProcessor,
-} from '@opentelemetry/sdk-trace-node';
-import { instrumentMongoose } from './instrumentation';
-import { ATTR_DB_QUERY_TEXT, ATTR_DB_OPERATION_NAME } from './constants';
-import { canListenOnLoopback } from './test-support';
-import type { SerializerPayload } from './types';
-
-let mongod: MongoMemoryServer | undefined;
-let exporter: InMemorySpanExporter;
-let provider: NodeTracerProvider;
-
-const userSchema = new mongoose.Schema({
-  name: { type: String, required: true },
-  email: { type: String, required: true },
-});
-
-let User: mongoose.Model<any>;
-
-const supportsLocalServer = await canListenOnLoopback();
-
-beforeAll(async () => {
-  exporter = new InMemorySpanExporter();
-  provider = new NodeTracerProvider({
-    spanProcessors: [new SimpleSpanProcessor(exporter)],
-  });
-  provider.register();
-
-  if (!supportsLocalServer) {
-    return;
-  }
-
-  mongod = await MongoMemoryServer.create();
-
-  // Custom serializer that only outputs the operation + condition keys
-  instrumentMongoose(mongoose, {
-    dbStatementSerializer: (op: string, payload: SerializerPayload) => {
-      const keys = payload.condition ? Object.keys(payload.condition) : [];
-      return `${op}(${keys.join(',')})`;
-    },
-    statementRedactor: false, // Disable redaction for this test
-  });
-
-  await mongoose.connect(mongod.getUri());
-  User = mongoose.model('User', userSchema);
-});
-
-afterAll(async () => {
-  await mongoose.disconnect();
-  await mongod?.stop();
-  await provider.shutdown();
-});
-
-beforeEach(() => exporter.reset());
-
-describe('custom dbStatementSerializer', () => {
-  if (!supportsLocalServer) {
-    it.skip('skips custom mongoose integration tests when the environment cannot open local TCP ports', () => {});
-    return;
-  }
-
-  it('uses custom serializer output as db.query.text', async () => {
-    await User.find({ name: 'Alice', email: 'alice@example.com' }).exec();
-
-    const spans = exporter.getFinishedSpans();
-    const findSpan = spans.find(
-      (s) => s.attributes[ATTR_DB_OPERATION_NAME] === 'find',
-    );
-    expect(findSpan).toBeDefined();
-    const queryText = findSpan!.attributes[ATTR_DB_QUERY_TEXT] as string;
-    expect(queryText).toBe('find(name,email)');
-  });
-
-  it('does not redact when statementRedactor is false', async () => {
-    await User.find({ email: 'alice@example.com' }).exec();
-
-    const spans = exporter.getFinishedSpans();
-    const findSpan = spans.find(
-      (s) => s.attributes[ATTR_DB_OPERATION_NAME] === 'find',
-    );
-    const queryText = findSpan!.attributes[ATTR_DB_QUERY_TEXT] as string;
-    // Custom serializer doesn't include values, so email won't appear,
-    // but importantly the redactor is not running
-    expect(queryText).toBe('find(email)');
-  });
-});

package/src/config-disabled.integration.test.ts

@@ -1,79 +0,0 @@
-import { describe, it, expect, beforeAll, afterAll, beforeEach } from 'vitest';
-import mongoose from 'mongoose';
-import { MongoMemoryServer } from 'mongodb-memory-server';
-import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
-import {
-  InMemorySpanExporter,
-  SimpleSpanProcessor,
-} from '@opentelemetry/sdk-trace-node';
-import { instrumentMongoose } from './instrumentation';
-import { ATTR_DB_QUERY_TEXT, ATTR_DB_OPERATION_NAME } from './constants';
-import { canListenOnLoopback } from './test-support';
-
-let mongod: MongoMemoryServer | undefined;
-let exporter: InMemorySpanExporter;
-let provider: NodeTracerProvider;
-
-const userSchema = new mongoose.Schema({
-  name: { type: String, required: true },
-  email: { type: String, required: true },
-});
-
-let User: mongoose.Model<any>;
-
-const supportsLocalServer = await canListenOnLoopback();
-
-beforeAll(async () => {
-  exporter = new InMemorySpanExporter();
-  // Use the same NodeTracerProvider pattern as the main integration test
-  provider = new NodeTracerProvider({
-    spanProcessors: [new SimpleSpanProcessor(exporter)],
-  });
-  provider.register();
-
-  if (!supportsLocalServer) {
-    return;
-  }
-
-  mongod = await MongoMemoryServer.create();
-  instrumentMongoose(mongoose, { dbStatementSerializer: false });
-  await mongoose.connect(mongod.getUri());
-  User = mongoose.model('User', userSchema);
-});
-
-afterAll(async () => {
-  await mongoose.disconnect();
-  await mongod?.stop();
-  await provider.shutdown();
-});
-
-beforeEach(() => exporter.reset());
-
-describe('dbStatementSerializer: false', () => {
-  if (!supportsLocalServer) {
-    it.skip('skips disabled-config mongoose integration tests when the environment cannot open local TCP ports', () => {});
-    return;
-  }
-
-  it('does not set db.query.text on spans', async () => {
-    await User.find({ name: 'Alice' }).exec();
-
-    const spans = exporter.getFinishedSpans();
-    const findSpan = spans.find(
-      (s) => s.attributes[ATTR_DB_OPERATION_NAME] === 'find',
-    );
-    expect(findSpan).toBeDefined();
-    expect(findSpan!.attributes[ATTR_DB_QUERY_TEXT]).toBeUndefined();
-  });
-
-  it('still creates spans with correct operation name', async () => {
-    await User.findOne({ name: 'Bob' }).exec();
-
-    const spans = exporter.getFinishedSpans();
-    const span = spans.find(
-      (s) => s.attributes[ATTR_DB_OPERATION_NAME] === 'findOne',
-    );
-    expect(span).toBeDefined();
-    expect(span!.name).toBe('findOne users');
-  });
-});

package/src/constants.ts

@@ -1,25 +0,0 @@
-// Stable OTel semantic conventions only — no deprecated attributes.
-
-export const ATTR_DB_QUERY_TEXT = 'db.query.text' as const;
-export const ATTR_DB_OPERATION_NAME = 'db.operation.name' as const;
-export const ATTR_DB_SYSTEM_NAME = 'db.system.name' as const;
-export const ATTR_DB_COLLECTION_NAME = 'db.collection.name' as const;
-export const ATTR_DB_NAMESPACE = 'db.namespace' as const;
-export const ATTR_SERVER_ADDRESS = 'server.address' as const;
-export const ATTR_SERVER_PORT = 'server.port' as const;
-
-// Stable code semconv — used for user-defined statics/methods/query helpers.
-export const ATTR_CODE_FUNCTION_NAME = 'code.function.name' as const;
-
-// Autotel-namespaced attributes for user-defined Mongoose functions.
-// Mirrors the existing `hook.*` namespace used for schema hook spans.
-export const ATTR_MONGOOSE_METHOD_NAME = 'mongoose.method.name' as const;
-/** One of: "static" | "instance" | "query". */
-export const ATTR_MONGOOSE_METHOD_TYPE = 'mongoose.method.type' as const;
-export const ATTR_MONGOOSE_METHOD_MODEL = 'mongoose.method.model' as const;
-export const ATTR_MONGOOSE_METHOD_PARAMETERS =
-  'mongoose.method.parameters' as const;
-export const ATTR_MONGOOSE_METHOD_PARAMETER_COUNT =
-  'mongoose.method.parameter_count' as const;
-
-export const DB_SYSTEM_NAME_VALUE_MONGODB = 'mongodb' as const;