fix(js-sdk-loader): Gracefully handle Project.DoesNotExist for orphaned ProjectKeys#118228
Open
sentry[bot] wants to merge 1 commit into
Open
fix(js-sdk-loader): Gracefully handle Project.DoesNotExist for orphaned ProjectKeys#118228sentry[bot] wants to merge 1 commit into
sentry[bot] wants to merge 1 commit into
Conversation
github-actions
Bot
added
the
Scope: Backend
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR addresses the
Project.DoesNotExisterror occurring in the/js-sdk-loader/{public_key}{minified}.jsendpoint.Problem:
The
JavaScriptSdkLoader.get()method would crash withProject.DoesNotExistif aProjectKeywas found (e.g., from cache) but theProjectit referenced had been deleted. This happens when an orphanedProjectKeyexists, often due to a project being deleted while its DSN is still being requested by clients.Solution:
Project.objects.get_from_cache(id=key.project_id)call (line 288 injs_sdk_loader.py) is now wrapped in atry/except Project.DoesNotExistblock.Project.DoesNotExistis caught, thekeyvariable is explicitly set toNone.js_sdk_loaderwhich already handleskey = Noneby falling back to serving the noop SDK template (sentry/js-sdk-loader-noop.js.tmpl).js-sdk-loader.orphaned_project_key, is incremented when this scenario occurs, providing observability into the frequency of orphanedProjectKeys.This change ensures that the JS SDK loader remains robust and serves a noop SDK instead of crashing, even when encountering DSNs for projects that no longer exist.
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.
Fixes SENTRY-3VXA