-
Notifications
You must be signed in to change notification settings - Fork 6.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Read library glide module names from Java indexes #5052
Merged
copybara-service
merged 1 commit into
bumptech:master
from
sjudd:handle_java_indexes_in_ksp_processor
Mar 8, 2023
Merged
Read library glide module names from Java indexes #5052
copybara-service
merged 1 commit into
bumptech:master
from
sjudd:handle_java_indexes_in_ksp_processor
Mar 8, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Progress for bumptech#5043 Annotation processors (including ksp) only run on newly compiled code. Libraries have been previously compiled, so an annotation processor will not be run on them. To find any LibraryGlideModules included in those libraries, we look for specific generated classes in those libraries that we call Indexes. Indexes contain an annotation listing the class names of any LibraryGlideModules. Indexes are generated by Glide's annotation processors for each library and are exported as part of the library. To preserve the package private visibility of the existing Java Index annotation, I created a new Index annotation for the KSP processor. This lets us reference the KSP Index annotation directly. Unfortunately it also means that the Java and KSP Index classes are not the same. While it's only a small amount of duplicated code, it's a significant compatibility issue because the KSP and Java processors no longer produce the same Index class. In particular the KSP processor looks only for its Index class and not for the Java processor's Index class. This is unfortunate because Glide's libraries are always processed by the Java annotation processor, not the KSP processor. In turn this means that Glide's KSP processor effectively ignores any of Glide's integration libraries. To fix this in the short term I've made the KSP processor look for both its Indexes and the Java annotation processors Indexes. A more robust fix would be to merge the two Index processors so that the annotation processors are mutually compatible. I'll do that in a follow-up. I've written tests, but they're somewhat involved so I'll send them as a follow-up.
c600e4b
to
16306e8
Compare
nikclayton
added a commit
to pachli/pachli-android
that referenced
this pull request
Oct 13, 2023
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [com.github.bumptech.glide:okhttp3-integration](https://github.com/bumptech/glide) | `4.15.1` -> `4.16.0` | [![age](https://developer.mend.io/api/mc/badges/age/maven/com.github.bumptech.glide:okhttp3-integration/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/com.github.bumptech.glide:okhttp3-integration/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/com.github.bumptech.glide:okhttp3-integration/4.15.1/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/com.github.bumptech.glide:okhttp3-integration/4.15.1/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [com.github.bumptech.glide:glide](https://github.com/bumptech/glide) | `4.15.1` -> `4.16.0` | [![age](https://developer.mend.io/api/mc/badges/age/maven/com.github.bumptech.glide:glide/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/com.github.bumptech.glide:glide/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/com.github.bumptech.glide:glide/4.15.1/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/com.github.bumptech.glide:glide/4.15.1/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [com.github.bumptech.glide:ksp](https://github.com/bumptech/glide) | `4.15.1` -> `4.16.0` | [![age](https://developer.mend.io/api/mc/badges/age/maven/com.github.bumptech.glide:ksp/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/com.github.bumptech.glide:ksp/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/com.github.bumptech.glide:ksp/4.15.1/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/com.github.bumptech.glide:ksp/4.15.1/4.16.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>bumptech/glide (com.github.bumptech.glide:okhttp3-integration)</summary> ### [`v4.16.0`](https://github.com/bumptech/glide/releases/tag/v4.16.0): Glide 4.16.0 This release focuses on some build improvements and Compose. The two major Compose improvements are adding support for Compose specific transitions (e.g. cross fade) and supporting recomposition based on request state using `GlideSubcomposition`. There's also been a bunch of internal refactoring to move away from Painters to Modifier nodes based on feedback from the Compose team. This is still an alpha release of Compose, but barring unexpectedly negative feedback, the next release should be beta. This should be the last release of Glide that targets Java 7. That probably means our next release will be a major version change. ##### Features - Allow passing an executor into ChromiumRequestSerializer in [bumptech/glide#5077 - Allow host app to provide a way to clear all resources onStop() by [@​osamaaftab](https://github.com/osamaaftab) in [bumptech/glide#5145 ##### Compose - Add a Transition API and a CrossFade Transition for Compose by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5235 - Influence layout using intrinsics in GlideNode by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5240 \* Log instead of throwing parsing manifests to fix compose previews by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5167 - Launch no more than one request per onRemembered by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5062 - Remove GlidePainter in favor of Modifier nodes / Flows by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5230 - Replace flows in GlideSubcomposition with a listener on GlideNode by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5238 ##### Bugs - Read library glide module names from Java indexes by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5052 - Fix typo. anay -> any in GlideSymbolProcessor.kt. by [@​trevorhackman](https://github.com/trevorhackman) in [bumptech/glide#5029 - Include URL in error log by [@​paulsowden](https://github.com/paulsowden) in [bumptech/glide#5164 - Add `isInitialized` visible for testing method by [@​paulsowden](https://github.com/paulsowden) in [bumptech/glide#5163 - Use onIdle to avoid a race in FlowTests by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5202 - Add a isEquivalentTo method to correctly check equality by [@​mori-atsushi](https://github.com/mori-atsushi) in [bumptech/glide#5232 - Add [@​RequiresPermission](https://github.com/RequiresPermission) to NotificationTarget by [@​TWiStErRob](https://github.com/TWiStErRob) in [bumptech/glide#5220 ##### Deprecations - `placeholderOf(@​Composable)` in `GlideImage` is deprecated, use `GlideSubcomposition` instead. Keep in mind that using either forces a recomposition each time the state of the image load changes. Recomposition will have a significant performance penalty in scrolling lists and should be avoided. ##### Behavior Changes - Hard code disabling hardware bitmaps on O/OMR1. by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5115 - Do not set requireOriginal on Android photo picker uris. by [@​phoenixli](https://github.com/phoenixli) in [bumptech/glide#5162 ##### Breaking Changes ##### Build Changes - Add integration tests for ksp library modules. by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5054 - Update README.md to use https by [@​simoarpe](https://github.com/simoarpe) in [bumptech/glide#5058 - Use dokka to build scripts/update_javadocs.sh by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5104 - avif integration: Update libavif dependency by [@​vigneshvg](https://github.com/vigneshvg) in [bumptech/glide#5128 - Disable java 7 source obsolete warning. by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5168 - Update mockito version to fix j16 compilation. by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5169 - Switch Glide's dependencies to a version catalog. by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5183 - Remove jetifier by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5184 - Add an updated proguard plugin to compile on Java 17. by [@​sjudd](https://github.com/sjudd) in [bumptech/glide#5185 - Configure Renovate in [bumptech/glide#5186 - Increment ROBOLECTRIC_SDK to 19 from 18. by [@​brettchabot](https://github.com/brettchabot) in [bumptech/glide#5208 and [bumptech/glide#5207 - AGP: Upgrade AndroidManifest.xml's package to build.gradle's namespace. by [@​TWiStErRob](https://github.com/TWiStErRob) in [bumptech/glide#5221 ##### New Contributors - [@​trevorhackman](https://github.com/trevorhackman) made their first contribution in [bumptech/glide#5029 - [@​simoarpe](https://github.com/simoarpe) made their first contribution in [bumptech/glide#5058 - [@​paulsowden](https://github.com/paulsowden) made their first contribution in [bumptech/glide#5164 - [@​phoenixli](https://github.com/phoenixli) made their first contribution in [bumptech/glide#5162 - [@​osamaaftab](https://github.com/osamaaftab) made their first contribution in [bumptech/glide#5145 - [@​brettchabot](https://github.com/brettchabot) made their first contribution in [bumptech/glide#5207 - [@​mori-atsushi](https://github.com/mori-atsushi) made their first contribution in [bumptech/glide#5232 **Full Changelog**: bumptech/glide@v4.15.0...v4.16.0 Note - there's been a change in the gpg key used to sign these releases. The new public key is attached </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/pachli/pachli-android). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4xMDcuMiIsInVwZGF0ZWRJblZlciI6IjM3LjguMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Nik Clayton <nik@ngo.org.uk>
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Progress for #5043
Annotation processors (including ksp) only run on newly compiled code. Libraries have been previously compiled, so an annotation processor will not be run on them. To find any LibraryGlideModules included in those libraries, we look for specific generated classes in those libraries that we call Indexes. Indexes contain an annotation listing the class names of any LibraryGlideModules. Indexes are generated by Glide's annotation processors for each library and are exported as part of the library.
To preserve the package private visibility of the existing Java Index annotation, I created a new Index annotation for the KSP processor. This lets us reference the KSP Index annotation directly.
Unfortunately it also means that the Java and KSP Index classes are not the same. While it's only a small amount of duplicated code, it's a significant compatibility issue because the KSP and Java processors no longer produce the same Index class.
In particular the KSP processor looks only for its Index class and not for the Java processor's Index class. This is unfortunate because Glide's libraries are always processed by the Java annotation processor, not the KSP processor. In turn this means that Glide's KSP processor effectively ignores any of Glide's integration libraries.
To fix this in the short term I've made the KSP processor look for both its Indexes and the Java annotation processors Indexes. A more robust fix would be to merge the two Index processors so that the annotation processors are mutually compatible. I'll do that in a follow-up.
I've written tests, but they're somewhat involved so I'll send them as a follow-up.