Skip to content

Commit bb7e8eb

Browse files
original-brownbearoriginal-brownbear
authored
Introduce ShardState Enum + Slight Cleanup SnapshotsInProgress (#41940) (#42573)
* Added separate enum for the state of each shard, it was really confusing that we used the same enum for the state of the snapshot overall and the state of each individual shard * relates #40943 (comment) * Shortened some obvious spots in equals method and saved a few lines via `computeIfAbsent` to make up for adding 50 new lines to this class
1 parent a96606d commit bb7e8eb

File tree

7 files changed

+97
-60
lines changed

7 files changed

+97
-60
lines changed

‎server/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/status/TransportSnapshotsStatusAction.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,6 @@ private SnapshotsStatusResponse buildResponse(SnapshotsStatusRequest request, Li
174174
break;
175175
case INIT:
176176
case WAITING:
177-
case STARTED:
178177
stage = SnapshotIndexShardStage.STARTED;
179178
break;
180179
case SUCCESS:

‎server/src/main/java/org/elasticsearch/cluster/SnapshotsInProgress.java‎

Lines changed: 66 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
import java.util.HashMap;
4343
import java.util.List;
4444
import java.util.Map;
45+
import java.util.Objects;
4546

4647
/**
4748
* Meta data about snapshots that are currently executing
@@ -53,12 +54,7 @@ public class SnapshotsInProgress extends AbstractNamedDiffable<Custom> implement
5354
public boolean equals(Object o) {
5455
if (this == o) return true;
5556
if (o == null || getClass() != o.getClass()) return false;
56-
57-
SnapshotsInProgress that = (SnapshotsInProgress) o;
58-
59-
if (!entries.equals(that.entries)) return false;
60-
61-
return true;
57+
return entries.equals(((SnapshotsInProgress) o).entries);
6258
}
6359

6460
@Override
@@ -208,18 +204,11 @@ public String toString() {
208204
return snapshot.toString();
209205
}
210206

211-
// package private for testing
212-
ImmutableOpenMap<String, List<ShardId>> findWaitingIndices(ImmutableOpenMap<ShardId, ShardSnapshotStatus> shards) {
207+
private ImmutableOpenMap<String, List<ShardId>> findWaitingIndices(ImmutableOpenMap<ShardId, ShardSnapshotStatus> shards) {
213208
Map<String, List<ShardId>> waitingIndicesMap = new HashMap<>();
214209
for (ObjectObjectCursor<ShardId, ShardSnapshotStatus> entry : shards) {
215-
if (entry.value.state() == State.WAITING) {
216-
final String indexName = entry.key.getIndexName();
217-
List<ShardId> waitingShards = waitingIndicesMap.get(indexName);
218-
if (waitingShards == null) {
219-
waitingShards = new ArrayList<>();
220-
waitingIndicesMap.put(indexName, waitingShards);
221-
}
222-
waitingShards.add(entry.key);
210+
if (entry.value.state() == ShardState.WAITING) {
211+
waitingIndicesMap.computeIfAbsent(entry.key.getIndexName(), k -> new ArrayList<>()).add(entry.key);
223212
}
224213
}
225214
if (waitingIndicesMap.isEmpty()) {
@@ -241,28 +230,27 @@ ImmutableOpenMap<String, List<ShardId>> findWaitingIndices(ImmutableOpenMap<Shar
241230
*/
242231
public static boolean completed(ObjectContainer<ShardSnapshotStatus> shards) {
243232
for (ObjectCursor<ShardSnapshotStatus> status : shards) {
244-
if (status.value.state().completed() == false) {
233+
if (status.value.state().completed == false) {
245234
return false;
246235
}
247236
}
248237
return true;
249238
}
250239

251-
252240
public static class ShardSnapshotStatus {
253-
private final State state;
241+
private final ShardState state;
254242
private final String nodeId;
255243
private final String reason;
256244

257245
public ShardSnapshotStatus(String nodeId) {
258-
this(nodeId, State.INIT);
246+
this(nodeId, ShardState.INIT);
259247
}
260248

261-
public ShardSnapshotStatus(String nodeId, State state) {
249+
public ShardSnapshotStatus(String nodeId, ShardState state) {
262250
this(nodeId, state, null);
263251
}
264252

265-
public ShardSnapshotStatus(String nodeId, State state, String reason) {
253+
public ShardSnapshotStatus(String nodeId, ShardState state, String reason) {
266254
this.nodeId = nodeId;
267255
this.state = state;
268256
this.reason = reason;
@@ -272,11 +260,11 @@ public ShardSnapshotStatus(String nodeId, State state, String reason) {
272260

273261
public ShardSnapshotStatus(StreamInput in) throws IOException {
274262
nodeId = in.readOptionalString();
275-
state = State.fromValue(in.readByte());
263+
state = ShardState.fromValue(in.readByte());
276264
reason = in.readOptionalString();
277265
}
278266

279-
public State state() {
267+
public ShardState state() {
280268
return state;
281269
}
282270

@@ -298,14 +286,9 @@ public void writeTo(StreamOutput out) throws IOException {
298286
public boolean equals(Object o) {
299287
if (this == o) return true;
300288
if (o == null || getClass() != o.getClass()) return false;
301-
302289
ShardSnapshotStatus status = (ShardSnapshotStatus) o;
290+
return Objects.equals(nodeId, status.nodeId) && Objects.equals(reason, status.reason) && state == status.state;
303291

304-
if (nodeId != null ? !nodeId.equals(status.nodeId) : status.nodeId != null) return false;
305-
if (reason != null ? !reason.equals(status.reason) : status.reason != null) return false;
306-
if (state != status.state) return false;
307-
308-
return true;
309292
}
310293

311294
@Override
@@ -331,11 +314,11 @@ public enum State {
331314
MISSING((byte) 5, true, true),
332315
WAITING((byte) 6, false, false);
333316

334-
private byte value;
317+
private final byte value;
335318

336-
private boolean completed;
319+
private final boolean completed;
337320

338-
private boolean failed;
321+
private final boolean failed;
339322

340323
State(byte value, boolean completed, boolean failed) {
341324
this.value = value;
@@ -379,7 +362,6 @@ public static State fromValue(byte value) {
379362

380363
private final List<Entry> entries;
381364

382-
383365
public SnapshotsInProgress(List<Entry> entries) {
384366
this.entries = entries;
385367
}
@@ -437,7 +419,7 @@ public SnapshotsInProgress(StreamInput in) throws IOException {
437419
builder.put(shardId, new ShardSnapshotStatus(in));
438420
} else {
439421
String nodeId = in.readOptionalString();
440-
State shardState = State.fromValue(in.readByte());
422+
ShardState shardState = ShardState.fromValue(in.readByte());
441423
// Workaround for https://github.com/elastic/elasticsearch/issues/25878
442424
// Some old snapshot might still have null in shard failure reasons
443425
String reason = shardState.failed() ? "" : null;
@@ -484,7 +466,7 @@ public void writeTo(StreamOutput out) throws IOException {
484466
shardEntry.value.writeTo(out);
485467
} else {
486468
out.writeOptionalString(shardEntry.value.nodeId());
487-
out.writeByte(shardEntry.value.state().value());
469+
out.writeByte(shardEntry.value.state().value);
488470
}
489471
}
490472
out.writeLong(entry.repositoryStateId);
@@ -555,4 +537,52 @@ public void toXContent(Entry entry, XContentBuilder builder, ToXContent.Params p
555537
builder.endArray();
556538
builder.endObject();
557539
}
540+
541+
public enum ShardState {
542+
INIT((byte) 0, false, false),
543+
SUCCESS((byte) 2, true, false),
544+
FAILED((byte) 3, true, true),
545+
ABORTED((byte) 4, false, true),
546+
MISSING((byte) 5, true, true),
547+
WAITING((byte) 6, false, false);
548+
549+
private final byte value;
550+
551+
private final boolean completed;
552+
553+
private final boolean failed;
554+
555+
ShardState(byte value, boolean completed, boolean failed) {
556+
this.value = value;
557+
this.completed = completed;
558+
this.failed = failed;
559+
}
560+
561+
public boolean completed() {
562+
return completed;
563+
}
564+
565+
public boolean failed() {
566+
return failed;
567+
}
568+
569+
public static ShardState fromValue(byte value) {
570+
switch (value) {
571+
case 0:
572+
return INIT;
573+
case 2:
574+
return SUCCESS;
575+
case 3:
576+
return FAILED;
577+
case 4:
578+
return ABORTED;
579+
case 5:
580+
return MISSING;
581+
case 6:
582+
return WAITING;
583+
default:
584+
throw new IllegalArgumentException("No shard snapshot state for value [" + value + "]");
585+
}
586+
}
587+
}
558588
}

‎server/src/main/java/org/elasticsearch/snapshots/SnapshotShardsService.java‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
import org.elasticsearch.cluster.ClusterStateTaskListener;
4040
import org.elasticsearch.cluster.SnapshotsInProgress;
4141
import org.elasticsearch.cluster.SnapshotsInProgress.ShardSnapshotStatus;
42+
import org.elasticsearch.cluster.SnapshotsInProgress.ShardState;
4243
import org.elasticsearch.cluster.SnapshotsInProgress.State;
4344
import org.elasticsearch.cluster.block.ClusterBlockException;
4445
import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver;
@@ -246,7 +247,8 @@ private void startNewSnapshots(SnapshotsInProgress snapshotsInProgress) {
246247
// Add all new shards to start processing on
247248
final ShardId shardId = shard.key;
248249
final ShardSnapshotStatus shardSnapshotStatus = shard.value;
249-
if (localNodeId.equals(shardSnapshotStatus.nodeId()) && shardSnapshotStatus.state() == State.INIT
250+
if (localNodeId.equals(shardSnapshotStatus.nodeId())
251+
&& shardSnapshotStatus.state() == ShardState.INIT
250252
&& snapshotShards.containsKey(shardId) == false) {
251253
logger.trace("[{}] - Adding shard to the queue", shardId);
252254
if (startedShards == null) {
@@ -284,7 +286,7 @@ private void startNewSnapshots(SnapshotsInProgress snapshotsInProgress) {
284286
} else {
285287
// due to CS batching we might have missed the INIT state and straight went into ABORTED
286288
// notify master that abort has completed by moving to FAILED
287-
if (shard.value.state() == State.ABORTED) {
289+
if (shard.value.state() == ShardState.ABORTED) {
288290
notifyFailedSnapshotShard(snapshot, shard.key, shard.value.reason());
289291
}
290292
}
@@ -477,12 +479,14 @@ public String toString() {
477479

478480
/** Notify the master node that the given shard has been successfully snapshotted **/
479481
private void notifySuccessfulSnapshotShard(final Snapshot snapshot, final ShardId shardId) {
480-
sendSnapshotShardUpdate(snapshot, shardId, new ShardSnapshotStatus(clusterService.localNode().getId(), State.SUCCESS));
482+
sendSnapshotShardUpdate(snapshot, shardId,
483+
new ShardSnapshotStatus(clusterService.localNode().getId(), ShardState.SUCCESS));
481484
}
482485

483486
/** Notify the master node that the given shard failed to be snapshotted **/
484487
private void notifyFailedSnapshotShard(final Snapshot snapshot, final ShardId shardId, final String failure) {
485-
sendSnapshotShardUpdate(snapshot, shardId, new ShardSnapshotStatus(clusterService.localNode().getId(), State.FAILED, failure));
488+
sendSnapshotShardUpdate(snapshot, shardId,
489+
new ShardSnapshotStatus(clusterService.localNode().getId(), ShardState.FAILED, failure));
486490
}
487491

488492
/** Updates the shard snapshot status by sending a {@link UpdateIndexShardSnapshotStatusRequest} to the master node */

‎server/src/main/java/org/elasticsearch/snapshots/SnapshotsService.java‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
import org.elasticsearch.cluster.SnapshotDeletionsInProgress;
3838
import org.elasticsearch.cluster.SnapshotsInProgress;
3939
import org.elasticsearch.cluster.SnapshotsInProgress.ShardSnapshotStatus;
40+
import org.elasticsearch.cluster.SnapshotsInProgress.ShardState;
4041
import org.elasticsearch.cluster.SnapshotsInProgress.State;
4142
import org.elasticsearch.cluster.metadata.IndexMetaData;
4243
import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver;
@@ -774,7 +775,7 @@ public ClusterState execute(ClusterState currentState) {
774775
logger.warn("failing snapshot of shard [{}] on closed node [{}]",
775776
shardEntry.key, shardStatus.nodeId());
776777
shards.put(shardEntry.key,
777-
new ShardSnapshotStatus(shardStatus.nodeId(), State.FAILED, "node shutdown"));
778+
new ShardSnapshotStatus(shardStatus.nodeId(), ShardState.FAILED, "node shutdown"));
778779
}
779780
}
780781
}
@@ -870,7 +871,7 @@ private static ImmutableOpenMap<ShardId, ShardSnapshotStatus> processWaitingShar
870871
for (ObjectObjectCursor<ShardId, ShardSnapshotStatus> shardEntry : snapshotShards) {
871872
ShardSnapshotStatus shardStatus = shardEntry.value;
872873
ShardId shardId = shardEntry.key;
873-
if (shardStatus.state() == State.WAITING) {
874+
if (shardStatus.state() == ShardState.WAITING) {
874875
IndexRoutingTable indexShardRoutingTable = routingTable.index(shardId.getIndex());
875876
if (indexShardRoutingTable != null) {
876877
IndexShardRoutingTable shardRouting = indexShardRoutingTable.shard(shardId.id());
@@ -891,7 +892,7 @@ private static ImmutableOpenMap<ShardId, ShardSnapshotStatus> processWaitingShar
891892
// Shard that we were waiting for went into unassigned state or disappeared - giving up
892893
snapshotChanged = true;
893894
logger.warn("failing snapshot of shard [{}] on unassigned shard [{}]", shardId, shardStatus.nodeId());
894-
shards.put(shardId, new ShardSnapshotStatus(shardStatus.nodeId(), State.FAILED, "shard is unassigned"));
895+
shards.put(shardId, new ShardSnapshotStatus(shardStatus.nodeId(), ShardState.FAILED, "shard is unassigned"));
895896
} else {
896897
shards.put(shardId, shardStatus);
897898
}
@@ -941,7 +942,7 @@ private Tuple<Set<String>, Set<String>> indicesWithMissingShards(
941942
Set<String> missing = new HashSet<>();
942943
Set<String> closed = new HashSet<>();
943944
for (ObjectObjectCursor<ShardId, SnapshotsInProgress.ShardSnapshotStatus> entry : shards) {
944-
if (entry.value.state() == State.MISSING) {
945+
if (entry.value.state() == ShardState.MISSING) {
945946
if (metaData.hasIndex(entry.key.getIndex().getName()) &&
946947
metaData.getIndexSafe(entry.key.getIndex()).getState() == IndexMetaData.State.CLOSE) {
947948
closed.add(entry.key.getIndex().getName());
@@ -1192,7 +1193,7 @@ public ClusterState execute(ClusterState currentState) throws Exception {
11921193
for (ObjectObjectCursor<ShardId, ShardSnapshotStatus> shardEntry : snapshotEntry.shards()) {
11931194
ShardSnapshotStatus status = shardEntry.value;
11941195
if (status.state().completed() == false) {
1195-
status = new ShardSnapshotStatus(status.nodeId(), State.ABORTED, "aborted by snapshot deletion");
1196+
status = new ShardSnapshotStatus(status.nodeId(), ShardState.ABORTED, "aborted by snapshot deletion");
11961197
}
11971198
shardsBuilder.put(shardEntry.key, status);
11981199
}
@@ -1382,7 +1383,7 @@ private static ImmutableOpenMap<ShardId, SnapshotsInProgress.ShardSnapshotStatus
13821383
if (indexMetaData == null) {
13831384
// The index was deleted before we managed to start the snapshot - mark it as missing.
13841385
builder.put(new ShardId(indexName, IndexMetaData.INDEX_UUID_NA_VALUE, 0),
1385-
new SnapshotsInProgress.ShardSnapshotStatus(null, State.MISSING, "missing index"));
1386+
new SnapshotsInProgress.ShardSnapshotStatus(null, ShardState.MISSING, "missing index"));
13861387
} else {
13871388
IndexRoutingTable indexRoutingTable = clusterState.getRoutingTable().index(indexName);
13881389
for (int i = 0; i < indexMetaData.getNumberOfShards(); i++) {
@@ -1391,18 +1392,18 @@ private static ImmutableOpenMap<ShardId, SnapshotsInProgress.ShardSnapshotStatus
13911392
ShardRouting primary = indexRoutingTable.shard(i).primaryShard();
13921393
if (primary == null || !primary.assignedToNode()) {
13931394
builder.put(shardId,
1394-
new SnapshotsInProgress.ShardSnapshotStatus(null, State.MISSING, "primary shard is not allocated"));
1395+
new SnapshotsInProgress.ShardSnapshotStatus(null, ShardState.MISSING, "primary shard is not allocated"));
13951396
} else if (primary.relocating() || primary.initializing()) {
1396-
builder.put(shardId, new SnapshotsInProgress.ShardSnapshotStatus(primary.currentNodeId(), State.WAITING));
1397+
builder.put(shardId, new SnapshotsInProgress.ShardSnapshotStatus(primary.currentNodeId(), ShardState.WAITING));
13971398
} else if (!primary.started()) {
13981399
builder.put(shardId,
1399-
new SnapshotsInProgress.ShardSnapshotStatus(primary.currentNodeId(), State.MISSING,
1400+
new SnapshotsInProgress.ShardSnapshotStatus(primary.currentNodeId(), ShardState.MISSING,
14001401
"primary shard hasn't been started yet"));
14011402
} else {
14021403
builder.put(shardId, new SnapshotsInProgress.ShardSnapshotStatus(primary.currentNodeId()));
14031404
}
14041405
} else {
1405-
builder.put(shardId, new SnapshotsInProgress.ShardSnapshotStatus(null, State.MISSING,
1406+
builder.put(shardId, new SnapshotsInProgress.ShardSnapshotStatus(null, ShardState.MISSING,
14061407
"missing routing table"));
14071408
}
14081409
}

‎server/src/test/java/org/elasticsearch/cluster/SnapshotsInProgressTests.java‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121

2222
import org.elasticsearch.cluster.SnapshotsInProgress.Entry;
2323
import org.elasticsearch.cluster.SnapshotsInProgress.ShardSnapshotStatus;
24+
import org.elasticsearch.cluster.SnapshotsInProgress.ShardState;
2425
import org.elasticsearch.cluster.SnapshotsInProgress.State;
2526
import org.elasticsearch.common.collect.ImmutableOpenMap;
2627
import org.elasticsearch.index.shard.ShardId;
@@ -55,11 +56,11 @@ public void testWaitingIndices() {
5556
ImmutableOpenMap.Builder<ShardId, ShardSnapshotStatus> shards = ImmutableOpenMap.builder();
5657

5758
// test more than one waiting shard in an index
58-
shards.put(new ShardId(idx1Name, idx1UUID, 0), new ShardSnapshotStatus(randomAlphaOfLength(2), State.WAITING));
59-
shards.put(new ShardId(idx1Name, idx1UUID, 1), new ShardSnapshotStatus(randomAlphaOfLength(2), State.WAITING));
59+
shards.put(new ShardId(idx1Name, idx1UUID, 0), new ShardSnapshotStatus(randomAlphaOfLength(2), ShardState.WAITING));
60+
shards.put(new ShardId(idx1Name, idx1UUID, 1), new ShardSnapshotStatus(randomAlphaOfLength(2), ShardState.WAITING));
6061
shards.put(new ShardId(idx1Name, idx1UUID, 2), new ShardSnapshotStatus(randomAlphaOfLength(2), randomNonWaitingState(), ""));
6162
// test exactly one waiting shard in an index
62-
shards.put(new ShardId(idx2Name, idx2UUID, 0), new ShardSnapshotStatus(randomAlphaOfLength(2), State.WAITING));
63+
shards.put(new ShardId(idx2Name, idx2UUID, 0), new ShardSnapshotStatus(randomAlphaOfLength(2), ShardState.WAITING));
6364
shards.put(new ShardId(idx2Name, idx2UUID, 1), new ShardSnapshotStatus(randomAlphaOfLength(2), randomNonWaitingState(), ""));
6465
// test no waiting shards in an index
6566
shards.put(new ShardId(idx3Name, idx3UUID, 0), new ShardSnapshotStatus(randomAlphaOfLength(2), randomNonWaitingState(), ""));
@@ -72,7 +73,7 @@ public void testWaitingIndices() {
7273
assertFalse(waitingIndices.containsKey(idx3Name));
7374
}
7475

75-
private State randomNonWaitingState() {
76-
return randomFrom(Arrays.stream(State.values()).filter(s -> s != State.WAITING).collect(Collectors.toSet()));
76+
private ShardState randomNonWaitingState() {
77+
return randomFrom(Arrays.stream(ShardState.values()).filter(s -> s != ShardState.WAITING).collect(Collectors.toSet()));
7778
}
7879
}

0 commit comments

Comments
 (0)