Add immutable 'operator' metadata classes for cluster state #87763
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| package org.elasticsearch.cluster.metadata; | ||
|
|
||
| import org.elasticsearch.cluster.Diff; | ||
| import org.elasticsearch.cluster.SimpleDiffable; | ||
| import org.elasticsearch.common.io.stream.StreamInput; | ||
| import org.elasticsearch.common.io.stream.StreamOutput; | ||
| import org.elasticsearch.xcontent.ConstructingObjectParser; | ||
| import org.elasticsearch.xcontent.ParseField; | ||
| import org.elasticsearch.xcontent.ToXContentFragment; | ||
| import org.elasticsearch.xcontent.XContentBuilder; | ||
| import org.elasticsearch.xcontent.XContentParser; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
|
|
||
| import static org.elasticsearch.xcontent.ConstructingObjectParser.constructorArg; | ||
|
|
||
| /** | ||
| * A metadata class to hold error information about errors encountered | ||
| * while applying a cluster state update for a given namespace. | ||
| * <p> | ||
| * This information is held by the {@link OperatorMetadata} class. | ||
| */ | ||
| public record OperatorErrorMetadata(Long version, ErrorKind errorKind, List<String> errors) | ||
|
There was a problem hiding this comment. The error metadata is set when a file fails to get processed for some reason. In this case we launch a cluster state update task that will update this metadata. Example here: The builder code is now removed, so the OperatorErrorMetadata will be directly created. |
||
| implements | ||
| SimpleDiffable<OperatorErrorMetadata>, | ||
| ToXContentFragment { | ||
|
|
||
| static final ParseField ERRORS = new ParseField("errors"); | ||
| static final ParseField VERSION = new ParseField("version"); | ||
| static final ParseField ERROR_KIND = new ParseField("error_kind"); | ||
|
|
||
| /** | ||
| * Constructs an operator error metadata | ||
| * | ||
| * @param version the metadata version of the content which failed to apply | ||
| * @param errorKind the kind of error we encountered while processing | ||
| * @param errors the list of errors encountered during parsing and validation of the operator content | ||
| */ | ||
| public OperatorErrorMetadata {} | ||
|
|
||
| @Override | ||
| public void writeTo(StreamOutput out) throws IOException { | ||
| out.writeLong(version); | ||
| out.writeString(errorKind.getKindValue()); | ||
| out.writeCollection(errors, StreamOutput::writeString); | ||
| } | ||
|
|
||
| /** | ||
| * Reads an {@link OperatorErrorMetadata} from a {@link StreamInput} | ||
| * | ||
| * @param in the {@link StreamInput} to read from | ||
| * @return {@link OperatorErrorMetadata} | ||
| * @throws IOException | ||
| */ | ||
| public static OperatorErrorMetadata readFrom(StreamInput in) throws IOException { | ||
| return new OperatorErrorMetadata(in.readLong(), ErrorKind.of(in.readString()), in.readList(StreamInput::readString)); | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.startObject(); | ||
| builder.field(VERSION.getPreferredName(), version); | ||
| builder.field(ERROR_KIND.getPreferredName(), errorKind.getKindValue()); | ||
| builder.stringListField(ERRORS.getPreferredName(), errors); | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| private static final ConstructingObjectParser<OperatorErrorMetadata, Void> PARSER = new ConstructingObjectParser<>( | ||
| "operator_error_metadata", | ||
| (a) -> new OperatorErrorMetadata((Long) a[0], ErrorKind.of((String) a[1]), (List<String>) a[2]) | ||
| ); | ||
|
|
||
| static { | ||
| PARSER.declareLong(constructorArg(), VERSION); | ||
| PARSER.declareString(constructorArg(), ERROR_KIND); | ||
| PARSER.declareStringArray(constructorArg(), ERRORS); | ||
| } | ||
|
|
||
| /** | ||
| * Reads an {@link OperatorErrorMetadata} from xContent | ||
| * | ||
| * @param parser {@link XContentParser} | ||
| * @return {@link OperatorErrorMetadata} | ||
| */ | ||
| public static OperatorErrorMetadata fromXContent(final XContentParser parser) { | ||
| return PARSER.apply(parser, null); | ||
| } | ||
|
|
||
| /** | ||
| * Reads an {@link OperatorErrorMetadata} {@link Diff} from {@link StreamInput} | ||
| * | ||
| * @param in the {@link StreamInput} to read the diff from | ||
| * @return a {@link Diff} of {@link OperatorErrorMetadata} | ||
| * @throws IOException | ||
| */ | ||
| public static Diff<OperatorErrorMetadata> readDiffFrom(StreamInput in) throws IOException { | ||
| return SimpleDiffable.readDiffFrom(OperatorErrorMetadata::readFrom, in); | ||
| } | ||
|
|
||
| /** | ||
| * Enum for kinds of errors we might encounter while processing operator cluster state updates. | ||
| */ | ||
| public enum ErrorKind { | ||
| PARSING("parsing"), | ||
| VALIDATION("validation"), | ||
| TRANSIENT("transient"); | ||
|
|
||
| private final String kind; | ||
|
|
||
| ErrorKind(String kind) { | ||
| this.kind = kind; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the String value for this enum value | ||
| * | ||
| * @return the String value for the enum | ||
| */ | ||
| public String getKindValue() { | ||
| return kind; | ||
| } | ||
|
|
||
| /** | ||
| * Helper method to construct {@link ErrorKind} from a String. | ||
| * | ||
| * The JDK default implementation throws incomprehensible error. | ||
| * @param kind String value | ||
| * @return {@link ErrorKind} | ||
| */ | ||
| public static ErrorKind of(String kind) { | ||
| for (var report : values()) { | ||
| if (report.kind.equals(kind)) { | ||
| return report; | ||
| } | ||
| } | ||
| throw new IllegalArgumentException("kind not supported [" + kind + "]"); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
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.
Here's an example in the related PR of how this will be used:
https://github.com/elastic/elasticsearch/pull/86224/files#diff-d017ebae07494c580da12a539a666fe1d87537f167e71761cf60451b8913d554R127
The related PR is out of date, it calls the API operatorState and it has the extra helper method to perform the additional .get.
Instead of:
we'll be calling: