Intellij uses the native image from `.gradle/palantir-java-formatter-caches` by crogoz · Pull Request #1306 · palantir/palantir-java-format

crogoz · 2025-05-23T12:10:41Z

Before this PR

Unused artifact transforms are cleaned up by Gradle every 7 days. This could lead to situation - if people do not refresh the Gradle project in Intellij - where the formatter would fail to run because:

Caused by: java.io.IOException: Cannot run program "~/.gradle/caches/8.12.1/transforms/8b5bfec0f342b9bc0fee275f271594d7/transformed/palantir-java-format-native-2.63.0-nativeImage-macos_aarch64.bin.executable" (in directory "/~/.gradle/caches/8.12.1/transforms/8b5bfec0f342b9bc0fee275f271594d7/transformed"): error=2, No such file or directory

internal slack thread here

After this PR

When we are writing the Intellij configuration files, we would firstly copy + move the nativeImage to our own cache (in ~/.gradle/palantir-java-formatter-caches).
the Intellij configuration files are updated using Gradle tasks that also get added as startParameters (similar logic to https://github.com/palantir/gradle-idea-configuration/blob/develop/gradle-idea-configuration/src/main/groovy/com/palantir/gradle/ideaconfiguration/IdeaConfigurationPlugin.java#L48)

==COMMIT_MSG==
Intellij uses the native image from .gradle/palantir-java-formatter-caches
==COMMIT_MSG==

Possible downsides?

changelog-app · 2025-05-23T12:10:45Z

Generate changelog in `changelog/@unreleased`

What do the change types mean?

feature: A new feature of the service.
improvement: An incremental improvement in the functionality or operation of the service.
fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
and external consumers of the service's API (e.g. customer-written software or integrations).
deprecation: Advertises the intention to remove service functionality without any change to the
operation of the service itself.
manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
performing database surgery, ...) at the time of upgrade for it to succeed.
migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?

❗The break and manual task changelog types will result in a major release!
🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
✨ All others will result in a minor version release.

Type

Description

Intellij uses the native image from .gradle/palantir-java-formatter-caches

Check the box to generate changelog(s)

Generate changelog entry

…/palantir-java-format into cr/fix-missing-native-image-dir

crogoz · 2025-05-23T14:02:28Z

adding do not merge until I finish testing the last commit

crogoz · 2025-05-23T15:21:16Z

gradle-palantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/FileUtils.java

+import java.util.Comparator;
+import java.util.stream.Stream;
+
+public final class FileUtils {


same as in gradle-jdks

crogoz · 2025-05-23T15:23:49Z

...lantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/NativeImageAtomicCopy.java

+
+    private static Logger logger = Logging.getLogger(PalantirJavaFormatIdeaPlugin.class);
+
+    public static URI copyToCacheDir(URI srcUri) {


similar to the logic in gradle-jdks https://github.com/palantir/gradle-jdks/blob/develop/gradle-jdks-setup/src/main/java/com/palantir/gradle/jdks/setup/GradleJdkInstallationSetup.java#L114 with a few modification eg. not copying a directory, but a file

crogoz · 2025-05-23T15:24:50Z

...java-format/src/main/groovy/com/palantir/javaformat/gradle/PalantirJavaFormatIdeaPlugin.java

-
-            Optional<Configuration> nativeImplConfiguration = maybeGetNativeImplConfiguration(rootProject);
-
-            configureLegacyIdea(rootProject, implConfiguration, nativeImplConfiguration);


Removed the configureLegacyIdea logic completely. I see that we did that in gradle-idea-configuration as well but happy to bring it back if you think this might be problematic for some usecases.

let's drop it!

crogoz · 2025-05-26T08:51:39Z

...java-format/src/main/groovy/com/palantir/javaformat/gradle/PalantirJavaFormatIdeaPlugin.java

-        if (!Boolean.getBoolean("idea.active")) {
-            return;
-        }


I am not sure here - do we still need to check the idea.active and run this when the idea plugin is applied ?

CRogers · 2025-05-27T11:56:08Z

...lantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/NativeImageAtomicCopy.java

+        return Path.of(Optional.ofNullable(System.getenv("GRADLE_USER_HOME"))
+                .orElseGet(() -> System.getenv("HOME") + "/.gradle"));


I think we can use project.getGradle().getGradleUserHomeDir() instead

felixdesouza · 2025-05-27T12:31:18Z

...java-format/src/main/groovy/com/palantir/javaformat/gradle/PalantirJavaFormatIdeaPlugin.java

+            TaskProvider<UpdatePalantirJavaFormatIdeaXmlFile> updatePalantirJavaFormatIpr = rootProject
+                    .getTasks()
+                    .register("updatePalantirJavaFormatIpr", UpdatePalantirJavaFormatIdeaXmlFile.class, task -> {
+                        task.getOutputFile().set(rootProject.file(rootProject.getName() + ".ipr"));
+                        task.getShouldCreateOutputIfAbsent().set(false);
+                    });


do we still need this? I don't have any .ipr files in my directories anymore

I think we could probably drop the old way now. We've had the huge warning via baseline for ages now, and it's super deprecated.

felixdesouza · 2025-05-27T12:31:59Z

...java-format/src/main/groovy/com/palantir/javaformat/gradle/PalantirJavaFormatIdeaPlugin.java

+            TaskProvider<UpdateWorkspaceXmlFile> updateWorkspaceIwsXml = rootProject
+                    .getTasks()
+                    .register("updateWorkspaceIwsXml", UpdateWorkspaceXmlFile.class, task -> {
+                        task.getOutputFile().set(rootProject.file(rootProject.getName() + ".iws"));
+                        task.getShouldCreateOutputIfAbsent().set(false);
+                    });


similarly here, isn't this just the idea logic?

CRogers · 2025-07-18T10:22:56Z

...rmat/src/main/groovy/com/palantir/javaformat/gradle/UpdatePalantirJavaFormatIdeaXmlFile.java

+    @OutputDirectory
+    public abstract RegularFileProperty getCacheDir();


This cache dir can have multiple different formatters in it right? If so, we should just have a single output that is the file we expect it to be in, otherwise Gradle will regard this task not up-to-date as extra stuff gets added to it.

CRogers · 2025-07-18T10:26:18Z

...rmat/src/main/groovy/com/palantir/javaformat/gradle/UpdatePalantirJavaFormatIdeaXmlFile.java

+        java.util.Optional<URI> nativeUri = getNativeImageConfig().isEmpty()
+                ? java.util.Optional.empty()
+                : java.util.Optional.of(getNativeImageConfig().getSingleFile().toURI())


I'd probably preferentially import java.util.Optional and fully qualify the org.gradle.api.tasks.Optional to make this a bit more readable.

CRogers · 2025-07-18T10:27:17Z

...rmat/src/main/groovy/com/palantir/javaformat/gradle/UpdatePalantirJavaFormatIdeaXmlFile.java

+                getImplementationConfig().getFiles().stream().map(File::toURI).collect(Collectors.toList());
+        java.util.Optional<URI> nativeUri = getNativeImageConfig().isEmpty()
+                ? java.util.Optional.empty()
+                : java.util.Optional.of(getNativeImageConfig().getSingleFile().toURI())


Instead of this, you can use getImplementationConfig().getFiles().stream().findFirst().map(File::toUri)

autorelease3 · 2025-07-18T14:00:55Z

Released 2.72.0

crogoz added 2 commits May 23, 2025 13:41

copy & move native imahge

81ad7f3

fix

f7a0ba6

svc-changelog and others added 3 commits May 23, 2025 12:11

Add generated changelog entries

7b4f77d

.

ca1472e

Merge branch 'cr/fix-missing-native-image-dir' of github.com:palantir…

c07fb52

…/palantir-java-format into cr/fix-missing-native-image-dir

crogoz added the do not merge label May 23, 2025

crogoz added 2 commits May 23, 2025 17:20

cleanup

00b038c

.

8508f87

crogoz commented May 26, 2025

View reviewed changes

mvoe

05c1e2a

crogoz commented May 26, 2025

View reviewed changes

crogoz removed the do not merge label May 26, 2025

crogoz requested a review from CRogers May 26, 2025 08:51

CRogers reviewed May 27, 2025

View reviewed changes

felixdesouza reviewed May 27, 2025

View reviewed changes

crogoz added 2 commits May 27, 2025 16:22

comments

0a9f080

Merge branch 'develop' into cr/fix-missing-native-image-dir

830b1e0

crogoz added do not merge autorelease merge when ready and removed do not merge labels Jul 17, 2025

CRogers reviewed Jul 18, 2025

View reviewed changes

address comments

a154129

crogoz requested a review from CRogers July 18, 2025 13:32

CRogers approved these changes Jul 18, 2025

View reviewed changes

bulldozer-bot bot merged commit e58c1d9 into develop Jul 18, 2025
9 of 10 checks passed

bulldozer-bot bot deleted the cr/fix-missing-native-image-dir branch July 18, 2025 14:00


		private static Logger logger = Logging.getLogger(PalantirJavaFormatIdeaPlugin.class);

		public static URI copyToCacheDir(URI srcUri) {


		Optional<Configuration> nativeImplConfiguration = maybeGetNativeImplConfiguration(rootProject);

		configureLegacyIdea(rootProject, implConfiguration, nativeImplConfiguration);

		return Path.of(Optional.ofNullable(System.getenv("GRADLE_USER_HOME"))
		.orElseGet(() -> System.getenv("HOME") + "/.gradle"));

		@OutputDirectory
		public abstract RegularFileProperty getCacheDir();

Conversation

crogoz commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before this PR

After this PR

Possible downsides?

Uh oh!

changelog-app bot commented May 23, 2025 • edited by crogoz Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generate changelog in changelog/@unreleased

Uh oh!

crogoz commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

autorelease3 bot commented Jul 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

crogoz commented May 23, 2025 •

edited

Loading

changelog-app bot commented May 23, 2025 •

edited by crogoz

Loading

Generate changelog in `changelog/@unreleased`

crogoz commented May 23, 2025 •

edited

Loading