alluxio-master-2.x/core/server/master/src/main/java/alluxio/master/backup/BackupWorkerRole.java
/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio.master.backup;

import alluxio.AlluxioURI;
import alluxio.ClientContext;
import alluxio.Constants;
import alluxio.ProcessUtils;
import alluxio.conf.Configuration;
import alluxio.conf.PropertyKey;
import alluxio.exception.AlluxioException;
import alluxio.exception.BackupException;
import alluxio.grpc.BackupPRequest;
import alluxio.grpc.BackupState;
import alluxio.grpc.BackupStatusPRequest;
import alluxio.grpc.GrpcService;
import alluxio.grpc.ServiceType;
import alluxio.master.CoreMasterContext;
import alluxio.master.MasterClientContext;
import alluxio.master.MasterInquireClient;
import alluxio.master.StateLockOptions;
import alluxio.master.journal.CatchupFuture;
import alluxio.master.transport.GrpcMessagingClient;
import alluxio.master.transport.GrpcMessagingConnection;
import alluxio.master.transport.Listener;
import alluxio.retry.ExponentialBackoffRetry;
import alluxio.retry.RetryPolicy;
import alluxio.util.logging.SamplingLogger;
import alluxio.util.network.NetworkAddressUtils;
import alluxio.wire.BackupStatus;

import com.google.common.base.Preconditions;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.util.Collections;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;

/**
 * Implementation of {@link BackupRole} for standby mode.
 */
public class BackupWorkerRole extends AbstractBackupRole {
  private static final Logger LOG = LoggerFactory.getLogger(BackupWorkerRole.class);
  private static final Logger SAMPLING_LOG = new SamplingLogger(LOG, 10L * Constants.SECOND_MS);

  // Constant timeout for journal transition before backup.
  private static final long BACKUP_ABORT_AFTER_TRANSITION_TIMEOUT_MS = 30000;
  // Minimum retry wait time between each connection attempt to leader.
  private final long mLeaderConnectionIntervalMin;
  // Maximum retry wait time between each connection attempt to leader.
  private final long mLeaderConnectionIntervalMax;
  // Interval at which backup progress will be sent to the leader.
  private final long mBackupHeartbeatIntervalMs;
  // Timeout for when suspend request is not followed by a backup request.
  private final long mBackupAbortSuspendTimeoutMs;

  /** Connection with the leader. */
  private GrpcMessagingConnection mLeaderConnection;
  /** Close listener for leader connection. */
  private Listener<GrpcMessagingConnection> mLeaderConnectionCloseListener;

  /** Future to control ongoing backup. */
  private Future<?> mBackupFuture;

  /** Scheduled future for sending backup progress. */
  private Future<?> mBackupProgressFuture;
  /** Scheduled future for timing out various backup stages. */
  private ScheduledFuture<?> mBackupTimeoutTask;

  /**
   * Creates a new backup worker.
   *
   * @param masterContext the master context
   */
  public BackupWorkerRole(CoreMasterContext masterContext) {
    super(masterContext);
    LOG.info("Creating backup-worker role.");
    // Read properties.
    mBackupHeartbeatIntervalMs =
        Configuration.getMs(PropertyKey.MASTER_BACKUP_HEARTBEAT_INTERVAL);
    mLeaderConnectionIntervalMin =
        Configuration.getMs(PropertyKey.MASTER_BACKUP_CONNECT_INTERVAL_MIN);
    mLeaderConnectionIntervalMax =
        Configuration.getMs(PropertyKey.MASTER_BACKUP_CONNECT_INTERVAL_MAX);
    mBackupAbortSuspendTimeoutMs =
        Configuration.getMs(PropertyKey.MASTER_BACKUP_SUSPEND_TIMEOUT);
    // Submit a task to establish and maintain connection with the leader.
    mExecutorService.submit(this::establishConnectionToLeader);
  }

  @Override
  public void close() throws IOException {
    if (mRoleClosed) {
      return;
    }

    LOG.info("Closing backup-worker role.");
    // Cancel suspend timeout.
    if (mBackupTimeoutTask != null && !mBackupTimeoutTask.isDone()) {
      mBackupTimeoutTask.cancel(true);
    }
    // Cancel ongoing backup task.
    if (mBackupFuture != null) {
      mBackupFuture.cancel(true);
    }
    // Cancel heartbeat task.
    if (mBackupProgressFuture != null) {
      mBackupProgressFuture.cancel(true);
    }
    // Close leader close listener.
    // This will ensure, connection won't be re-established when closed during stop.
    if (mLeaderConnectionCloseListener != null) {
      mLeaderConnectionCloseListener.close();
    }
    // Close the connection with the leader.
    if (mLeaderConnection != null) {
      try {
        mLeaderConnection.close().get();
      } catch (Exception e) {
        LOG.warn("Failed to close backup-leader connection: {}. Error: {}", mLeaderConnection, e);
      }
      mLeaderConnection = null;
    }
    // Stopping the base after because closing connection uses the base executor.
    super.close();
  }

  @Override
  public Map<ServiceType, GrpcService> getRoleServices() {
    return Collections.emptyMap();
  }

  @Override
  public BackupStatus backup(BackupPRequest request, StateLockOptions stateLockOptions)
      throws AlluxioException {
    throw new IllegalStateException("Backup-worker role can't serve RPCs");
  }

  @Override
  public BackupStatus getBackupStatus(BackupStatusPRequest statusPRequest) {
    throw new IllegalStateException("Backup-worker role can't serve RPCs");
  }

  /**
   * Handler for suspend message. It's used in standby master.
   */
  private CompletableFuture<Void> handleSuspendJournalsMessage(BackupSuspendMessage suspendMsg) {
    LOG.info("Received suspend message: {}", suspendMsg);
    Preconditions.checkState(!mBackupTracker.inProgress(), "Backup in progress");

    // Create a completed future for returning form this handler.
    // This future is only used for providing a receipt of message.
    CompletableFuture<Void> msgFuture = CompletableFuture.completedFuture(null);

    try {
      mJournalSystem.suspend(this::interruptBackup);
      LOG.info("Suspended journals for backup.");
    } catch (IOException e) {
      String failMessage = "Failed to suspended journals for backup.";
      LOG.error(failMessage, e);
      throw new RuntimeException(failMessage, e);
    }
    // Schedule a timeout task to resume journals if protocol is not followed by the leader.
    mBackupTimeoutTask = mTaskScheduler.schedule(() -> {
      LOG.info("Resuming journals as backup request hasn't been received.");
      enforceResumeJournals();
    }, mBackupAbortSuspendTimeoutMs, TimeUnit.MILLISECONDS);

    return msgFuture;
  }

  private void interruptBackup() {
    LOG.info("Interrupting ongoing backup.");
    if (mBackupFuture != null && !mBackupFuture.isDone()) {
      LOG.info("Attempt to cancel backup task.");
      mBackupFuture.cancel(true);
    }
    boolean shouldResume = true;
    if (mBackupTimeoutTask != null) {
      LOG.info("Attempt to cancel backup timeout task.");
      shouldResume = mBackupTimeoutTask.cancel(true);
    }
    if (shouldResume) {
      try {
        LOG.info("Attempt to resume journal application.");
        mJournalSystem.resume();
      } catch (Exception e) {
        LOG.warn("Failed to resume journal application: {}", e.toString());
      }
    }
    LOG.warn("Backup interrupted successfully.");
  }

  /**
   * Handler for backup request message. It's used in standby master.
   */
  private CompletableFuture<Void> handleRequestMessage(BackupRequestMessage requestMsg) {
    LOG.info("Received backup message: {}", requestMsg);
    Preconditions.checkState(!mBackupTracker.inProgress(), "Backup in progress");

    // Create a completed future for returning form this handler.
    // This future is only used for providing a receipt of message.
    CompletableFuture<Void> msgFuture = CompletableFuture.completedFuture(null);

    // Reset backup tracker.
    mBackupTracker.reset();
    // Update current backup status with given backup id.
    mBackupTracker.update(new BackupStatus(requestMsg.getBackupId(), BackupState.Initiating));
    mBackupTracker.updateHostname(NetworkAddressUtils.getLocalHostName(
        (int) Configuration.getMs(PropertyKey.NETWORK_HOST_RESOLUTION_TIMEOUT_MS)));

    // Start sending backup progress to leader.
    startHeartbeatThread();

    // Cancel timeout task created by suspend message handler.
    if (!mBackupTimeoutTask.cancel(true)) {
      LOG.warn("Journal has been resumed due to a time-out");
      mBackupTracker.updateError(new BackupException("Journal has been resumed due to a time-out"));
      return msgFuture;
    }

    // Spawn a task for advancing journals to target sequences, then taking the backup.
    mBackupFuture = mExecutorService.submit(() -> {
      // Mark state as transitioning.
      mBackupTracker.updateState(BackupState.Transitioning);
      try {
        LOG.info(
            "Initiating catching up of journals to consistent sequences before starting backup. {}",
            requestMsg.getJournalSequences());
        CatchupFuture catchupFuture = mJournalSystem.catchup(requestMsg.getJournalSequences());
        CompletableFuture.runAsync(catchupFuture::waitTermination)
            .get(BACKUP_ABORT_AFTER_TRANSITION_TIMEOUT_MS, TimeUnit.MILLISECONDS);

        LOG.info("Journal transition completed. Taking a backup.");
        mBackupTracker.updateState(BackupState.Running);
        AlluxioURI backupUri =
            takeBackup(requestMsg.getBackupRequest(), mBackupTracker.getEntryCounter());
        mBackupTracker.updateBackupUri(backupUri);
        mBackupTracker.updateState(BackupState.Completed);
        // Wait until backup heartbeats are completed.
        try {
          mBackupProgressFuture.get();
        } catch (Exception e) {
          LOG.warn("Failed to wait for backup heartbeat completion. ", e);
        }
      } catch (InterruptedException e) {
        LOG.error("Backup interrupted at worker", e);
        mBackupTracker.updateError(
            new BackupException("Backup interrupted at worker", e));
      } catch (Exception e) {
        LOG.error("Backup failed at worker", e);
        mBackupTracker.updateError(
            new BackupException(String.format("Backup failed at worker: %s", e.getMessage()), e));
      } finally {
        enforceResumeJournals();
      }
    });

    return msgFuture;
  }

  /**
   * Resumes the journals. Crashes the process if resume fails.
   */
  private void enforceResumeJournals() {
    try {
      mJournalSystem.resume();
    } catch (Throwable e) {
      ProcessUtils.fatalError(LOG, e, "Failed to resume journals.");
    }
  }

  /**
   * Creates a task for sending periodic heartbeats to leader backup master.
   * Heartbeats are stopped once the backup is finished.
   */
  private void startHeartbeatThread() {
    // Cancel if existing heartbeat task is active.
    if (mBackupProgressFuture != null && !mBackupProgressFuture.isDone()) {
      mBackupProgressFuture.cancel(true);
    }
    // Submit new heartbeat task.
    mBackupProgressFuture = mExecutorService.submit(() -> {
      while (true) {
        // No need to check result because heartbeat will be sent regardless.
        boolean finished =
            mBackupTracker.waitUntilFinished(mBackupHeartbeatIntervalMs, TimeUnit.MILLISECONDS);
        try {
          sendMessageBlocking(mLeaderConnection,
              new BackupHeartbeatMessage(mBackupTracker.getCurrentStatus()));
        } catch (Exception e) {
          LOG.warn("Failed to send heartbeat to backup-leader: {}. Error: {}", mLeaderConnection,
              e);
        }
        // Stop sending heartbeats if the latest backup has been finished.
        if (finished) {
          break;
        }
      }
    });
  }

  /**
   * Prepares new leader connection.
   */
  private void activateLeaderConnection(GrpcMessagingConnection leaderConnection)
      throws IOException {
    // Register connection error listener.
    leaderConnection.onException((error) -> LOG.warn("Backup-leader connection failed.", error));
    // Register connection close listener.
    mLeaderConnectionCloseListener = leaderConnection.onClose((connection) -> {
      LOG.info("Backup-leader connection closed. {}", connection);
      // Cancel ongoing backup if leader is lost.
      if (mBackupFuture != null && !mBackupFuture.isDone()) {
        LOG.warn("Cancelling ongoing backup as backup-leader is lost.");
        mBackupFuture.cancel(true);
        mBackupTracker.reset();
      }
      // Re-establish leader connection to a potentially new leader.
      mExecutorService.submit(this::establishConnectionToLeader);
    });
    // Register message handlers under catalyst context.
    try {
      mGrpcMessagingContext.execute(() -> {
        // Register suspend message handler.
        leaderConnection.handler(BackupSuspendMessage.class, this::handleSuspendJournalsMessage);
        // Register backup message handler.
        leaderConnection.handler(BackupRequestMessage.class, this::handleRequestMessage);
        // Send handshake message to introduce connection to leader.
        leaderConnection.sendAndReceive(new BackupHandshakeMessage(
            NetworkAddressUtils.getLocalHostName((int) Configuration.global()
                .getMs(PropertyKey.NETWORK_HOST_RESOLUTION_TIMEOUT_MS))));
      }).get();
    } catch (InterruptedException ie) {
      throw new RuntimeException("Interrupted while activating backup-leader connection.");
    } catch (ExecutionException ee) {
      leaderConnection.close();
      throw new IOException("Failed to activate backup-leader connection.", ee.getCause());
    }
  }

  /**
   * Establishes a connection with the leader backup master.
   */
  private void establishConnectionToLeader() {
    // Create unending retry policy for establishing connection with the leader backup master.
    RetryPolicy infiniteRetryPolicy = new ExponentialBackoffRetry(
        (int) mLeaderConnectionIntervalMin, (int) mLeaderConnectionIntervalMax, Integer.MAX_VALUE);

    while (infiniteRetryPolicy.attempt()) {
      // Get leader address.
      InetSocketAddress leaderAddress;
      try {
        // Create inquire client to determine leader address.
        MasterInquireClient inquireClient =
            MasterClientContext.newBuilder(ClientContext.create(Configuration.global()))
                .build().getMasterInquireClient();

        leaderAddress = inquireClient.getPrimaryRpcAddress();
        InetSocketAddress localAddress = NetworkAddressUtils.getConnectAddress(
            NetworkAddressUtils.ServiceType.MASTER_RPC, Configuration.global());
        if (leaderAddress.equals(localAddress)) {
          SAMPLING_LOG.info("Currently being promoted to leader");
          continue;
        }
      } catch (Throwable t) {
        LOG.warn("Failed to get backup-leader address. Error:{}. Attempt:{}", t,
            infiniteRetryPolicy.getAttemptCount());
        continue;
      }
      // InetSocketAddress acquired. Establish messaging connection with the leader.
      try {
        // Create messaging client for backup-leader.
        GrpcMessagingClient messagingClient = new GrpcMessagingClient(Configuration.global(),
            mServerUserState, mExecutorService);

        // Initiate the connection to backup-leader on catalyst context and wait.
        mLeaderConnection =
            mGrpcMessagingContext.execute(() -> messagingClient.connect(leaderAddress)).get().get();

        // Activate the connection.
        activateLeaderConnection(mLeaderConnection);
        LOG.info("Established connection to backup-leader: {}", leaderAddress);
        break;
      } catch (Throwable t) {
        LOG.warn("Failed to establish connection to backup-leader: {}. Error:{}. Attempt:{}",
            leaderAddress, t, infiniteRetryPolicy.getAttemptCount());
      }
    }
  }
}
