feat: Add @sentry/gatsby #2652

dcramer · 2020-06-05T20:52:56Z

No description provided.

dcramer · 2020-06-05T20:53:30Z

Still confirming this all works as expected via some other projects. I'd love to get automated tests in here, but I'm not entirely sure how without a huge boilerplate project (which may not be what we want). I also didn't test Netlify, and just based it on their docs.

dcramer · 2020-06-05T20:56:43Z

If ya'll have any initial feedback on project layout/core stuff let me know. I based it on apm/react, and I'm not sure if I can remove any of the stuff from package.json.

dcramer · 2020-06-05T21:04:44Z

Cool looks like this pattern works

packages/gatsby/src/gatsby-browser.js

packages/gatsby/src/gatsby-node.js

scefali · 2020-06-05T21:54:51Z

packages/gatsby/src/gatsby-node.js

+            process.env.ZEIT_BITBUCKET_COMMIT_SHA ||
+            '',
+        ),
+        __SENTRY_DSN__: JSON.stringify(process.env.SENTRY_DSN || ''),


@dcramer I hope this doesn't pick the wrong DSN with a Vercel project. They have some hack in the next JS Sentry example because I presume they have an internal DSN for Sentry that conflicts: https://github.com/vercel/next.js/blob/canary/examples/with-sentry-simple/next.config.js#L8

HazAT

This should go in the index.ts file

export * from '@sentry/react';

I am not sure how Gatsby works but in theory, users would be able to use the profiler component + ErrorBoundary of our react package.

cc @AbhiPrasad

Otherwise, nice 👍

HazAT · 2020-06-08T06:32:55Z

packages/gatsby/package.json

+    "@sentry/browser": "5.16.1",
+    "@sentry/types": "5.16.1"


Suggested change

"@sentry/browser": "5.16.1",

"@sentry/types": "5.16.1"

"@sentry/apm": "5.16.1",

"@sentry/react": "5.16.1",

"@sentry/types": "5.16.1"

Missing reference to @sentry/apm

Also, shouldn't we be able to have @sentry/react as a base (vs. @sentry/browser)?

Yes @sentry/react can be used wherever @sentry/browser is used, the react package is a superset of the browser package (https://github.com/getsentry/sentry-javascript/blob/master/packages/react/src/index.ts#L1).

Also, we shouldn't need @sentry/types right? Right now the gatsby exported files don't use TS at all, so a user can just install @sentry/types manually if they want types.

It probably also makes sense then to makes docs changes + announcement of @sentry/react and @sentry/gatsby at the same time.

Yep, we can officially publish them at the same time.

sentry/react makes sense - though theres a possibility in the future it could make sense to inject sentry during compilation which is node.js. ks there actually anything I need to change in that case?

We can just require("@sentry/node") in gatsby-node.js right? Don't think it should change what we have right now.

👍 yeah wasn't sure

AbhiPrasad · 2020-06-08T11:07:34Z

packages/gatsby/package.json

+    "@sentry/types": "5.16.1"
+  },
+  "peerDependencies": {
+    "gatsby": "*"


This config will work for all gatsby versions?

I dont know what versions itll work for, and I don't really want to dig through Gatsby history to figure out when specific APIs were created/etc.

packages/gatsby/package.json

AbhiPrasad · 2020-06-08T11:14:08Z

packages/gatsby/src/gatsby-node.js

+            process.env.ZEIT_GITHUB_COMMIT_SHA ||
+            process.env.ZEIT_GITLAB_COMMIT_SHA ||
+            process.env.ZEIT_BITBUCKET_COMMIT_SHA ||
+            '',


Is there no way for us to make this a user set option without relying on environmental variables? Can we provide some kind of pluginOptions like they can with onClientEntry and pluginParams?

this is still able to be overwritten from pluginOptions, but we should not make a user set anything unless they absolutely have to. frictionless has always been the goal.

packages/gatsby/package.json

dcramer · 2020-06-09T22:14:55Z

what else do we need here to get this merged?

AbhiPrasad

We bumped to 5.17.0 so we will need to use that.

AbhiPrasad · 2020-06-09T22:39:40Z

packages/gatsby/package.json

+    "access": "public"
+  },
+  "dependencies": {
+    "@sentry/browser": "5.16.1",


Suggested change

"@sentry/browser": "5.16.1",

"@sentry/react": "5.17.0",

AbhiPrasad · 2020-06-09T22:39:51Z

packages/gatsby/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@sentry/gatsby",
+  "version": "5.16.1",


Suggested change

"version": "5.16.1",

"version": "5.17.0",

ditto wherever 5.16.1 is used

dcramer · 2020-06-09T22:46:36Z

Any reason we dont just use 0.0.0 in package.json and automatically change them in releases?

HazAT

Forgot this, we need to extend from the react package then we are golden.

packages/gatsby/package.json

packages/gatsby/src/gatsby-browser.js

dcramer · 2020-06-10T17:10:19Z

I'm going to add a baseline of module level export tests ("does it export react helpers"), if nothing else so we have a functional test suite

dcramer · 2020-06-10T17:29:45Z

I couldn't get tests passing locally.. @sentry/react (based on this import) wasn't exporting some of the things that it clearly exports in its index.ts file. That means its either broken (I doubt that), or I have no idea what I'm doing :)

Hopefully passes in CI!

getsentry-bot · 2020-06-10T17:34:14Z

	Messages
📖	@sentry/browser bundle gzip'ed minified size: (ES5: 17.083 kB) (ES6: 16.1533 kB)
📖	✅ TSLint passed

Generated by 🚫 dangerJS against a146fdc

dcramer force-pushed the feat/gatsby branch from cab0286 to f1af389 Compare June 5, 2020 20:54

dcramer force-pushed the feat/gatsby branch 2 times, most recently from 5b133db to 756812d Compare June 5, 2020 20:58

dcramer marked this pull request as ready for review June 5, 2020 21:04

dcramer requested a review from kamilogorek as a code owner June 5, 2020 21:04

scefali reviewed Jun 5, 2020

View reviewed changes

packages/gatsby/src/gatsby-browser.js Show resolved Hide resolved

scefali reviewed Jun 5, 2020

View reviewed changes

packages/gatsby/src/gatsby-node.js Show resolved Hide resolved

scefali reviewed Jun 5, 2020

View reviewed changes

packages/gatsby/src/gatsby-node.js Show resolved Hide resolved

dcramer force-pushed the feat/gatsby branch from 756812d to b764dbb Compare June 5, 2020 21:44

scefali reviewed Jun 5, 2020

View reviewed changes

HazAT requested changes Jun 8, 2020

View reviewed changes

AbhiPrasad reviewed Jun 8, 2020

View reviewed changes

dcramer force-pushed the feat/gatsby branch 2 times, most recently from e4141ae to 1ae8b14 Compare June 8, 2020 15:38

AbhiPrasad approved these changes Jun 9, 2020

View reviewed changes

dcramer force-pushed the feat/gatsby branch from 1ae8b14 to 7551ede Compare June 9, 2020 22:48

dcramer requested a review from HazAT June 9, 2020 23:31

HazAT approved these changes Jun 10, 2020

View reviewed changes

HazAT requested changes Jun 10, 2020

View reviewed changes

packages/gatsby/package.json Outdated Show resolved Hide resolved

packages/gatsby/src/gatsby-browser.js Outdated Show resolved Hide resolved

dcramer force-pushed the feat/gatsby branch from 7551ede to fa55b23 Compare June 10, 2020 15:14

dcramer requested a review from HazAT June 10, 2020 15:15

HazAT approved these changes Jun 10, 2020

View reviewed changes

dcramer force-pushed the feat/gatsby branch 2 times, most recently from 64155cc to c751c9c Compare June 10, 2020 17:27

feat: Add @sentry/gatsby

00fbfb3

dcramer force-pushed the feat/gatsby branch from c751c9c to 00fbfb3 Compare June 10, 2020 17:42

Merge branch 'master' into feat/gatsby

a146fdc

dcramer merged commit e8093c2 into master Jun 10, 2020

dcramer deleted the feat/gatsby branch June 10, 2020 20:56

LekoArts mentioned this pull request Apr 12, 2021

fix(@sentry/gatsby): Specify gatsby peer dep #3385

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add @sentry/gatsby #2652

feat: Add @sentry/gatsby #2652

dcramer commented Jun 5, 2020

dcramer commented Jun 5, 2020

dcramer commented Jun 5, 2020

dcramer commented Jun 5, 2020

scefali Jun 5, 2020

HazAT left a comment

HazAT Jun 8, 2020

AbhiPrasad Jun 8, 2020

AbhiPrasad Jun 8, 2020

HazAT Jun 8, 2020

dcramer Jun 8, 2020

AbhiPrasad Jun 8, 2020

dcramer Jun 8, 2020

AbhiPrasad Jun 8, 2020

dcramer Jun 8, 2020

AbhiPrasad Jun 8, 2020

dcramer Jun 8, 2020

dcramer commented Jun 9, 2020

AbhiPrasad left a comment

AbhiPrasad Jun 9, 2020

AbhiPrasad Jun 9, 2020

AbhiPrasad Jun 9, 2020

dcramer commented Jun 9, 2020

HazAT left a comment

dcramer commented Jun 10, 2020

dcramer commented Jun 10, 2020

getsentry-bot commented Jun 10, 2020 •

edited

feat: Add @sentry/gatsby #2652

feat: Add @sentry/gatsby #2652

Conversation

dcramer commented Jun 5, 2020

dcramer commented Jun 5, 2020

dcramer commented Jun 5, 2020

dcramer commented Jun 5, 2020

Choose a reason for hiding this comment

HazAT left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcramer commented Jun 9, 2020

AbhiPrasad left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcramer commented Jun 9, 2020

HazAT left a comment

Choose a reason for hiding this comment

dcramer commented Jun 10, 2020

dcramer commented Jun 10, 2020

getsentry-bot commented Jun 10, 2020 • edited

getsentry-bot commented Jun 10, 2020 •

edited