-
Notifications
You must be signed in to change notification settings - Fork 37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make Cosmos DTO objects immutable #1013
Make Cosmos DTO objects immutable #1013
Conversation
f34a7aa
to
1bc6f6e
Compare
|
||
/** | ||
* A metadata class for a table of ScalarDB to know the type of each column | ||
* | ||
* @author Yuji Ito | ||
*/ | ||
@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"}) | ||
@NotThreadSafe | ||
@ThreadSafe | ||
public class CosmosTableMetadata { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove setters and make attributes final here
|
||
/** | ||
* A record class that Cosmos DB uses for storing a document based on ScalarDB data model. | ||
* | ||
* @author Yuji Ito | ||
*/ | ||
@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"}) | ||
@NotThreadSafe | ||
@ThreadSafe | ||
public class Record { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Likewise
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left minor comments, but LGTM! Thank you!
core/src/main/java/com/scalar/db/storage/cosmos/CosmosTableMetadata.java
Outdated
Show resolved
Hide resolved
Co-authored-by: Toshihiro Suzuki <brfrn169@gmail.com>
20d1297
to
8b82fd7
Compare
private final Map<String, String> columns; | ||
|
||
public CosmosTableMetadata() { | ||
this(null, null, null, null, null, null); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This constructor is used only in unit tests (com.scalar.db.storage.cosmos.CosmosAdminTestBase#dropTable_WithMetadataLeft_ShouldDropContainerAndOnlyDeleteMetadata
). How about making the test use the new constructor or adding @VisibleForTesting
annotation here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Jackson requires a default constructor so we need it not only for testing purpose. I will add a comment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see. Where are we using Jackson databind for CosmosTableMetadata? I want to reproduce it and look into it as I'm a bit familiar with Jackson databind.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ooops. Sorry, I missed the background.
This PR makes the CosmosMetadata and Record objects immutable. These DTO (Data Transfer Object) are used by the Cosmos SDK which uses Jackson.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
JFYI: The following might be an option to work with Jackson databind internally used in Cosmos SDK, although it would make things a bit complicated.
- build.gradle
implementation 'com.fasterxml.jackson.core:jackson-databind:2.15.2'
- CosmosTableMetadata.java
public CosmosTableMetadata(
@JsonProperty("id")
@Nullable String id,
@JsonProperty("partitionKeyNames")
@Nullable LinkedHashSet<String> partitionKeyNames,
@JsonProperty("clusteringKeyNames")
@Nullable LinkedHashSet<String> clusteringKeyNames,
@JsonProperty("clusteringOrders")
@Nullable Map<String, String> clusteringOrders,
@JsonProperty("secondaryIndexNames")
@Nullable Set<String> secondaryIndexNames,
@JsonProperty("columns")
@Nullable Map<String, String> columns) {
this.id = id != null ? id : "";
this.partitionKeyNames = partitionKeyNames != null ? partitionKeyNames : new LinkedHashSet<>();
...
}
I'm wondering why Cosmos SDK doesn't use https://github.com/FasterXML/jackson-modules-java8/tree/master/parameter-names or equivalent on their side...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see. Thanks for sharing it.
Yes, it would be nice if the SDK were using that feature of Jackson.
Though, adding the jackson datababind dependency on our side to tinker with the Cosmos SDK default behavior seems a bit dangerous to me.
this.secondaryIndexNames = secondaryIndexNames; | ||
public CosmosTableMetadata( | ||
@Nullable String id, | ||
@Nullable LinkedHashSet<String> partitionKeyNames, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can be declared as an interface Set<String>
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah no, we can't do that because the insertion order is important for this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see. Understood. (Another option might be simply using List
with de-duplications)
core/src/main/java/com/scalar/db/storage/cosmos/CosmosTableMetadata.java
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thank you!
Changes
This PR makes the
CosmosMetadata
andRecord
objects immutable. These DTO (Data Transfer Object) are used by the Cosmos SDK which uses Jackson.Note
This PR originated thanks to this discussion #989 (comment)