Propose a lint rule to detect missing `@Serializable` annotation on type-safe routes passed to navigation functions for improved compile-time safety. [362725816]

Fixed

Feature Request

Status Update

No update yet.

Description

jb...@google.com

created issue #1

Aug 28, 2024 03:20PM

The current lint rules for detecting incorrect type-safe routes passed into navigation functions don't account for if the type-safe route is actually marked as `@Serializable`. So they may give developers suggested fixes that actually end up crashing at runtime once navigation attempts to use the kotlinx.serialization APIs on it.

Instead of the lint rule having users correct what they pass in then fail anyway, it would be nice if there was a lint rule that indicated that the `@Serializable` annotation needs to be added to the route class/object. This would provide some compile time safety to ensure that navigation only gets passed the correct objects.

Comments

jb...@google.com <jb...@google.com> Sep 16, 2024 08:25PM

Assigned to cl...@google.com.

ap...@google.com <ap...@google.com> #2Sep 18, 2024 02:50PM

Project: platform/frameworks/support
Branch: androidx-main

commit f94a73512db7e5749628f17e71361b347c5b9949
Author: Clara Fok <clarafok@google.com>
Date: Fri Sep 13 15:39:32 2024

Add navigation-common lint for Serializable annotation

The lint checks if routes that are used to create NavDestinations are annotated with kotlinx @Serializable

Test: ./gradlew navigation:navigation-common-lint:test
Bug:362725816
Change-Id: I28bda5541ec144f17668302d56ecaef4011becb3

M navigation/navigation-common-lint/src/main/java/androidx/navigation/common/lint/NavigationCommonIssueRegistry.kt
A navigation/navigation-common-lint/src/main/java/androidx/navigation/common/lint/TypeSafeDestinationMissingAnnotationDetector.kt
A navigation/navigation-common-lint/src/test/java/androidx/navigation/common/lint/MissingSerializableAnnotationDetectorTest.kt
M navigation/navigation-lint-common/src/main/java/androidx/navigation/lint/common/LintUtil.kt
M navigation/navigation-lint-common/src/main/java/androidx/navigation/lint/common/TestStub.kt

https://android-review.googlesource.com/3270114

ap...@google.com <ap...@google.com> #3Sep 23, 2024 04:50PM

Project: platform/frameworks/support
Branch: androidx-main

commit 33f3eee080a07079f9ce7b34d58ee210869fe180
Author: Clara Fok <clarafok@google.com>
Date: Wed Sep 18 23:32:56 2024

Add navigation-compose lint for type safe annotations

The lint checks if routes that are used to create NavDestinations are annotated with kotlinx @Serializable, and checks that enum arg types are annotated with @Keep.

Test: ./gradlew navigation:navigation-compose-lint:test
Bug: 362725816
Bug: 358687142
Change-Id: I954023cd0cb4a5ee7d08647cf9a8139b0c8ae9d9

M navigation/navigation-compose-lint/src/main/java/androidx/navigation/compose/lint/NavigationComposeIssueRegistry.kt
A navigation/navigation-compose-lint/src/main/java/androidx/navigation/compose/lint/TypeSafeDestinationMissingAnnotationDetector.kt
A navigation/navigation-compose-lint/src/test/java/androidx/navigation/compose/lint/MissingKeepAnnotationDetectorTest.kt
A navigation/navigation-compose-lint/src/test/java/androidx/navigation/compose/lint/MissingSerializableAnnotationDetectorTest.kt
M navigation/navigation-compose-lint/src/test/java/androidx/navigation/compose/lint/Stubs.kt

https://android-review.googlesource.com/3271440

ap...@google.com <ap...@google.com> #4Sep 23, 2024 04:50PM

Project: platform/frameworks/support
Branch: androidx-main

commit 50b1c751929ecb0bfafa59afc1a6101b39668e9b
Author: Clara Fok <clarafok@google.com>
Date: Wed Sep 18 20:55:45 2024

Add navigation-runtime lint for type safe annotations

The lint checks if routes that are used to create NavDestinations are annotated with kotlinx @Serializable, and checks that enum arg types are annotated with @Keep.

Test: ./gradlew navigation:navigation-runtime-lint:test
Bug: 362725816
Bug: 358687142
Change-Id: Ie601a15449b1561154bd3ae5d990e006a371c7c6

M navigation/navigation-runtime-lint/src/main/java/androidx/navigation/runtime/lint/NavigationRuntimeIssueRegistry.kt
A navigation/navigation-runtime-lint/src/main/java/androidx/navigation/runtime/lint/TypeSafeDestinationMissingAnnotationDetector.kt
A navigation/navigation-runtime-lint/src/test/java/androidx/navigation/runtime/lint/MissingKeepAnnotationDetectorTest.kt
A navigation/navigation-runtime-lint/src/test/java/androidx/navigation/runtime/lint/MissingSerializableAnnotationDetectorTest.kt
A navigation/navigation-runtime-lint/src/test/java/androidx/navigation/runtime/lint/Stubs.kt

https://android-review.googlesource.com/3271439

ap...@google.com <ap...@google.com> #5Sep 23, 2024 04:50PM

Project: platform/frameworks/support
Branch: androidx-main

commit 49c974dc53e902b0fb2b105e72c60b276fe22afe
Author: Clara Fok <clarafok@google.com>
Date: Wed Sep 18 10:49:48 2024

Add annotation lint for NavDestinationBuilder.deepLink

Lint for @Serializable and @Keep with NavDestinationBuilder.deepLink as entry point

Test: ./gradlew navigation:navigation-common-lint:test
Bug: 362725816
Change-Id: Id8c6ef1ee0839a43864afac58a5437ad1379e25f

M navigation/navigation-common-lint/src/main/java/androidx/navigation/common/lint/TypeSafeDestinationMissingAnnotationDetector.kt
M navigation/navigation-common-lint/src/test/java/androidx/navigation/common/lint/MissingKeepAnnotationDetectorTest.kt
M navigation/navigation-common-lint/src/test/java/androidx/navigation/common/lint/MissingSerializableAnnotationDetectorTest.kt
M navigation/navigation-lint-common/src/main/java/androidx/navigation/lint/common/TestStub.kt

https://android-review.googlesource.com/3271437

ap...@google.com <ap...@google.com> #6Sep 24, 2024 06:13PM

Project: platform/frameworks/support
Branch: androidx-main

commit 8b4f5f4e8219232187ac103252715c7213215625
Author: Clara Fok <clarafok@google.com>
Date: Tue Sep 24 04:42:33 2024

Add annotation lint for NavDeepLink builders

Lint for @Serializable and @Keep with for navDeepLink builders

Test: ./gradlew navigation:navigation-common-lint:test
Bug: 362725816
Bug: 358687142
Change-Id: I4a259b5544e4e4655c4bdee812d64f3b2a1947bd

M navigation/navigation-common-lint/src/main/java/androidx/navigation/common/lint/TypeSafeDestinationMissingAnnotationDetector.kt
M navigation/navigation-common-lint/src/test/java/androidx/navigation/common/lint/MissingKeepAnnotationDetectorTest.kt
M navigation/navigation-common-lint/src/test/java/androidx/navigation/common/lint/MissingSerializableAnnotationDetectorTest.kt
M navigation/navigation-lint-common/src/main/java/androidx/navigation/lint/common/BaseTypeSafeDestinationMissingAnnotationDetector.kt
M navigation/navigation-lint-common/src/main/java/androidx/navigation/lint/common/TestStub.kt

https://android-review.googlesource.com/3278871

cl...@google.com <cl...@google.com> #7Sep 25, 2024 04:56AM

Marked as fixed.

Fixed internally, available in navigation 2.8.2.

pr...@google.com <pr...@google.com> #8Oct 2, 2024 05:37PM

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.annotation:annotation-wasm-js:1.9.0-rc01
androidx.annotation:annotation-watchosdevicearm64:1.9.0-rc01