[Metadata Immutability] Change different indices lookup objects from array type to lists
#8 647 ouverte le 11 juil. 2023
Métriques du dépôt
- Stars
- (8 123 stars)
- Métriques de merge PR
- (Merge moyen 5j 9h) (266 PRs mergées en 30 j)
Description
Is your feature request related to a problem? Please describe. Metadata object as part of ClusterState is supposed to be immutable by design. However, certain objects within Metadata do not reflect this design.
The following arrays should be replaced with lists and should implement Collections.unmodifiableList() or any other immutable implementations. Assigning them as arrays leave them open for mutability.
https://github.com/opensearch-project/OpenSearch/blob/main/server/src/main/java/org/opensearch/cluster/metadata/Metadata.java#L268
String[] allIndices,
String[] visibleIndices,
String[] allOpenIndices,
String[] visibleOpenIndices,
String[] allClosedIndices,
String[] visibleClosedIndices,
Also, the usage of these arrays is prominently in IndexNameExpressionResolver where before these arrays are utilized, they are converted to lists before they are consumed. It is thus unreasonable to keep these objects as arrays as opposed to lists.
Describe the solution you'd like
Store the above objects as lists, and implement them as Collections.unmodifiableList() in the Metadata constructor.
Describe alternatives you've considered Briefly discussed this change here, but this change was out of scope of https://github.com/opensearch-project/OpenSearch/pull/7853
Additional context this change will require changes in how the metadata or its diff is parsed as XContent as well.