Lint accesses source sets information without dependencies [253219347]

Fixed

Bug

Status Update

No update yet.

Description

ga...@google.com

created issue #1

Oct 12, 2022 01:41PM

Lint access source set information in a way that does not capture dependency information. Androidx is hitting this with:

* What went wrong:
A problem was found with the configuration of task ':room:room-compiler-processing-testing:lintAnalyze' (type 'AndroidLintAnalysisTask').
  - Gradle detected a problem with the following location: '$OUT_DIR/androidx/room/room-compiler-processing-testing/build/test-config-copy'.
    
    Reason: Task ':room:room-compiler-processing-testing:lintAnalyze' uses this output of task ':room:room-compiler-processing-testing:copyTestConfiguration' without declaring an explicit or implicit dependency. This can lead to incorrect results being produced, depending on what order the tasks are executed.
    
    Possible solutions:
      1. Declare task ':room:room-compiler-processing-testing:copyTestConfiguration' as an input of ':room:room-compiler-processing-testing:lintAnalyze'.
      2. Declare an explicit dependency on ':room:room-compiler-processing-testing:copyTestConfiguration' from ':room:room-compiler-processing-testing:lintAnalyze' using Task#dependsOn.
      3. Declare an explicit dependency on ':room:room-compiler-processing-testing:copyTestConfiguration' from ':room:room-compiler-processing-testing:lintAnalyze' using Task#mustRunAfter.
    
    Please refer to https://docs.gradle.org/8.0-milestone-2/userguide/validation_problems.html#implicit_dependency for more details about this problem.

* Exception is:
org.gradle.internal.execution.WorkValidationException: A problem was found with the configuration of task ':room:room-compiler-processing-testing:lintAnalyze' (type 'AndroidLintAnalysisTask').
  - Gradle detected a problem with the following location: '$OUT_DIR/androidx/room/room-compiler-processing-testing/build/test-config-copy'.
    
    Reason: Task ':room:room-compiler-processing-testing:lintAnalyze' uses this output of task ':room:room-compiler-processing-testing:copyTestConfiguration' without declaring an explicit or implicit dependency. This can lead to incorrect results being produced, depending on what order the tasks are executed.
    
    Possible solutions:
      1. Declare task ':room:room-compiler-processing-testing:copyTestConfiguration' as an input of ':room:room-compiler-processing-testing:lintAnalyze'.
      2. Declare an explicit dependency on ':room:room-compiler-processing-testing:copyTestConfiguration' from ':room:room-compiler-processing-testing:lintAnalyze' using Task#dependsOn.
      3. Declare an explicit dependency on ':room:room-compiler-processing-testing:copyTestConfiguration' from ':room:room-compiler-processing-testing:lintAnalyze' using Task#mustRunAfter.
    
    Please refer to https://docs.gradle.org/8.0-milestone-2/userguide/validation_problems.html#implicit_dependency for more details about this problem.

BUILD FAILED in 25m 59s

The issue seems to be usage of non-provider based APIs here.

We should switch to SourceSet.getAllSource().getSourceDirectories().

Comments

sp...@google.com <sp...@google.com> #2Oct 14, 2022 07:39PM

Accepted by sp...@google.com.

Some things to work out before making the annotations type-use:

Determine guidelines for type nullability in public API
Determine rules for when type nullability can change in public API
Confirm that intellij nullability lint works as expected for type-use nullability annotations
Test what the impact would be on existing arrays (due to ambiguities of type-use annotations on arrays)
Confirm usage of type-use androidx.annotation.NonNull/Nullable in metalava won't break anything for platform

au...@google.com <au...@google.com> #3Oct 17, 2022 04:53PM

Plan for making the annotations type-use: https://docs.google.com/document/d/1tNqV9Dgtii6wvulm8emjs0bwgSL3Fwf3F4LFXfVeyTU/edit

au...@google.com <au...@google.com> #4Oct 17, 2022 06:17PM

Tracking sheet for which projects have been migrated.

au...@google.com <au...@google.com> #5Oct 21, 2022 01:00AM

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

commit 558f17c6f9e237897fcc87fa556ca4af5c1808c6
Author: Julia McClellan <juliamcclellan@google.com>
Date: Thu Sep 19 14:50:25 2024

Add JSpecify to list of Dackka allowed nullness annotations

Test: Compared the output of `./gradlew docs-tip-of-tree:docs` with the current codebase and aosp/3190072, which switches all nullness annotations to jspecify. Only observed changes were updated nullness annotation links and additional copies of some inherited methods when a parent used a different nullness annotation (similar to

b/280845383

)
Bug: 326456246

Change-Id: I40ede9c84dbae3a1ac7d3d4e98f77a56e119caaa

M buildSrc/private/src/main/kotlin/androidx/build/docs/AndroidXDocsImplPlugin.kt

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

au...@google.com <au...@google.com> #6Oct 21, 2022 01:15AM

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

commit c8f5025ba9bf1deb5effbebb7e79683ee7ff9f50
Author: Julia McClellan <juliamcclellan@google.com>
Date: Fri Sep 20 12:31:45 2024

Add JSpecify package-list

Bug: 326456246
Test: checking links in output of `./gradlew docs-tip-of-tree:docs` with aosp/3190072 which switches annotations to jspecify
Change-Id: Ic52ecc37cfb84002ba830dfca6186db2dc5bae67

M buildSrc/private/src/main/kotlin/androidx/build/dackka/DackkaTask.kt
A docs-public/package-lists/jspecify/package-list

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

au...@google.com <au...@google.com> #7Oct 21, 2022 01:28AM

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

commit b05578cabee04fdccd2f24c7e2d6a8b25b94a97a
Author: Julia McClellan <juliamcclellan@google.com>
Date: Mon Sep 23 11:21:48 2024

Add java format task

Will be used by the jspecify update script

Bug: 326456246
Test: `./gradlew core:core:javaFormat`, `./gradlew core:core:javaFormat --fix-imports-only` to check java diffs. `./gradlew paging:paging-guava:javaFormat` to check the task succeeds for a project with no java files

Change-Id: I6027419d4ad520a4bd82decd009d252b7077d8a6

M buildSrc/private/src/main/kotlin/androidx/build/AndroidXImplPlugin.kt
A buildSrc/private/src/main/kotlin/androidx/build/JavaFormat.kt
M gradle/libs.versions.toml

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

au...@google.com <au...@google.com> #8Oct 21, 2022 01:39AM

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

commit 7d0e9ad06dd1a8372872053b882be71ec2208df7
Author: Julia McClellan <juliamcclellan@google.com>
Date: Fri Sep 20 13:55:03 2024

Add script to migrate projects to JSpecify

This script runs lint to update usage of AndroidX nullness annotations to type-use position, switches the imports to point to JSpecify, and adds a dependency in each build.gradle file.

Bug: 326456246
Test: `development/jspecify_update.py` runs over all projects and created aosp/3190072. Tested `development/jspecify_update.py cursoradapter` to run over a specific directory.
Change-Id: Id0b0620d4d2dd12f88bdd6ece6885b8abb7b7843

A development/jspecify_update.py

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

sp...@google.com <sp...@google.com> #9Oct 21, 2022 04:55PM

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

commit 619650cc911ddda040d11f5162d6cdd3bcd48b04
Author: Julia McClellan <juliamcclellan@google.com>
Date: Mon Sep 23 11:38:03 2024

Add kotlin compiler args for JSpecify

These arguments make the kotlin compiler enforce correct usage of jspecify nullness annotations. They will become default in language version 2.1 but are needed until then.

Bug: 326456246
Test: Local testing of running `compileKotlin` when using jspecify nullness incorrectly
Change-Id: I635baf825df0e67d489879dcb2e812b3ee3cffb4

M buildSrc/private/src/main/kotlin/androidx/build/AndroidXImplPlugin.kt

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

sp...@google.com <sp...@google.com> #10Oct 21, 2022 11:30PM

Assigned to au...@google.com.

Project: platform/frameworks/support
Branch: androidx-main
Author: Julia McClellan <juliamcclellan@google.com>
Link: https://android-review.googlesource.com/3277033

Migrate cursoradapter to use JSpecify annotations

Expand for full commit details

Migrate cursoradapter to use JSpecify annotations

CL created by running `development/jspecify_update.py cursoradapter`

This is the first test of switching to JSpecify annotations. cursoradapter was chosen to check that google3 drops go smoothly because:
* Only a few files need updating
* There have been no recent code updates so merge conflicts are unlikely
* There are usages of it in google3
* No other libraries have a tip-of-tree dependency on it

Bug: 326456246
Test: `checkApi`, `lint`, `runErrorProne` for `cursoradapter:cursoradapter`
Relnote: "This library now uses [JSpecify nullness annotations](https://jspecify.dev/), which are type-use. Kotlin developers should use the following compiler arguments to enforce correct usage: -Xjspecify-annotations=strict, -Xtype-enhancement-improvements-strict-mode"

Change-Id: I02c0c11b0cd80d4a725dc78bb1cff0de937927cf

Files:

M cursoradapter/cursoradapter/build.gradle
M cursoradapter/cursoradapter/src/main/java/androidx/cursoradapter/widget/CursorAdapter.java
M cursoradapter/cursoradapter/src/main/java/androidx/cursoradapter/widget/CursorFilter.java
M cursoradapter/cursoradapter/src/main/java/androidx/cursoradapter/widget/ResourceCursorAdapter.java
M cursoradapter/cursoradapter/src/main/java/androidx/cursoradapter/widget/SimpleCursorAdapter.java

Hash: 7be429cb0f283d0ba3f2dfcc3355e7a5eea47a6c
Date: Mon Sep 23 12:09:09 2024

Bug_253219347_gradle_project_bug.zip

153 KB

Download

au...@google.com <au...@google.com> #11Oct 22, 2022 12:05AM

It seems https://android-review.googlesource.com/3277033 is breaking WebRTC somehow.

Here is the error we get when trying to roll the commit (https://ci.chromium.org/ui/p/webrtc/builders/try/android_arm_rel/61313/overview):

ERROR Unresolved dependencies.
//third_party/androidx:androidx_cursoradapter_cursoradapter_java__classes(//build/toolchain/android:android_clang_arm)
  needs //third_party/android_deps:org_jspecify_jspecify_java(//build/toolchain/android:android_clang_arm

Don't really know how to fix this dependency, is this something you've seen somewhere else ?

bug.zip

163 KB

Download

sp...@google.com <sp...@google.com> #12Oct 22, 2022 04:03AM

It looks like you need to add JSpecify as a dependency somewhere. I'm not familiar with WebRTC, what are you trying to merge the commit into, and do you know how new dependencies are normally handled? What build system is it using?

To drop the library to g3, we needed to manually add the new dependency to the BUILD file for the library (cl/681488587).

bug_repro.zip

153 KB

Download

xa...@google.com <xa...@google.com> #13Oct 28, 2022 02:14AM

Reassigned to sp...@google.com.

what are you trying to merge the commit into

So this is a bit convoluted, the commit got in Chromium with https://chromium.googlesource.com/chromium/src/+/33a3497ac8891cb080a811c262c402dd803aa1a5. And the failure occurs when Chromium is rolled into WebRTC.

What build system is it using?

The build system is gn (the same as Chromium).

do you know how new dependencies are normally handled?

Usually new dependencies added in androidx are transparent to WebRTC. I'm actually not sure where the library is defined in the first place.

sp...@google.com <sp...@google.com> #14Oct 28, 2022 03:07PM

FYI issue is fixed @head (no idea how it got fixed), sorry for the spam.

au...@google.com <au...@google.com> #15Oct 28, 2022 04:23PM

I will be adding the dependency to most other AndroidX libraries, so if this comes up again we can try to figure out what changed -- from looking at the build history, it seems to have switched from the dependency error to a different error later in the build with changes https://webrtc-review.googlesource.com/c/src/+/364686 and https://webrtc-review.googlesource.com/c/src/+/364685.

sp...@google.com <sp...@google.com> #16Feb 15, 2023 08:47PM

Marked as fixed.

Right, the new error was unrelated (caused by

https://chromium-review.googlesource.com/c/chromium/src/+/5901711).
When I fixed this one then it just worked ¯\_(ツ)_/¯

> so if this comes up again we can try to figure out what changed
SG, thank you !

na...@google.com <na...@google.com> #17Jul 26, 2023 05:21PM

Project: platform/frameworks/support
Branch: androidx-main
Author: Julia McClellan <juliamcclellan@google.com>
Link: https://android-review.googlesource.com/3287878

Migrate benchmark to use JSpecify annotations

Expand for full commit details

Migrate benchmark to use JSpecify annotations

CL created by running `development/jspecify_update.py benchmark`

We are updating all AndroidX libraries to use the Jspecify nullness annotations (https://docs.google.com/document/d/1XjainD032hUdCfgXIzRThHvP9FJANYuocKaTDXWuLXo/edit?usp=sharing)

Bug: 326456246
Test: `checkApi`, `lint`, `runErrorProne`
Relnote: "This library now uses [JSpecify nullness annotations](https://jspecify.dev/), which are type-use. Kotlin developers should use the following compiler arguments to enforce correct usage: -Xjspecify-annotations=strict, -Xtype-enhancement-improvements-strict-mode"
Change-Id: I7104f0ca68a72a7e996b79f1609cde685e6c61e6

Files:

M benchmark/benchmark-common/build.gradle
M benchmark/benchmark-common/src/main/java/androidx/benchmark/simpleperf/ProfileSession.java
M benchmark/benchmark-common/src/main/java/androidx/benchmark/simpleperf/RecordOptions.java
M benchmark/benchmark-common/src/main/java/androidx/benchmark/vmtrace/ByteBufferUtil.java
M benchmark/benchmark-common/src/main/java/androidx/benchmark/vmtrace/MethodInfo.java
M benchmark/benchmark-common/src/main/java/androidx/benchmark/vmtrace/VmTraceHandler.java
M benchmark/benchmark-common/src/main/java/androidx/benchmark/vmtrace/VmTraceParser.java
M benchmark/benchmark-macro/build.gradle
M benchmark/benchmark-macro/src/main/java/androidx/benchmark/macro/JankCollectionHelper.java

Hash: aa1b06262eb961422573cf16839740a2b1ed232d
Date: Wed Oct 09 09:55:35 2024

Issue 253219347

Description

Issue summary

Comments

sp...@google.com <sp...@google.com> #2Oct 14, 2022 07:39PM

au...@google.com <au...@google.com> #3Oct 17, 2022 04:53PM

au...@google.com <au...@google.com> #4Oct 17, 2022 06:17PM

au...@google.com <au...@google.com> #5Oct 21, 2022 01:00AM

au...@google.com <au...@google.com> #6Oct 21, 2022 01:15AM

au...@google.com <au...@google.com> #7Oct 21, 2022 01:28AM

au...@google.com <au...@google.com> #8Oct 21, 2022 01:39AM

sp...@google.com <sp...@google.com> #9Oct 21, 2022 04:55PM

sp...@google.com <sp...@google.com> #10Oct 21, 2022 11:30PM

au...@google.com <au...@google.com> #11Oct 22, 2022 12:05AM

sp...@google.com <sp...@google.com> #12Oct 22, 2022 04:03AM

xa...@google.com <xa...@google.com> #13Oct 28, 2022 02:14AM

sp...@google.com <sp...@google.com> #14Oct 28, 2022 03:07PM

au...@google.com <au...@google.com> #15Oct 28, 2022 04:23PM

sp...@google.com <sp...@google.com> #16Feb 15, 2023 08:47PM

na...@google.com <na...@google.com> #17Jul 26, 2023 05:21PM

Add comment

Issue metadata