ref(getting-started-docs): Source sdks version from sentry release registry #54675

priscilawebdev · 2023-08-14T11:38:26Z

We're getting the SDK version from the sentry release registry and showing it for platforms that suggest a specific version for users to install.

It will be quite fast, but if the endpoint takes a bit longer to respond, a small '...loading' text will appear instead of a version number. During this time, users can't manually copy the code, and the button to copy it to the clipboard won't show up.

closes: #53921

Preview:

Screen.Recording.2023-08-17.at.14.57.14.mov

Related required PRs:

…gistry

priscilawebdev · 2023-08-14T11:39:12Z

static/app/api.tsx

@@ -275,6 +279,7 @@ export class Client {
    this.baseUrl = options.baseUrl ?? '/api/0';
    this.headers = options.headers ?? Client.JSON_HEADERS;
    this.activeRequests = {};
+    this.credentials = options.credentials ?? 'include';


This was creating a problem related to accessing data from another source (cross-origin issue) while trying to get information from the sentry release registry. With this update, we can now pass a custom credentials as this PR does for the getting-started-docs, passing omit

…sdk-version-from-sentry-release-registry

matejminar · 2023-08-14T12:01:30Z

static/app/gettingStartedDocs/rust/rust.tsx

-sentry = "0.31.5"
+sentry = "${sourcePackageRegistries?.data?.['sentry.rust'] ?? '0.30.0'}"


Should this be "0.31.5"?

oh yes, I went through this list 2x but missed this one. Thanks 🙏

matejminar · 2023-08-14T12:04:26Z

static/app/components/onboarding/gettingStartedDoc/useSourcePackageRegistries.tsx

+  const {isLoading, data} = useApiQuery<ReleaseRegistrySdk>(
+    ['https://release-registry.services.sentry.io/sdks'],
+    {
+      staleTime: Infinity,
+    },
+    API_CLIENT
+  );


Do we have an OOTB error handling here? We should get a sentry error when this request fails so that we know that versions in the onboarding are defaulting to hardcoded ones (those might be ancient at that point in time).

it is a good idea, but if this request fails, sentry should capture it OOTB or? I am not aware of places where we handle isError, other than in a few try...catch

sentry should capture it OOTB or?

yeah, that's what I'm wondering as well because I don't know by heart if we capture it by default these days

it's pretty important that we log this, otherwise, we won't notice this error is happening and people will just install old versions of the SDK - is there some way we can validate whether we log it or not? just for peace of mind

you are right... unfortunately we our react-query layer still doesn't capture a request fail error

priscilawebdev · 2023-08-14T13:28:12Z

static/app/gettingStartedDocs/rust/rust.tsx

-sentry = "0.31.5"
+sentry = "${sourcePackageRegistries?.data?.['sentry.rust'] ?? '0.30.0'}"


oh yes, I went through this list 2x but missed this one. Thanks 🙏

static/app/gettingStartedDocs/rust/rust.tsx

github-actions · 2023-08-14T13:31:50Z

🚨 Warning: This pull request contains Frontend and Backend changes!

It's discouraged to make changes to Sentry's Frontend and Backend in a single pull request. The Frontend and Backend are not atomically deployed. If the changes are interdependent of each other, they must be separated into two pull requests and be made forward or backwards compatible, such that the Backend or Frontend can be safely deployed independently.

Have questions? Please ask in the #discuss-dev-infra channel.

…sdk-version-from-sentry-release-registry

priscilawebdev · 2023-08-17T13:16:25Z

static/app/components/onboarding/gettingStartedDoc/useSourcePackageRegistries.tsx

+  useEffect(() => {
+    if (releaseRegistrySdk.error) {
+      handleXhrErrorResponse(
+        'Failed to fetch sentry release registry',
+        releaseRegistrySdk.error
+      );
+    }
+  }, [releaseRegistrySdk.error]);


this is meh but according to our slack discussion, we don't capture response errors out of the box as it was too noisy before and when we need to track them, we shall use handleXhrErrorResponse

matejminar · 2023-08-17T13:52:52Z

static/app/gettingStartedDocs/apple/apple-macos.tsx

+  sourcePackageRegistries,
+}: Partial<
+  Pick<ModuleProps, 'dsn' | 'sourcePackageRegistries'>
+> = {}): LayoutProps['steps'] => [


I wish we could simplify this. It's quite clunky, especially because we repeat it in lots of places.

yes, I talked to Arthur about it too... we should definitely simplify this, but would prefer to do that in a separate PR

matejminar · 2023-08-17T13:56:20Z

static/app/utils/handleXhrErrorResponse.tsx

+        ? new Error(message, {
+            cause: {
+              responseText: err.responseText,
+              responseJSON: err.responseJSON,
+              status: err.status,
+              statusText: err.statusText,
+              name: err.name,
+              stack: err.stack,
+            },
+          })


This should ideally be a separate PR - I have very little confidence reviewing this peace. Do we know which field is causing troubles? The only difference I can see is cause,message vs responseJSON.

AbhiPrasad

The main benefit of having this "layer" between the frontend and the release registry is the cache as mentioned above. A process runs every 5 minutes to get the list from the registry, but is this really a big advantage? We're also using caching in the UI with React Query.

I think it's just so we have a single way of grabbing this data - but since it requires more backend changes not worth the effort IMO.

We can keep iterating on these views after merge!

priscilawebdev · 2023-08-17T14:05:35Z

This should ideally be a separate PR - I have very little confidence reviewing this peace. Do we know which field is causing troubles? The only difference I can see is cause,message vs responseJSON.

I am not sure if the problem is because we pass cause as a sub-property of cause but with this change, everything seems to be working well.. I will create a separate PR for this, but until then, probably we won't be capturing request errors.

I also asked Billy but he is not sure why this is not working

…sdk-version-from-sentry-release-registry

getsentry-bot · 2023-08-17T15:07:56Z

PR reverted: 0f1c8ff

…lease registry (#54675)" This reverts commit d5615b9. Co-authored-by: priscilawebdev <29228205+priscilawebdev@users.noreply.github.com>

priscilawebdev · 2023-08-17T15:08:01Z

Reverting this PR since after merging there is a cross-origin issue 😞

ref(getting-started-docs): Source sdks version from sentry release re…

48b3f36

…gistry

priscilawebdev requested a review from a team as a code owner August 14, 2023 11:38

github-actions bot added the Scope: Frontend Automatically applied to PRs that change frontend components label Aug 14, 2023

priscilawebdev commented Aug 14, 2023

View reviewed changes

vercel bot deployed to Preview August 14, 2023 11:39 View deployment

Merge branch 'master' into priscila/feat/getting-started-docs-source-…

81f6537

…sdk-version-from-sentry-release-registry

vercel bot deployed to Preview August 14, 2023 11:44 View deployment

make prop optional

f2d7b9f

vercel bot deployed to Preview August 14, 2023 11:54 View deployment

priscilawebdev requested a review from a team August 14, 2023 11:55

add description to hook

7a9d428

vercel bot deployed to Preview August 14, 2023 11:59 View deployment

matejminar reviewed Aug 14, 2023

View reviewed changes

priscilawebdev commented Aug 14, 2023

View reviewed changes

Update static/app/gettingStartedDocs/rust/rust.tsx

51a106f

vercel bot deployed to Preview August 14, 2023 13:31 View deployment

priscilawebdev requested a review from a team as a code owner August 14, 2023 13:31

priscilawebdev requested review from a team August 14, 2023 13:31

priscilawebdev requested a review from a team as a code owner August 14, 2023 13:31

priscilawebdev requested review from a team August 14, 2023 13:31

priscilawebdev requested review from a team as code owners August 14, 2023 13:31

github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Aug 14, 2023

priscilawebdev force-pushed the priscila/feat/getting-started-docs-source-sdk-version-from-sentry-release-registry branch from 3797eff to 51a106f Compare August 14, 2023 13:33

Merge branch 'master' into priscila/feat/getting-started-docs-source-…

23db940

…sdk-version-from-sentry-release-registry

priscilawebdev removed the request for review from a team August 14, 2023 13:34

remove test code

0f05f3c

vercel bot deployed to Preview August 17, 2023 10:07 View deployment

fix tsc error

5a54ead

vercel bot deployed to Preview August 17, 2023 11:17 View deployment

priscilawebdev added 2 commits August 17, 2023 14:16

Merge branch 'master' into priscila/feat/getting-started-docs-source-…

d063924

…sdk-version-from-sentry-release-registry

cr feedback

1f34c19

vercel bot deployed to Preview August 17, 2023 13:00 View deployment

revert new changes

eea3f51

priscilawebdev requested a review from ArthurKnaus August 17, 2023 13:06

vercel bot deployed to Preview August 17, 2023 13:07 View deployment

priscilawebdev requested a review from obostjancic August 17, 2023 13:11

priscilawebdev commented Aug 17, 2023

View reviewed changes

priscilawebdev mentioned this pull request Aug 17, 2023

Use gradle plugin auto install in onboarding docs #54928

Merged

matejminar approved these changes Aug 17, 2023

View reviewed changes

AbhiPrasad approved these changes Aug 17, 2023

View reviewed changes

priscilawebdev added 2 commits August 17, 2023 16:06

Merge branch 'master' into priscila/feat/getting-started-docs-source-…

8d91175

…sdk-version-from-sentry-release-registry

Matej cr feedback

bd3397b

priscilawebdev enabled auto-merge (squash) August 17, 2023 14:08

vercel bot deployed to Preview August 17, 2023 14:10 View deployment

priscilawebdev merged commit d5615b9 into master Aug 17, 2023
49 checks passed

priscilawebdev deleted the priscila/feat/getting-started-docs-source-sdk-version-from-sentry-release-registry branch August 17, 2023 14:37

priscilawebdev added the Trigger: Revert Add to a merged PR to revert it (skips CI) label Aug 17, 2023

priscilawebdev restored the priscila/feat/getting-started-docs-source-sdk-version-from-sentry-release-registry branch August 17, 2023 15:31

priscilawebdev removed the Trigger: Revert Add to a merged PR to revert it (skips CI) label Aug 17, 2023

ArthurKnaus mentioned this pull request Aug 18, 2023

feat(getting-started-docs): Source SDK version from sentry release registry #54943

Merged

github-actions bot locked and limited conversation to collaborators Sep 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ref(getting-started-docs): Source sdks version from sentry release registry #54675

ref(getting-started-docs): Source sdks version from sentry release registry #54675

priscilawebdev commented Aug 14, 2023 •

edited

Loading

priscilawebdev Aug 14, 2023 •

edited

Loading

matejminar Aug 14, 2023

priscilawebdev Aug 14, 2023

matejminar Aug 14, 2023

priscilawebdev Aug 14, 2023 •

edited

Loading

matejminar Aug 14, 2023

priscilawebdev Aug 14, 2023

priscilawebdev Aug 14, 2023

github-actions bot commented Aug 14, 2023

priscilawebdev Aug 17, 2023

matejminar Aug 17, 2023

priscilawebdev Aug 17, 2023

matejminar Aug 17, 2023

AbhiPrasad left a comment

priscilawebdev commented Aug 17, 2023 •

edited

Loading

getsentry-bot commented Aug 17, 2023

priscilawebdev commented Aug 17, 2023

		sentry = "0.31.5"
		sentry = "${sourcePackageRegistries?.data?.['sentry.rust'] ?? '0.30.0'}"

ref(getting-started-docs): Source sdks version from sentry release registry #54675

ref(getting-started-docs): Source sdks version from sentry release registry #54675

Conversation

priscilawebdev commented Aug 14, 2023 • edited Loading

priscilawebdev Aug 14, 2023 • edited Loading

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

priscilawebdev Aug 14, 2023 • edited Loading

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

github-actions bot commented Aug 14, 2023

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

AbhiPrasad left a comment

Choose a reason for hiding this comment

priscilawebdev commented Aug 17, 2023 • edited Loading

getsentry-bot commented Aug 17, 2023

priscilawebdev commented Aug 17, 2023

priscilawebdev commented Aug 14, 2023 •

edited

Loading

priscilawebdev Aug 14, 2023 •

edited

Loading

priscilawebdev Aug 14, 2023 •

edited

Loading

priscilawebdev commented Aug 17, 2023 •

edited

Loading