Skip to content

Commit f84c306

Browse files
Lms24lobsterkatie
authored andcommitted
feat(docs): Add Backend removal and Transport injection to migration docs (#4934)
Add two small bullet points to the "General API changes" section, briefly explaining the removal of `Backend` and the injection of `Transport`s. The transport injection part needs to be revisited once we switch over to just using `NewTransport` as well as when we're passing the transports as `options` properties to the client constructors.
1 parent 2307fbc commit f84c306

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

MIGRATION.md

+13
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,19 @@ For our efforts to reduce bundle size of the SDK we had to remove and refactor p
9191
- Remove deprecated `Status`, `SessionStatus`, and `RequestSessionStatus` enums. These were only part of an internal API. If you are using these enums, we encourage you to to look at [b177690d](https://github.com/getsentry/sentry-javascript/commit/b177690d89640aef2587039113c614672c07d2be), [5fc3147d](https://github.com/getsentry/sentry-javascript/commit/5fc3147dfaaf1a856d5923e4ba409479e87273be), and [f99bdd16](https://github.com/getsentry/sentry-javascript/commit/f99bdd16539bf6fac14eccf1a974a4988d586b28) to to see the changes we've made to our code as result. We generally recommend using string literals instead of the removed enums.
9292
- Remove deprecated `getActiveDomain` method and `DomainAsCarrier` type from `@sentry/hub`.
9393
- Rename `registerRequestInstrumentation` to `instrumentOutgoingRequests` in `@sentry/tracing`.
94+
- Remove `Backend` and port its functionality into `Client` (see
95+
[#4911](https://github.com/getsentry/sentry-javascript/pull/4911) and
96+
[#4919](https://github.com/getsentry/sentry-javascript/pull/4919)). `Backend` was an unnecessary abstraction which is
97+
not present in other Sentry SDKs. For the sake of reducing complexity, increasing consistency with other Sentry SDKs and
98+
decreasing bundle-size, `Backend` was removed.
99+
<!-- TODO(v7): Add more info and PR link for passing transports in options once this is done -->
100+
<!-- TODO(v7): This needs refinement once NewTransport is the default (maybe this should get its own section with an expamp) -->
101+
- Inject transport into client instead of initializing it in the client in `setupTransport` (see
102+
[#4921](https://github.com/getsentry/sentry-javascript/pull/4921/)). If you are creating your own `Client` or
103+
calling `initAndBind`, you will have to supply your desired transport. Either provide a custom one or call
104+
`setupBrowserTransport` or `setupNodeTransport` for default transports, depending on your requirements.
105+
106+
94107

95108
# Upgrading from 6.17.x to 6.18.0
96109

0 commit comments

Comments
 (0)