Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cloudflare): Add plugin for cloudflare pages #13123

Merged
merged 1 commit into from
Jul 31, 2024

Conversation

AbhiPrasad
Copy link
Member

@AbhiPrasad AbhiPrasad commented Jul 30, 2024

ref #12620

Before reviewing this PR, I recommend reading through a GH discussion I wrote up that explains the reasoning behind the API surface of the cloudflare SDK: #13007

The PR that adds Cloudflare Workers support is also helpful context: #13025

This PR adds support for Cloudflare Pages, Cloudflare's fullstack development deployment platform that is powered by Cloudflare Workers under the hood. Think of this platform having very similar capabilities (and constraints) as Vercel.

To set the plugin up, you do something like so:

// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
  dsn: process.env.SENTRY_DSN,
  tracesSampleRate: 1.0,
});

We have to use the middleware instead of a global init because we need to call init for every single new incoming request to make sure the sentry instance does not get stale with redeployments.

While implementing sentryPagesPlugin, I noticed that there was a logic that was redundant between it and withSentry, the API for cloudflare workers.

This led me to refactor this into a common helper, wrapRequestHandler, which is contained in packages/cloudflare/src/request.ts. That is why there is diffs in this PR for packages/cloudflare/src/handler.ts.

image

@AbhiPrasad AbhiPrasad requested a review from a team July 30, 2024 21:12
@AbhiPrasad AbhiPrasad self-assigned this Jul 30, 2024
@AbhiPrasad AbhiPrasad requested review from lforst, s1gr1d and andreiborza and removed request for a team July 30, 2024 21:12
@AbhiPrasad AbhiPrasad force-pushed the abhi-cloudflare-pages-plugin branch 2 times, most recently from a793bd5 to 0499776 Compare July 30, 2024 21:24
@AbhiPrasad
Copy link
Member Author

Note: sourcemaps for pages don't work very well, and I'm not sure why.

image

digging into it further, but hopefully the answer is easy. Regardless that should not block this PR.

Copy link
Member

@s1gr1d s1gr1d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

Comment on lines 5 to 24
/**
*
* @param _options
* @returns
*/
export function sentryPagesPlugin<
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

L: You could add some docs here :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, thank you!

@AbhiPrasad AbhiPrasad force-pushed the abhi-cloudflare-pages-plugin branch from 0499776 to c7ac38c Compare July 31, 2024 12:56
Copy link
Contributor

size-limit report 📦

Path Size
@sentry/browser 22.45 KB (0%)
@sentry/browser (incl. Tracing) 34.22 KB (0%)
@sentry/browser (incl. Tracing, Replay) 70.28 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 63.62 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas) 74.68 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback) 87.26 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics) 89.11 KB (0%)
@sentry/browser (incl. metrics) 26.75 KB (0%)
@sentry/browser (incl. Feedback) 39.37 KB (0%)
@sentry/browser (incl. sendFeedback) 27.06 KB (0%)
@sentry/browser (incl. FeedbackAsync) 31.7 KB (0%)
@sentry/react 25.22 KB (0%)
@sentry/react (incl. Tracing) 37.22 KB (0%)
@sentry/vue 26.6 KB (0%)
@sentry/vue (incl. Tracing) 36.06 KB (0%)
@sentry/svelte 22.58 KB (0%)
CDN Bundle 23.64 KB (0%)
CDN Bundle (incl. Tracing) 35.88 KB (0%)
CDN Bundle (incl. Tracing, Replay) 70.31 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) 75.57 KB (0%)
CDN Bundle - uncompressed 69.37 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed 106.31 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed 218.16 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 230.99 KB (0%)
@sentry/nextjs (client) 37.07 KB (-0.04% 🔽)
@sentry/sveltekit (client) 34.79 KB (-0.06% 🔽)
@sentry/node 114.65 KB (+0.09% 🔺)
@sentry/node - without tracing 89.33 KB (0%)
@sentry/aws-serverless 98.5 KB (0%)

@AbhiPrasad AbhiPrasad merged commit 945cdbc into develop Jul 31, 2024
128 checks passed
@AbhiPrasad AbhiPrasad deleted the abhi-cloudflare-pages-plugin branch July 31, 2024 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants