feat(cloudflare): Allow users to pass handler to sentryPagesPlugin by AbhiPrasad · Pull Request #13192 · getsentry/sentry-javascript

AbhiPrasad · 2024-08-02T14:00:00Z

While working on adding the cloudflare sdk to some open source projects, I noticed that setup for the cloudflare plugin was a bit of a hassle when you needed access to environmental variables.

This PR allows users to pass a function to sentryPagesPlugin that looks like so:

handler: (context: EventPluginContext<Env,Params,Data,PluginParams>)=>CloudflareOptions

This means that users can access the cloudflare context (which only exists at the request level) to get environmental variables.

exportconstonRequest=Sentry.sentryPagesPlugin(context=>({dsn: context.env.SENTRY_DSN,tracesSampleRate: 1.0,}));

To make some other use cases easier, this PR also exposes the wrapRequestHandler API to users.

AbhiPrasad · 2024-08-02T14:00:48Z

 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ PluginParams = any,


This is weakening the type, but it's on purpose - constraining the PluginParams to be both an object and function doesn't work really well 😬.

Lms24 · 2024-08-02T16:42:31Z

 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any


l: If one can only access env variables in the function, should we update the JSDoc of this function?

yes for sure, good call

AbhiPrasad · 2024-08-02T14:00:00Z

While working on adding the cloudflare sdk to some open source projects, I noticed that setup for the cloudflare plugin was a bit of a hassle when you needed access to environmental variables.

This PR allows users to pass a function to sentryPagesPlugin that looks like so:

handler: (context: EventPluginContext<Env,Params,Data,PluginParams>)=>CloudflareOptions

This means that users can access the cloudflare context (which only exists at the request level) to get environmental variables.

exportconstonRequest=Sentry.sentryPagesPlugin(context=>({dsn: context.env.SENTRY_DSN,tracesSampleRate: 1.0,}));

To make some other use cases easier, this PR also exposes the wrapRequestHandler API to users.

AbhiPrasad · 2024-08-02T14:00:48Z

 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ PluginParams = any,


This is weakening the type, but it's on purpose - constraining the PluginParams to be both an object and function doesn't work really well 😬.

Lms24 · 2024-08-02T16:42:31Z

 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any


l: If one can only access env variables in the function, should we update the JSDoc of this function?

yes for sure, good call

AbhiPrasad · 2024-08-02T14:00:00Z

While working on adding the cloudflare sdk to some open source projects, I noticed that setup for the cloudflare plugin was a bit of a hassle when you needed access to environmental variables.

This PR allows users to pass a function to sentryPagesPlugin that looks like so:

handler: (context: EventPluginContext<Env,Params,Data,PluginParams>)=>CloudflareOptions

This means that users can access the cloudflare context (which only exists at the request level) to get environmental variables.

exportconstonRequest=Sentry.sentryPagesPlugin(context=>({dsn: context.env.SENTRY_DSN,tracesSampleRate: 1.0,}));

To make some other use cases easier, this PR also exposes the wrapRequestHandler API to users.

AbhiPrasad · 2024-08-02T14:00:48Z

 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ PluginParams = any,


This is weakening the type, but it's on purpose - constraining the PluginParams to be both an object and function doesn't work really well 😬.

Lms24 · 2024-08-02T16:42:31Z

 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any


l: If one can only access env variables in the function, should we update the JSDoc of this function?

yes for sure, good call

AbhiPrasad · 2024-08-02T14:00:00Z

While working on adding the cloudflare sdk to some open source projects, I noticed that setup for the cloudflare plugin was a bit of a hassle when you needed access to environmental variables.

This PR allows users to pass a function to sentryPagesPlugin that looks like so:

handler: (context: EventPluginContext<Env,Params,Data,PluginParams>)=>CloudflareOptions

This means that users can access the cloudflare context (which only exists at the request level) to get environmental variables.

exportconstonRequest=Sentry.sentryPagesPlugin(context=>({dsn: context.env.SENTRY_DSN,tracesSampleRate: 1.0,}));

To make some other use cases easier, this PR also exposes the wrapRequestHandler API to users.

AbhiPrasad · 2024-08-02T14:00:48Z

 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ PluginParams = any,


This is weakening the type, but it's on purpose - constraining the PluginParams to be both an object and function doesn't work really well 😬.

Lms24 · 2024-08-02T16:42:31Z

 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any


l: If one can only access env variables in the function, should we update the JSDoc of this function?

yes for sure, good call

AbhiPrasad · 2024-08-02T14:00:00Z

While working on adding the cloudflare sdk to some open source projects, I noticed that setup for the cloudflare plugin was a bit of a hassle when you needed access to environmental variables.

This PR allows users to pass a function to sentryPagesPlugin that looks like so:

handler: (context: EventPluginContext<Env,Params,Data,PluginParams>)=>CloudflareOptions

This means that users can access the cloudflare context (which only exists at the request level) to get environmental variables.

exportconstonRequest=Sentry.sentryPagesPlugin(context=>({dsn: context.env.SENTRY_DSN,tracesSampleRate: 1.0,}));

To make some other use cases easier, this PR also exposes the wrapRequestHandler API to users.

AbhiPrasad · 2024-08-02T14:00:48Z

 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ PluginParams = any,


This is weakening the type, but it's on purpose - constraining the PluginParams to be both an object and function doesn't work really well 😬.

Lms24 · 2024-08-02T16:42:31Z

 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any


l: If one can only access env variables in the function, should we update the JSDoc of this function?

yes for sure, good call

AbhiPrasad · 2024-08-02T14:00:00Z

While working on adding the cloudflare sdk to some open source projects, I noticed that setup for the cloudflare plugin was a bit of a hassle when you needed access to environmental variables.

This PR allows users to pass a function to sentryPagesPlugin that looks like so:

handler: (context: EventPluginContext<Env,Params,Data,PluginParams>)=>CloudflareOptions

This means that users can access the cloudflare context (which only exists at the request level) to get environmental variables.

exportconstonRequest=Sentry.sentryPagesPlugin(context=>({dsn: context.env.SENTRY_DSN,tracesSampleRate: 1.0,}));

To make some other use cases easier, this PR also exposes the wrapRequestHandler API to users.

AbhiPrasad · 2024-08-02T14:00:48Z

 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ PluginParams = any,


This is weakening the type, but it's on purpose - constraining the PluginParams to be both an object and function doesn't work really well 😬.

Lms24 · 2024-08-02T16:42:31Z

 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any


l: If one can only access env variables in the function, should we update the JSDoc of this function?

yes for sure, good call

AbhiPrasad · 2024-08-02T14:00:00Z

While working on adding the cloudflare sdk to some open source projects, I noticed that setup for the cloudflare plugin was a bit of a hassle when you needed access to environmental variables.

This PR allows users to pass a function to sentryPagesPlugin that looks like so:

handler: (context: EventPluginContext<Env,Params,Data,PluginParams>)=>CloudflareOptions

This means that users can access the cloudflare context (which only exists at the request level) to get environmental variables.

exportconstonRequest=Sentry.sentryPagesPlugin(context=>({dsn: context.env.SENTRY_DSN,tracesSampleRate: 1.0,}));

To make some other use cases easier, this PR also exposes the wrapRequestHandler API to users.

AbhiPrasad · 2024-08-02T14:00:48Z

 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ PluginParams = any,


This is weakening the type, but it's on purpose - constraining the PluginParams to be both an object and function doesn't work really well 😬.

Lms24 · 2024-08-02T16:42:31Z

 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any


l: If one can only access env variables in the function, should we update the JSDoc of this function?

yes for sure, good call

AbhiPrasad · 2024-08-02T14:00:00Z

While working on adding the cloudflare sdk to some open source projects, I noticed that setup for the cloudflare plugin was a bit of a hassle when you needed access to environmental variables.

This PR allows users to pass a function to sentryPagesPlugin that looks like so:

handler: (context: EventPluginContext<Env,Params,Data,PluginParams>)=>CloudflareOptions

This means that users can access the cloudflare context (which only exists at the request level) to get environmental variables.

exportconstonRequest=Sentry.sentryPagesPlugin(context=>({dsn: context.env.SENTRY_DSN,tracesSampleRate: 1.0,}));

To make some other use cases easier, this PR also exposes the wrapRequestHandler API to users.

AbhiPrasad · 2024-08-02T14:00:48Z

 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ PluginParams = any,


This is weakening the type, but it's on purpose - constraining the PluginParams to be both an object and function doesn't work really well 😬.

Lms24 · 2024-08-02T16:42:31Z

 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
->(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any


l: If one can only access env variables in the function, should we update the JSDoc of this function?

yes for sure, good call

AbhiPrasad requested a review from a teamAugust 2, 2024 14:00

AbhiPrasad self-assigned this Aug 2, 2024

AbhiPrasad requested review from Lms24 and nicohrubec and removed request for a teamAugust 2, 2024 14:00

AbhiPrasad commented Aug 2, 2024
View reviewed changes

Lms24 approved these changes Aug 2, 2024
View reviewed changes

AbhiPrasad added 3 commits August 2, 2024 14:27

feat(cloudflare): Allow users to pass handler to sentryPagesPlugin
4074413

add request handler logic
200939e

add comment to pages plugin
cbe6d17

AbhiPrasad force-pushed the abhi-cloudflare-types-fix branch from 307d7ef to cbe6d17Compare August 2, 2024 18:38

AbhiPrasad added the Package: cloudflare label Aug 2, 2024

AbhiPrasad enabled auto-merge (squash) August 2, 2024 19:16

AbhiPrasad merged commit 07a30e5 into developAug 2, 2024

AbhiPrasad deleted the abhi-cloudflare-types-fix branch August 2, 2024 19:18

q1blue mentioned this pull request Aug 27, 2024
[Snyk] Upgrade @sentry/react from 7.16.0 to 8.23.0 https-quantumblockchainai-atlassian-net/ossinsight#820
Open

gokulk16 mentioned this pull request Aug 27, 2024
[Snyk] Upgrade @sentry/browser from 8.20.0 to 8.23.0 gokulk16/type-to-calculate-web#35
Closed

voidedstarlight mentioned this pull request Aug 27, 2024
[Snyk] Upgrade @sentry/browser from 8.22.0 to 8.23.0 climatechangeinformation-org/website#195
Closed

This was referenced Aug 27, 2024
[Snyk] Upgrade @sentry/nextjs from 8.22.0 to 8.23.0 dupipcom/hypnos#52
Open
[Snyk] Upgrade @sentry/nextjs from 8.20.0 to 8.23.0 dupipcom/hygieia#1
Merged

sleidig mentioned this pull request Aug 27, 2024
[Snyk] Upgrade @sentry/node from 8.22.0 to 8.23.0 Aam-Digital/account-backend#39
Closed

tomwwinter mentioned this pull request Aug 27, 2024
[Snyk] Upgrade @sentry/angular from 8.20.0 to 8.23.0 Aam-Digital/ndb-core#2537
Closed

aam-digital-ci mentioned this pull request Aug 27, 2024
[Snyk] Upgrade @sentry/node from 8.22.0 to 8.23.0 Aam-Digital/replication-backend#152
Closed

chaitanyapotti mentioned this pull request Aug 27, 2024
[Snyk] Upgrade @sentry/types from 8.23.0 to 8.24.0 torusresearch/CustomAuth#351
Open

gokulk16 mentioned this pull request Aug 28, 2024
[Snyk] Upgrade @sentry/browser from 8.20.0 to 8.24.0 gokulk16/type-to-calculate-web#36
Closed

This was referenced Aug 28, 2024
[Snyk] Upgrade @sentry/nextjs from 8.20.0 to 8.24.0 dupipcom/hygieia#3
Open
[Snyk] Upgrade @sentry/nextjs from 8.22.0 to 8.24.0 dupipcom/hypnos#53
Open

q1blue mentioned this pull request Aug 28, 2024
[Snyk] Upgrade @sentry/react from 7.16.0 to 8.24.0 https-quantumblockchainai-atlassian-net/ossinsight#833
Open

This was referenced Aug 29, 2024
[Snyk] Upgrade @sentry/nextjs from 8.22.0 to 8.24.0 dupipcom/hypnos#54
Open
[Snyk] Upgrade @sentry/nextjs from 8.20.0 to 8.24.0 dupipcom/hygieia#4
Open

sleidig mentioned this pull request Aug 29, 2024
[Snyk] Upgrade @sentry/node from 8.22.0 to 8.24.0 Aam-Digital/account-backend#40
Closed

gokulk16 mentioned this pull request Aug 30, 2024
[Snyk] Upgrade @sentry/browser from 8.20.0 to 8.25.0 gokulk16/type-to-calculate-web#38
Merged

This was referenced Aug 30, 2024
[Snyk] Upgrade @sentry/nextjs from 8.22.0 to 8.25.0 dupipcom/hypnos#55
Open
[Snyk] Upgrade @sentry/nextjs from 8.20.0 to 8.25.0 dupipcom/hygieia#5
Open

This was referenced Aug 30, 2024
[Snyk] Upgrade @sentry/node from 8.22.0 to 8.25.0 Aam-Digital/replication-backend#154
Closed
[Snyk] Upgrade @sentry/node from 8.22.0 to 8.25.0 Aam-Digital/account-backend#41
Closed

q1blue mentioned this pull request Aug 30, 2024
[Snyk] Upgrade @sentry/react from 7.16.0 to 8.25.0 https-quantumblockchainai-atlassian-net/ossinsight#835
Open

angeloreale mentioned this pull request Aug 31, 2024
[Snyk] Upgrade @sentry/nextjs from 8.22.0 to 8.25.0 dupipcom/hypnos#60
Open

FengShangWuQi mentioned this pull request Sep 1, 2024
[Snyk] Upgrade @sentry/gatsby from 7.20.0 to 8.25.0 FengShangWuQi/fengshangwuqi.github.io#1918
Closed

PierreGode mentioned this pull request Sep 4, 2024
[Snyk] Upgrade @sentry/node from 8.9.2 to 8.25.0 PierreGode/shields#1
Closed

This was referenced Sep 4, 2024
[Snyk] Upgrade @sentry/node from 8.22.0 to 8.26.0 Aam-Digital/account-backend#42
Closed
[Snyk] Upgrade @sentry/node from 8.22.0 to 8.26.0 Aam-Digital/replication-backend#158
Closed

q1blue mentioned this pull request Sep 7, 2024
[Snyk] Upgrade @sentry/react from 7.16.0 to 8.26.0 https-quantumblockchainai-atlassian-net/ossinsight#846
Open

FengShangWuQi mentioned this pull request Sep 8, 2024
[Snyk] Upgrade @sentry/gatsby from 7.20.0 to 8.26.0 FengShangWuQi/fengshangwuqi.github.io#1919
Closed

bagulm123 mentioned this pull request Sep 8, 2024
[Snyk] Upgrade: , , chart.js, classnames, cytoscape, typescript bagulm123/komiser#18
Open

KeeghanM mentioned this pull request Sep 12, 2024
[Snyk] Upgrade: , , , , , , next, posthog-js, posthog-node, react-chessboard, stripe KeeghanM/chess-training-app#94
Merged

This was referenced Sep 13, 2024
[Snyk] Upgrade: , , chart.js, classnames, cytoscape, next, typescript bagulm123/komiser#19
Open
[Snyk] Upgrade: , , , chart.js, classnames, cytoscape, next, typescript bagulm123/komiser#20
Open