.tav.yml

# This file is used by tool TAV - Test All Versions.
# See: https://github.com/watson/test-all-versions

'@apollo/server':
  versions: ^4.0.0
  peerDependencies: graphql@^16.6.0
  node: '>=14.16.0'
  commands: node test/instrumentation/modules/@apollo/server.test.js

generic-pool:
  versions: ^2.0.0 || ^3.1.0
  commands: node test/instrumentation/modules/generic-pool.test.js

# Testing 'got' was initially added to test an issue in its usage of
# mimic-response@1.0.0. However, this test case serves to sanity test 'got'
# usage with the agent. Got@12 is pure ESM, so cannot currently be tested with
# the current test script.
#
# Supported got versions: '>=4 <12'. As of v11.8.6, this range includes 103
# got versions. Testing all these versions as a "sanity test" is a waste of
# resources. Instead we test just a few: the latest 8.x, 9.x, and 10.x (all
# no longer getting releases); and >=11.8.6.
got:
  versions: '8.3.2 || 9.6.0 || 10.7.0 || >=11.8.6 <12'
  commands: node test/instrumentation/modules/http/github-423.test.js

mysql:
  versions: ^2.0.0
  commands:
    - node test/instrumentation/modules/mysql/mysql.test.js
    - node test/instrumentation/modules/mysql/pool-release-1.test.js

# mysql2
# - v1.6.2 is broken: https://github.com/sidorares/node-mysql2/issues/869
# - v2.2.3 has a github dep ("@types/mysql": "types/mysql") that hits
#   npm v6 install issue https://github.com/npm/cli/issues/4896
# - v3: It isn't clear what the min supported Node.js version is. "engines" says
#   8.0.0, however it uses an lru-cache that supports only node >=16.14! From
#   trial and error the effective min supported node is v14.6.0.
#   See https://github.com/elastic/apm-agent-nodejs/pull/3301#issuecomment-1530138870
mysql2:
  - versions: '>=1.0.0 <1.6.0'
    commands:
      - node test/instrumentation/modules/mysql2/mysql.test.js
      - node test/instrumentation/modules/mysql2/pool-release-1.test.js
  - versions: '>=1.6.0 <1.6.2 || >=1.6.3 <2.2.3 || >=2.2.4 <3'
    node: '>=8.0.0'
    commands:
      - node test/instrumentation/modules/mysql2/mysql.test.js
      - node test/instrumentation/modules/mysql2/pool-release-1.test.js
  - versions: '>=3.0.0 <4'
    node: '>=14.6.0'
    commands:
      - node test/instrumentation/modules/mysql2/mysql.test.js
      - node test/instrumentation/modules/mysql2/pool-release-1.test.js

redis:
  - versions: '>=2.0.0 <4.0.0'
    commands: node test/instrumentation/modules/redis-2-3.test.js
  - versions:
      mode: latest-minors
      include: '>=4.0.0 <5'
      # redis@4.6.9 was a bad release, it accidentally broke node v14 support.
      exclude: '4.6.9'
    commands:
      - node test/instrumentation/modules/redis.test.js
      - node test/instrumentation/modules/redis-disabled.test.js
      - node test/instrumentation/modules/redis4-legacy.test.js

# We want these version ranges:
#   # v3.1.3 is broken in older versions of Node because of https://github.com/luin/ioredis/commit/d5867f7c7f03a770a8c0ca5680fdcbfcaf8488e7
#   versions: '>=2 <3.1.3 || >3.1.3 <4'
#   versions: '^4.0.0'
# However, there are a *lot* of ioredis releases, so we statically list a
# subset (the first, plus then the latest in each major.minor).
ioredis:
  - versions:
      mode: latest-minors
      include: '>=2.0.0 <4'
    commands: node test/instrumentation/modules/ioredis.test.js
  - versions:
      # Test v4.0.0, latest v4 and 5 versions in between.
      mode: max-7
      include: '>=4.0.0 <5'
    commands: node test/instrumentation/modules/ioredis.test.js
  - versions:
      mode: latest-minors
      include: '>=5.0.0 <6'
    commands: node test/instrumentation/modules/ioredis.test.js

pg:
  # We want this version range:
  #   versions: '>=4 <9'
  # but test a subset to reduce the test matrix. The last 4.x release was in
  # 2017, 5.x in 2017, 6.x in 2017, 7.x in 2020.
  #
  # Maintenance note: This should be updated for newer MAJOR.MINOR releases.
  - versions: '4.0.0 || 4.5.7 || 5.2.1 || 6.4.2 || 7.18.2 || 8.0.3 || 8.1.0 || 8.2.2 || 8.3.3 || 8.4.2 || 8.5.1 || 8.6.0 || 8.7.3 || 8.8.0 || 8.9.0 || 8.10.0 || >8.10.0 <9'
    node: '<14'
    peerDependencies:
      - knex@^0.20 # latest knex that supports back to node v8
    commands:
      - node test/instrumentation/modules/pg/pg.test.js
      - node test/instrumentation/modules/pg/knex.test.js
  # We want this version range:
  #   versions: '>=8.0.3 <9' # Prior versions didn't work in Node.js 14
  # but only the latest MAJOR.MINOR.x to reduce the test matrix.
  #
  # Maintenance note: This should be updated for newer MAJOR.MINOR releases.
  - versions: '8.0.3 || 8.1.0 || 8.2.2 || 8.3.3 || 8.4.2 || 8.5.1 || 8.6.0 || 8.7.3 || 8.8.0 || 8.9.0 || 8.10.0 || >8.10.0 <9'
    node: '>=14'
    commands:
      - node test/instrumentation/modules/pg/pg.test.js
      - node test/instrumentation/modules/pg/knex.test.js

# Latest mongodb-core release (v3.2.7) was released in 2019. We test a subset
# of the full supported range.
mongodb-core:
  versions:
    mode: latest-minors
    include: '>=1.2.19 <4'
  commands: node test/instrumentation/modules/mongodb-core.test.js

mongodb:
  - versions:
      # Test v3.3, latest v4 and 5 versions in between.
      mode: max-7
      include: '>=3.3 <5'
    commands: node test/instrumentation/modules/mongodb/mongodb.test.js
  - versions: '>=5 <6'
    node: '>=14.20.1'
    commands: node test/instrumentation/modules/mongodb/mongodb.test.js
  - versions: '>=6 <7'
    node: '>=16.20.1'
    commands: node test/instrumentation/modules/mongodb/mongodb.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
# resources. Instead we test just the latest 3.x release.
bluebird:
  versions: '3.7.2'
  commands:
    - node test/instrumentation/modules/bluebird/bluebird.test.js
    - node test/instrumentation/modules/bluebird/cancel.test.js

# knex (https://github.com/knex/knex/blob/master/UPGRADING.md)
# - knex 0.18.0 min supported node is v8
# - knex 0.21.0 min supported node is v10
# - knex 1.0.0 min supported node is v12
# - knex 3.0.0 min supported node is v16
knex:
  # Latest 0.16 release was in 2019, therefore only test first and last in this range.
  - versions: '0.10.0 || 0.16.5'
    commands: node test/instrumentation/modules/pg/knex.test.js
  # Latest 0.20.x release was 2020-04, there only test first and last in this range.
  - versions: '0.17.0 || 0.20.15'
    node: '>=8.6.0'
    commands: node test/instrumentation/modules/pg/knex.test.js
  - versions: '0.21.21 || ^0.95.15' # latest majors subset of '>=0.21 <1'
    node: '>=10.22.0'
    commands: node test/instrumentation/modules/pg/knex.test.js
  - versions: '1.0.7 || ^2.5.1' # latest majors subset of '>=1 <3'
    node: '>=12.0.0'
    commands: node test/instrumentation/modules/pg/knex.test.js
  - versions: '^3.0.1'
    node: '>=16'
    commands: node test/instrumentation/modules/pg/knex.test.js

ws:
  - versions:
      mode: max-5
      include: '>=1 <8'
    commands: node test/instrumentation/modules/ws.test.js

graphql:
  - versions:
      mode: max-5
      include: '>=0.7.0 <16'
      exclude: '0.11.0' # Testing with 0.11.0 was "buggy".
    commands: node test/instrumentation/modules/graphql.test.js
  - versions:
      mode: latest-minors
      include: '>=16.0.0 <17'
    node: '>=12'
    commands: node test/instrumentation/modules/graphql.test.js

express:
  versions:
    mode: latest-minors
    # include requires an upper bound. v5 is still in beta
    # (5.0.0-beta.1": "2022-02-15T01:11:25.229Z) but we use 6 to make sure any
    # future release is included if we udpate
    include: '>=4 <6' # latest minors subset of '>=4 <6'
  commands:
    - node test/instrumentation/modules/express/basic.test.js
    - node test/instrumentation/modules/express/capture-exceptions-off.test.js
    - node test/instrumentation/modules/express/capture-exceptions-on.test.js
    - node test/instrumentation/modules/express/set-framework.test.js

apollo-server-express:
  # We want this version range:
  #   versions: '>=2.9.16 <2.2 || >= 2.3.2 <3'
  # but only the latest MAJOR.MINOR.x to reduce the test matrix.
  #
  # Maintenance note: This should be updated for newer MAJOR.MINOR releases.
  - versions: '2.9.16 || 2.10.1 || 2.11.0 || 2.12.0 || 2.13.1 || 2.14.5 || 2.15.1 || 2.16.1 || 2.17.0 || 2.18.2 || 2.19.2 || 2.20.0 || 2.21.2 || 2.22.2 || 2.23.0 || 2.24.1 || 2.25.0 || >2.25.x <3'
    peerDependencies: graphql@^14.0.0
    node: '>=6'
    commands: node test/instrumentation/modules/apollo-server-express.test.js
  # We want this version range (2.12.0 was the first release of
  # apollo-server-express after graphql@15 was released):
  #   versions: '>=2.12.0 <3'
  # but only the latest MAJOR.MINOR.x to reduce the test matrix.
  #
  # Maintenance note: This should be updated for newer MAJOR.MINOR releases.
  - versions: '2.15.1 || 2.16.1 || 2.17.0 || 2.18.2 || 2.19.2 || 2.20.0 || 2.21.2 || 2.22.2 || 2.23.0 || 2.24.1 || 2.25.0 || >2.25.x <3'
    peerDependencies: graphql@^15.0.0
    # Per https://github.com/graphql/graphql-js/releases/tag/v15.0.0
    # graphql v15 supports node v8 as a minimum.
    node: '>=8'
    commands: node test/instrumentation/modules/apollo-server-express.test.js
  # We want this version range:
  #   versions: '^3.0.0'
  # but only test the latest MAJOR.MINOR.x to reduce the test matrix.
  #
  # Maintenance note: This should be updated for newer MAJOR.MINOR releases.
  - versions: '3.0.2 || 3.1.2 || 3.2.0 || 3.3.0 || 3.4.1 || 3.5.0 || 3.6.8 || 3.7.0 || 3.8.2 || 3.9.0 || ^3.10.2'
    peerDependencies: graphql@^15.0.0
    commands: node test/instrumentation/modules/apollo-server-express.test.js

express-queue:
  versions: '>=0.0.11'
  commands: node test/instrumentation/modules/express-queue.test.js

koa-router:
  versions: '>=5.2.0 <13'
  peerDependencies: koa@2
  commands: node test/instrumentation/modules/koa-router/old-name.test.js

'@koa/router':
  versions: '>=8 <13'
  peerDependencies: koa@2
  commands: node test/instrumentation/modules/koa-router/new-name.test.js

elasticsearch:
  versions: '>=8.0.0'
  commands: node test/instrumentation/modules/elasticsearch.test.js

# @elastic/elasticsearch
# - Version 7.7.0 included a change that broke usage with Node.js < 10.
#   Fixed in 7.7.1: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/changelog-client.html#_7_7_1
#   Note: When this repo drops Node.js v8 support, `versions` can be simplified.
# - Version 7.12.0 dropped support for node v8.
# - Version 8.0.0 dropped node v10 support.
# - Version 8.2.0 dropped node v12 support.
#   - Skip "8.2.0" because https://github.com/elastic/elasticsearch-js/pull/1688
#   - The ES client team uses "8.2.0-patch.N" for patch releases *after*
#     "8.2.0" because they are stuck with stack version numbers. However,
#     semver (and TAV) consider "-patch.N" to be a *prereleases*. This
#     leads to some tortured "versions:" ranges below.
# - Version 8.11.0 dropped node v14 and v16 support.
'@elastic/elasticsearch':
  - versions: '>=7.0.0 <7.7.0 || >7.7.0 <7.12.0'
    commands: node test/instrumentation/modules/@elastic/elasticsearch.test.js
  - versions: '>=7.12.0 <8.2'
    node: '>=12.0.0'
    commands: node test/instrumentation/modules/@elastic/elasticsearch.test.js
  - versions: '>=8.2.0-patch.1 <8.2.0 || >8.2.0 <8.11.0'
    node: '>=14.0.0'
    commands: node test/instrumentation/modules/@elastic/elasticsearch.test.js
  - versions: '>=8.11.0'
    node: '>=18.0.0'
    commands: node test/instrumentation/modules/@elastic/elasticsearch.test.js

handlebars:
  versions:
    mode: max-7
    include: '>=1 <5'
  commands: node test/instrumentation/modules/handlebars.test.js

# Pug v3 dropped node v8 support (https://github.com/pugjs/pug/releases/tag/pug%403.0.0).
pug:
  - versions: '0.1.0 || >2.0.0 <3.0.0'
    commands: node test/instrumentation/modules/pug.test.js
  - versions: '>=3.0.0'
    node: '>8'
    commands: node test/instrumentation/modules/pug.test.js

# @hapi/hapi
# - Package name: Starting with v17.9.0 and v18.2.0 the name changed from
#   'hapi' to '@hapi/hapi'. Starting in elastic-apm-node@4, only the newer
#   '@hapi/hapi' is instrumented.
# - Node version compat:
#   - @hapi/hapi@19: supports node >=v12 (judging from commit 50d8d7d)
#   - @hapi/hapi@20: appears (from travis template refs) to support node >=v12
#   - @hapi/hapi@20.1.2 fixed an issue (https://github.com/hapijs/hapi/pull/4225)
#     needed to work with node >=16. Earlier versions of Hapi will crash when
#     handling a POST.
#   - @hapi/hapi@21: dropped support for node v12, and requires v14.10.0
#     for 'performance.eventLoopUtilization'
'@hapi/hapi':
  - versions: '>=17.0.0 <19.0.0'
    node: '>=8.12.0 <16.0.0'
    commands:
      - node test/instrumentation/modules/hapi/hapi.test.js
      - node test/instrumentation/modules/hapi/set-framework.test.js
  - versions: '>=19.0.0 <20.1.2'
    node: '>=12.0.0 <16.0.0'
    commands:
      - node test/instrumentation/modules/hapi/hapi.test.js
      - node test/instrumentation/modules/hapi/set-framework.test.js
  - versions: '>=20.1.2 <21.0.0'
    node: '>=12.0.0'
    commands:
      - node test/instrumentation/modules/hapi/hapi.test.js
      - node test/instrumentation/modules/hapi/set-framework.test.js
  - versions: '>=21.0.0'
    node: '>=14.10.0'
    commands:
      - node test/instrumentation/modules/hapi/hapi.test.js
      - node test/instrumentation/modules/hapi/set-framework.test.js

tedious:
  - versions:
      include: '>=1 <11'
      mode: latest-majors
    node: '>=6'
    commands: node test/instrumentation/modules/tedious.test.js
  - versions:
      include: '>=11 <12'
      mode: latest-majors
    node: '>=10.17.0'
    commands: node test/instrumentation/modules/tedious.test.js
  # Tedious v12,v13,v14 advertise a min-supported Node.js version of 12.3.0.
  # Tedious v15 advertises a min-supported Node.js version of 14.
  # However, as of @azure/core-rest-pipeline@1.15.0 they effectively have a
  # min-working Node.js of >=16 (possibly >=18).
  - versions:
      include: '>=12 <17'
      mode: latest-majors
    node: '>=16'
    commands: node test/instrumentation/modules/tedious.test.js
  - versions:
      include: '>=17 <19'
      mode: latest-majors
    node: '18.x || >=20'
    commands: node test/instrumentation/modules/tedious.test.js

cassandra-driver:
  # 3.1.0 is broken
  versions: '>=3 <3.1.0 || >3.1.0 <5'
  commands: node test/instrumentation/modules/cassandra-driver/cassandra-driver.test.js

# Restify
# - restify <v10 doesn't work with node v18+ (https://github.com/restify/node-restify/issues/1888)
# - restify v9 used `require('node:...')` that requires node >v14.18.0
#   (https://nodejs.org/api/modules.html#core-modules)
restify:
  - versions: '>=5.2.0 <8.0.0'
    node: '<18.0.0'
    commands:
      - node test/instrumentation/modules/restify/basic.test.js
      - node test/instrumentation/modules/restify/set-framework.test.js
  - versions: '>=8.0.0 <9.0.0'
    node: '>=8.6.0 <18.0.0'
    commands:
      - node test/instrumentation/modules/restify/basic.test.js
      - node test/instrumentation/modules/restify/set-framework.test.js
  - versions: '>=9.0.0 <10.0.0'
    node: '>=14.18.0 <18.0.0'
    commands:
      - node test/instrumentation/modules/restify/basic.test.js
      - node test/instrumentation/modules/restify/set-framework.test.js
  - versions: '>=10.0.0 <12.0.0'
    node: '>=14.18.0'
    commands:
      - node test/instrumentation/modules/restify/basic.test.js
      - node test/instrumentation/modules/restify/set-framework.test.js

# https://www.fastify.io/docs/latest/LTS/
# - #1086 suggests fastify@2.4.0 was a broken release, skip it.
# - fastify@4.0.1 is broken: https://github.com/fastify/fastify/issues/3998#issuecomment-1153662513
# - fastify@4.16.0 - 4.16.2 (inclusive) are broken releases
# - Do not run "test/sanitize-field-names/fastify.test.js" for older fastify,
#   because the test file uses '@fastify/formbody', which only has versions
#   for fastify >=3.
fastify:
  - versions: '1.0.0 || 1.14.6' # subset of '1.x'
    node: '>=6 <12'
    commands:
      - node test/instrumentation/modules/fastify/fastify.test.js
      - node test/instrumentation/modules/fastify/async-await.test.js
      - node test/instrumentation/modules/fastify/set-framework.test.js
  - versions: '2.0.0 || 2.15.3' # subset of '>=2.0.0 <2.4.0 || >2.4.0 <3'
    node: '>=6 <15'
    commands:
      - node test/instrumentation/modules/fastify/fastify.test.js
      - node test/instrumentation/modules/fastify/async-await.test.js
      - node test/instrumentation/modules/fastify/set-framework.test.js
  - versions:
      mode: max-7
      include: '>=3 <4'
    peerDependencies: '@fastify/formbody@^6.0.1'
    node: '>=10'
    commands:
      - node test/instrumentation/modules/fastify/fastify.test.js
      - node test/instrumentation/modules/fastify/async-await.test.js
      - node test/instrumentation/modules/fastify/set-framework.test.js
      - node test/sanitize-field-names/fastify.test.js
  - versions:
      mode: max-7
      include: '>=4 <5'
      exclude: '4.0.1 || >=4.16.0 <=4.16.2'
    peerDependencies: '@fastify/formbody@^7'
    node: '>=14.6.0'
    commands:
      - node test/instrumentation/modules/fastify/fastify.test.js
      - node test/instrumentation/modules/fastify/async-await.test.js
      - node test/instrumentation/modules/fastify/set-framework.test.js
      - node test/sanitize-field-names/fastify.test.js

finalhandler:
  versions: '*'
  commands: node test/instrumentation/modules/finalhandler.test.js

memcached:
  versions: '>=2.2.0'
  commands: node test/instrumentation/modules/memcached.test.js

aws-sdk:
  # - v2.1372.0 changed the SQS client protocol from "query" to "json", which
  #   isn't supported in localstack. It was reverted in v2.1373.0.
  # - v2.1491.0 and up changed protocol to "json" again, eventually supported
  #   in localstack v3.
  versions:
    mode: max-7
    include: '>=2.858.0 <3'
    exclude: '2.1372.0'
  commands:
    - node test/instrumentation/modules/aws-sdk/aws4-retries.test.js
    - node test/instrumentation/modules/aws-sdk/s3.test.js
    - node test/instrumentation/modules/aws-sdk/sns.test.js
    - node test/instrumentation/modules/aws-sdk/sqs.test.js
    - node test/instrumentation/modules/aws-sdk/dynamodb.test.js

'@aws-sdk/client-s3':
  versions:
    # - 3.377.0 was a bad release (https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1828#issuecomment-1834276719)
    mode: max-7
    include: '>=3.15.0 <4'
    exclude: '3.377.0'
  commands:
    - node test/instrumentation/modules/@aws-sdk/client-s3.test.js
  node: '>=14'

'@aws-sdk/client-dynamodb':
  versions:
    mode: max-7
    include: '>=3.15.0 <4'
  commands:
    - node test/instrumentation/modules/@aws-sdk/client-s3.test.js
  node: '>=14'

'@aws-sdk/client-sns':
  versions:
    mode: max-7
    include: '>=3.15.0 <4'
  commands:
    - node test/instrumentation/modules/@aws-sdk/client-sns.test.js
  node: '>=14'

'@aws-sdk/client-sqs':
  versions:
    mode: max-7
    include: '>=3.15.0 <4'
  commands:
    - node test/instrumentation/modules/@aws-sdk/client-sqs.test.js
  node: '>=14'

# - undici@4.7.0 added its diagnostics_channel support.
# - In undici@4.7.1 the `request.origin` property was added, which we need
#   in the 'undici:request:create' diagnostic message.
undici:
  - versions:
      mode: max-7
      include: '>=6.0.0 <7'
    node: '>=18.17.0'
    commands: node test/instrumentation/modules/undici/undici.test.js
  - versions:
      mode: max-7
      include: '>=4.7.1 <6'
    commands: node test/instrumentation/modules/undici/undici.test.js

kafkajs:
  versions:
    mode: latest-minors
    include: '>=2 <3'
  commands: node test/instrumentation/modules/kafkajs/kafkajs.test.js