Use Worker API for process isolation in Spotless
#1492
+190
−30
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| /* | ||
| * (c) Copyright 2025 Palantir Technologies Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.palantir.javaformat.gradle.spotless; | ||
|
|
||
| import org.gradle.api.file.ConfigurableFileCollection; | ||
| import org.gradle.api.file.RegularFileProperty; | ||
| import org.gradle.workers.WorkParameters; | ||
|
|
||
| public interface FormatJavaParameters extends WorkParameters { | ||
|
|
||
| RegularFileProperty getInputFile(); | ||
|
|
||
| RegularFileProperty getOutputFile(); | ||
|
|
||
| ConfigurableFileCollection getFormatterClasspath(); | ||
| } |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| /* | ||
| * (c) Copyright 2025 Palantir Technologies Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.palantir.javaformat.gradle.spotless; | ||
|
|
||
| import com.google.common.base.Suppliers; | ||
| import com.palantir.javaformat.java.FormatterService; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.io.UncheckedIOException; | ||
| import java.nio.file.Files; | ||
| import java.util.ServiceLoader; | ||
| import java.util.function.Supplier; | ||
| import org.gradle.api.logging.Logger; | ||
| import org.gradle.api.logging.Logging; | ||
| import org.gradle.workers.WorkAction; | ||
|
|
||
| public abstract class FormatJavaWorkAction implements WorkAction<FormatJavaParameters> { | ||
|
|
||
| private static final Logger logger = Logging.getLogger(FormatJavaWorkAction.class); | ||
|
|
||
| private static final Supplier<FormatterService> formatterService = Suppliers.memoize(() -> { | ||
| logger.info("Loading FormatterService in worker daemon"); | ||
| return ServiceLoader.load(FormatterService.class, FormatJavaWorkAction.class.getClassLoader()) | ||
| .findFirst() | ||
| .orElseThrow(() -> new IllegalStateException( | ||
| "No FormatterService found. Ensure palantir-java-format is on the worker classpath.")); | ||
| }); | ||
|
|
||
| @Override | ||
| public void execute() { | ||
| FormatJavaParameters params = getParameters(); | ||
|
|
||
| try { | ||
| File inputFile = params.getInputFile().get().getAsFile(); | ||
| File outputFile = params.getOutputFile().get().getAsFile(); | ||
|
|
||
| String input = Files.readString(inputFile.toPath()); | ||
|
|
||
| logger.debug("Formatting file with worker process: {}", inputFile.getName()); | ||
|
|
||
| String output = formatterService.get().formatSourceReflowStringsAndFixImports(input); | ||
|
|
||
| Files.writeString(outputFile.toPath(), output); | ||
|
|
||
| } catch (IOException e) { | ||
| throw new UncheckedIOException("Failed to format Java file", e); | ||
| } catch (Exception e) { | ||
| throw new RuntimeException( | ||
| "Formatting failed in worker daemon. This may indicate a bug in palantir-java-format " | ||
| + "or insufficient resources. Original error: " + e.getMessage(), | ||
| e); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Running this locally, does it log this per file or just once per gradle invocation? Not sure is gradle is doing something funky with classloaders even in process isolation that means this may be new each time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
once per gradle invocation - or at least per spotless invocation: