dd-trace 4.30.0 → 4.31.0

package/packages/dd-trace/src/external-logger/test/index.spec.js

@@ -1,147 +0,0 @@
-'use strict'
-
-require('../../../../dd-trace/test/setup/tap')
-const proxyquire = require('proxyquire')
-const { expect } = require('chai')
-const nock = require('nock')
-
-const tracerLogger = require('../../log')
-
-describe('External Logger', () => {
-  let externalLogger
-  let interceptor
-  let errorLog
-
-  beforeEach(() => {
-    errorLog = sinon.spy(tracerLogger, 'error')
-
-    const { ExternalLogger } = proxyquire('../src', {
-      '../../log': {
-        error: errorLog
-      }
-    })
-
-    externalLogger = new ExternalLogger({
-      ddsource: 'logging_from_space',
-      hostname: 'mac_desktop',
-      apiKey: 'API_KEY_PLACEHOLDER',
-      interval: 10000,
-      timeout: 5000,
-      limit: 10
-    })
-  })
-
-  afterEach(() => {
-    interceptor.done()
-    errorLog.restore()
-  })
-
-  it('should properly encode the log message', (done) => {
-    let request
-    const currentTime = Date.now()
-
-    interceptor = nock('https://http-intake.logs.datadoghq.com:443')
-      .post('/api/v2/logs')
-      .reply((_uri, req, cb) => {
-        request = req
-        cb(null, [202, '{}', { 'Content-Type': 'application/json' }])
-      })
-
-    const span = {
-      service: 'openAi',
-      trace_id: '000001000',
-      span_id: '9999991999'
-    }
-    const tags = {
-      env: 'external_logger',
-      version: '1.2.3',
-      service: 'external'
-    }
-    externalLogger.log({
-      message: 'oh no, something is up',
-      custom: 'field',
-      attribute: 'funky',
-      service: 'outer_space',
-      level: 'info'
-    }, span, tags)
-
-    externalLogger.flush((err) => {
-      try {
-        expect(request[0]).to.have.property('message', 'oh no, something is up')
-        expect(request[0]).to.have.property('custom', 'field')
-        expect(request[0]).to.have.property('attribute', 'funky')
-        expect(request[0]).to.have.property('service', 'outer_space')
-        expect(request[0]).to.have.property('level', 'info')
-        expect(request[0]).to.have.property('dd.trace_id', '000001000')
-        expect(request[0]).to.have.property('dd.span_id', '9999991999')
-        expect(request[0].timestamp).to.be.greaterThanOrEqual(currentTime)
-        expect(request[0]).to.have.property('ddsource', 'logging_from_space')
-        expect(request[0]).to.have.property('ddtags', 'env:external_logger,version:1.2.3,service:external')
-      } catch (e) {
-        done(e)
-        return
-      }
-
-      done(err)
-    })
-  })
-
-  it('should empty the log queue when calling flush', (done) => {
-    interceptor = nock('https://http-intake.logs.datadoghq.com:443')
-      .post('/api/v2/logs')
-      .reply(202, {})
-
-    externalLogger.enqueue({})
-    expect(externalLogger.queue.length).to.equal(1)
-
-    externalLogger.flush((err) => {
-      expect(externalLogger.queue.length).to.equal(0)
-      done(err)
-    })
-  })
-
-  it('tracer logger should handle error response codes from Logs API', (done) => {
-    interceptor = nock('https://http-intake.logs.datadoghq.com:443')
-      .post('/api/v2/logs')
-      .reply(400, {})
-
-    externalLogger.enqueue({})
-    externalLogger.flush((err) => {
-      expect(err).to.be.an.instanceOf(Error)
-      expect(errorLog.getCall(0).args[0]).to.be.equal(
-        'failed to send 1 logs, received response code 400'
-      )
-      done()
-    })
-  })
-
-  it('tracer logger should handle simulated network error', (done) => {
-    interceptor = nock('https://http-intake.logs.datadoghq.com:443')
-      .post('/api/v2/logs')
-      .replyWithError('missing API key')
-
-    externalLogger.enqueue({})
-    externalLogger.flush((err) => {
-      expect(err).to.be.an.instanceOf(Error)
-      expect(errorLog.getCall(0).args[0]).to.be.equal(
-        'failed to send 1 log(s), with error missing API key'
-      )
-      done()
-    })
-  })
-
-  it('causes a flush when exceeding log queue limit', (done) => {
-    const flusher = sinon.stub(externalLogger, 'flush')
-
-    for (let i = 0; i < 10; i++) {
-      externalLogger.enqueue({})
-    }
-    expect(flusher).to.not.have.been.called
-
-    externalLogger.enqueue({})
-    expect(flusher).to.have.been.called
-
-    flusher.restore()
-    done()
-  })
-})

package/scripts/check-proposal-labels.js

@@ -1,71 +0,0 @@
-/* eslint-disable no-console */
-
-const childProcess = require('child_process')
-const ORIGIN = 'origin/'
-
-let releaseBranch = process.env['GITHUB_BASE_REF'] // 'origin/v3.x'
-let releaseVersion = releaseBranch
-if (releaseBranch.startsWith(ORIGIN)) {
-  releaseVersion = releaseBranch.substring(ORIGIN.length)
-} else {
-  releaseBranch = ORIGIN + releaseBranch
-}
-let currentBranch = process.env['GITHUB_HEAD_REF'] // 'ugaitz/workflow-to-verify-dont-land-on-v3.x'
-if (!currentBranch.startsWith(ORIGIN)) {
-  currentBranch = ORIGIN + currentBranch
-}
-
-const getHashesCommandWithExclusions = 'branch-diff --user DataDog --repo dd-trace-js --exclude-label=semver-major' +
-  ` --exclude-label=dont-land-on-${releaseVersion} ${releaseBranch} ${currentBranch}`
-const getHashesCommandWithoutExclusions =
-  `branch-diff --user DataDog --repo dd-trace-js ${releaseBranch} ${currentBranch}`
-
-childProcess.exec(getHashesCommandWithExclusions, { timeout: 30000 },
-  (withExclusionError, withExclusionStdout, withExclusionStderr) => {
-    if (withExclusionError) {
-      console.error(`stdout:
-${withExclusionStdout}
-stderr:
-${withExclusionStderr}
-`, withExclusionError)
-      process.exit(1)
-      return
-    }
-    if (withExclusionStderr) {
-      console.error(withExclusionStderr)
-      process.exit(1)
-      return
-    }
-    const commitsHashesWithExclusions = withExclusionStdout.split('\n')
-
-    childProcess.exec(getHashesCommandWithoutExclusions,
-      (withoutExclusionError, withoutExclusionStdout, withoutExclusionStderr) => {
-        if (withoutExclusionError) {
-          console.error(`stdout:
-${withoutExclusionStdout}
-stderr:
-${withoutExclusionStderr}
-`, withoutExclusionError)
-          process.exit(1)
-          return
-        }
-        if (withoutExclusionStderr) {
-          console.error(withoutExclusionStderr)
-          process.exit(1)
-          return
-        }
-        const commitsHashesWithoutExclusions = withoutExclusionStdout.split('\n')
-        if (commitsHashesWithExclusions.length !== commitsHashesWithoutExclusions.length) {
-          const commitsWithInvalidLabels = []
-          commitsHashesWithoutExclusions.filter(c1 => {
-            if (!commitsHashesWithExclusions.some(c2 => c2 === c1)) {
-              commitsWithInvalidLabels.push(c1)
-            }
-          })
-          console.error('Some excluded label added in the release proposal', commitsWithInvalidLabels)
-          process.exit(1)
-        } else {
-          console.log('Commit PRs label looks OK')
-        }
-      })
-  })

package/scripts/check_licenses.js

@@ -1,69 +0,0 @@
-'use strict'
-
-const fs = require('fs')
-const path = require('path')
-const readline = require('readline')
-const pkg = require(path.join(__dirname, '..', '/package.json'))
-
-const filePath = path.join(__dirname, '..', '/LICENSE-3rdparty.csv')
-const deps = new Set(Object.keys(pkg.dependencies || {}))
-const devDeps = new Set(Object.keys(pkg.devDependencies || {}))
-
-let index = 0
-
-const licenses = {
-  require: new Set(),
-  dev: new Set(),
-  file: new Set()
-}
-
-const lineReader = readline.createInterface({
-  input: fs.createReadStream(filePath)
-})
-
-lineReader.on('line', line => {
-  if (index !== 0) {
-    const columns = line.split(',')
-    const type = columns[0]
-    const license = columns[1]
-
-    licenses[type].add(license)
-  }
-
-  index++
-})
-
-lineReader.on('close', () => {
-  if (!checkLicenses(deps, 'require') || !checkLicenses(devDeps, 'dev')) {
-    process.exit(1)
-  }
-})
-
-function checkLicenses (typeDeps, type) {
-  /* eslint-disable no-console */
-
-  const missing = []
-  const extraneous = []
-
-  for (const dep of typeDeps) {
-    if (!licenses[type].has(dep)) {
-      missing.push(dep)
-    }
-  }
-
-  for (const dep of licenses[type]) {
-    if (!typeDeps.has(dep)) {
-      extraneous.push(dep)
-    }
-  }
-
-  if (missing.length) {
-    console.log(`Missing 3rd-party license for ${missing.join(', ')}.`)
-  }
-
-  if (extraneous.length) {
-    console.log(`Extraneous 3rd-party license for ${extraneous.join(', ')}.`)
-  }
-
-  return missing.length === 0 && extraneous.length === 0
-}

package/scripts/helpers/color.js

@@ -1,8 +0,0 @@
-'use strict'
-
-// https://en.wikipedia.org/wiki/ANSI_escape_code#Colors
-module.exports = {
-  GRAY: '\\033[1;90m',
-  CYAN: '\\033[1;36m',
-  NONE: '\\033[0m'
-}

package/scripts/helpers/exec.js

@@ -1,22 +0,0 @@
-'use strict'
-
-const execSync = require('child_process').execSync
-const color = require('./color')
-
-function exec (command, options) {
-  options = Object.assign({ stdio: [0, 1, 2] }, options)
-
-  execSync(`echo "${color.GRAY}$ ${command}${color.NONE}"`, { stdio: [0, 1, 2] })
-
-  return execSync(command, options)
-}
-
-function pipe (command, options) {
-  return exec(command, Object.assign({ stdio: 'pipe' }, options))
-    .toString()
-    .replace(/\n$/, '')
-}
-
-exec.pipe = pipe
-
-module.exports = exec

package/scripts/helpers/title.js

@@ -1,15 +0,0 @@
-'use strict'
-
-const exec = require('child_process').execSync
-const color = require('./color')
-
-function title (str) {
-  const options = { stdio: [0, 1, 2] }
-  const line = ''.padStart(str.length, '=')
-
-  exec(`echo "${color.CYAN}${line}${color.NONE}"`, options)
-  exec(`echo "${color.CYAN}${str}${color.NONE}"`, options)
-  exec(`echo "${color.CYAN}${line}${color.NONE}"`, options)
-}
-
-module.exports = title

package/scripts/install_plugin_modules.js

@@ -1,248 +0,0 @@
-'use strict'
-
-const fs = require('fs')
-const os = require('os')
-const path = require('path')
-const crypto = require('crypto')
-const semver = require('semver')
-const proxyquire = require('proxyquire')
-const exec = require('./helpers/exec')
-const childProcess = require('child_process')
-const externals = require('../packages/dd-trace/test/plugins/externals')
-
-const requirePackageJsonPath = require.resolve('../packages/dd-trace/src/require-package-json')
-
-// Can remove couchbase after removing support for couchbase <= 3.2.0
-const excludeList = os.arch() === 'arm64' ? ['couchbase', 'grpc', 'oracledb'] : []
-const workspaces = new Set()
-const versionLists = {}
-const deps = {}
-const names = []
-const filter = process.env.hasOwnProperty('PLUGINS') && process.env.PLUGINS.split('|')
-
-Object.keys(externals).forEach(external => externals[external].forEach(thing => {
-  if (thing.dep) {
-    if (!deps[external]) {
-      deps[external] = []
-    }
-    deps[external].push(thing.name)
-  }
-}))
-
-fs.readdirSync(path.join(__dirname, '../packages/datadog-instrumentations/src'))
-  .filter(file => file.endsWith('js'))
-  .forEach(file => {
-    file = file.replace('.js', '')
-
-    if (!filter || filter.includes(file)) {
-      names.push(file)
-    }
-  })
-
-run()
-
-async function run () {
-  assertFolder()
-  await assertVersions()
-  assertWorkspace()
-  // Some native addon packages rely on libraries that are not supported on ARM64
-  excludeList.forEach(pkg => delete workspaces[pkg])
-  install()
-}
-
-async function assertVersions () {
-  const internals = names
-    .map(key => {
-      const instrumentations = []
-      const name = key
-
-      try {
-        loadInstFile(`${name}/server.js`, instrumentations)
-        loadInstFile(`${name}/client.js`, instrumentations)
-      } catch (e) {
-        loadInstFile(`${name}.js`, instrumentations)
-      }
-
-      return instrumentations
-    })
-    .reduce((prev, next) => prev.concat(next), [])
-
-  for (const inst of internals) {
-    await assertInstrumentation(inst, false)
-  }
-
-  const externalNames = Object.keys(externals).filter(name => ~names.indexOf(name))
-  for (const name of externalNames) {
-    for (const inst of [].concat(externals[name])) {
-      await assertInstrumentation(inst, true)
-    }
-  }
-}
-
-async function assertInstrumentation (instrumentation, external) {
-  const versions = process.env.PACKAGE_VERSION_RANGE ? [process.env.PACKAGE_VERSION_RANGE]
-    : [].concat(instrumentation.versions || [])
-
-  for (const version of versions) {
-    if (version) {
-      await assertModules(instrumentation.name, semver.coerce(version).version, external)
-      await assertModules(instrumentation.name, version, external)
-    }
-  }
-}
-
-async function assertModules (name, version, external) {
-  const range = process.env.RANGE
-  if (range && !semver.subset(version, range)) return
-  addFolder(name)
-  addFolder(name, version)
-  assertFolder(name)
-  assertFolder(name, version)
-  await assertPackage(name, null, version, external)
-  await assertPackage(name, version, version, external)
-  assertIndex(name)
-  assertIndex(name, version)
-}
-
-function assertFolder (name, version) {
-  if (!fs.existsSync(folder())) {
-    fs.mkdirSync(folder())
-  }
-
-  if (name && name.includes(path.sep)) {
-    name.split(path.sep).reduce(parent => assertFolder(parent))
-  }
-
-  if (!fs.existsSync(folder(name, version))) {
-    fs.mkdirSync(folder(name, version))
-  }
-}
-
-async function assertPackage (name, version, dependency, external) {
-  const dependencies = { [name]: dependency }
-  if (deps[name]) {
-    await addDependencies(dependencies, name, dependency)
-  }
-  const pkg = {
-    name: [name, sha1(name).substr(0, 8), sha1(version)].filter(val => val).join('-'),
-    version: '1.0.0',
-    license: 'BSD-3-Clause',
-    private: true,
-    dependencies
-  }
-
-  if (!external) {
-    if (name === 'aerospike') {
-      pkg.installConfig = {
-        'hoistingLimits': 'workspaces'
-      }
-    } else {
-      pkg.workspaces = {
-        nohoist: ['**/**']
-      }
-    }
-  }
-  fs.writeFileSync(filename(name, version, 'package.json'), JSON.stringify(pkg, null, 2) + '\n')
-}
-
-async function addDependencies (dependencies, name, versionRange) {
-  const versionList = await getVersionList(name)
-  const version = semver.maxSatisfying(versionList, versionRange)
-  const pkgJson = await npmView(`${name}@${version}`)
-  for (const dep of deps[name]) {
-    for (const section of ['devDependencies', 'peerDependencies']) {
-      if (pkgJson[section] && dep in pkgJson[section]) {
-        dependencies[dep] = pkgJson[section][dep]
-        break
-      }
-    }
-  }
-}
-
-async function getVersionList (name) {
-  if (versionLists[name]) {
-    return versionLists[name]
-  }
-  const list = await npmView(`${name} versions`)
-  versionLists[name] = list
-  return list
-}
-
-function npmView (input) {
-  return new Promise((resolve, reject) => {
-    childProcess.exec(`npm view ${input} --json`, (err, stdout) => {
-      if (err) {
-        reject(err)
-        return
-      }
-      resolve(JSON.parse(stdout.toString('utf8')))
-    })
-  })
-}
-
-function assertIndex (name, version) {
-  const index = `'use strict'
-
-const requirePackageJson = require('${requirePackageJsonPath}')
-
-module.exports = {
-  get (id) { return require(id || '${name}') },
-  getPath (id) { return require.resolve(id || '${name}' ) },
-  version () { return requirePackageJson('${name}', module).version }
-}
-`
-  fs.writeFileSync(filename(name, version, 'index.js'), index)
-}
-
-function assertWorkspace () {
-  fs.writeFileSync(filename(null, null, 'package.json'), JSON.stringify({
-    name: 'versions',
-    version: '1.0.0',
-    license: 'BSD-3-Clause',
-    private: true,
-    workspaces: {
-      packages: Array.from(workspaces)
-    }
-  }, null, 2) + '\n')
-}
-
-function install () {
-  exec('yarn --ignore-engines', { cwd: folder() })
-}
-
-function addFolder (name, version) {
-  const basename = [name, version].filter(val => val).join('@')
-  if (!excludeList.includes(name)) workspaces.add(basename)
-}
-
-function folder (name, version) {
-  const basename = [name, version].filter(val => val).join('@')
-  return path.join(__dirname, '..', 'versions', basename)
-}
-
-function filename (name, version, file) {
-  return path.join(folder(name, version), file)
-}
-
-function sha1 (str) {
-  if (!str) return
-
-  const shasum = crypto.createHash('sha1')
-  shasum.update(str)
-  return shasum.digest('hex')
-}
-
-function loadInstFile (file, instrumentations) {
-  const instrument = {
-    addHook (instrumentation) {
-      instrumentations.push(instrumentation)
-    }
-  }
-
-  const instPath = path.join(__dirname, `../packages/datadog-instrumentations/src/${file}`)
-
-  proxyquire.noPreserveCache()(instPath, {
-    './helpers/instrument': instrument,
-    '../helpers/instrument': instrument
-  })
-}

package/scripts/publish_docs.js

@@ -1,21 +0,0 @@
-'use strict'
-
-const exec = require('./helpers/exec')
-const title = require('./helpers/title')
-
-title(`Publishing API documentation to GitHub Pages`)
-
-const msg = process.argv[2]
-
-if (!msg) {
-  throw new Error('Please provide a reason for the change. Example: node scripts/publish_docs.js "fix typo"')
-}
-
-exec('yarn install', { cwd: './docs' })
-exec('rm -rf ./out', { cwd: './docs' })
-exec('yarn type:doc') // run first because typedoc requires an empty directory
-exec('git init', { cwd: './docs/out' }) // cloning would overwrite generated docs
-exec('git remote add origin git@github.com:DataDog/dd-trace-js.git', { cwd: './docs/out' })
-exec('git add -A', { cwd: './docs/out' })
-exec(`git commit -m "${msg}"`, { cwd: './docs/out' })
-exec('git push -f origin main:gh-pages', { cwd: './docs/out' })