LocalConfiguration can become out of sync from the Activity configuration [247143459]

Bug

Status Update

No update yet.

Description

va...@google.com

created issue #1

Sep 16, 2022 08:42PM

Conditions:

API 32 or API 33
An activity that is not opting out of screen size related config changes (android:configChanges is empty or only has unrelated entries)
No resources that differ between the corresponding window sizes

When resizing the activity in multi-window mode under those conditions, there are cases where:

the Activity is not recreated
Activity.onConfigurationChanged is not called
View.onConfigurationChanged is not called

Because LocalConfiguration.current is driven by View.onConfigurationChanged at the moment, this results in LocalConfiguration.current not updating, and getting out of sync with the underlying Activity configuration.

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        setContent {
            LaunchedEffect(Unit) {
                while(true) {
                    delay(1000)
                    Log.d("vanyo", "activity configuration: ${resources.configuration}")
                }
            }
            Log.d("vanyo", "LocalConfiguration ${LocalConfiguration.current}")
        }
    }
}

In the above, constantly polling for the Activity configuration reveals that it is changing (when resizing happens), but LocalConfiguration.current does not update.

This particularly matters for material3-window-size-class, since the LocalConfiguration.current is used as a signal to relcalculate the window metrics

Workarounds or potential fixes:

Find an alternate signal to update LocalConfiguration.current to the current configuration, since View.onConfigurationChanged may not always be called
Specify android:configChanges for the screen size changes, to ensure that View.onConfigurationChanged is called
Add resources that intentionally influence the "buckets" to ensure that the Activity is recreated

Comments

va...@google.com <va...@google.com> #2Sep 16, 2022 09:56PM

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

device-2022-09-16-145443.webm

9.9 MB

Download

lp...@google.com <lp...@google.com> #3Sep 20, 2022 04:38PM

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

lp...@google.com <lp...@google.com> #4Sep 20, 2022 04:39PM

Tracking sheet for which projects have been migrated.

va...@google.com <va...@google.com> #5Sep 20, 2022 04:56PM

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

va...@google.com <va...@google.com> #6Sep 21, 2022 09:55PM

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

Message last modified on Sep 21, 2022 09:55PM

js...@google.com <js...@google.com> #7Sep 24, 2022 10:26AM

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

ar...@gmail.com <ar...@gmail.com> #8Nov 6, 2022 05:45AM

Comment has been deleted.

Message last modified on Jan 19, 2023 04:47PM

te...@gmail.com <te...@gmail.com> #9Jun 28, 2024 09:52AM

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

va...@google.com <va...@google.com> #10Jun 28, 2024 03:47PM

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

te...@gmail.com <te...@gmail.com> #11Jun 28, 2024 04:17PM

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 ?

pe...@gmail.com <pe...@gmail.com> #12Oct 26, 2024 12:34PM

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).

pe...@gmail.com <pe...@gmail.com> #13Oct 26, 2024 12:35PM

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.