Skip to content

doc: Add clarifying comment for hub on ACS #11633

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 16, 2024
Merged

doc: Add clarifying comment for hub on ACS #11633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1312fbe
doc: Add clarifying comment for hub on ACS
mydea Apr 16, 2024
d17ea9e
better comment
mydea Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion packages/core/src/asyncContext/stackStrategy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,13 @@ export class AsyncContextStack {
*/
function getAsyncContextStack(): AsyncContextStack {
const registry = getMainCarrier();

// For now we continue to keep this as `hub` on the ACS,
// as e.g. the Loader Script relies on this.
// Eventually we may change this if/when we update the loader to not require this field anymore
// Related, we also write to `hub` in {@link ./../sdk.ts registerClientOnGlobalHub}
const sentry = getSentryCarrier(registry) as { hub?: AsyncContextStack };

// If there's no hub, or its an old API, assign a new one
if (sentry.hub) {
return sentry.hub;
}
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/sdk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ export function setCurrentClient(client: Client): void {
}

/**
* Unfortunately, we still have to manually bind the client to the "hub" set on the global
* Unfortunately, we still have to manually bind the client to the "hub" property set on the global
* Sentry carrier object. This is because certain scripts (e.g. our loader script) obtain
* the client via `window.__SENTRY__.hub.getClient()`.
*
* @see {@link hub.ts getGlobalHub}
* @see {@link ./asyncContext/stackStrategy.ts getAsyncContextStack}
*/
function registerClientOnGlobalHub(client: Client): void {
const sentryGlobal = getSentryCarrier(getMainCarrier()) as { hub?: AsyncContextStack };
Expand Down