org.opensearch.action.support.replication.ReplicationModeAwareProxy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation
OpenSearch subproject :server
There is a newer version: 2.18.0
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

package org.opensearch.action.support.replication;

import org.opensearch.action.support.replication.ReplicationOperation.ReplicaResponse;
import org.opensearch.cluster.node.DiscoveryNode;
import org.opensearch.cluster.node.DiscoveryNodes;
import org.opensearch.cluster.routing.ShardRouting;
import org.opensearch.core.action.ActionListener;

import java.util.Objects;
import java.util.function.BiConsumer;
import java.util.function.Consumer;

/**
 * This implementation of {@link ReplicationProxy} fans out the replication request to current shard routing basis
 * the shard routing's replication mode and replication override policy.
 *
 * @opensearch.internal
 */
public class ReplicationModeAwareProxy> extends ReplicationProxy {

    private final ReplicationMode replicationModeOverride;

    /**
     * This ReplicasProxy is used for performing primary term validation.
     */
    private final ReplicationOperation.Replicas primaryTermValidationProxy;

    private final DiscoveryNodes discoveryNodes;

    private final boolean isRemoteEnabled;

    public ReplicationModeAwareProxy(
        ReplicationMode replicationModeOverride,
        DiscoveryNodes discoveryNodes,
        ReplicationOperation.Replicas replicasProxy,
        ReplicationOperation.Replicas primaryTermValidationProxy,
        boolean remoteIndexSettingsEnabled
    ) {
        super(replicasProxy);
        this.replicationModeOverride = Objects.requireNonNull(replicationModeOverride);
        this.primaryTermValidationProxy = Objects.requireNonNull(primaryTermValidationProxy);
        this.discoveryNodes = discoveryNodes;
        this.isRemoteEnabled = remoteIndexSettingsEnabled;
    }

    @Override
    protected void performOnReplicaProxy(
        ReplicationProxyRequest proxyRequest,
        ReplicationMode replicationMode,
        BiConsumer>, ReplicationProxyRequest> performOnReplicaConsumer
    ) {
        assert replicationMode == ReplicationMode.FULL_REPLICATION || replicationMode == ReplicationMode.PRIMARY_TERM_VALIDATION;

        Consumer> replicasProxyConsumer;
        if (replicationMode == ReplicationMode.FULL_REPLICATION) {
            replicasProxyConsumer = getReplicasProxyConsumer(fullReplicationProxy, proxyRequest);
        } else {
            replicasProxyConsumer = getReplicasProxyConsumer(primaryTermValidationProxy, proxyRequest);
        }
        performOnReplicaConsumer.accept(replicasProxyConsumer, proxyRequest);
    }

    @Override
    ReplicationMode determineReplicationMode(ShardRouting shardRouting, ShardRouting primaryRouting) {
        // If the current routing is the primary, then it does not need to be replicated
        if (shardRouting.isSameAllocation(primaryRouting)) {
            return ReplicationMode.NO_REPLICATION;
        }
        // Perform full replication during primary relocation
        if (primaryRouting.relocating() && shardRouting.isSameAllocation(primaryRouting.getTargetRelocatingShard())) {
            return ReplicationMode.FULL_REPLICATION;
        }
        /*
        Only applicable during remote store migration.
        During the migration process, remote based index settings will not be enabled,
        thus we will rely on node attributes to figure out the replication mode
         */
        if (isRemoteEnabled == false) {
            DiscoveryNode targetNode = discoveryNodes.get(shardRouting.currentNodeId());
            if (targetNode != null && targetNode.isRemoteStoreNode() == false) {
                // Perform full replication if replica is hosted on a non-remote node.
                return ReplicationMode.FULL_REPLICATION;
            }
        }
        return replicationModeOverride;
    }
}