Re-enable couchbase testing

This change re-enables testing for the couchbase integration.  In order
to do so, there are a few changes which were made:

1. Use a new container repository for couchbase (previously owned by
   sabrenner, now owned by DataDog).
1. Drop testing support for Couchbase API versions 2.6.5, 3.0.0-3.2.0,
   and 3.2.2

**Reasons for dropping versions**

* 2.6.5 - Couchbase only supports this version for node versions 6, 8,
  and 10.  Since dd-trace-js does not support these versions, 2.6.5 is
  dropped.
* 3.0.0 <= x < 3.2.0 - Couchbase officialy dropped support for 3.0.x in
  Jul 2022 and 3.1 in June 2023.  Since these dates have passed, we are
  dropping support in dd-trace-js
* 3.2.2 - This version of couchbase encounters segfaults when calling
  'upsert'  with couchbase server 6.0.  These issues can be fixed by
  using Couchbase API 4.0+ with Couchbase Server 7.0+.  However,
  dd-trace-js does not yet support testing against either of these.

Author: tabgok

.github/workflows/plugins.yml

@@ -182,24 +182,25 @@ jobs:
         uses: ./.github/actions/testagent/logs
       - uses: codecov/codecov-action@v2
 
-  # couchbase:
-  #   runs-on: ubuntu-latest
-  #   services:
-  #     couchbase:
-  #       image: sabrenner/couchbase-server-sandbox:latest
-  #       ports:
-  #         - 8091-8095:8091-8095
-  #         - 11210:11210
-  #   env:
-  #     PLUGINS: couchbase
-  #     SERVICES: couchbase
-  #   steps:
-  #     - uses: actions/checkout@v2
-  #     - uses: ./.github/actions/node/setup
-  #     - run: yarn install
-  #     - uses: ./.github/actions/node/oldest
-  #     - run: yarn test:plugins:ci
-  #     - uses: codecov/codecov-action@v2
+  couchbase:
+    runs-on: ubuntu-latest
+    services:
+      couchbase:
+        image: ghcr.io/datadog/couchbase-server-sandbox:latest
+        ports:
+          - 8091-8095:8091-8095
+          - 11210:11210
+    env:
+      PLUGINS: couchbase
+      SERVICES: couchbase
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./.github/actions/testagent/start
+      - uses: ./.github/actions/node/setup
+      - run: yarn install
+      - uses: ./.github/actions/node/oldest
+      - run: yarn test:plugins:ci
+      - uses: codecov/codecov-action@v2
 
   connect:
     runs-on: ubuntu-latest

docker-compose.yml

@@ -1,7 +1,7 @@
 version: "2"
 services:
   couchbase:
-    image: sabrenner/couchbase-server-sandbox:latest
+    image: ghcr.io/datadog/couchbase-server-sandbox:latest
     ports:
       - "127.0.0.1:8091-8095:8091-8095"
       - "127.0.0.1:11210:11210"

packages/datadog-instrumentations/src/couchbase.js

@@ -159,76 +159,6 @@ function wrapV3Query (query) {
   }
 }
 
-// semver >=2 <3
-addHook({ name: 'couchbase', file: 'lib/bucket.js', versions: ['^2.6.5'] }, Bucket => {
-  const startCh = channel('apm:couchbase:query:start')
-  const finishCh = channel('apm:couchbase:query:finish')
-  const errorCh = channel('apm:couchbase:query:error')
-
-  Bucket.prototype._maybeInvoke = wrapMaybeInvoke(Bucket.prototype._maybeInvoke)
-  Bucket.prototype.query = wrapQuery(Bucket.prototype.query)
-
-  shimmer.wrap(Bucket.prototype, '_n1qlReq', _n1qlReq => function (host, q, adhoc, emitter) {
-    if (!startCh.hasSubscribers) {
-      return _n1qlReq.apply(this, arguments)
-    }
-
-    if (!emitter || !emitter.once) return _n1qlReq.apply(this, arguments)
-
-    const n1qlQuery = getQueryResource(q)
-
-    const asyncResource = new AsyncResource('bound-anonymous-fn')
-    return asyncResource.runInAsyncScope(() => {
-      startCh.publish({ resource: n1qlQuery, bucket: { name: this.name || this._name } })
-
-      emitter.once('rows', asyncResource.bind(() => {
-        finishCh.publish(undefined)
-      }))
-
-      emitter.once('error', asyncResource.bind((error) => {
-        errorCh.publish(error)
-        finishCh.publish(undefined)
-      }))
-
-      try {
-        return _n1qlReq.apply(this, arguments)
-      } catch (err) {
-        err.stack // trigger getting the stack at the original throwing point
-        errorCh.publish(err)
-
-        throw err
-      }
-    })
-  })
-
-  wrapAllNames(['upsert', 'insert', 'replace', 'append', 'prepend'], name => {
-    Bucket.prototype[name] = wrap(`apm:couchbase:${name}`, Bucket.prototype[name])
-  })
-
-  return Bucket
-})
-
-addHook({ name: 'couchbase', file: 'lib/cluster.js', versions: ['^2.6.5'] }, Cluster => {
-  Cluster.prototype._maybeInvoke = wrapMaybeInvoke(Cluster.prototype._maybeInvoke)
-  Cluster.prototype.query = wrapQuery(Cluster.prototype.query)
-
-  return Cluster
-})
-
-// semver >=3 <3.2.0
-
-addHook({ name: 'couchbase', file: 'lib/collection.js', versions: ['>=3.0.0 <3.2.0'] }, Collection => {
-  wrapAllNames(['upsert', 'insert', 'replace'], name => {
-    shimmer.wrap(Collection.prototype, name, wrapWithName(name))
-  })
-
-  return Collection
-})
-
-addHook({ name: 'couchbase', file: 'lib/cluster.js', versions: ['>=3.0.0 <3.2.0'] }, Cluster => {
-  shimmer.wrap(Cluster.prototype, 'query', wrapV3Query)
-  return Cluster
-})
 
 // semver >=3.2.0
 

packages/datadog-plugin-couchbase/test/index.spec.js

@@ -18,141 +18,7 @@ describe('Plugin', () => {
       tracer = global.tracer = require('../../dd-trace')
     })
 
-    withVersions('couchbase', 'couchbase', '<3.0.0', version => {
-      let N1qlQuery
-      describe('without configuration', () => {
-        beforeEach(done => {
-          agent.load('couchbase').then(() => {
-            couchbase = proxyquire(`../../../versions/couchbase@${version}`, {}).get()
-            N1qlQuery = couchbase.N1qlQuery
-            cluster = new couchbase.Cluster('localhost:8091')
-            cluster.authenticate('Administrator', 'password')
-            cluster.enableCbas('localhost:8095')
-            bucket = cluster.openBucket('datadog-test', (err) => done(err))
-          })
-        })
-
-        afterEach(() => {
-          bucket.disconnect()
-        })
-
-        after(() => {
-          return agent.close({ ritmReset: false })
-        })
-
-        it('should run the Query callback in the parent context', done => {
-          const query = 'SELECT 1+1'
-          const span = tracer.startSpan('test.query.cb')
-
-          tracer.scope().activate(span, () => {
-            const n1qlQuery = N1qlQuery.fromString(query)
-            cluster.query(n1qlQuery, (err, rows) => {
-              expect(tracer.scope().active()).to.equal(span)
-              done(err)
-            })
-          })
-        })
-
-        it('should run any Bucket operations in the parent context', done => {
-          const span = tracer.startSpan('test')
-
-          tracer.scope().activate(span, () => {
-            bucket.get('1', () => {
-              expect(tracer.scope().active()).to.equal(span)
-              done()
-            })
-          })
-        })
-
-        describe('queries on cluster', () => {
-          it('should handle N1QL queries', done => {
-            const query = 'SELECT 1+1'
-
-            agent
-              .use(traces => {
-                const span = traces[0][0]
-                expect(span).to.have.property('name', 'couchbase.query')
-                expect(span).to.have.property('service', 'test-couchbase')
-                expect(span).to.have.property('resource', query)
-                expect(span).to.have.property('type', 'sql')
-                expect(span.meta).to.have.property('span.kind', 'client')
-                expect(span.meta).to.have.property('couchbase.bucket.name', 'datadog-test')
-                expect(span.meta).to.have.property('component', 'couchbase')
-              })
-              .then(done)
-              .catch(done)
-
-            const n1qlQuery = N1qlQuery.fromString(query)
-            cluster.query(n1qlQuery, (err) => {
-              if (err) done(err)
-            })
-
-            if (semver.intersects(version, '2.4.0 - 2.5.0')) {
-              // Due to bug JSCBC-491 in Couchbase, we have to reconnect to dispatch waiting queries
-              const triggerBucket = cluster.openBucket('datadog-test', (err) => {
-                if (err) done(err)
-              })
-              triggerBucket.on('connect', () => triggerBucket.disconnect())
-            }
-          })
-
-          it('should handle storage queries', done => {
-            agent
-              .use(traces => {
-                const span = traces[0][0]
-                expect(span).to.have.property('name', 'couchbase.upsert')
-                expect(span).to.have.property('service', 'test-couchbase')
-                expect(span).to.have.property('resource', 'couchbase.upsert')
-                expect(span.meta).to.have.property('span.kind', 'client')
-                expect(span.meta).to.have.property('couchbase.bucket.name', 'datadog-test')
-                expect(span.meta).to.have.property('component', 'couchbase')
-              })
-              .then(done)
-              .catch(done)
-
-            bucket.upsert('testdoc', { name: 'Frank' }, (err, result) => {
-              if (err) done(err)
-            })
-          })
-
-          it('should skip instrumentation for invalid arguments', (done) => {
-            try {
-              bucket.upsert('testdoc', { name: 'Frank' })
-            } catch (e) {
-              expect(e.message).to.equal('Third argument needs to be an object or callback.')
-              done()
-            }
-          })
-        })
-
-        describe('queries on buckets', () => {
-          it('should handle N1QL queries', done => {
-            const query = 'SELECT 1+2'
-
-            agent
-              .use(traces => {
-                const span = traces[0][0]
-                expect(span).to.have.property('name', 'couchbase.query')
-                expect(span).to.have.property('service', 'test-couchbase')
-                expect(span).to.have.property('resource', query)
-                expect(span).to.have.property('type', 'sql')
-                expect(span.meta).to.have.property('span.kind', 'client')
-                expect(span.meta).to.have.property('couchbase.bucket.name', 'datadog-test')
-                expect(span.meta).to.have.property('component', 'couchbase')
-              })
-              .then(done)
-              .catch(done)
-
-            const n1qlQuery = N1qlQuery.fromString(query)
-            bucket.query(n1qlQuery, (err) => {
-              if (err) done(err)
-            })
-          })
-        })
-      })
-    })
-
-    withVersions('couchbase', 'couchbase', '>=3.0.0', version => {
+    withVersions('couchbase', 'couchbase', '3.2.0 - 3.2.1', version => {
       beforeEach(() => {
         tracer = global.tracer = require('../../dd-trace')
       })

scripts/install_plugin_modules.js

@@ -12,7 +12,7 @@ const externals = require('../packages/dd-trace/test/plugins/externals')
 
 const requirePackageJsonPath = require.resolve('../packages/dd-trace/src/require-package-json')
 
-const excludeList = os.arch() === 'arm64' ? ['couchbase', 'grpc', 'oracledb'] : []
+const excludeList = os.arch() === 'arm64' ? ['grpc', 'oracledb'] : []
 const workspaces = new Set()
 const versionLists = {}
 const deps = {}