Skip to content

[Transform] Read metadata from Project State #131205

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Jul 16, 2025
Merged

[Transform] Read metadata from Project State #131205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b22fd30
[Transform] Read metadata from Project State
prwhelan Jul 14, 2025
762e265
Merge branch 'main' into mp/2
prwhelan Jul 14, 2025
f8228d5
Merge branch 'main' into mp/2
prwhelan Jul 14, 2025
18569d5
Merge branch 'main' into mp/2
prwhelan Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions ...k/plugin/core/src/main/java/org/elasticsearch/xpack/core/transform/TransformMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
import org.elasticsearch.cluster.ClusterState;
import org.elasticsearch.cluster.Diff;
import org.elasticsearch.cluster.NamedDiff;
import org.elasticsearch.cluster.ProjectState;
import org.elasticsearch.cluster.metadata.Metadata;
import org.elasticsearch.cluster.metadata.ProjectId;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.collect.Iterators;
import org.elasticsearch.common.io.stream.StreamInput;
Expand Down Expand Up @@ -209,6 +211,9 @@ public TransformMetadata build() {
}
}

/**
* @deprecated use {@link #transformMetadata(ClusterState, ProjectId)}
*/
@Deprecated(forRemoval = true)
public static TransformMetadata getTransformMetadata(ClusterState state) {
TransformMetadata TransformMetadata = (state == null) ? null : state.metadata().getSingleProjectCustom(TYPE);
Expand All @@ -218,6 +223,24 @@ public static TransformMetadata getTransformMetadata(ClusterState state) {
return TransformMetadata;
}

public static TransformMetadata transformMetadata(@Nullable ClusterState state, @Nullable ProjectId projectId) {
if (state == null || projectId == null) {
return EMPTY_METADATA;
}
return transformMetadata(state.projectState(projectId));
}

public static TransformMetadata transformMetadata(@Nullable ProjectState projectState) {
if (projectState == null) {
return EMPTY_METADATA;
}
TransformMetadata transformMetadata = projectState.metadata().custom(TYPE);
if (transformMetadata == null) {
return EMPTY_METADATA;
}
return transformMetadata;
}

public static boolean upgradeMode(ClusterState state) {
return getTransformMetadata(state).upgradeMode();
}
Expand Down
41 changes: 41 additions & 0 deletions ...gin/transform/src/test/java/org/elasticsearch/xpack/transform/TransformMetadataTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,17 @@

package org.elasticsearch.xpack.transform;

import org.elasticsearch.cluster.ClusterName;
import org.elasticsearch.cluster.ClusterState;
import org.elasticsearch.cluster.metadata.Metadata;
import org.elasticsearch.cluster.metadata.ProjectMetadata;
import org.elasticsearch.common.io.stream.Writeable;
import org.elasticsearch.test.AbstractChunkedSerializingTestCase;
import org.elasticsearch.xcontent.XContentParser;
import org.elasticsearch.xpack.core.transform.TransformMetadata;

import static org.hamcrest.Matchers.equalTo;

public class TransformMetadataTests extends AbstractChunkedSerializingTestCase<TransformMetadata> {

@Override
Expand All @@ -35,4 +41,39 @@ protected TransformMetadata mutateInstance(TransformMetadata instance) {
.upgradeMode(instance.upgradeMode() == false)
.build();
}

public void testTransformMetadataFromClusterState() {
var expectedTransformMetadata = new TransformMetadata.Builder().resetMode(true).upgradeMode(true).build();
var projectId = randomUniqueProjectId();
var clusterState = ClusterState.builder(new ClusterName("_name"))
.metadata(
Metadata.builder().put(ProjectMetadata.builder(projectId).putCustom(TransformMetadata.TYPE, expectedTransformMetadata))
)
.build();

assertThat(TransformMetadata.transformMetadata(clusterState, projectId), equalTo(expectedTransformMetadata));
assertThat(TransformMetadata.getTransformMetadata(clusterState), equalTo(expectedTransformMetadata));
}

public void testTransformMetadataFromMissingClusterState() {
assertThat(TransformMetadata.transformMetadata(null, randomUniqueProjectId()), equalTo(TransformMetadata.EMPTY_METADATA));
assertThat(TransformMetadata.getTransformMetadata(null), equalTo(TransformMetadata.EMPTY_METADATA));
}

public void testTransformMetadataFromMissingProjectId() {
assertThat(
TransformMetadata.transformMetadata(ClusterState.builder(new ClusterName("_name")).build(), null),
equalTo(TransformMetadata.EMPTY_METADATA)
);
}

public void testTransformMetadataWhenAbsentFromClusterState() {
var projectId = randomUniqueProjectId();
var clusterState = ClusterState.builder(new ClusterName("_name"))
.metadata(Metadata.builder().put(ProjectMetadata.builder(projectId)))
.build();

assertThat(TransformMetadata.transformMetadata(clusterState, projectId), equalTo(TransformMetadata.EMPTY_METADATA));
assertThat(TransformMetadata.getTransformMetadata(clusterState), equalTo(TransformMetadata.EMPTY_METADATA));
}
}