Annotate StackNavigator#push as delicate API #747
Conversation
WalkthroughThe recent changes enhance the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant StackNavigator
participant Component
User->>Component: Initiates action (e.g. button click)
Component->>StackNavigator: Calls pushNew(configuration)
StackNavigator-->>Component: Updates navigation stack
Component-->>User: Reflects new state or configuration
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (6)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/Annotations.kt (1 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/StackNavigatorExt.kt (2 hunks)
- docs/navigation/stack/navigation.md (1 hunks)
- sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/cards/DefaultCardsComponent.kt (2 hunks)
- sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/counters/DefaultCountersComponent.kt (2 hunks)
- sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/dynamicfeatures/DefaultDynamicFeaturesComponent.kt (2 hunks)
Files skipped from review due to trivial changes (1)
- docs/navigation/stack/navigation.md
Additional comments not posted (9)
decompose/src/commonMain/kotlin/com/arkivanov/decompose/Annotations.kt (1)
26-32: LGTM! The new annotation class is consistent and well-documented.The
DelicateDecomposeApiannotation is appropriately defined with@RequiresOptInand@Retentionannotations. The documentation comment provides clear guidance on its usage.sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/counters/DefaultCountersComponent.kt (2)
9-9: LGTM! The import statement forpushNewis necessary and correct.The import statement for
pushNewis required for the updatedonNextfunction.
39-39: LGTM! The updatedonNextfunction improves navigation.The
onNextlambda function now usespushNewto create a new configuration with an incremented index andisBackEnabledset totrue.sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/cards/DefaultCardsComponent.kt (2)
10-10: LGTM! The import statement forpushNewis necessary and correct.The import statement for
pushNewis required for the updatedonAddClickedfunction.
Line range hint
57-62:
LGTM! The updatedonAddClickedfunction improves navigation.The
onAddClickedfunction now usespushNewto create a new configuration with an incremented number and sets the color based on the number.sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/dynamicfeatures/DefaultDynamicFeaturesComponent.kt (2)
8-8: LGTM! The import change is appropriate.The import statement for
pushhas been replaced withpushNew, which aligns with the updated method usage in the file.
54-54: LGTM! TheonFeature2callback update is appropriate.The
onFeature2callback now usespushNewinstead ofpush, which improves navigation clarity and avoids pushing duplicate configurations.decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/StackNavigatorExt.kt (2)
3-4: LGTM! The import change is appropriate.The import statement for
DelicateDecomposeApihas been added, which aligns with the addition of theDelicateDecomposeApiannotation in the file.
16-24: LGTM! Thepushfunction update is appropriate.The
pushfunction has been annotated withDelicateDecomposeApiand its documentation has been updated to provide clearer guidance on the usage and implications of this method.However, ensure that all function calls to
pushare reviewed to verify correct usage.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (9)
- decompose/api/android/decompose.api (1 hunks)
- decompose/api/decompose.klib.api (1 hunks)
- decompose/api/jvm/decompose.api (1 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/Annotations.kt (1 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/StackNavigatorExt.kt (2 hunks)
- docs/navigation/stack/navigation.md (1 hunks)
- sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/cards/DefaultCardsComponent.kt (2 hunks)
- sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/counters/DefaultCountersComponent.kt (2 hunks)
- sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/dynamicfeatures/DefaultDynamicFeaturesComponent.kt (2 hunks)
Files skipped from review as they are similar to previous changes (6)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/Annotations.kt
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/StackNavigatorExt.kt
- docs/navigation/stack/navigation.md
- sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/cards/DefaultCardsComponent.kt
- sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/counters/DefaultCountersComponent.kt
- sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/dynamicfeatures/DefaultDynamicFeaturesComponent.kt
Additional comments not posted (4)
decompose/api/jvm/decompose.api (1)
78-79: AnnotationDelicateDecomposeApiis correctly defined.The annotation is properly defined and follows best practices.
decompose/api/android/decompose.api (1)
91-92: AnnotationDelicateDecomposeApiis correctly defined.The annotation is properly defined and follows best practices.
decompose/api/decompose.klib.api (2)
253-255: LGTM!The
DelicateDecomposeApiannotation class is correctly implemented as a marker.
256-258: LGTM!The
ExperimentalDecomposeApiannotation class is correctly implemented as a marker.
| * Marks delicate Decompose API that requires special attention when used. | ||
| * See the docs of the annotated API for more information. | ||
| */ | ||
| @RequiresOptIn(level = RequiresOptIn.Level.WARNING) |
There was a problem hiding this comment.
I'd recommend marking the level as ERROR to force people to read the description. Otherwise the issue may persist
There was a problem hiding this comment.
Thanks. I will keep it as warning for now, similar to DelicateCoroutinesApi.
Closes #741.
Summary by CodeRabbit
New Features
DelicateDecomposeApiannotation to signal APIs that require careful handling.pushNew, enhancing navigation behavior.Documentation
pushfunction, clarifying its usage and suggesting alternatives.Bug Fixes