chore: upgrade to mocha@10

[trentm]

From mocha@7. Drop use of ts-mocha in favour of a .mocharc.yml.
This mimicks the same mocha@10 update that was done in opentelemetry-js.git
a long while back.

Refs: #1826 (comment)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.49%. Comparing base (b043ffb) to head (c993c34).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2481      +/-   ##
==========================================
- Coverage   90.74%   90.49%   -0.26%     
==========================================
  Files         156      151       -5     
  Lines        7728     7418     -310     
  Branches     1590     1550      -40     
==========================================
- Hits         7013     6713     -300     
+ Misses        715      705      -10     

see 5 files with indirect coverage changes

[trentm]

npm test in instr-router is failing:

 > @opentelemetry/[email protected] test
> nyc mocha 'test/**/*.ts'


 Exception during run: test/index.test.ts(30,25): error TS7016: Could not find a declaration file for module 'router'. '/home/runner/work/opentelemetry-js-contrib/opentelemetry-js-contrib/node_modules/router/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/router` if it exists or add a new declaration (.d.ts) file containing `declare module 'router';`
Error: test/index.test.ts(39,15): error TS7006: Parameter 'req' implicitly has an 'any' type.
Error: test/index.test.ts(39,20): error TS7006: Parameter 'res' implicitly has an 'any' type.
Error: test/index.test.ts(39,25): error TS7006: Parameter 'next' implicitly has an 'any' type.
Error: test/index.test.ts(44,23): error TS7006: Parameter 'req' implicitly has an 'any' type.
Error: test/index.test.ts(44,28): error TS7006: Parameter 'res' implicitly has an 'any' type.
Error: test/index.test.ts(44,33): error TS7006: Parameter 'next' implicitly has an 'any' type.
Error: test/index.test.ts(48,38): error TS7006: Parameter 'req' implicitly has an 'any' type.
Error: test/index.test.ts(48,43): error TS7006: Parameter 'res' implicitly has an 'any' type.
Error: test/index.test.ts(48,48): error TS7006: Parameter 'next' implicitly has an 'any' type.
Error: test/index.test.ts(54,43): error TS7006: Parameter 'req' implicitly has an 'any' type.
Error: test/index.test.ts(54,48): error TS7006: Parameter 'res' implicitly has an 'any' type.
Error: test/index.test.ts(54,53): error TS7006: Parameter 'next' implicitly has an 'any' type.
Error: test/index.test.ts(63,51): error TS7006: Parameter 'req' implicitly has an 'any' type.
Error: test/index.test.ts(63,56): error TS7006: Parameter 'res' implicitly has an 'any' type.
Error: test/index.test.ts(63,61): error TS7006: Parameter 'next' implicitly has an 'any' type.
Error: test/index.test.ts(74,51): error TS7006: Parameter 'err' implicitly has an 'any' type.
Error: test/index.test.ts(74,56): error TS7006: Parameter 'req' implicitly has an 'any' type.
Error: test/index.test.ts(74,61): error TS7006: Parameter 'res' implicitly has an 'any' type.
Error: test/index.test.ts(74,66): error TS7006: Parameter 'next' implicitly has an 'any' type.
Error: test/index.test.ts(79,38): error TS7006: Parameter 'req' implicitly has an 'any' type.
Error: test/index.test.ts(79,43): error TS7006: Parameter 'res' implicitly has an 'any' type.
Error: test/index.test.ts(79,48): error TS7006: Parameter 'next' implicitly has an 'any' type.
Error: test/index.test.ts(88,22): error TS7006: Parameter 'err' implicitly has an 'any' type.

I don't know how to solve this. @david-luna If you have a chance to look at this and provide TypeScript expertise, I'd appreciate it.

[github-actions]

This package does not have an assigned component owner and is considered unmaintained. As such this package is in feature-freeze and this PR will be closed with 14 days unless a new owner or a sponsor (a member of @open-telemetry/javascript-approvers) for the feature is found. It is the responsibility of the author to find a sponsor for this feature.
Are you familiar with this package? Consider becoming a component owner.

[david-luna]

@trentm

for some reason with this configuration the tests are not getting the router types from ./src/router.d.ts. Probably is ts-node making a slight different tsconfig.json

cd ./plugins/node/opentelemetry-instrumentation-router

npmx tsc --showConfig

{
    "compilerOptions": {
        "allowUnreachableCode": false,
        "allowUnusedLabels": false,
        "declaration": true,
        "declarationMap": true,
        "forceConsistentCasingInFileNames": true,
        "inlineSources": true,
        "module": "commonjs",
        "noEmitOnError": true,
        "noFallthroughCasesInSwitch": true,
        "noImplicitOverride": true,
        "noImplicitReturns": true,
        "noUnusedLocals": true,
        "sourceMap": true,
        "strict": true,
        "strictNullChecks": true,
        "target": "es2017",
        "incremental": true,
        "newLine": "lf",
        "rootDir": "./",
        "outDir": "./build"
    },
    "files": [
        "./src/constants.ts",
        "./src/index.ts",
        "./src/instrumentation.ts",
        "./src/internal-types.ts",
        "./src/router.d.ts",  <-- router types are included
        "./src/utils.ts",
        "./src/version.ts",
        "./src/enums/AttributeNames.ts",
        "./src/enums/LayerType.ts",
        "./test/index.test.ts"
    ],
    "include": [
        "src/**/*.ts",
        "test/**/*.ts"
    ],
    "exclude": [
        "../../../node_modules"
    ]
}

npx ts-node --showConfig

{
  "ts-node": {
    "cwd": "/Users/david/Documents/repos/otel/opentelemetry-js-contrib/plugins/node/opentelemetry-instrumentation-router",
    "projectSearchDir": "/Users/david/Documents/repos/otel/opentelemetry-js-contrib/plugins/node/opentelemetry-instrumentation-router",
    "project": "/Users/david/Documents/repos/otel/opentelemetry-js-contrib/plugins/node/opentelemetry-instrumentation-router/tsconfig.json"
  },
  "compilerOptions": {
    "allowUnreachableCode": false,
    "allowUnusedLabels": false,
    "declaration": false,
    "forceConsistentCasingInFileNames": true,
    "inlineSources": true,
    "module": "commonjs",
    "noEmitOnError": true,
    "noFallthroughCasesInSwitch": true,
    "noImplicitOverride": true,
    "noImplicitReturns": true,
    "noUnusedLocals": true,
    "sourceMap": true,
    "strict": true,
    "strictNullChecks": true,
    "target": "es2017",
    "incremental": true,
    "newLine": "lf",
    "rootDir": "./",
    "outDir": "./.ts-node",
    "inlineSourceMap": false,
    "noEmit": false
  }  <-- no "files" defined in this configuration
}

The easies way to have the type definitions in the test is to use triple slash directive pointing to the router.d.ts file.

// file: index.test.ts
/*
 * Copyright The OpenTelemetry Authors
 * ...
 */

/// <reference path="../src/router.d.ts" />

import { context, trace } from '@opentelemetry/api';
import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';

[trentm]

/me sponsoring this

[trentm]

The easies way to have the type definitions in the test is to use triple slash directive pointing to the router.d.ts file.

Thanks! I'll try that.

[trentm]

The easies way to have the type definitions in the test is to use triple slash directive pointing to the router.d.ts file.

Thanks! I'll try that.

I guess this isn't the easiest way, because our lint rules say using the triple-slash-directive is an error. :) Sigh.

[trentm]

FWIW a similar test failure happens with packages/opentelemetry-host-metrics. These two packages (host-metrics and instrumentation-router) are the two packages that have .d.ts files committed.

A theory is that the issue relates to require: 'ts-node/register' in .mocharc.yml being insufficient. Perhaps it doesn't find and load the "tsconfig.json" file in each package?

I'd welcome suggestions on what to do here.