Flink: Close catalog in dynamic sink operators to prevent resource leaks#16044
Open
donPain wants to merge 5 commits intoapache:mainfrom
Open
Flink: Close catalog in dynamic sink operators to prevent resource leaks#16044donPain wants to merge 5 commits intoapache:mainfrom
donPain wants to merge 5 commits intoapache:mainfrom
Conversation
donPain
force-pushed
the
main
branch
3 times, most recently
from
2f9bee7 to
e7dedc6
Compare
Operators in the Flink dynamic sink pipeline (DynamicTableUpdateOperator, DynamicRecordProcessor, DynamicWriteResultAggregator, TableSerializerCache) load a catalog via CatalogLoader but never close it. When the catalog is a RESTCatalog backed by S3FileIO, this leaks HTTP clients, S3 clients, and other resources held by the catalog's CloseableGroup. Fix each operator to close its catalog on shutdown if it implements Closeable. For TableSerializerCache, cache the catalog instance to avoid creating a new (leaked) catalog on every serializer update. Add tests for operator lifecycle with both Closeable and non-Closeable catalogs, and an integration test with RESTCatalog + S3FileIO.
Author
|
Hey @nastra could you take a look at this PR when you have a moment? |
Contributor
|
CC: @mxm, @Guosmilesmile |
mxm
reviewed
Apr 21, 2026
Comment on lines
+77
to
+85
| testImplementation project(':iceberg-aws') | ||
| testImplementation(platform(libs.awssdk.bom)) | ||
| testImplementation "software.amazon.awssdk:s3" | ||
| testImplementation "software.amazon.awssdk:auth" | ||
| testImplementation "software.amazon.awssdk:kms" | ||
| testImplementation "software.amazon.awssdk:sts" | ||
| testImplementation libs.testcontainers | ||
| testImplementation libs.testcontainers.junit.jupiter | ||
| testImplementation libs.testcontainers.minio |
Contributor
There was a problem hiding this comment.
Do we really need all these dependencies to verify the fix?
Author
There was a problem hiding this comment.
In my production scenario, I was using S3Tables, so I needed to simulate at least one object-store with a "rest" catalog
Comment on lines
+125
to
+127
| if (catalog == null) { | ||
| catalog = catalogLoader.loadCatalog(); | ||
| } |
Contributor
There was a problem hiding this comment.
Where are we closing this catalog?
Comment on lines
+142
to
+169
| @Test | ||
| void testCloseOperatorWithNonCloseableCatalog() throws Exception { | ||
| DynamicTableUpdateOperator operator = | ||
| new DynamicTableUpdateOperator( | ||
| CATALOG_EXTENSION.catalogLoader(), | ||
| 10, | ||
| 1000, | ||
| 10, | ||
| TableCreator.DEFAULT, | ||
| CASE_SENSITIVE, | ||
| PRESERVE_COLUMNS); | ||
| operator.open(null); | ||
|
|
||
| DynamicRecordInternal input = | ||
| new DynamicRecordInternal( | ||
| TABLE, | ||
| "branch", | ||
| SCHEMA1, | ||
| GenericRowData.of(1), | ||
| PartitionSpec.unpartitioned(), | ||
| 42, | ||
| false, | ||
| Collections.emptySet()); | ||
| operator.map(input); | ||
|
|
||
| // HadoopCatalog is not Closeable, so close should complete without error | ||
| operator.close(); | ||
| } |
Contributor
There was a problem hiding this comment.
Not sure we need this test. There won't be a way to call close on a catalog which doesn't implement Closeable.
Author
There was a problem hiding this comment.
Yes, I added that to validate local tests and forgot to remove it, good point.
Comment on lines
+227
to
+229
| if (catalog instanceof Closeable) { | ||
| ((Closeable) catalog).close(); | ||
| } |
Comment on lines
+202
to
+206
| try { | ||
| ((Closeable) catalog).close(); | ||
| } catch (Exception e) { | ||
| throw new RuntimeException(e); | ||
| } |
Contributor
There was a problem hiding this comment.
Can we standardize on a single way of writing this? Found different style in 1.20 vs 2.1
if (catalog instanceof Closeable rs)
Author
There was a problem hiding this comment.
Yes, of course. What do you think about changing the runtime exception to a more specific exception?
Comment on lines
+110
to
+112
| if (catalog instanceof Closeable) { | ||
| ((Closeable) catalog).close(); | ||
| } |
…s, and add missing close catalog.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Operators in the Flink dynamic sink pipeline (DynamicTableUpdateOperator, DynamicRecordProcessor, DynamicWriteResultAggregator, TableSerializerCache) load a catalog via CatalogLoader but never close it. When the catalog is a RESTCatalog backed by S3FileIO, this leaks HTTP clients, S3 clients, and other resources held by the catalog's CloseableGroup.
Fix each operator to close its catalog on shutdown if it implements Closeable. For TableSerializerCache, cache the catalog instance to avoid creating a new (leaked) catalog on every serializer update.
Add tests for operator lifecycle with both Closeable and non-Closeable catalogs, and an integration test with RESTCatalog + S3FileIO.
Warning exception trace:
