Safe Args Generated Classes failing Jetpack API Lint check [185843837]

Fixed

Bug

Status Update

No update yet.

Description

ds...@google.com

created issue #1

Apr 20, 2021 01:02AM

Component used: Navigation, Safe Args plugin

Version used: 2.3.4

Hi!

I'm working on creating a debug view for AppSearch as a Jetpack library. I'm using Navigation component for managing switching between fragments. I'm using the Safe Args plugin for passing in arguments to a destination fragment. However, the classes the Safe Args plugin generates in the build tree are causing the Jetpack API lint check to fail:

> Task :appsearch:appsearch-debug-view:generateApi

../../../../out/androidx/appsearch/appsearch-debug-view/build/generated/source/navigation-args/release/androidx/appsearch/debugview/view/DocumentFragmentArgs.java:119: error: Builder must be final: androidx.appsearch.debugview.view.DocumentFragmentArgs.Builder [StaticFinalBuilder]
../../../../out/androidx/appsearch/appsearch-debug-view/build/generated/source/navigation-args/release/androidx/appsearch/debugview/view/DocumentFragmentArgs.java:165: error: Getter should be on the built object, not the builder: method androidx.appsearch.debugview.view.DocumentFragmentArgs.Builder.getDocumentUri() [GetterOnBuilder]
../../../../out/androidx/appsearch/appsearch-debug-view/build/generated/source/navigation-args/release/androidx/appsearch/debugview/view/DocumentFragmentArgs.java:171: error: Getter should be on the built object, not the builder: method androidx.appsearch.debugview.view.DocumentFragmentArgs.Builder.getDocumentNamespace() [GetterOnBuilder]
../../../../out/androidx/appsearch/appsearch-debug-view/build/generated/source/navigation-args/release/androidx/appsearch/debugview/view/DocumentFragmentArgs.java:123: error: Missing nullability o    Your change has API lint issues. Fix the code according to the messages above.

    If a check is broken, suppress it in code in Kotlin with @Suppress("id")/@get:Suppress("id")
    and in Java with @SuppressWarnings("id") and file bug to
    https://issuetracker.google.com/issues/new?component=739152&template=1344623

    If you are doing a refactoring or suppression above does not work, use ./gradlew updateApiLintBaseline

The class generating these errors is attached. I would appreciate it if the Lint issues could be resolved so I can continue using Safe Args!

DocumentFragmentArgs.java

6 KB

View

Download

Comments

il...@google.com <il...@google.com> #2Apr 20, 2021 04:53PM

Assigned to jb...@google.com.

I think making the Builder final and adding the missing nullability makes a lot of sense.

We'll want to keep the getters for API compatibility purposes, so let's suppress that warning.

ap...@google.com <ap...@google.com> #3Aug 18, 2021 08:07PM

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

commit 0cf2de39de68f680b2912a64ebf72c164b87aabc
Author: Jeremy Woods <jbwoods@google.com>
Date: Wed Aug 18 12:27:52 2021

Fix safe args builder lint warnings

The SafeArgs java generator currently has lint warnings for the Builder
not being final, missing nullability annotation, and getter on builder
errors.

The change makes the appropriate changes to prevent those warnings.

RelNote: "The SafeArgs java generator should no longer cause lint
warnings when generating Args classes."
Test: ./gradlew --rerun-tasks navigation:navigation-safe-args-generator:test
Bug: 185843837

Change-Id: I1a6661b10b8e380aaa9fcfd1fc710c35b047bd6d

M navigation/navigation-safe-args-generator/src/main/kotlin/androidx/navigation/safe/args/generator/java/JavaNavWriter.kt
M navigation/navigation-safe-args-generator/src/test/test-data/expected/java_nav_writer_test/MainFragment$InnerFragmentArgs.java
M navigation/navigation-safe-args-generator/src/test/test-data/expected/java_nav_writer_test/MainFragmentArgs.java
M navigation/navigation-safe-args-generator/src/test/test-data/expected/java_nav_writer_test/SanitizedMainFragmentArgs.java

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

jb...@google.com <jb...@google.com> #4Aug 18, 2021 08:11PM

Marked as fixed.

This has been fixed internally and will be available in the Navigation 2.4.0-alpha08 release.

Issue 185843837

Description

Issue summary

Comments

il...@google.com <il...@google.com> #2Apr 20, 2021 04:53PM

ap...@google.com <ap...@google.com> #3Aug 18, 2021 08:07PM

jb...@google.com <jb...@google.com> #4Aug 18, 2021 08:11PM

Add comment

Issue metadata