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

since these are in public API (:/) we need to do this in 1.2

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

since it is already marked as deprecated, we can probably do it by now.

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

Opening diff shortly

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

Project: platform/frameworks/support
Branch: androidx-master-dev

commit d576cbdc911cba16638a44fd8223391a90a07ef7
Author: Mike Nakhimovich <digitalbuddha@users.noreply.github.com>
Date: Tue Aug 11 09:30:34 2020

[GH] Hide deprecated internal API.

## Proposed Changes

* `RoomDatabase.java` has protected `mCallbacks` field which is leaking in the API docs, we should @Hide it.

## Testing

Test: Ran unit tests locally

## Issues Fixed

Fixes: 76109329

This is an imported pull request from

https://github.com/androidx/androidx/pull/61.

Resolves #61
Github-Pr-Head-Sha: 6440daa3a63752c7f9d5ba2a390248cd85bc634f
GitOrigin-RevId: fe92d8466a59b44b218b6ca3cbd57dcda17992f7

Change-Id: Id599cdf5b02b32bdae0166266fb7da967598fe92

A room/runtime/api/current.ignore
M room/runtime/api/current.txt
M room/runtime/api/public_plus_experimental_current.txt
M room/runtime/api/restricted_current.txt
M room/runtime/src/main/java/androidx/room/RoomDatabase.java

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

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