Support Gradle incremental annotation processing [112110217]

Fixed

Feature Request

Status Update

No update yet.

Description

da...@google.com

created issue #1

Aug 1, 2018 11:57PM

See:

https://docs.gradle.org/nightly/userguide/java_plugin.html#sec:incremental_annotation_processing

Comments

da...@google.com <da...@google.com> #2Mar 15, 2019 05:56PM

Please include a sample project that reproduces your issue.

to...@gmail.com <to...@gmail.com> #3Apr 12, 2019 09:13AM

Sample project attached. Just add to plain project this dependencies allow to reproduce.

def emoji2_version = "1.1.0-beta01"
implementation "androidx.emoji2:emoji2:$emoji2_version"

def lifecycle_version = "2.5.0-alpha01"
implementation "androidx.lifecycle:lifecycle-process:$lifecycle_version"

se...@gmail.com <se...@gmail.com> #4Apr 12, 2019 09:16AM

The reason may be related to this change, which check itself before it is initialized. Use 2.4.0 of lifecycle-process as workaround.

to...@gmail.com <to...@gmail.com> #5May 21, 2019 01:25PM

Yes, this is due to this change, as well as the fact that EmojiCompatInitializer has a ProcessLifecycleInitializer as a dependency and also re-calls it, but in manual mode.

da...@google.com <da...@google.com> #6May 21, 2019 03:33PM

ProcessLifecycleInitializer is expected to already be initialized (via the manifest provider for App Startup) by the time that code runs - App Startup shouldn't be calling create if that component has already been initialized, hence you shouldn't get any exception. We'll take a look on where things are breaking down though.

ap...@google.com <ap...@google.com> #7May 29, 2019 10:54PM

Thanks for the answer.

As I understand EmojiCompatInitializer has ProcessLifecycleInitializer as a dependency. That is mean, the ProcessLifecycleInitializer must be executed before the EmojiCompatInitializer, which in its create method calls the delayUntilFirstResume method, which in turn calls the ProcessLifecycleInitializer via appInitializer.initializeComponent(ProcessLifecycleInitializer.class)

Maybe it would be more correct to create a bug in emoji-2, but let it be here.

ap...@google.com <ap...@google.com> #8May 30, 2019 06:10PM

This issue isn't related to emoji2, it could be reproduced easily with the lifecycle-process (2.4.0 -> 2.5.0-alpha01) only.

ap...@google.com <ap...@google.com> #9Jun 6, 2019 05:23PM

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

commit 97993ad954cb98211ef52b6e26c7877dbdeeec1c
Author: Jeremy Woods <jbwoods@google.com>
Date: Tue Feb 01 17:06:11 2022

Bump lifecycle process start-up dependency to 1.1.1

Bumping the startup dependency to include aosp/1855769.

RelNote: "Updated `lifecycle-process` to depend on [Startup 1.1.1](/jetpack/androidx/releases/startup#1.1.1) to ensure that fixes that prevent `ProcessLifecycleInitializer` from throwing a `StartupException` are available by default."
Bug: 216490724
Test: tested in sample app

Change-Id: Ib01dfbba1d63aa03e43e09ee8886cc76e1050e1b

M lifecycle/lifecycle-process/build.gradle

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

ap...@google.com <ap...@google.com> #10Jun 7, 2019 07:15PM

This has been fixed internally and will be released in the Lifecycle 2.5.0-alpha02 release.

da...@google.com <da...@google.com> #11Jun 7, 2019 07:40PM

Marked as fixed.

When will start-up 1.1.1 release?

to...@avast.com <to...@avast.com> #12Jun 28, 2019 10:38AM

It should be out before the end of the week.

yb...@google.com <yb...@google.com> #13Jun 28, 2019 07:17PM

in a couple of weeks, we should have it.

mi...@gtempaccount.com <mi...@gtempaccount.com> #14Oct 10, 2019 05:19AM

I updated to 2.2.0 stable release and added the option "room.incremental = true" to my gradle properties.
But I am still seeing this warning:
w: [kapt] Incremental annotation processing requested, but support is disabled because the following processors are not incremental: androidx.room.RoomProcessor (DYNAMIC).

mi...@gtempaccount.com <mi...@gtempaccount.com> #15Oct 10, 2019 05:30AM

Sorry about my last comment. I just saw I configured it wrong. It is not supposed to be se tin the gradle.properties, but in the annotationProcessorOptions.

android {
...
defaultConfig {
...
javaCompileOptions {
annotationProcessorOptions {
arguments = [
"room.schemaLocation":"$projectDir/schemas".toString(),
"room.incremental":"true",
"room.expandProjection":"true"]
}
}
}
}

co...@protonmail.com <co...@protonmail.com> #16Jan 23, 2020 07:03AM

@Yigit Will a future version of room have this enabled by default?

yb...@google.com <yb...@google.com> #17Jan 23, 2020 05:30PM

yes, it will be but we are looking for some feedback before we make the switch just to be safe and not break other people.

ap...@google.com <ap...@google.com> #18Jun 18, 2020 05:41PM

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

commit 2715143f2b6f2b74a088b242b39c9841d2d8dcf2
Author: Daniel Santiago Rivera <danysantiago@google.com>
Date: Thu Jun 18 09:54:58 2020

Make room.incremental default be true

Relnote: Room's incremental annotation processing option is now ON by default.
Bug: 112110217
Test: :room:integration-tests:room-i-a-p:test
Change-Id: If46d955da45d985543ab982bd0e9d27bbd961517

M room/compiler/src/main/kotlin/androidx/room/processor/Context.kt

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

bl...@gmail.com <bl...@gmail.com> #19Aug 20, 2020 08:45AM

Is it switched on by default in 2.2.5? Because I still got the message got a warning from kapt

[WARN] Incremental annotation processing requested, but support is disabled because the following processors are not incremental: androidx.room.RoomProcessor (DYNAMIC).

Solved to adding "room.incremental"="true" in the annotation params.

bl...@gmail.com <bl...@gmail.com> #20Aug 20, 2020 08:46AM

Oops, spoke too soon. First appears in the release notes for 2.3.0:

https://developer.android.com/jetpack/androidx/releases/room#2.3.0-alpha02

hu...@google.com <hu...@google.com> #21Sep 17, 2020 09:27PM

KNOWN ISSUE: Note that incremental Room is currently broken in some cases (Issue 159501719), so we may need to revert this change or send out a patch to at least provide workarounds to users. https://issuetracker.google.com//159501719#comment18 lists the possible fixes.

hu...@google.com <hu...@google.com> #22Sep 17, 2020 09:33PM

Sorry there was a typo, correction: https://issuetracker.google.com/159501719#comment18