Skip to content

Implement BeamFileSystemClient for Delta Lake connector#38873

Open
joaohmalves wants to merge 4 commits into
apache:masterfrom
joaohmalves:implement-beam-filesystem-client
Open

Implement BeamFileSystemClient for Delta Lake connector#38873
joaohmalves wants to merge 4 commits into
apache:masterfrom
joaohmalves:implement-beam-filesystem-client

Conversation

@joaohmalves

Copy link
Copy Markdown

Implements the Delta Kernel Engine FileSystemClient interface backed by Apache Beam's native FileSystems API. This provides the foundational abstraction required for the Delta Lake conector to read/write metadata logs across any Beam-supported storage layer (GCS, S3, HDFS, local files, etc.).

What changes
sdks/java/io/.../BeamFileSystemClient.java: Implements FileSystemClient. Implements listFrom using FileSystems.match with lexicographical sorting; maps readFiles to sequential bounded array stream reads; delegates delete and copyFileAtomically using Beam's native lifecycle options (IGNORE_MISSING_FILES, SKIP_IF_DESTINATION_EXISTS).

sdks/java/io/.../BeamEngine.java: Hooks up BeamFileSystemClient as the default system client instance inside the engine constructors.

sdks/java/io/.../BeamFileSystemClientTest.java: Unit tests covering filesystem operations, range reads, folder behavior, and ordering logic using JUnit TemporaryFolder.

Fixes #38554.


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 implements the Delta Kernel Engine's FileSystemClient interface using Apache Beam's native FileSystems API. This change provides the necessary abstraction for the Delta Lake connector to perform metadata log operations across various storage layers supported by Beam, such as GCS, S3, and HDFS. The integration ensures that the Delta Lake connector can operate seamlessly within the Beam ecosystem by delegating filesystem lifecycle and I/O operations to Beam's robust infrastructure.

Highlights

  • Implementation of BeamFileSystemClient: Introduced a new implementation of the Delta Kernel FileSystemClient interface that leverages Apache Beam's native FileSystems API, enabling storage-agnostic metadata log operations.
  • Engine Integration: Updated BeamEngine to utilize the new BeamFileSystemClient as the default system client, ensuring consistent filesystem interactions across the Delta Lake connector.
  • Comprehensive Testing: Added unit tests in BeamFileSystemClientTest to validate filesystem operations, including file listing, range reads, and atomic copies, ensuring robust behavior across different storage environments.
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.

Footnotes

  1. 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.

@joaohmalves joaohmalves changed the title Implement BeamFileSystemClient for Delta Lake connector (#38554) Implement BeamFileSystemClient for Delta Lake connector Jun 9, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces BeamFileSystemClient, a Delta Kernel FileSystemClient implementation backed by Apache Beam's FileSystems. It integrates this client into BeamEngine and updates various DoFns and tests to use it. The review feedback identifies two critical issues in BeamFileSystemClient: an unused normalizedInput variable in listFrom that should be used to ensure consistent path normalization (along with filtering out directories), and the use of Java 9+ and Java 12+ APIs (InputStream.readNBytes and skipNBytes) which will cause runtime errors on Java 8/11 environments. Replacing these with Guava's ByteStreams is recommended.

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.

Comment on lines +57 to +63
for (MatchResult.Metadata metadata :
FileSystems.match(glob, EmptyMatchTreatment.ALLOW).metadata()) {
String metadataPath = metadata.resourceId().toString();
if (normalizeForOrdering(metadataPath).compareTo(normalizeForOrdering(path)) >= 0) {
statuses.add(toDeltaFileStatus(metadata));
}
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The normalizedInput variable is defined on line 55 but never used. Instead, the raw path parameter is used in the comparison on line 60. This can lead to incorrect filtering in listFrom if the input path and the matched metadata paths have different normalization formats (e.g., file:/ vs file:///).

Additionally, listFrom should filter out directories to prevent downstream components from attempting to read directories as files. We can achieve this by checking !metadata.resourceId().isDirectory().

    for (MatchResult.Metadata metadata :
        FileSystems.match(glob, EmptyMatchTreatment.ALLOW).metadata()) {
      if (metadata.resourceId().isDirectory()) {
        continue;
      }
      String metadataPath = metadata.resourceId().toString();
      if (normalizeForOrdering(metadataPath).compareTo(normalizeForOrdering(normalizedInput)) >= 0) {
        statuses.add(toDeltaFileStatus(metadata));
      }
    }

Comment on lines +161 to +170
} else {
try (InputStream stream = Channels.newInputStream(channel)) {
stream.skipNBytes(startOffset);
int read = stream.readNBytes(data, 0, readLength);
if (read != readLength) {
throw new EOFException(
String.format("Expected %s bytes from %s but read %s", readLength, path, read));
}
}
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The methods InputStream.skipNBytes (introduced in Java 12) and InputStream.readNBytes (introduced in Java 9) are used here. Since Apache Beam supports Java 8 and Java 11 as target runtimes, using these Java 12+ APIs will cause NoSuchMethodError at runtime on those platforms.

We can use Guava's ByteStreams.skipFully and ByteStreams.readFully instead, which are fully compatible with Java 8/11 and are already available on the classpath.

      } else {
        try (InputStream stream = Channels.newInputStream(channel)) {
          com.google.common.io.ByteStreams.skipFully(stream, startOffset);
          com.google.common.io.ByteStreams.readFully(stream, data);
        }
      }

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@github-actions

Copy link
Copy Markdown
Contributor

Assigning reviewers:

R: @kennknowles for label java.

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task]: Implement BeamFileSystemClient

1 participant