Sentry.nativeNodeFetchIntegration fails to import opentelemetry-instrumentation-fetch-node in jest #12225

Activity

1. TheHolyWaffle

   added

   Type: Bug

   on May 27, 2024
2. getsantry

   added

   Waiting for: Product Owner

   on May 27, 2024
3. getsantry

   added this to GitHub Issues with 👀 3on May 27, 2024
4. getsantry

   moved this to Waiting for: Product Owner in GitHub Issues with 👀 3on May 27, 2024
5. github-actions

   added

   Package: node

   on May 27, 2024
6. mydea commented on May 27, 2024

   

   mydea

   on May 27, 2024

   Member

   More actions

   So what is the actual problem here? It seems that this is a problem with the env not supporting lazy loading properly. If this is not loaded in jest it's probably not a problem, or are you actually having a problem because of this in your app? Is this only happening in test env, for example?
7. getsantry

   removed

   Waiting for: Product Owner

   on May 27, 2024
8. getsantry

   moved this from Waiting for: Product Owner to No status in GitHub Issues with 👀 3on May 27, 2024
9. TheHolyWaffle commented on May 27, 2024

   

   TheHolyWaffle

   on May 27, 2024

   Last edited by TheHolyWaffle

   Author

   More actions

   Hi @mydea Apologies if this isn't well defined.

   For more context, I maintain a beforeBreadcrumb function in our company and I'd like to test it's behavior using jest. I leverage sentry-testkit for that but I noticed the breadcrumbs are not coming through anymore when upgrading from v7 to v8.

   The reason it fails is because it fails to load the native node fetch integration during the jest beforeEach. (The stacktrace from above). I'd like to get this functioning again 🙏

   Here's the bigger context:

   import { beforeBreadcrumb } from './before-breadcrumb';
   import * as Sentry from '@sentry/node';
   import sentryTestkit from 'sentry-testkit';
   
   describe('integration test', () => {
       const { testkit, sentryTransport } = sentryTestkit();
       beforeAll(() => {
           Sentry.init({
               dsn: 'https://00000000000000000000000000000000@0000000.ingest.us.sentry.io/0000000',
               transport: sentryTransport,
               beforeBreadcrumb: beforeBreadcrumb,
               integrations: [Sentry.nativeNodeFetchIntegration()],
           });
       });
       beforeEach(() => testkit.reset());
       afterEach(() => Sentry.getCurrentScope().clearBreadcrumbs());
   
       it('should work for native node fetch', async () => {
           await fetch('http://example.com/fetch', {
               headers: {
                   'My-custom-header': 'foo',
                   'My-Custom-Header-2': ['foo', 'bar'],
               },
           });
           Sentry.captureException(new Error('foo'));
           await Sentry.flush();
           expect(testkit.reports()).toHaveLength(1);
           expect(testkit.reports()[0]!.breadcrumbs[0]).toStrictEqual({
               timestamp: expect.any(Number),
               category: 'http',
               data: {
                   'http.method': 'GET',
                   status_code: 200,
                   url: 'http://example.com/fetch',
                   'http.header.My-custom-header': 'foo',
                   'http.header.My-Custom-Header-2': 'foo,bar',
                   'http.header.accept': '*/*',
                   'http.header.accept-language': '*',
                   'http.header.sec-fetch-mode': 'cors',
                   'http.header.user-agent': 'node',
                   'http.header.accept-encoding': expect.any(String),
                   'http.header.sentry-trace': expect.any(String),
                   'http.header.baggage': expect.any(String),
               },
               type: 'http',
           });
       });
   });
10. getsantry

    added

    Waiting for: Product Owner

    on May 27, 2024
11. getsantry

    moved this to Waiting for: Product Owner in GitHub Issues with 👀 3on May 27, 2024
12. mydea commented on May 27, 2024

    

    mydea

    on May 27, 2024

    Member

    More actions

    Ah, OK, I can see the problem now.

    Honestly I don't think there is an easy way to solve this in the SDK side of things 🤔 did you try to follow docs in jest here: https://jestjs.io/docs/ecmascript-modules for this?
13. getsantry

    removed

    Waiting for: Product Owner

    on May 27, 2024
14. getsantry

    moved this from Waiting for: Product Owner to No status in GitHub Issues with 👀 3on May 27, 2024
15. mydea

    changed the title [-]Sentry.nativeNodeFetchIntegration fails to import opentelemetry-instrumentation-fetch-node in cjs[/-] [+]Sentry.nativeNodeFetchIntegration fails to import opentelemetry-instrumentation-fetch-node in jest[/+] on May 27, 2024
16. TheHolyWaffle commented on May 27, 2024

    

    TheHolyWaffle

    on May 27, 2024

    Author

    More actions

    I can run the tests using NODE_OPTIONS=--experimental-vm-modules npx jest which makes it succeed.

    But I'm wondering if this isn't also an issue in other cjs environments (besides Jest) where one might forget to use the --experimental-vm-modules flag?
17. getsantry

    added

    Waiting for: Product Owner

    on May 27, 2024
18. getsantry

    moved this to Waiting for: Product Owner in GitHub Issues with 👀 3on May 27, 2024
19. mydea commented on May 27, 2024

    

    mydea

    on May 27, 2024

    Member

    More actions

    I can run the tests using NODE_OPTIONS=--experimental-vm-modules npx jest which makes it succeed.

    But I'm wondering if this isn't also an issue in other cjs environments (besides Jest) where one might forget to use the --experimental-vm-modules flag?

    So this should work just fine in true cjs apps (we have a bunch of tests covering this, and this is actually what makes this work normally for almost all apps, as the vast majority of apps out there is running in CJS mode as of now). I think it's really just a jest issue which does not properly support all of these things (yet), unfortunately 🤔 See #12137 for tests for this, which all run in CJS.

    It's good to know that this flag fixes it, at least! 🙏

    I would close this issue for now as there really isn't much we can do about this I believe!
20. mydea

    closed this as completedon May 27, 2024
21. getsantry

    removed

    Waiting for: Product Owner

    on May 27, 2024
22. TheHolyWaffle commented on May 27, 2024

    

    TheHolyWaffle

    on May 27, 2024

    Author

    More actions

    I agree, this is jest specific problem and using the vm flag fixes it. I should really spend the time to switch to something like vitest....

    Thanks for spending some time on this anyway 🙏 @mydea

    ❤️React with ❤️1Reacted by Francesco Gringl-Novy