Report source lineage from HadoopFormatIO #37265
Conversation
Summary of ChangesHello @shnapz, 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 enhances Apache Beam's data lineage capabilities by extending source lineage reporting to Highlights
🧠 New Feature in Public Preview: You can now enable Memory 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 AssistThe 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
Customization To customize 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 Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. 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. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
/gemini review |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds source lineage reporting to HadoopFormatIO for file-based sources, which is a valuable addition. The implementation correctly identifies file-based splits and extracts their paths for lineage tracking.
The refactoring of the common lineage reporting logic into a shared utility method FileSystems.reportSourceLineage(List<ResourceId>) is a great improvement, reducing code duplication and centralizing the logic.
I have a couple of suggestions to improve maintainability and readability:
- In
FileSystems.java, I've suggested introducing a constant for the magic number100to make the code clearer. - In
HadoopFormatIO.java, I've proposed refactoring the newreportSourceLineagemethod to use Java Streams for a more concise and modern implementation.
Overall, this is a well-structured and useful contribution.
| public static void reportSourceLineage(List<ResourceId> resourceIds) { | ||
| if (resourceIds.size() <= 100) { | ||
| for (ResourceId resourceId : resourceIds) { | ||
| FileSystems.reportSourceLineage(resourceId); | ||
| } | ||
| } else { | ||
| HashSet<ResourceId> uniqueDirs = new HashSet<>(); | ||
| for (ResourceId resourceId : resourceIds) { | ||
| ResourceId dir = resourceId.getCurrentDirectory(); | ||
| uniqueDirs.add(dir); | ||
| if (uniqueDirs.size() > 100) { | ||
| FileSystems.reportSourceLineage(dir, LineageLevel.TOP_LEVEL); | ||
| return; | ||
| } | ||
| } | ||
| for (ResourceId uniqueDir : uniqueDirs) { | ||
| FileSystems.reportSourceLineage(uniqueDir); | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
The magic number 100 is used multiple times for thresholding. It would be better to define it as a constant to improve readability and maintainability. A class-level constant would be ideal, but a local constant within the method is also an improvement.
public static void reportSourceLineage(List<ResourceId> resourceIds) {
final int MAX_LINEAGE_TARGETS = 100;
if (resourceIds.size() <= MAX_LINEAGE_TARGETS) {
for (ResourceId resourceId : resourceIds) {
FileSystems.reportSourceLineage(resourceId);
}
} else {
HashSet<ResourceId> uniqueDirs = new HashSet<>();
for (ResourceId resourceId : resourceIds) {
ResourceId dir = resourceId.getCurrentDirectory();
uniqueDirs.add(dir);
if (uniqueDirs.size() > MAX_LINEAGE_TARGETS) {
FileSystems.reportSourceLineage(dir, LineageLevel.TOP_LEVEL);
return;
}
}
for (ResourceId uniqueDir : uniqueDirs) {
FileSystems.reportSourceLineage(uniqueDir);
}
}
}| List<ResourceId> fileResources = new ArrayList<>(); | ||
|
|
||
| for (SerializableSplit split : inputSplits) { | ||
| InputSplit inputSplit = split.getSplit(); | ||
|
|
||
| if (inputSplit instanceof FileSplit) { | ||
| String pathString = ((FileSplit) inputSplit).getPath().toString(); | ||
| ResourceId resourceId = FileSystems.matchNewResource(pathString, false); | ||
| fileResources.add(resourceId); | ||
| } | ||
| } | ||
|
|
||
| FileSystems.reportSourceLineage(fileResources); |
There was a problem hiding this comment.
This loop can be refactored to use Java Streams for a more concise and declarative style.
List<ResourceId> fileResources =
inputSplits.stream()
.map(SerializableSplit::getSplit)
.filter(FileSplit.class::isInstance)
.map(FileSplit.class::cast)
.map(fileSplit -> FileSystems.matchNewResource(fileSplit.getPath().toString(), false))
.collect(Collectors.toList());
FileSystems.reportSourceLineage(fileResources);1 participant
This PR adds source lineage reporting to
HadoopFormatIOfor file-based sources.Background
While
FileBasedSourcealready reports source lineage metrics,HadoopFormatIOdid not.HadoopFormatIOis a more generic IO transform that supports various data sources including databases, NoSQL stores, and file systems through Hadoop'sInputFormat/OutputFormatinterfaces.Changes
InputSplitis an instance ofFileSplit)FileSystems.reportSourceLineage(List<ResourceId>)to reduce code duplicationImplementation Details
The implementation reports lineage only for file-based sources detected via
FileSplitinstances. Non-file sources (e.g., database reads viaDBInputFormat) are intentionally excluded as they don't represent file resources.Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
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, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.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)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.