Fix artifact staging filenames on Windows by AtharvUrunkar · Pull Request #39363 · apache/beam

AtharvUrunkar · 2026-07-17T08:06:51Z

What is the issue?

Artifact staging can fail on Windows when an environment ID contains characters that are invalid in Windows filenames, such as :. The environment ID was previously embedded directly into the generated staging filename, causing an InvalidPathException before the pipeline could run.

What does this PR do?

Sanitizes Windows-invalid filename characters in environment IDs before using them in staged artifact filenames.
Adds a regression test using an environment ID containing : to verify that artifact staging succeeds on Windows.

Testing

./gradlew :runners:java-fn-execution:test --tests "org.apache.beam.runners.fnexecution.artifact.ArtifactStagingServiceTest"
./gradlew :runners:java-fn-execution:spotlessCheck
./gradlew :runners:java-fn-execution:check

All tests and checks pass successfully.

gemini-code-assist · 2026-07-17T08:06:58Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses an issue where artifact staging would fail on Windows due to invalid characters in environment IDs. By sanitizing these IDs before they are used in file paths, the system now avoids InvalidPathException errors, ensuring consistent behavior across different operating systems.

Highlights

Filename Sanitization: Introduced character replacement for environment IDs to ensure compatibility with Windows filesystem constraints.
Regression Testing: Added a new test case to verify that artifact staging handles environment IDs containing invalid characters like colons correctly.

New Features

🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces sanitization for environment names when creating artifact filenames by replacing invalid characters (such as <>:"/\\|?*) with underscores, and adds a corresponding unit test. The feedback suggests precompiling the regular expression pattern to improve performance and enhancing the unit test to assert that the physical file created is indeed sanitized, ensuring the test is effective across all platforms.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

gemini-code-assist · 2026-07-17T08:07:55Z

        // all path separators.
        List<String> components = Splitter.onPattern("[^A-Za-z-_.]]").splitToList(path);
        String base = components.get(components.size() - 1);
+        String sanitizedEnvironment = environment.replaceAll("[<>:\"/\\\\|?*]", "_");


To avoid compiling the regular expression pattern on every invocation of createFilename, it is highly recommended to precompile the pattern as a private static final Pattern constant at the class level.

For example:

private static final Pattern INVALID_WINDOWS_CHARS = Pattern.compile("[<>:\"/\\\\|?*]");

Suggested change

String sanitizedEnvironment = environment.replaceAll("[<>:\"/\\\\|?*]", "_");

String sanitizedEnvironment = INVALID_WINDOWS_CHARS.matcher(environment).replaceAll("_");

gemini-code-assist · 2026-07-17T08:07:55Z

+    assertEquals(1, staged.size());
+    checkArtifacts(contentsList, staged.get(environment));


Since : is a valid filename character on Unix-like operating systems (such as Linux and macOS), this test will pass on those platforms even without the sanitization fix. To ensure the test actually verifies the sanitization behavior across all platforms (including CI environments running on Linux), consider asserting that the physical file created in the staging directory contains the sanitized environment string (0_ref_Environment_default) and does not contain the colon (:).

github-actions · 2026-07-17T09:38:57Z

Assigning reviewers:

R: @chamikaramj added as fallback since no labels match configuration

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

github-actions · 2026-07-17T10:36:44Z

Assigning reviewers:

R: @chamikaramj added as fallback since no labels match configuration

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

github-actions · 2026-07-17T11:32:35Z

Assigning reviewers:

R: @chamikaramj added as fallback since no labels match configuration

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

github-actions · 2026-07-17T12:32:48Z

Assigning reviewers:

R: @chamikaramj added as fallback since no labels match configuration

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

github-actions · 2026-07-17T13:35:30Z

Assigning reviewers:

R: @chamikaramj added as fallback since no labels match configuration

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

github-actions · 2026-07-17T14:36:46Z

Assigning reviewers:

R: @chamikaramj added as fallback since no labels match configuration

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

github-actions · 2026-07-17T15:32:23Z

Assigning reviewers:

R: @chamikaramj added as fallback since no labels match configuration

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

Fix artifact staging filenames on Windows

9d732fc

github-actions Bot added runners fn-execution labels Jul 17, 2026

gemini-code-assist Bot reviewed Jul 17, 2026

View reviewed changes

github-actions Bot added the Next Action: Reviewers label Jul 17, 2026

Eliaaazzz mentioned this pull request Jul 17, 2026

Fail fast in artifact staging when storing an artifact fails #39367

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix artifact staging filenames on Windows#39363

Fix artifact staging filenames on Windows#39363
AtharvUrunkar wants to merge 1 commit into
apache:masterfrom
AtharvUrunkar:fix-artifact-staging-windows-filename

AtharvUrunkar commented Jul 17, 2026

Uh oh!

gemini-code-assist Bot commented Jul 17, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot Jul 17, 2026

Uh oh!

gemini-code-assist Bot Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	String sanitizedEnvironment = environment.replaceAll("[<>:\"/\\\\\|?*]", "_");
	String sanitizedEnvironment = INVALID_WINDOWS_CHARS.matcher(environment).replaceAll("_");

		assertEquals(1, staged.size());
		checkArtifacts(contentsList, staged.get(environment));

Uh oh!

Conversation

AtharvUrunkar commented Jul 17, 2026

What is the issue?

What does this PR do?

Testing

Uh oh!

gemini-code-assist Bot commented Jul 17, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant