Skip to content

feat: Add Remix SDK #5231

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

Closed
wants to merge 3 commits into from
Closed

feat: Add Remix SDK #5231

wants to merge 3 commits into from

Conversation

onurtemizkan
Copy link
Collaborator

@onurtemizkan onurtemizkan commented Jun 8, 2022

Ref: #4894

Example project: https://github.com/onurtemizkan/remix-blues-with-sentry

Client side

  • Uses React SDK underneath, and requires <ErrorBoundary /> to properly catch errors.
  • Supports parameterized route paths with remixRouterInstrumentation and withSentryRouteTracing.

Tested:

Server side

  • Uses Node SDK underneath.
  • For tracing, monkey-patches createRequestHandler from @remix-run/server-runtime which apparently is used by all server-side adapters of Remix.
  • action and loader functions are patched as parameters of createRequestHandler.

Tested:

  • Tracing action / loader
  • Tracing requestHandler
  • With Prisma spans
  • Error Tracking

Link to Transaction
Link to Event

TODO

  • Sourcemaps
  • Add README
  • Add docs
  • Increase Test coverage
  • Integration tests

@github-actions
Copy link
Contributor

github-actions bot commented Jun 8, 2022

size-limit report 📦

Path Size
@sentry/browser - ES5 CDN Bundle (gzipped + minified) 19.43 KB (added)
@sentry/browser - ES5 CDN Bundle (minified) 60.21 KB (added)
@sentry/browser - ES6 CDN Bundle (gzipped + minified) 18.24 KB (added)
@sentry/browser - ES6 CDN Bundle (minified) 53.83 KB (added)
@sentry/browser - Webpack (gzipped + minified) 20 KB (added)
@sentry/browser - Webpack (minified) 65.2 KB (added)
@sentry/react - Webpack (gzipped + minified) 20.02 KB (added)
@sentry/nextjs Client - Webpack (gzipped + minified) 43.95 KB (added)
@sentry/browser + @sentry/tracing - ES5 CDN Bundle (gzipped + minified) 25.56 KB (added)
@sentry/browser + @sentry/tracing - ES6 CDN Bundle (gzipped + minified) 24.11 KB (added)

@lforst lforst self-requested a review June 10, 2022 13:44
@AbhiPrasad
Copy link
Member

@onurtemizkan skimmed through the PR and looks great!

I would like us to split this up for ease of review and tracking through GH. Let's open PRs for the following:

  1. Have a PR that just adds the Remix SDK package boilerplate (setups up folder structure) - but has nothing in src/* or test/*
  2. PR that adds client-side support with tests
  3. PR that adds server-side support with tests
  4. Sourcemaps support
  5. PR for README
  6. Integration tests for Remix
  7. PR for sentry-docs

I'm going to update #4894 with these details!

@AbhiPrasad AbhiPrasad added this to the Sentry Remix SDK milestone Jun 14, 2022
@onurtemizkan
Copy link
Collaborator Author

Closing as we published alpha for Remix SDK 🥳 https://www.npmjs.com/package/@sentry/remix

@onurtemizkan onurtemizkan deleted the onur/remix-sdk branch July 4, 2022 09:51
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