google-java-format (and removeUnusedImports) broken on JDK 16+ (has workaround) #834

lazystone · 2021-04-07T10:15:48Z

When running under JDK 16 I get this error message:

Task :spotlessJava FAILED
Step 'google-java-format' found problem in 'src/main/java/se/inoviagroup/v2t/gateway/api/AuthUtils.java':
        ...
Caused by: java.lang.IllegalAccessError: class com.google.googlejavaformat.java.JavaInput (in unnamed module @0x615edab4) cannot access class com.sun.tools.javac.parser.Tokens$TokenKind (in module jdk.compiler) because module jdk.compiler does not export com.sun.tools.javac.parser to unnamed module @0x615edab4
        at com.google.googlejavaformat.java.JavaInput.buildToks(JavaInput.java:349)
        at com.google.googlejavaformat.java.JavaInput.buildToks(JavaInput.java:334)
        at com.google.googlejavaformat.java.JavaInput.<init>(JavaInput.java:276)
        at com.google.googlejavaformat.java.Formatter.getFormatReplacements(Formatter.java:280)
        at com.google.googlejavaformat.java.Formatter.formatSource(Formatter.java:267)
        at com.google.googlejavaformat.java.Formatter.formatSource(Formatter.java:233)
        ... 142 more

EDIT:

EDIT 2 & 3

we thought no workaround necessary starting with plugin-gradle 6.5.1 and plugin-maven 2.22.3, but that was incorrect, the workaround is still required

The text was updated successfully, but these errors were encountered:

nedtwigg · 2021-04-07T17:38:34Z

I think this can be worked-around if we somehow add these flags to the JVM which runs Gradle.

  --add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED \
  --add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED \
  --add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED \
  --add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED \
  --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED \

The deeper fix will be related to #724.

jmaicher · 2021-04-12T06:29:46Z

This can be done in maven via MAVEN_OPTS or ${maven.projectBasedir}/.mvn/jvm.config, see https://maven.apache.org/configure.html

dymk · 2021-04-13T23:38:26Z

@nedtwigg The following can be added to your gradle.properties to work-around the bug:

org.gradle.jvmargs=--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED \
  --add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED \
  --add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED \
  --add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED \
  --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED

- update gradle.properties for spotless jdk16 work around - diffplug/spotless#834

ZacSweers · 2021-05-02T23:24:56Z

Edit: Nevermind! I had an override of jvmargs in my gradle home that was overridding this

anuraaga · 2021-05-14T06:55:51Z

I tried playing with the Worker API for running Spotless. As a PoC, I could get GoogleJavaFormatIntegrationTest to pass

https://github.com/diffplug/spotless/compare/main...anuraaga:worker?expand=1

It was nice seeing how so much of the configuration is serializable, presumably to satisfy Gradle cache, which is a requirement for the Worker API. However, not all of it is, for example

https://github.com/diffplug/spotless/compare/main...anuraaga:worker?expand=1#diff-fb99f7a4cb3e09aa538ffb82c60c7119d0eddfb92fd93af98cb6337df1e87476R47
https://github.com/diffplug/spotless/compare/main...anuraaga:worker?expand=1#diff-b8ce946c3dca62f457228d3530c14e442ccdefe8e6619965cd3c2bcebf9e0d94R103

Can any team member skim through that PR to see if it seems feasible at all? If it is I can continue with it but it's quite invasive so want to get a sanity check first.

nedtwigg · 2021-05-14T16:57:21Z

Thanks for the investigation! It is promising. In your draft, there are a few places where a transient String/File path becomes non-transient. These classes are compared for equality based on their serialized representation. By making them non-transient, the remote build cache will no longer work, because task inputs are now keyed on absolute paths.

The root of this problem is LazyForwardingEquality. Pretty much everything in Spotless derives from this. This class allowed us to avoid implementing .equals() and .hashCode() in a lot of places, and it also allowed us to do lazy configuration back in Gradle 2.x, before Gradle had task configuration avoidance.

I think there are two different, but not exactly mutually exclusive paths forward:

Rename LazyForwardingEquality to LazySerializedEquality, and make a new class LazyDelegatedEquality which actually calls .equals() on the state object rather than comparing serialized bytes. This will require writing more boilerplate code, but it allows us to put absolute paths into objects without breaking remote build cache.
Give up on FormatterStep supporting .equals(), and instead have it provide List<File> inputFiles() and Object inputProp(). We would explicitly pass these to Gradle's own up-to-date mechanisms, rather than swallowing them up into our own .equals().

If you are interested in continuing the experiment, open a draft PR and we can continue from there. These improvements are also on the path to properly supporting the Gradle configuration cache.

* The workaround to make google-java-format work described in diffplug/spotless#834 requires raising the minimum build requirement to JDK 11. * Runtime compatibility with JDK 8 is ensured by using the '--release' compiler flag.

details see: diffplug/spotless#834

- https://github.com/google/google-java-format#jdk-16 - diffplug/spotless#834

As explained in the [spotless issue tracker](diffplug/spotless#834), there is an outstanding issue with the google formatter depending on JDK internals. We add the flags listed there to avoid module errors when running spotless. After upgrading and rerunning `spotlessApply`, several stray semicolons became apparent and have now been removed.

* Bump JDA version to 324 (#31) Updates JDA (they forgot something with slash-commands, has been added now) * Add spotless integration This hopefully makes formatting more consistent. The Eclipse XML style was chosen as it is understood by Eclipse, VSC (JDT), Spotless and mostly by IntelliJ. * Make gradelew executable * Add "Remove unused imports" setting to spotless Co-authored-by: Marko Radosavljević <marko@radosavljevic.dev> * Remove unused imports to fix diffplug/spotless#834 (#35) Co-authored-by: I-Al-Istannen <i-al-istannen@users.noreply.github.com> Co-authored-by: Marko Radosavljević <marko@radosavljevic.dev> Co-authored-by: Jonas <jnhrd254@gmail.com>

ascopes · 2021-09-12T10:07:47Z

@nedtwigg

I think this can be worked-around if we somehow add these flags to the JVM which runs Gradle.

It is worth being wary of doing this, since passing these flags will cause javac for JDK 1.8 to fail, as the flags are unsupported.

See diffplug/spotless#834 (comment)

Fixes same problem as deepjavalibrary/djl-serving#184 using workaround described in diffplug/spotless#834 and found in https://github.com/diffplug/spotless/tree/main/plugin-gradle#google-java-format.

Fixes #184 Uses workaround described in diffplug/spotless#834 and found in https://github.com/diffplug/spotless/tree/main/plugin-gradle#google-java-format.

See diffplug/spotless#834 Signed-off-by: Jan N. Klug <github@klug.nrw>

Fixes same problem as deepjavalibrary/djl-serving#184 using workaround described in diffplug/spotless#834 and found in https://github.com/diffplug/spotless/tree/main/plugin-gradle#google-java-format.

…thanks to diffplug#1224 and diffplug#1228.

Read more about the spotless fix here diffplug/spotless#834

See diffplug/spotless#834 Signed-off-by: Jan N. Klug <github@klug.nrw>

* Raise source level to Java 17 (except for model classes) * Remove Nashorn script engine * Upgrade spotless and add jvm options See diffplug/spotless#834 * Add suppression for findBugs false positive error * Upgrade xtext to 2.29.0 * Adjust JNA * Resolve itests Signed-off-by: Jan N. Klug <github@klug.nrw>

diffplug/spotless#834 (comment)

* Raise source level to Java 17 (except for model classes) * Remove Nashorn script engine * Upgrade spotless and add jvm options See diffplug/spotless#834 * Add suppression for findBugs false positive error * Upgrade xtext to 2.29.0 * Adjust JNA * Resolve itests Signed-off-by: Jan N. Klug <github@klug.nrw> GitOrigin-RevId: 41ba3ff

poojaverma009 · 2023-11-27T11:09:02Z

Is there any way to resolve this without updating gradle.proerties file with below
org.gradle.jvmargs=--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
--add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
--add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
--add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
--add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED

tisonkun · 2023-11-27T11:13:34Z

@poojaverma009 upgrade to the latest Spotless. It's resolved.

poojaverma009 · 2023-11-27T11:20:47Z

I am trying to update my project from jdk version 11 to 17 but I am getting below error
Step 'removeUnusedImports' found problem in 'functional-tests/src/main/java/com/comp/atlas/oyo/upgrade/configuration/TesterConfiguration.java':
null
java.lang.reflect.InvocationTargetException
at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at com.diffplug.spotless.java.GoogleJavaFormatStep$State.lambda$constructRemoveUnusedFunction$3(GoogleJavaFormatStep.java:190)
at com.diffplug.spotless.java.GoogleJavaFormatStep$State.lambda$createRemoveUnusedImportsOnly$1(GoogleJavaFormatStep.java:167)
at com.diffplug.spotless.FormatterFunc.apply(FormatterFunc.java:32)
at com.diffplug.spotless.FormatterStepImpl$Standard.format(FormatterStepImpl.java:78)
at com.diffplug.spotless.FormatterStep$Strict.format(FormatterStep.java:76)
at com.diffplug.spotless.Formatter.compute(Formatter.java:230)
at com.diffplug.spotless.PaddedCell.calculateDirtyState(PaddedCell.java:201)
at com.diffplug.spotless.PaddedCell.calculateDirtyState(PaddedCell.java:188)
at com.diffplug.gradle.spotless.SpotlessTaskImpl.processInputFile(SpotlessTaskImpl.java:71)
at com.diffplug.gradle.spotless.SpotlessTaskImpl.performAction(SpotlessTaskImpl.java:57)
at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at org.gradle.internal.reflect.JavaMethod.invoke(JavaMethod.java:125)
at org.gradle.api.internal.project.taskfactory.IncrementalInputsTaskAction.doExecute(IncrementalInputsTaskAction.java:32)
at org.gradle.api.internal.project.taskfactory.StandardTaskAction.execute(StandardTaskAction.java:51)
at org.gradle.api.internal.project.taskfactory.AbstractIncrementalTaskAction.execute(AbstractIncrementalTaskAction.java:25)
at org.gradle.api.internal.project.taskfactory.StandardTaskAction.execute(StandardTaskAction.java:29)

tisonkun · 2023-11-27T11:27:39Z

@poojaverma009 which version of spotless do you use?

poojaverma009 · 2023-11-27T11:31:38Z

spotlessVersion = '5.14.3'

tisonkun · 2023-11-27T11:34:55Z

This is fixed by #1224 and #1228 so use a version >= 6.7.1 should work.

This is what I mean by:

@poojaverma009 upgrade to the latest Spotless. It's resolved.

poojaverma009 · 2023-11-27T12:39:03Z

Thanks
It worked

nedtwigg changed the title ~~Gradle: spotlessApply fails under JDK 16~~ google-java-format broken on JDK 16+ Apr 7, 2021

nedtwigg added the bug label Apr 7, 2021

popfalushi mentioned this issue Apr 16, 2021

Java 16 + gradle 7.0 compatibility grpc-ecosystem/grpc-spring#520

Merged

nedtwigg mentioned this issue Apr 20, 2021

Non-reproducible behavior around dependency verification with Spotless plugin #815

Closed

flyingfishflash added a commit to flyingfishflash/ledger that referenced this issue Apr 29, 2021

refactor(ci): gradle 7.0.0 on jdk16

aeec972

- update gradle.properties for spotless jdk16 work around - diffplug/spotless#834

nedtwigg mentioned this issue May 19, 2021

Exception formatting switch expressions google/google-java-format#477

Closed

nedtwigg mentioned this issue Jun 1, 2021

removeUnusedImports fails on Java 17 #871

Closed

4 tasks

iemejia mentioned this issue Jun 1, 2021

Java 17 compatibility google/google-java-format#612

Closed

marcphilipp added a commit to junit-team/junit5 that referenced this issue Jun 4, 2021

Work around diffplug/spotless#834

faa56b1

connoratrug added a commit to molgenis/molgenis-emx2 that referenced this issue Jun 10, 2021

fix: Add workaround for running gradle spotless plugin with jdk 16

b15ffc0

details see: diffplug/spotless#834

nedtwigg changed the title ~~google-java-format broken on JDK 16+~~ google-java-format (and removeUnusedImports) broken on JDK 16+ (has workaround) Jun 15, 2021

cpovirk added a commit to jspecify/jspecify that referenced this issue Jul 8, 2021

Keep spotlessCheck working with JAVA_HOME set to JDK16+.

6aef68b

- https://github.com/google/google-java-format#jdk-16 - diffplug/spotless#834

bryanateoan mentioned this issue Aug 27, 2021

update build java version to 16 Contrast-Security-OSS/contrast-sdk-java#105

Closed

kwvanderlinde mentioned this issue Sep 1, 2021

Upgrade spotless gradle plugin to 5.14.3 RPTools/maptool#2932

Merged

nedtwigg mentioned this issue Sep 1, 2021

Using Maven Plugin with Java 14 results in an exception #923

Closed

6 tasks

marandaneto mentioned this issue Sep 2, 2021

Bump AGP to 7.0.2 getsentry/sentry-java#1650

Merged

4 tasks

illuminator3 mentioned this issue Sep 8, 2021

Fix spotless Together-Java/TJ-Bot#35

Merged

illuminator3 added a commit to Together-Java/TJ-Bot that referenced this issue Sep 8, 2021

Remove unused imports to fix diffplug/spotless#834 (#35)

0df17f3

Tais993 mentioned this issue Sep 8, 2021

Pull'd develop branch Together-Java/TJ-Bot#36

Closed

nakamura-to added a commit to domaframework/doma-it that referenced this issue Sep 13, 2021

Use google-java-format 1.11.0.

522b527

See diffplug/spotless#834 (comment)

zachgk mentioned this issue Aug 2, 2022

Updates to gradle 7.5 and fix formatter deepjavalibrary/djl-serving#189

Merged

aidar-stripe mentioned this issue Aug 4, 2022

Enforce java compilation version in pom apache/pinot#9139

Open

J-N-K added a commit to J-N-K/openhab-core that referenced this issue Aug 19, 2022

upgrade spotless and add jvm options

58dc7b7

See diffplug/spotless#834 Signed-off-by: Jan N. Klug <github@klug.nrw>

asfimport mentioned this issue Dec 8, 2021

Build does not work with JDK16 as gradle's runtime [LUCENE-10066] apache/lucene#11104

Closed

nedtwigg added a commit to mernst/spotless that referenced this issue Sep 14, 2022

Remove workarounds to diffplug#834 because they are no longer needed …

ef219c0

…thanks to diffplug#1224 and diffplug#1228.

b3z added a commit to trintel/trintel that referenced this issue Oct 23, 2022

Spotless Apply & fix google format for jdk17

1d6b3ba

Read more about the spotless fix here diffplug/spotless#834

stevealexr mentioned this issue Oct 26, 2022

Allow case sensitive local file rename TeamAmaze/AmazeFileManager#3593

Merged

4 tasks

J-N-K added a commit to J-N-K/openhab-core that referenced this issue Dec 8, 2022

upgrade spotless and add jvm options

9c4afdc

See diffplug/spotless#834 Signed-off-by: Jan N. Klug <github@klug.nrw>

J-N-K added a commit to J-N-K/openhab-core that referenced this issue Dec 16, 2022

upgrade spotless and add jvm options

d33a502

See diffplug/spotless#834 Signed-off-by: Jan N. Klug <github@klug.nrw>

J-N-K added a commit to J-N-K/openhab-core that referenced this issue Dec 19, 2022

upgrade spotless and add jvm options

f34dc2c

See diffplug/spotless#834 Signed-off-by: Jan N. Klug <github@klug.nrw>

eduardz1 added a commit to eduardz1/Jmail that referenced this issue Dec 22, 2022

workaround for google java formatting

d8e67fe

diffplug/spotless#834 (comment)

runningcode pushed a commit to runningcode/junit5 that referenced this issue Feb 15, 2023

Work around diffplug/spotless#834

40e5d3a

eggrobin mentioned this issue Mar 8, 2023

Work around spotless issues in recent JDKs unicode-org/unicodetools#418

Merged

Adithya2907 mentioned this issue Mar 29, 2023

Updated build.gradle to allow mantis-common-serde to be compiled using JDK 17 Netflix/mantis#387

Closed

4 tasks

ttosta-google mentioned this issue Sep 13, 2023

deps: update dependencies com.coveo:fmt-mvn-plugin and com.google.goo… GoogleCloudPlatform/cloud-sql-jdbc-socket-factory#1525

Closed

gmaltsev mentioned this issue Nov 29, 2023

Downgrading Spotless to pre-JDK16 versions breaks idempotency #1916

Closed

mattgogerly mentioned this issue Nov 30, 2023

fix(java17): upgrade Spotless to support JDK 17 spinnaker/spinnaker-gradle-project#204

Merged

daberkow mentioned this issue Jul 11, 2024

Old version of spotless java creating compilation issues palantir/gradle-baseline#2828

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

google-java-format (and removeUnusedImports) broken on JDK 16+ (has workaround) #834

google-java-format (and removeUnusedImports) broken on JDK 16+ (has workaround) #834

lazystone commented Apr 7, 2021 •

edited by nedtwigg

Loading

nedtwigg commented Apr 7, 2021

jmaicher commented Apr 12, 2021 •

edited

Loading

dymk commented Apr 13, 2021

ZacSweers commented May 2, 2021 •

edited

Loading

anuraaga commented May 14, 2021

nedtwigg commented May 14, 2021 •

edited

Loading

ascopes commented Sep 12, 2021

poojaverma009 commented Nov 27, 2023

tisonkun commented Nov 27, 2023

poojaverma009 commented Nov 27, 2023

tisonkun commented Nov 27, 2023

poojaverma009 commented Nov 27, 2023

tisonkun commented Nov 27, 2023 •

edited

Loading

poojaverma009 commented Nov 27, 2023

google-java-format (and removeUnusedImports) broken on JDK 16+ (has workaround) #834

google-java-format (and removeUnusedImports) broken on JDK 16+ (has workaround) #834

Comments

lazystone commented Apr 7, 2021 • edited by nedtwigg Loading

nedtwigg commented Apr 7, 2021

jmaicher commented Apr 12, 2021 • edited Loading

dymk commented Apr 13, 2021

ZacSweers commented May 2, 2021 • edited Loading

anuraaga commented May 14, 2021

nedtwigg commented May 14, 2021 • edited Loading

ascopes commented Sep 12, 2021

poojaverma009 commented Nov 27, 2023

tisonkun commented Nov 27, 2023

poojaverma009 commented Nov 27, 2023

tisonkun commented Nov 27, 2023

poojaverma009 commented Nov 27, 2023

tisonkun commented Nov 27, 2023 • edited Loading

poojaverma009 commented Nov 27, 2023

lazystone commented Apr 7, 2021 •

edited by nedtwigg

Loading

jmaicher commented Apr 12, 2021 •

edited

Loading

ZacSweers commented May 2, 2021 •

edited

Loading

nedtwigg commented May 14, 2021 •

edited

Loading

tisonkun commented Nov 27, 2023 •

edited

Loading