Implement basic CI version capper

Author: bouwkast

packages/datadog-instrumentations/src/helpers/latests.json

@@ -0,0 +1,112 @@
+{
+  "pinned": [
+    "ENTER_PACKAGE_NAME_HERE"
+  ],
+  "latests": {
+    "aerospike": "6.0.2",
+    "amqp10": "3.6.0",
+    "amqplib": "0.10.5",
+    "apollo-server-core": "3.13.0",
+    "@apollo/server": "4.11.3",
+    "@apollo/gateway": "2.10.0",
+    "avsc": "5.7.7",
+    "@smithy/smithy-client": "4.1.6",
+    "@aws-sdk/smithy-client": "3.374.0",
+    "aws-sdk": "2.1692.0",
+    "@azure/functions": "4.6.1",
+    "bluebird": "3.7.2",
+    "body-parser": "1.20.3",
+    "bunyan": "1.8.15",
+    "cassandra-driver": "4.8.0",
+    "connect": "3.7.0",
+    "cookie-parser": "1.4.7",
+    "cookie": "1.0.2",
+    "couchbase": "4.4.5",
+    "@cucumber/cucumber": "11.2.0",
+    "cypress": "14.1.0",
+    "@elastic/transport": "8.9.4",
+    "@elastic/elasticsearch": "8.17.1",
+    "elasticsearch": "16.7.3",
+    "express-mongo-sanitize": "2.2.0",
+    "express-session": "1.18.1",
+    "express": "4.21.2",
+    "fastify": "5.2.1",
+    "find-my-way": "9.2.0",
+    "fs": "0.0.1-security",
+    "generic-pool": "3.9.0",
+    "@google-cloud/pubsub": "4.10.0",
+    "@graphql-tools/executor": "1.4.2",
+    "graphql": "16.10.0",
+    "@grpc/grpc-js": "1.12.6",
+    "handlebars": "4.7.8",
+    "@hapi/hapi": "21.3.12",
+    "hapi": "18.1.0",
+    "ioredis": "5.5.0",
+    "jest-environment-node": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "@jest/core": "29.7.0",
+    "@jest/test-sequencer": "29.7.0",
+    "@jest/reporters": "29.7.0",
+    "jest-circus": "29.7.0",
+    "@jest/transform": "29.7.0",
+    "jest-config": "29.7.0",
+    "jest-runtime": "29.7.0",
+    "jest-worker": "29.7.0",
+    "kafkajs": "2.2.4",
+    "knex": "3.1.0",
+    "koa": "2.16.0",
+    "@koa/router": "13.1.0",
+    "koa-router": "13.0.1",
+    "@langchain/core": "0.3.41",
+    "@langchain/openai": "0.4.4",
+    "ldapjs": "3.0.7",
+    "limitd-client": "2.14.1",
+    "lodash": "4.17.21",
+    "mariadb": "3.4.0",
+    "memcached": "2.2.2",
+    "microgateway-core": "3.3.5",
+    "moleculer": "0.14.35",
+    "mongodb-core": "3.2.7",
+    "mongodb": "6.14.0",
+    "mongoose": "8.11.0",
+    "mquery": "5.0.0",
+    "multer": "1.4.5-lts.1",
+    "mysql": "2.18.1",
+    "mysql2": "3.12.0",
+    "next": "15.2.0",
+    "node-serialize": "0.0.4",
+    "nyc": "17.1.0",
+    "openai": "4.86.1",
+    "@opensearch-project/opensearch": "3.4.0",
+    "oracledb": "6.8.0",
+    "paperplane": "3.1.2",
+    "passport-http": "0.3.0",
+    "passport-local": "1.0.0",
+    "passport": "0.7.0",
+    "pg": "8.13.3",
+    "pino": "9.6.0",
+    "pino-pretty": "13.0.0",
+    "@playwright/test": "1.50.1",
+    "playwright": "1.50.1",
+    "promise-js": "0.0.7",
+    "promise": "8.3.0",
+    "protobufjs": "7.4.0",
+    "pug": "3.0.3",
+    "q": "1.5.1",
+    "@node-redis/client": "1.0.6",
+    "@redis/client": "1.6.0",
+    "redis": "4.7.0",
+    "restify": "11.1.0",
+    "rhea": "3.0.3",
+    "router": "1.3.8",
+    "selenium-webdriver": "4.29.0",
+    "sequelize": "6.37.5",
+    "sharedb": "5.1.1",
+    "tedious": "18.6.1",
+    "undici": "7.4.0",
+    "vitest": "3.0.7",
+    "@vitest/runner": "3.0.7",
+    "when": "3.7.8",
+    "winston": "3.17.0"
+  }
+}

scripts/helpers/versioning.js

@@ -0,0 +1,78 @@
+const fs = require('fs')
+const path = require('path')
+const childProcess = require('child_process')
+const proxyquire = require('proxyquire')
+
+const versionLists = {}
+const names = []
+
+const filter = process.env.hasOwnProperty('PLUGINS') && process.env.PLUGINS.split('|')
+
+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)
+    }
+  })
+
+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 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
+  })
+}
+
+function getInternals () {
+  return 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), [])
+}
+
+module.exports = {
+  getVersionList,
+  npmView,
+  loadInstFile,
+  getInternals
+}

scripts/install_plugin_modules.js

@@ -9,6 +9,7 @@ const exec = require('./helpers/exec')
 const childProcess = require('child_process')
 const externals = require('../packages/dd-trace/test/plugins/externals')
 const { getInstrumentation } = require('../packages/dd-trace/test/setup/helpers/load-inst')
+const latests = require('../packages/datadog-instrumentations/src/helpers/latests.json')
 
 const requirePackageJsonPath = require.resolve('../packages/dd-trace/src/require-package-json')
 
@@ -106,9 +107,21 @@ function assertFolder (name, version) {
 }
 
 async function assertPackage (name, version, dependencyVersionRange, external) {
-  const dependencies = { [name]: dependencyVersionRange }
+  // Apply version cap from latests.json if available
+  // TODO: pinned versions?
+  let cappedVersionRange = dependencyVersionRange
+  if (latests.latests[name]) {
+    const latestVersion = latests.latests[name]
+    // If the range would allow versions beyond what we've tested, cap it
+    if (semver.validRange(dependencyVersionRange) &&
+        !semver.subset(`<=${latestVersion}`, dependencyVersionRange)) {
+      cappedVersionRange = `${dependencyVersionRange} <=${latestVersion}`
+    }
+  }
+  
+  const dependencies = { [name]: cappedVersionRange }
   if (deps[name]) {
-    await addDependencies(dependencies, name, dependencyVersionRange)
+    await addDependencies(dependencies, name, cappedVersionRange)
   }
   const pkg = {
     name: [name, sha1(name).substr(0, 8), sha1(version)].filter(val => val).join('-'),

scripts/outdated.js

@@ -0,0 +1,129 @@
+/* eslint-disable no-console */
+const {
+    getInternals,
+    npmView
+  } = require('./helpers/versioning')
+  const path = require('path')
+  const fs = require('fs')
+  
+  const latestsPath = path.join(
+    __dirname,
+    '..',
+    'packages',
+    'datadog-instrumentations',
+    'src',
+    'helpers',
+    'latests.json'
+  )
+  
+  // Get internal package names from existing getInternals helper
+  const internalsNames = Array.from(new Set(getInternals().map(n => n.name)))
+    .filter(x => typeof x === 'string' && x !== 'child_process' && !x.startsWith('node:'))
+  
+  // Initial structure with placeholder for pinned packages
+  const initialStructure = {
+    pinned: ['ENTER_PACKAGE_NAME_HERE'],
+    latests: {}
+  }
+  
+  /**
+     * Updates latests.json with the current latest versions from npm
+     */
+  async function fix () {
+    console.log('Starting fix operation...')
+    console.log(`Found ${internalsNames.length} packages to process`)
+  
+    let outputData = initialStructure
+    if (fs.existsSync(latestsPath)) {
+      console.log('Found existing latests.json, loading it...')
+      outputData = require(latestsPath)
+    }
+  
+    const latests = {}
+    let processed = 0
+    const total = internalsNames.length
+  
+    for (const name of internalsNames) {
+      processed++
+      process.stdout.write(`Processing package ${processed}/${total}: ${name}...`)
+  
+      try {
+        const distTags = await npmView(name + ' dist-tags')
+        const latest = distTags.latest
+        if (latest) {
+          latests[name] = latest
+          process.stdout.write(` found version ${latest}\n`)
+        } else {
+          process.stdout.write(' WARNING: no version found\n')
+          console.log(`Warning: Could not fetch latest version for "${name}"`)
+        }
+      } catch (error) {
+        process.stdout.write(' ERROR\n')
+        console.error(`Error fetching version for "${name}":`, error.message)
+      }
+    }
+  
+    outputData.latests = latests
+    console.log('\nWriting updated versions to latests.json...')
+    fs.writeFileSync(latestsPath, JSON.stringify(outputData, null, 2))
+    console.log('Successfully updated latests.json')
+    console.log(`Processed ${total} packages`)
+  }
+  
+  /**
+     * Checks if latests.json matches current npm versions
+     */
+  async function check () {
+    console.log('Starting version check...')
+  
+    if (!fs.existsSync(latestsPath)) {
+      console.log('latests.json does not exist. Run with "fix" to create it.')
+      process.exitCode = 1
+      return
+    }
+  
+    const currentData = require(latestsPath)
+    console.log(`Found ${internalsNames.length} packages to check`)
+  
+    let processed = 0
+    let mismatches = 0
+    const total = internalsNames.length
+  
+    for (const name of internalsNames) {
+      processed++
+      process.stdout.write(`Checking package ${processed}/${total}: ${name}...`)
+  
+      const latest = currentData.latests[name]
+      if (!latest) {
+        process.stdout.write(' MISSING\n')
+        console.log(`No latest version found for "${name}"`)
+        process.exitCode = 1
+        continue
+      }
+  
+      try {
+        const distTags = await npmView(name + ' dist-tags')
+        const npmLatest = distTags.latest
+        if (npmLatest !== latest) {
+          process.stdout.write(' MISMATCH\n')
+          console.log(`"latests.json: is not up to date for "${name}": expected "${npmLatest}", got "${latest}"`)
+          process.exitCode = 1
+          mismatches++
+        } else {
+          process.stdout.write(' OK\n')
+        }
+      } catch (error) {
+        process.stdout.write(' ERROR\n')
+        console.error(`Error checking version for "${name}":`, error.message)
+      }
+    }
+  
+    console.log('\nCheck completed:')
+    console.log(`- Total packages checked: ${total}`)
+    console.log(`- Version mismatches found: ${mismatches}`)
+    if (mismatches > 0) {
+      console.log('Run with "fix" to update versions')
+    }
+  }
+  if (process.argv.includes('fix')) fix()
+  else check()