Provide a composable way to handle pre create use cases [161390636]

Fixed

Feature Request

Status Update

No update yet.

Description

il...@google.com

created issue #1

Jul 15, 2020 10:02PM

Component used: Activity Version used: 1.2.0-alpha06

The APIs of LifecycleOwner provide us with a callback for when you reach the CREATED state, but for activities that is often after some critical code needs to run.

For example:

Calling setTheme to reset your theme from a branded launch theme
Calling setLocalNightMode()

These all need to be called before super.onCreate() and specifically the inflation of any layout.

It would be nice if there was a composable way to get a callback at that exact time without needing to manually add code to onCreate() (which, will fine for app code, is hard to do as a library).

Comments

il...@google.com <il...@google.com> Jul 15, 2020 10:02PM

Accepted by il...@google.com.

ap...@google.com <ap...@google.com> #2Jul 22, 2020 11:56PM

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

commit b4a3fe1d53c8c8082cf16795da164c446f7fd912
Author: Ian Lake <ilake@google.com>
Date: Wed Jul 15 14:34:08 2020

Add a hook that fires before the Activity's super.onCreate()

Provide a standard, composable API for libraries and
developers to run code as soon as possible after a
Context is available to an Activity (i.e., before the
logic in the base Activity.onCreate() runs and before any
layout is inflated).

This updates the code in FragmentActivity and
AppCompatActivity to use that new API.

Test: new activity tests pass
Test: existing fragment and appcompat tests still pass
BUG: 161390636
Relnote: "`ComponentActivity` now implements
`ContextAware`, allowing you to add one or more
`OnContextAvailableListener` instances which will
receive a callback before the base `Activity.onCreate()`."

Change-Id: I513da73bc0862b62af4166be35ba353fc7869a09

M activity/activity/api/1.2.0-alpha07.txt
M activity/activity/api/current.txt
M activity/activity/api/public_plus_experimental_1.2.0-alpha07.txt
M activity/activity/api/public_plus_experimental_current.txt
M activity/activity/api/restricted_1.2.0-alpha07.txt
M activity/activity/api/restricted_current.txt
M activity/activity/src/androidTest/java/androidx/activity/ComponentActivityLifecycleTest.kt
A activity/activity/src/androidTest/java/androidx/activity/contextaware/ContextAwareHelperTest.kt
M activity/activity/src/main/java/androidx/activity/ComponentActivity.java
A activity/activity/src/main/java/androidx/activity/contextaware/ContextAware.java
A activity/activity/src/main/java/androidx/activity/contextaware/ContextAwareHelper.java
A activity/activity/src/main/java/androidx/activity/contextaware/OnContextAvailableListener.java
M appcompat/appcompat/build.gradle
M appcompat/appcompat/src/main/java/androidx/appcompat/app/AppCompatActivity.java
M fragment/fragment/src/main/java/androidx/fragment/app/FragmentActivity.java

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

ap...@google.com <ap...@google.com> #3Aug 4, 2020 04:19PM

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

commit 494d98d48e3c95c4338bda7ed1bf46797de257f6
Author: Ian Lake <ilake@google.com>
Date: Mon Aug 03 13:07:36 2020

Deliver the Context when added after it is available

Previously, an OnContextAvailableListener would only
receive a callback if added prior to the Context
being made available.

Rather than allow developers fall into a pitfall
where they add a listener and never receive a
callback, synchronously deliver the currently
available Context to listeners.

Test: updated activity tests pass
BUG: 161390636
Relnote: N/A
Change-Id: I24eff02712c90e84e1998407082e0b07cf04b44a

M activity/activity/api/current.txt
M activity/activity/api/public_plus_experimental_current.txt
M activity/activity/api/restricted_current.txt
M activity/activity/src/androidTest/java/androidx/activity/contextaware/ContextAwareHelperTest.kt
M activity/activity/src/main/java/androidx/activity/ComponentActivity.java
M activity/activity/src/main/java/androidx/activity/contextaware/ContextAware.java
M activity/activity/src/main/java/androidx/activity/contextaware/ContextAwareHelper.java

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

ap...@google.com <ap...@google.com> #4Aug 4, 2020 04:19PM

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

commit 5d11382f47626211d512b9135f6b5f40b88f6647
Author: Ian Lake <ilake@google.com>
Date: Mon Aug 03 12:45:55 2020

Simplify OnContextAvailableListener interface

Rather than pass the ContextAware object,
the Context, and a Bundle for saved instance
state, pass only the Context to the
onContextAvailable() callback.

The ContextAware parameter is not needed in
general (unregistering is a corner case that
can be handled by capturing a reference to the
ContextAware).

The saved instance state Bundle is not needed
when we can ensure that the
SavedStateRegistry has had its state restored
before the listeners are called. This ensures
that all Saved State logic is centralized in
the API specifically built for saving state
rather than leaking into other APIs.

To accomplish this API change, the storage of
FragmentManager's and AppCompatDelegate's saved
state was moved to SavedStateRegistry as part of
FragmentActivity and AppCompatActivity,
respectively. Longer term, FragmentManager and
AppCompatDelegate should provide public APIs for
connecting directly to SavedStateRegistry, but
that is out of scope for this change.

Test: activity, fragment, and appcompat tests pass
BUG: 161390636
Relnote: N/A
Change-Id: I32fdd4b2c4c391c3fa97158dbd7508fa96b08d7a

M activity/activity/api/current.txt
M activity/activity/api/public_plus_experimental_current.txt
M activity/activity/api/restricted_current.txt
M activity/activity/src/androidTest/java/androidx/activity/ComponentActivityLifecycleTest.kt
M activity/activity/src/androidTest/java/androidx/activity/ComponentActivitySavedStateTest.kt
M activity/activity/src/androidTest/java/androidx/activity/contextaware/ContextAwareHelperTest.kt
M activity/activity/src/main/java/androidx/activity/ComponentActivity.java
M activity/activity/src/main/java/androidx/activity/contextaware/ContextAwareHelper.java
M activity/activity/src/main/java/androidx/activity/contextaware/OnContextAvailableListener.java
M appcompat/appcompat/src/main/java/androidx/appcompat/app/AppCompatActivity.java
M fragment/fragment/src/androidTest/java/androidx/fragment/app/FragmentArchLifecycleTest.kt
M fragment/fragment/src/main/java/androidx/fragment/app/FragmentActivity.java

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

ap...@google.com <ap...@google.com> #5Aug 12, 2020 06:46PM

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

commit d830158f1671930bab215716e329349a42eec1dd
Author: Ian Lake <ilake@google.com>
Date: Fri Jul 31 14:14:29 2020

Add suspending withContextAvailable to ContextAware

Expand the ContextAware interface to allow developers
to synchronously peek to see if the context is
availble.

This allows us to write a Kotlin extension
withContextAvailable() that runs a non-suspending
block once the context becomes available (either
synchronously if it is already available or by
using a OnContextAvailableListener under the hood
if not).

Test: new tests pass
BUG: 161390636
Relnote: "Added a `peekAvailableContext()` API to
`ContextAware` to allow you to synchronously determine
if a Context is available. A suspending Kotlin extension
`withContextAvailable()` allows you to run a
non-suspending block when the Context becomes available
and return a result."

Change-Id: I8290cd9de8231913036d23a233c177ed45d2d370

M activity/activity-ktx/api/current.txt
M activity/activity-ktx/api/public_plus_experimental_current.txt
M activity/activity-ktx/api/restricted_current.txt
A activity/activity-ktx/src/androidTest/java/androidx/activity/contextaware/ContextAwareTest.kt
A activity/activity-ktx/src/main/java/androidx/activity/contextaware/ContextAware.kt
M activity/activity/api/current.txt
M activity/activity/api/public_plus_experimental_current.txt
M activity/activity/api/restricted_current.txt
M activity/activity/src/androidTest/java/androidx/activity/contextaware/ContextAwareHelperTest.kt
M activity/activity/src/main/java/androidx/activity/ComponentActivity.java
M activity/activity/src/main/java/androidx/activity/contextaware/ContextAware.java
M activity/activity/src/main/java/androidx/activity/contextaware/ContextAwareHelper.java

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

il...@google.com <il...@google.com> #6Aug 12, 2020 08:18PM

Marked as fixed.

The new ContextAware API will be available in Activity 1.2.0-alpha08 and is used by Fragment 1.3.0-alpha08 and AppCompat 1.3.0-alpha02 to implement FragmentManager's and AppCompatDelegate's pre-onCreate() logic.

e....@gmail.com <e....@gmail.com> #7Aug 19, 2020 06:17PM

Wait, this can't work as advertised.

FragmentActivity extends ComponentActivity

public FragmentActivity(@LayoutRes int contentLayoutId) {
    super(contentLayoutId);
    init();
}

private void init() {
    addOnContextAvailableListener(new OnContextAvailableListener() {
        // ...
    }
}

ComponentActivity

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
    // ...
    mContextAwareHelper.dispatchOnContextAvailable(this);
    super.onCreate(savedInstanceState);
    //...
}

Call FragmentActivity constructor,
which calls ComponentActivity super constructor,
which dispatches context available... to noone,
and calls platform Activity.onCreate.
Bubble up to FragmentActivity constructor and register context listener,
which is invoked synchronously but only after platform Activity.onCreate has already been called.

Did I miss something? I'm confused.

e....@gmail.com <e....@gmail.com> #8Aug 19, 2020 06:34PM

Never mind, constructor vs onCreate. :facepalm: Sorry.

il...@google.com <il...@google.com> #9Aug 19, 2020 06:43PM

Re #8 - the fact that these are different things is indeed exactly why this API exists :)

sl...@gmail.com <sl...@gmail.com> #10Jan 21, 2021 10:29AM

https://docs.google.com/document/d/1hyftTRyqV7ZJ5s2b_-Q9K6RJdpgedgvKP4vYoTK7i1A/edit?usp=drive_web ([Feedback] Bass Booster)