Support different JS runtimes #5611

AbhiPrasad · 2022-08-19T14:53:33Z

Problem Statement

The Sentry SDK should work with WinterCG-compatible runtimes other than NodeJS. We should build new SDKs for these platforms, or figure out how to adapt our Node SDK to fit them.

The spec: https://github.com/wintercg/proposal-common-minimum-api

Cloudflare Workers: cloudflare workers support #2484
Deno: Support for Deno server #3009
Vercel Edge Runtime: Vercel Edge Runtime SDK #8087
Next.js middleware support #4206
Netlify Edge Functions - Apparently based on Deno
Fastly Compute@Edge
AWS LLRT
WinterJS

There are also other JS runtimes we can take a look at:

Bun: Support for Bun #7979

Solution Brainstorm

If you are interested in this, please comment on the individual issues linked above!

timfish · 2022-09-16T19:27:27Z

The first step in supporting other runtimes is getting core, hub, types and utils compiling without dom/node types:

- Move @sentry/hub code to @sentry/core and keep @sentry/hub as a stub re-exporting types from core so it's not a breaking change
- ref(hub): Move @sentry/hub code to @sentry/core #5823
- getGlobalObject should be replaced with something more universal like this from core-js. globalThis is the global in WinterCG and browsers/node have supported it for a while too
- Remove DOM and node TypeScript lib types from packages that shouldn't be using them
- Node types can be used in any package #5834
- ref(typescript): Remove DOM from default lib types #5816

At this point, core, hub and types are compiling without DOM/node lib types.

However, utils still requires DOM and node lib types to build successfully.

To rectify this, all runtime specific code should be moved to the runtime packages:

- Move all browser specific code from @sentry/utils to @sentry/browser/utils
- - Move supportsErrorEvent, supportsDOMError, supportsDOMException, supportsFetch, supportsNativeFetch, supportsReferrerPolicy and supportsHistory to @sentry/browser
- - Move some functions (like getLocationHref and getDomElement) from browser.ts to @sentry/browser
- - Move everything in instrument.ts to @sentry/browser
  - ❌ This is an issue due to addInstrumentationHandler usage in tracing
- Move all node specific code from @sentry/utils to @sentry/node
- - Move everything in node.ts to @sentry/node
  - ❌ Moving dynamicRequire is an issue since it's used in tracing

The above can done without technically making breaking changes since we make no guarantees about @sentry/utils, but it will impact downstream SDKs that make use of some of the moved functions.

The major downside to moving these utilities to the browser/node packages and exporting them at the root is that they would become public API methods (for downstream SDKs to use) and with that comes stability guarantees.

It would be less of a maintenance headache to either:

Move them to new packages (like @sentry/browser-utils) or package export (@sentry/browser/utils)
Wrap them in an internal object export that we make no stability promises about

`@sentry/tracing`

There are a few issues above where @sentry/tracing relies on code from @sentry/utils which will get moved to browser/node. This will result in tracing depending on both browser/node. This can further be fixed by splitting the tracing code #5815.

- Replaces `getGlobalObject` global object detection with a modern implementation taken from `core-js` which is then modified/simplified a little - Prioritises `globalThis` which was previously removed due to requiring a TypeScript version which was required in a no longer supported version of Angular (#2978) - This is a requirement for future support of other js runtimes (#5611) - No longer uses `isNodeEnv` 🎉 - Caches the global so it doesn't need to be evaluated for every invocation of `getGlobalObject`

lforst · 2022-09-26T14:53:37Z

How about having these as named exports? @sentry/tracing, @sentry/tracing/browser and @sentry/tracing/node?

Shouldn't it be @sentry/browser/tracing instead of @sentry/tracing/browser? So we can depend on @sentry/browser from within @sentry/browser/tracing. Maning the tracing submodule in @sentry/browser is just an extension of @sentry/browser. (I worded that kinda confusing but I think it gets the point across).

Also, I'd just have all tracing functionality in @sentry/node by default, so there wouldn't be any need for @sentry/node/tracing.

timfish · 2022-09-26T15:50:52Z

Yep, I need to update the above ramblings.

There's a more recent issue for the tracing changes.

Also, I'd just have all tracing functionality in @sentry/node by default, so there wouldn't be any need for @sentry/node/tracing.

Would we want to add all the hub extensions by default too?

We wouldn't want to run _autoloadDatabaseIntegrations in the Electron SDK because it hits app startup time significantly!

lforst · 2022-09-26T16:29:06Z

Continued thread over in more recent issue here: #5815 (comment)

AbhiPrasad · 2022-10-07T14:53:43Z

We had a discussion internally about the global object changes - @timfish could we look into if we can just use globalThis?

timfish · 2022-10-07T15:01:41Z

could we look into if we can just use globalThis?

Eventually, but we'll need to wait for Node.js v12 to be our MSV.

And the Sentry supported browsers suggests we need to support Android 4.4 and IE10/11 so these would need to be polyfilled.

That means we can probably remove the window and self lines from this:

sentry-javascript/packages/utils/src/global.ts

Lines 56 to 65 in 8570f0d

    
           const GLOBAL = 
        
             (typeof globalThis == 'object' && isGlobalObj(globalThis)) || 
        
             // eslint-disable-next-line no-restricted-globals 
        
             (typeof window == 'object' && isGlobalObj(window)) || 
        
             (typeof self == 'object' && isGlobalObj(self)) || 
        
             (typeof global == 'object' && isGlobalObj(global)) || 
        
             (function (this: any) { 
        
               return this; 
        
             })() || 
        
             {};

lobsterkatie · 2022-10-07T17:29:30Z

LOL

Looks like we haven't updated this page in quite a long time. (EDIT: Heh. Turns out July-me already discovered that: getsentry/sentry-docs#5351)

I can say for sure we don't need to worry about Android 4.4. I did a quick google, and the first version which can handle, for example, object spread is Android 8. For IE11, we've already told people that they have to use one of our ES5 bundles, to which we could add a polyfill if necessary. But the Node 10 business is definitely a bigger blocker. I like your idea of at least removing the browser-specific parts.

AbhiPrasad · 2022-10-13T07:18:58Z

We merged in #5831, could we rebase the rest of the PRs @timfish?

pbteja1998 · 2022-10-19T20:38:13Z

I’m using Remix with Cloudflare Workers. It would be great if there is support for this.

There is this package that everyone uses when using Cloudflare Workers, it might be a good starting point to start work on Cloudflare Workers runtime.
https://github.com/robertcepa/toucan-js

huw · 2023-02-18T04:58:58Z

I realised I didn’t post cross-post here last time—I have a pretty hacky solution for Cloudflare Workers with Toucan.

KrisBraun · 2023-05-07T02:43:07Z

🤞 for Cloudflare Pages support, which should be nearly identical to Cloudflare Workers, just with different handlers.

lforst · 2023-05-08T07:53:07Z

@KrisBraun Gonna happen soon™ 👀

huw · 2023-07-31T18:40:05Z

I’ve updated my Cloudflare Workers Gist for Toucan v3.2.0 and Remix v2. It’s a lot more complicated & hacky now thanks to Remix v2, but still very possible. Please reply there if you have any questions :)

Now we've dropped Nove v12 we can simplify to `globalThis`: #5611 (comment)

Now we've dropped Nove v12 we can simplify to `globalThis`: getsentry#5611 (comment)

AbhiPrasad · 2024-08-02T22:58:32Z

With @sentry/cloudflare being available in 8.22.0 and us having SDKs for @sentry/vercel-edge, @sentry/bun, @sentry/deno + exposing a bunch of APIs via @sentry/core, I think we can close this issue - we support every major non-node runtime, and we have all the building blocks via generic JS APIs in the SDKs for you to support any custom runtime you wish.

The one's left on the list are:

but right now these are not high priority for us. We'll tackle them slowly over the next couple quarters (PRs are always welcome though!)

AbhiPrasad added Type: Improvement Status: Backlog labels Aug 19, 2022

AbhiPrasad mentioned this issue Aug 31, 2022

TypeError: Cannot read properties of undefined (reading 'getElementById') #5667

Closed

3 tasks

This comment was marked as outdated.

Sign in to view

timfish mentioned this issue Sep 23, 2022

feat(utils): Modern implementation of getGlobalObject #5809

Merged

AbhiPrasad assigned timfish Sep 23, 2022

timfish mentioned this issue Sep 26, 2022

ref(tracing): Split @sentry/tracing into runtime specific packages #5815

Closed

AbhiPrasad mentioned this issue Sep 26, 2022

[v8] Remove @sentry/hub package #5665

Closed

AbhiPrasad added this to the JS Multiple Runtime Support milestone Sep 26, 2022

timfish mentioned this issue Sep 26, 2022

ref(typescript): Remove DOM from default lib types #5816

Closed

AbhiPrasad changed the title ~~Support different JS runtimes~~ WinterCG - Support different JS runtimes Oct 5, 2022

timfish mentioned this issue Oct 7, 2022

ref(utils): window and self are no longer required for global object detection? #5913

Closed

timfish mentioned this issue Oct 11, 2022

ref(browser): Remove XHR transport from default bundle #5927

Closed

AbhiPrasad mentioned this issue Oct 13, 2022

ref(utils): Deprecate getGlobalObject as it's no longer used #5949

Merged

vladanpaunovic unassigned timfish Oct 14, 2022

This was referenced Oct 17, 2022

fix(utils): Rename global.ts -> worldwide.ts #5969

Merged

cloudflare workers support #2484

Closed

Lms24 mentioned this issue Jan 5, 2023

[docs] add @sentry/svelte import for clarity sveltejs/kit#8343

Merged

Lms24 changed the title ~~WinterCG - Support different JS runtimes~~ Support different JS runtimes Jan 9, 2023

Lms24 mentioned this issue Jan 10, 2023

SvelteKit SDK Roadmap #6692

Closed

AbhiPrasad mentioned this issue Apr 17, 2023

Not working with Bun getsentry/sentry#47445

Closed

krutoo mentioned this issue Apr 19, 2023

Исследовать возможность использования в среде отличной от Node.js sima-land/isomorph#38

Open

github-actions bot added the Waiting for: Team label May 7, 2023

github-actions bot removed the Waiting for: Team label May 8, 2023

hubertdeng123 removed the Status: Backlog label Jul 26, 2023

getsantry bot added the Waiting for: Product Owner label Jul 31, 2023

getsantry bot added this to GitHub Issues with 👀 Jul 31, 2023

getsantry bot moved this to Waiting for: Product Owner in GitHub Issues with 👀 Jul 31, 2023

Lms24 removed the Waiting for: Product Owner label Aug 3, 2023

getsantry bot removed the status in GitHub Issues with 👀 Aug 3, 2023

AbhiPrasad mentioned this issue Sep 18, 2023

Initial Support for Bun JS Runtime #9042

Closed

Lms24 mentioned this issue Mar 21, 2024

[Metrics] Support cloudflare workers #11220

Closed

timfish mentioned this issue Mar 29, 2024

feat(utils): Use globalThis #11351

Merged

AbhiPrasad pushed a commit that referenced this issue Apr 2, 2024

feat(utils): Use globalThis (#11351)

ed4a751

Now we've dropped Nove v12 we can simplify to `globalThis`: #5611 (comment)

cadesalaberry pushed a commit to cadesalaberry/sentry-javascript that referenced this issue Apr 19, 2024

feat(utils): Use globalThis (getsentry#11351)

9259c01

Now we've dropped Nove v12 we can simplify to `globalThis`: getsentry#5611 (comment)

AbhiPrasad mentioned this issue Jun 24, 2024

Sentry Cloudflare Workers SDK #12620

Closed

AbhiPrasad closed this as completed Aug 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support different JS runtimes #5611

Support different JS runtimes #5611

AbhiPrasad commented Aug 19, 2022 •

edited

Loading

This comment was marked as outdated.

timfish commented Sep 16, 2022 •

edited by AbhiPrasad

Loading

lforst commented Sep 26, 2022

timfish commented Sep 26, 2022 •

edited

Loading

lforst commented Sep 26, 2022

AbhiPrasad commented Oct 7, 2022

timfish commented Oct 7, 2022 •

edited

Loading

lobsterkatie commented Oct 7, 2022

AbhiPrasad commented Oct 13, 2022

pbteja1998 commented Oct 19, 2022

huw commented Feb 18, 2023

KrisBraun commented May 7, 2023

lforst commented May 8, 2023

huw commented Jul 31, 2023 •

edited

Loading

AbhiPrasad commented Aug 2, 2024

Support different JS runtimes #5611

Support different JS runtimes #5611

Comments

AbhiPrasad commented Aug 19, 2022 • edited Loading

Problem Statement

Solution Brainstorm

This comment was marked as outdated.

timfish commented Sep 16, 2022 • edited by AbhiPrasad Loading

@sentry/tracing

lforst commented Sep 26, 2022

timfish commented Sep 26, 2022 • edited Loading

lforst commented Sep 26, 2022

AbhiPrasad commented Oct 7, 2022

timfish commented Oct 7, 2022 • edited Loading

lobsterkatie commented Oct 7, 2022

AbhiPrasad commented Oct 13, 2022

pbteja1998 commented Oct 19, 2022

huw commented Feb 18, 2023

KrisBraun commented May 7, 2023

lforst commented May 8, 2023

huw commented Jul 31, 2023 • edited Loading

AbhiPrasad commented Aug 2, 2024

AbhiPrasad commented Aug 19, 2022 •

edited

Loading

timfish commented Sep 16, 2022 •

edited by AbhiPrasad

Loading

`@sentry/tracing`

timfish commented Sep 26, 2022 •

edited

Loading

timfish commented Oct 7, 2022 •

edited

Loading

huw commented Jul 31, 2023 •

edited

Loading