feat(instrumentation-nestjs-core): add support for NestJS 11

[neilime]

Which problem is this PR solving?

• nest-core instrumentation is not supporting last version of NestJS (11)

Short description of the changes

• Adding support for NestJS 11

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: neilime / name: Emilien Escalle (b1fbaf7)

[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.

[neilime]

@dyladan any chance to have some review, or any advice to move forward with this instrumentation

[david-luna]

Thanks for your contribution @neilime :)

you need to also update tav.yml to include the new version in test-all-versions workflow

[neilime]

@david-luna it's done

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.55%. Comparing base (2b7feac) to head (b1fbaf7).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2685   +/-   ##
=======================================
  Coverage   90.55%   90.55%           
=======================================
  Files         168      168           
  Lines        8078     8078           
  Branches     1548     1548           
=======================================
  Hits         7315     7315           
  Misses        763      763           

Files with missing lines	Coverage Δ
...instrumentation-nestjs-core/src/instrumentation.ts	95.45% <100.00%> (ø)

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[neilime]

@david-luna or @pichlermarc can you approve the workflows, I've fixed the failing tests. Thanks

[david-luna]

Unit tests are failing for Node.js v14
https://github.com/open-telemetry/opentelemetry-js-contrib/actions/runs/13396741804/job/37462305503?pr=2685

> @opentelemetry/instrumentation-nestjs-core@0.44.0 test
> nyc mocha --timeout 5000 'test/**/*.test.ts'



  nestjs-core
    1) "before each" hook for "should capture setup"
    2) "after each" hook for "should capture setup"


  0 passing (58ms)
  2 failing

  1) nestjs-core
       "before each" hook for "should capture setup":
     /home/runner/work/opentelemetry-js-contrib/opentelemetry-js-contrib/plugins/node/opentelemetry-instrumentation-nestjs-core/node_modules/@nestjs/common/file-stream/streamable-file.js:36
            this.options.length ??= bufferOrReadStream.length;
                                             ^^^

That version of node does not support this kind of assignment. We should skip tests for that version of node.

[neilime]

Unit tests are failing for Node.js v14 https://github.com/open-telemetry/opentelemetry-js-contrib/actions/runs/13396741804/job/37462305503?pr=2685

> @opentelemetry/instrumentation-nestjs-core@0.44.0 test
> nyc mocha --timeout 5000 'test/**/*.test.ts'



  nestjs-core
    1) "before each" hook for "should capture setup"
    2) "after each" hook for "should capture setup"


  0 passing (58ms)
  2 failing

  1) nestjs-core
       "before each" hook for "should capture setup":
     /home/runner/work/opentelemetry-js-contrib/opentelemetry-js-contrib/plugins/node/opentelemetry-instrumentation-nestjs-core/node_modules/@nestjs/common/file-stream/streamable-file.js:36
            this.options.length ??= bufferOrReadStream.length;
                                             ^^^

That version of node does not support this kind of assignment. We should skip tests for that version of node.

That's weird, as the test is failing with "@nestjs/common@^8.0.0", so something that didnt change.
I think this is a side effect of a dev deps upgrade.

I will test them one by one in nodejs 14 context

[neilime]

@david-luna I will separate the PR in 2 commits, one for dev deps upgrade, one for NestJS 11 upgrade.

I've made the first one, it works fine on local with nodejs 14, can you approve workflow to validate it passes on CI

[gperdomor]

@neilime I think this line should be updated too:
const supportedVersions = ['>=4.0.0 <11']; to something like const supportedVersions = ['>=4.0.0 <12'];

[neilime]

@neilime I think this line should be updated too: const supportedVersions = ['>=4.0.0 <11']; to something like const supportedVersions = ['>=4.0.0 <12'];

Yes it will be but as we have some weird issue with node 14, I separate the PR in two commits:

See #2685 (comment)

I'm waiting the CI validation of the first one before doing the second one

[neilime]

Now it's failing on mongodb tests with nodejs 18... Looks more and more weird.

I will try to rebase to be up to date with main.

Is there any way to allows workflow every time for this PR? it is very time consuming to wait for validation every time.

[neilime]

@david-luna @gperdomor @pichlermarc, I think the PR is good to pass all tests.

After many attempts to fix flaky tests, handle node 14 issues...

I've made the CI pass on my form repository, I you can approve the workflow it will be great.

Thanks

[mimiz]

Hello, is there a way to help on this PR ?

[neilime]

Hello, is there a way to help on this PR ?

On my side, I'm just waiting for CI workflows approval and some reviews

[darraghenright]

Thanks a million for this @neilime

[mimiz]

Hello,
It seems the modification is very simple, that CI checks are ok (tests and code quality), so this PR can be approved

[david-luna]

@neilime there have been changes you need to sync. I've already created an issue for the mongodb tests #2757

I'll try to allocate time this week.

Cheers

[neilime]

@neilime there have been changes you need to sync. I've already created an issue for the mongodb tests #2757

I'll try to allocate time this week.

Cheers

@david-luna it's done, thank you for checking it.

[david-luna]

This is odd and unrelated to the dependencies we're modifying in this PR. Could you please sync with main and run npm install again?

[neilime]

@david-luna done

[neilime]

@david-luna to be clean I've restarted from main and re-apply needed changes. Now the package-lock.json must be good.

[david-luna]

looks good! Thank you :)

[david-luna]

The only error in CI is the mongodb instrumentation test for nodejs v20.6.0. I'm working on it in #2764

[david-luna]

@neilime I was able to reproduce the test failure in another PR (ref). So I think this one is good to go :)