Skip to content
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.

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

feat(angular): Update SDK provider setup docs for Angular 19 #11921

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Nov 22, 2024

DESCRIBE YOUR PR

This PR updates the Angular provider setup in the Angular "Getting Started" docs page. In Angular 19, the APP_INITIALIZER DI token was deprecated and the new recommended way to provide a dependency (our TraceService) at app start is to use provideAppInitializer and the inject API.

To be clear, this is not a breaking change. But it makes sense for us to document the most up to date way as well.

Also made a minor wording change in the compatibility note

Our SDK is comaptible with Angular 19 since v8.40.0, so this PR can be merged whenever it's approved.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

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.

EXTRA RESOURCES

Copy link

vercel bot commented Nov 22, 2024

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 22, 2024 4:29pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Nov 22, 2024 4:29pm
develop-docs ⬜️ Ignored (Inspect) Nov 22, 2024 4:29pm

@Lms24 Lms24 self-assigned this Nov 22, 2024
@Lms24 Lms24 requested review from lforst and s1gr1d November 22, 2024 16:18
@Lms24 Lms24 changed the title feat(angular): Update SDK provider setup for Angular 19 feat(angular): Update SDK provider setup docs for Angular 19 Nov 22, 2024
Copy link

codecov bot commented Nov 22, 2024

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.13MB 9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.02MB 6 bytes (-0.0%) ⬇️

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Comment on lines +104 to +106
provideAppInitializer(() => {
inject(TraceService);
}),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this like a really sick API for us? Nice.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's quite neat but I don't think we can add many other things to it for now. SDK initialization for example still happens before the entire angular app is bootstrapped.

@Lms24 Lms24 merged commit a1313a6 into master Nov 27, 2024
11 checks passed
@Lms24 Lms24 deleted the lms/feat-angular-19-update branch November 27, 2024 12:31
martinhaintz pushed a commit that referenced this pull request Nov 27, 2024
…ierarchy

* master: (28 commits)
  feat(angular): Update SDK provider setup for Angular 19 (#11921)
  feat(dynamic-sampling): adapt docs to new dynamic sampling logic (#11886)
  update banner for post-launch week promotion (#11964)
  chore(android): Add masking options to AndroidManifest (#11863)
  Bump API schema to 2126f7dd (#11965)
  chore(Profiling): Add callouts and links to Android Profiling troubleshooting info (#11905)
  docs(flutter): Use sentry flutter init in samples (#11858)
  use native crypto to generate uuid (#11959)
  fix vercel integration 404 (#11958)
  Add RN Replay Privacy page (#11798)
  feat(dashboards): Add docs for Dashboard Edit Access Selector (#11822)
  feat(app-starts): Add RN SDK min version (#11650)
  feat(realy): Add Relay best practices guide (#11914)
  docs(sdks): New Scope APIs (#11943)
  docs(sdks): Span Sampling (#11940)
  Add include explaining sample code options (#11866)
  devenv: internal troubleshooting (#11947)
  Bump API schema to 0b18bfae (#11946)
  Bump API schema to 2bee5317 (#11945)
  feat: Link to Replay Issues when we mention Perf Issues as well (#11933)
  ...
@github-actions github-actions bot locked and limited conversation to collaborators Dec 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants