Snowflake: Avoid mutating caller-supplied properties map during catalog initialization#16608
Open
wombatu-kun wants to merge 1 commit into
Open
Snowflake: Avoid mutating caller-supplied properties map during catalog initialization#16608wombatu-kun wants to merge 1 commit into
wombatu-kun wants to merge 1 commit into
Conversation
…og initialization Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
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.
Summary
SnowflakeCatalog.initialize(String, Map)adds the JDBCapplicationanduser_agent_suffixidentifiers by callingproperties.put(...)directly on the caller-supplied map. This has two problems: it throwsUnsupportedOperationExceptionwhen the caller passes an immutable map (for exampleMap.of(...)orImmutableMap.of(...), which is a contract-legal and idiomatic way to callCatalog.initialize), and even with a mutable map it silently pollutes the caller's map with the two derived JDBC properties.Every other catalog (
JdbcCatalog,GlueCatalog,DynamoDbCatalog,HadoopCatalog,InMemoryCatalog) treats the input properties as read-only and copies them. This change makesSnowflakeCatalogdo the same: it builds a mutable copy withMaps.newHashMap(properties), adds the JDBC identifiers to the copy, and passes the copy to the JDBC client pool and catalog initialization, leaving the caller's map untouched.Tests
Added two tests to
TestSnowflakeCatalog:testInitializeWithImmutablePropertiesverifies that initializing with an immutable properties map no longer throws, andtestInitializeDoesNotMutateCallerPropertiesverifies that a mutable caller map is left unmodified afterinitialize. Both fail before this change and pass after.