chore: add TAV tests for mongoose

.ci/tav.json

@@ -23,6 +23,7 @@
     "memcached",
     "mongodb",
     "mongodb-core",
+    "mongoose",
     "mysql",
     "mysql2",
     "next",

.tav.yml

@@ -157,6 +157,27 @@ mongodb:
   node: '>=14.20.1'
   commands: node test/instrumentation/modules/mongodb.test.js
 
+# mongoose
+# - v5 is still maintained (v5.13.14 on 2021-12-27). v5.7.0 switched from `mongodb-core`
+#   to `mongodb`. Testing we are not affected by the switch with a subset of 294 releases
+# - v6 has 94 releases. Testing a subset
+# - v7 was released recently (2023-02-27)
+mongoose-5:
+  name: mongoose
+  versions: '5.0.0 || 5.3.2 || 5.5.10 || 5.9.2 || 5.11.2 || 5.13.14 || 5.13.17'
+  node: '>=4.0.0'
+  commands: node test/instrumentation/modules/mongoose.test.js
+mongoose-6:
+  name: mongoose
+  versions: '6.0.0 || 6.1.2 || 6.2.9 || 6.4.5 || 6.7.1 || 6.10.4 || 6.11.1'
+  node: '>=12.0.0'
+  commands: node test/instrumentation/modules/mongoose.test.js
+mongoose-7:
+  name: mongoose
+  versions: '7.0.0 || 7.0.4 || 7.1.0 || 7.1.2 || 7.2.1 || 7.2.2'
+  node: '>=14.20.1'
+  commands: node test/instrumentation/modules/mongoose.test.js
+
 # Bluebird is effectively deprecated (https://github.com/petkaantonov/bluebird#%EF%B8%8Fnote%EF%B8%8F).
 # Testing the full set of supported bluebird releases (`>=2 <4`) is currently
 # 119 releases. The last release was in 2019. Testing that many is a waste of

dev-utils/gen-notice.sh

@@ -97,6 +97,8 @@ npm ls --omit=dev --all --parseable \
             "measured-reporting": "license.node-measured.txt",
             "object-identity-map": "license.MIT.txt",
             "set-cookie-serde": "license.MIT.txt",
+            "sift": "license.MIT.txt",
+            "ip": "license.MIT.txt",
         }
         const allowNoLicFile = [
             "binary-search" // CC is a public domain dedication, no need for license text.

docs/supported-technologies.asciidoc

@@ -157,6 +157,7 @@ so those should be supported as well.
 |https://www.npmjs.com/package/mongodb[mongodb] |>=3.3.0 <6 |Will instrument all queries
 |https://www.npmjs.com/package/mongojs[mongojs] |>=1.0.0 <2.7.0 |Supported via mongodb-core
 |https://www.npmjs.com/package/mongoose[mongoose] |>=4.0.0 <5.7.0 |Supported via mongodb-core
+|https://www.npmjs.com/package/mongoose[mongoose] |>=5.7.0 <8 |Supported via mongodb
 |https://www.npmjs.com/package/mysql[mysql] |^2.0.0 |Will instrument all queries
 |https://www.npmjs.com/package/mysql2[mysql2] |>=1.0.0 <4.0.0 |Will instrument all queries
 |https://www.npmjs.com/package/pg[pg] |>=4.0.0 <9.0.0 |Will instrument all queries

examples/trace-mongoose.js

@@ -0,0 +1,60 @@
+/*
+ * Copyright Elasticsearch B.V. and other contributors where applicable.
+ * Licensed under the BSD 2-Clause License; you may not use this file except in
+ * compliance with the BSD 2-Clause License.
+ */
+
+// A small example showing Elastic APM tracing the 'mongoose' package.
+//
+// This assumes a MongoDB server running on localhost. You can use:
+//    npm run docker:start mongodb
+// to start a MongoDB docker container. Then `npm run docker:stop` to stop it.
+//
+// Some of the following code is adapted from
+// https://github.com/Automattic/mongoose/tree/master/examples/statics
+
+const apm = require('../').start({ // elastic-apm-node
+  serviceName: 'example-trace-mongoose',
+  logUncaughtExceptions: true
+})
+
+const mongoose = require('mongoose')
+
+const DB_URL = 'mongodb://localhost:27017/example-trace-mongoose'
+
+// Define a schema.
+const PersonSchema = new mongoose.Schema({
+  name: String,
+  age: Number,
+  birthday: Date
+})
+mongoose.model('Person', PersonSchema)
+
+async function run () {
+  // For tracing spans to be created, there must be an active transaction.
+  // Typically, a transaction is automatically started for incoming HTTP
+  // requests to a Node.js server. However, because this script is not running
+  // an HTTP server, we manually start a transaction. More details at:
+  // https://www.elastic.co/guide/en/apm/agent/nodejs/current/custom-transactions.html
+  const t1 = apm.startTransaction('t1')
+
+  const Person = mongoose.model('Person')
+  await mongoose.connect(DB_URL)
+
+  const bill = await Person.create({
+    name: 'bill',
+    age: 25,
+    birthday: new Date().setFullYear((new Date().getFullYear() - 25))
+  })
+  console.log('Person added to db: %s', bill)
+
+  const result = await Person.find({})
+  console.log('find result:', result)
+
+  // Cleanup.
+  await Person.deleteMany()
+  await mongoose.disconnect()
+  t1.end()
+}
+
+run()