-
-
Notifications
You must be signed in to change notification settings - Fork 475
feat(extend-app-start): [1/4] Add IAppStartExtender bridge #5605
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
base: feat/extend-app-start
Are you sure you want to change the base?
Changes from all commits
7a7d63f
313fff1
540931a
b8779ca
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| package io.sentry; | ||
|
|
||
| import org.jetbrains.annotations.ApiStatus; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| /** | ||
| * Bridges the {@code Sentry.extendAppStart()} / {@code Sentry.finishExtendedAppStart()} / {@code | ||
| * Sentry.getExtendedAppStartSpan()} static API to the Android implementation. The default | ||
| * implementation ({@link NoOpAppStartExtender}) does nothing, so the API is a no-op on platforms | ||
| * that don't provide an app start measurement. | ||
| */ | ||
| @ApiStatus.Internal | ||
| public interface IAppStartExtender { | ||
|
|
||
| /** | ||
| * Begins extending the app start. Intended to be called from {@code Application.onCreate} right | ||
| * after SDK init. No-ops if the app start already finished, none is in progress, or it was | ||
| * already extended (first call wins). | ||
| */ | ||
| void extendAppStart(); | ||
|
|
||
| /** | ||
| * Finishes the extended app start, allowing the app start transaction to complete. No-ops if the | ||
| * app start was not extended or this was already called. | ||
| */ | ||
| void finishExtendedAppStart(); | ||
|
|
||
| /** | ||
| * Returns the active extended app start span to attach child spans to, or {@code null} when the | ||
| * app start is not currently being extended. | ||
| */ | ||
| @Nullable | ||
| ISpan getExtendedAppStartSpan(); | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| package io.sentry; | ||
|
|
||
| import org.jetbrains.annotations.ApiStatus; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| @ApiStatus.Internal | ||
| public final class NoOpAppStartExtender implements IAppStartExtender { | ||
|
buenaflor marked this conversation as resolved.
|
||
|
|
||
| private static final @NotNull NoOpAppStartExtender instance = new NoOpAppStartExtender(); | ||
|
|
||
| private NoOpAppStartExtender() {} | ||
|
|
||
| public static @NotNull NoOpAppStartExtender getInstance() { | ||
| return instance; | ||
| } | ||
|
|
||
| @Override | ||
| public void extendAppStart() {} | ||
|
|
||
| @Override | ||
| public void finishExtendedAppStart() {} | ||
|
|
||
| @Override | ||
| public @Nullable ISpan getExtendedAppStartSpan() { | ||
| return null; | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| package io.sentry | ||
|
|
||
| import kotlin.test.Test | ||
| import kotlin.test.assertNull | ||
|
|
||
| class NoOpAppStartExtenderTest { | ||
| private val extender = NoOpAppStartExtender.getInstance() | ||
|
|
||
| @Test fun `extendAppStart does not throw`() = extender.extendAppStart() | ||
|
|
||
| @Test fun `finishExtendedAppStart does not throw`() = extender.finishExtendedAppStart() | ||
|
|
||
| @Test | ||
| fun `getExtendedAppStartSpan returns null`() { | ||
| assertNull(extender.extendedAppStartSpan) | ||
| } | ||
| } | ||
|
Comment on lines
+6
to
+17
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. following conventions of existing no-op class tests, lmk if we dont need this
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would remove this. I don't see a benefit and the downside is that it increases test duration. |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not related to your PR, but I wish we had an
internalpackage where we can put things that we don't want customers to use. I know there is the@ApiStatus.Internalannotation already but I think have the package would also help organize the code better.