[AURON #1858] Introduce Flink Auron interface#2057
Conversation
|
@richox @merrily01 CI is green, PTAL |
There was a problem hiding this comment.
Pull request overview
Introduces a small set of Flink-facing interfaces in auron-flink-runtime to standardize how Flink operators/functions expose Auron-native execution metadata for upcoming runtime features.
Changes:
- Add
SupportsAuronNativeinterface to expose physical plan nodes, output type, operator id, and metric node. - Add marker interfaces
FlinkAuronOperatorandFlinkAuronFunctionto tag Flink components that support the Auron-native contract.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| auron-flink-extension/auron-flink-runtime/src/main/java/org/apache/auron/flink/runtime/operator/SupportsAuronNative.java | Defines the shared contract for exposing Auron-native plan/type/metrics metadata. |
| auron-flink-extension/auron-flink-runtime/src/main/java/org/apache/auron/flink/runtime/operator/FlinkAuronOperator.java | Marker interface for Flink operators that implement SupportsAuronNative. |
| auron-flink-extension/auron-flink-runtime/src/main/java/org/apache/auron/flink/runtime/operator/FlinkAuronFunction.java | Marker interface for Flink functions that implement SupportsAuronNative. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| /** | ||
| * Flink function which supports Auron should implement this interface. | ||
| */ | ||
| public interface FlinkAuronFunction extends SupportsAuronNative {} |
There was a problem hiding this comment.
This marker interface is declared on a single line with inline braces. In this codebase interfaces are typically formatted with braces on separate lines (e.g., auron-core/src/main/java/org/apache/auron/jni/AuronAdaptorProvider.java:19-21), so please expand this to the standard multiline form for consistency.
| public interface FlinkAuronFunction extends SupportsAuronNative {} | |
| public interface FlinkAuronFunction extends SupportsAuronNative { | |
| } |
| package org.apache.auron.flink.runtime.operator; | ||
|
|
||
| /** | ||
| * Flink function which supports Auron should implement this interface. |
There was a problem hiding this comment.
The Javadoc sentence is awkward (“Flink function which supports…”). Please adjust the wording (e.g., “Flink functions that support Auron should implement this interface.”) to improve readability in generated docs.
| * Flink function which supports Auron should implement this interface. | |
| * Flink functions that support Auron should implement this interface. |
| /** | ||
| * Flink operator which supports Auron should implement this interface. | ||
| */ | ||
| public interface FlinkAuronOperator extends SupportsAuronNative {} |
There was a problem hiding this comment.
This marker interface is declared on a single line with inline braces. In this codebase interfaces are typically formatted with braces on separate lines (e.g., auron-core/src/main/java/org/apache/auron/jni/AuronAdaptorProvider.java:19-21), so please expand this to the standard multiline form for consistency.
| public interface FlinkAuronOperator extends SupportsAuronNative {} | |
| public interface FlinkAuronOperator extends SupportsAuronNative { | |
| } |
| package org.apache.auron.flink.runtime.operator; | ||
|
|
||
| /** | ||
| * Flink operator which supports Auron should implement this interface. |
There was a problem hiding this comment.
The Javadoc sentence is awkward (“Flink operator which supports…”). Please adjust the wording (e.g., “Flink operators that support Auron should implement this interface.”) to improve readability in generated docs.
| * Flink operator which supports Auron should implement this interface. | |
| * Flink operators that support Auron should implement this interface. |
| import org.apache.flink.table.types.logical.RowType; | ||
|
|
||
| /** | ||
| * Support native Auron interface. |
There was a problem hiding this comment.
The Javadoc summary is grammatically incorrect/ambiguous (“Support native Auron interface.”). Please rephrase to something like “Supports Auron native interface.” so the subject matches the type name and reads clearly in generated docs.
| * Support native Auron interface. | |
| * Supports Auron native interface. |
There was a problem hiding this comment.
Thanks for the PR! LGTM overall, just a few minor suggestions by Copilot. Mind updating those? @Tartarus0zm
Which issue does this PR close?
Closes #1858
Rationale for this change
Introducing Flink support for the Operator and Function interfaces implemented by Auron to facilitate subsequent feature development.
What changes are included in this PR?
Are there any user-facing changes?
How was this patch tested?