sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

Update hermes docs to use bundled hermesc script

Open SMJ93 opened this issue 3 years ago • 13 comments

Since React Native 0.69 hermes has been bundled with React Native.

If users use the old hermesc version from node_modules/hermes-engine the version won't match.

This PR recommends users to change their hermes script to use the the hermesc version from react-native if they are using React Native 0.69 or later:

// OS-BIN is osx-bin, win64-bin, or linux64-bin, depending on which operating system you are using
node_modules/react-native/sdks/hermesc/{OS-BIN}/hermesc

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

SMJ93 avatar Aug 25 '22 10:08 SMJ93

@SMJ93 is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Aug 25 '22 10:08 vercel[bot]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Sep 9, 2022 at 2:19PM (UTC)

vercel[bot] avatar Aug 25 '22 17:08 vercel[bot]

It looks like some of what you've added is already covered in a note just before step 3, but the folks on @getsentry/team-mobile will need to check this for technical accuracy. After that, I'll review for wording and structure.

imatwawana avatar Aug 25 '22 17:08 imatwawana

It looks like some of what you've added is already covered in a note just before step 3, but the folks on @getsentry/team-mobile will need to check this for technical accuracy. After that, I'll review for wording and structure.

Hi @imatwawana,

Yeah, that is quite hidden away - it is also better to explain why it has changed (see the link to react native blog).

Maybe a better alternative would be to flip the default to React Native 0.69 and keep the note for 0.68 and below?

SMJ93 avatar Aug 26 '22 10:08 SMJ93

It looks like some of what you've added is already covered in a note just before step 3, but the folks on @getsentry/team-mobile will need to check this for technical accuracy. After that, I'll review for wording and structure.

Hi @imatwawana,

Yeah, that is quite hidden away - it is also better to explain why it has changed (see the link to react native blog).

Maybe a better alternative would be to flip the default to React Native 0.69 and keep the note for 0.68 and below?

I'll definitely defer to the @getsentry/team-mobile team on the best way to approach this.

imatwawana avatar Aug 29 '22 14:08 imatwawana

I'd say we keep this open till more people adopt the 0.69.x version, right now the majority of our users are not there yet. The note below mentions 0.69.x support, what we can do is to move the note above the command, what do you think @imatwawana ?

marandaneto avatar Aug 30 '22 08:08 marandaneto

Sure, let's move the note up.

imatwawana avatar Aug 30 '22 15:08 imatwawana

@imatwawana Do you want me to update this PR or do you want to close and create a new one?

SMJ93 avatar Aug 30 '22 15:08 SMJ93

Feel free to just update this PR

imatwawana avatar Aug 30 '22 16:08 imatwawana

Oh sorry, I just realized that bumps into the recommendation that @marandaneto had made. Let's leave this one open and I'll open a new PR (#5467) to move the note. I'll circle back and make some suggestions on this PR to get it ready for when we can use it down the road.

imatwawana avatar Aug 30 '22 16:08 imatwawana

Hey @imatwawana, can this be merged?

SMJ93 avatar Sep 09 '22 08:09 SMJ93

Hey @imatwawana, can this be merged?

Per @marandaneto's comment before, we're gonna hold off on merging until more folks have adopted the newer version: https://github.com/getsentry/sentry-docs/pull/5455#issuecomment-1231336075 @marandaneto, please merge this whenever it makes sense.

imatwawana avatar Sep 09 '22 13:09 imatwawana

Hey @imatwawana, can this be merged?

Per @marandaneto's comment before, we're gonna hold off on merging until more folks have adopted the newer version: #5455 (comment) @marandaneto, please merge this whenever it makes sense.

React Native 0.69 has been out for nearly 3 months and 0.70 was released this week.

I assume most people who are setting up sentry will be using versions 0.69 and 0.70?

SMJ93 avatar Sep 09 '22 14:09 SMJ93

@imatwawana @marandaneto any update with this?

SMJ93 avatar Nov 14 '22 12:11 SMJ93

@imatwawana @marandaneto any update with this?

Sentry RN SDK v5 is still alpha (currently working on it), also the adoption of RN >= 0.70 is very low, any reason why you would like to push this? the docs already state which commands to run on the older and newer version.

marandaneto avatar Nov 15 '22 08:11 marandaneto

@marandaneto the adoption rate of 0.69+ is pretty high which includes the bundled version of hermes.

Chasing as I created this PR nearly 3 months ago.

Feel free to close if you are updating the cods as part of v5.

SMJ93 avatar Nov 15 '22 11:11 SMJ93

@marandaneto Maybe we can make this change independent of RN SDK v5 as v4 users can use v4 with 0.69+ if they make changes described in the troubleshooting page.

krystofwoldrich avatar Jan 17 '23 14:01 krystofwoldrich

@krystofwoldrich @marandaneto This is probably out of date now as RN 0.71 has just been released - feel free to close

SMJ93 avatar Jan 17 '23 14:01 SMJ93

@krystofwoldrich adjust the text if necessary and merge it since RN 0.7x is already stable.

marandaneto avatar Jan 17 '23 14:01 marandaneto