/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.celeborn.client.commit

import java.nio.ByteBuffer
import java.util
import java.util.concurrent.{Callable, ConcurrentHashMap, ThreadPoolExecutor, TimeUnit}
import java.util.function

import scala.collection.JavaConverters._
import scala.collection.mutable

import com.google.common.base.Preconditions.checkState
import com.google.common.cache.{Cache, CacheBuilder}
import com.google.common.collect.Sets

import org.apache.celeborn.client.{ClientUtils, LifecycleManager, ShuffleCommittedInfo, WorkerStatusTracker}
import org.apache.celeborn.client.CommitManager.CommittedPartitionInfo
import org.apache.celeborn.client.LifecycleManager.{ShuffleAllocatedWorkers, ShuffleFailedWorkers}
import org.apache.celeborn.common.{CelebornConf, CommitMetadata}
import org.apache.celeborn.common.internal.Logging
import org.apache.celeborn.common.meta.ShufflePartitionLocationInfo
import org.apache.celeborn.common.network.protocol.SerdeVersion
import org.apache.celeborn.common.protocol.{PartitionLocation, PartitionType, PbGetStageEndResponse}
import org.apache.celeborn.common.protocol.message.ControlMessages.GetReducerFileGroupResponse
import org.apache.celeborn.common.protocol.message.StatusCode
import org.apache.celeborn.common.rpc.RpcCallContext
import org.apache.celeborn.common.rpc.netty.{LocalNettyRpcCallContext, RemoteNettyRpcCallContext}
import org.apache.celeborn.common.util.JavaUtils
import org.apache.celeborn.common.write.LocationPushFailedBatches

/**
 * This commit handler is for ReducePartition ShuffleType, which means that a Reduce Partition contains all data
 * produced by all upstream MapTasks, and data in a Reduce Partition would only be consumed by one ReduceTask. If the
 * ReduceTask has multiple inputs, each will be a ReducePartition
 *
 * @see [[org.apache.celeborn.common.protocol.PartitionType.REDUCE]]
 */
class ReducePartitionCommitHandler(
    appUniqueId: String,
    conf: CelebornConf,
    shuffleAllocatedWorkers: ShuffleAllocatedWorkers,
    committedPartitionInfo: CommittedPartitionInfo,
    workerStatusTracker: WorkerStatusTracker,
    sharedRpcPool: ThreadPoolExecutor,
    lifecycleManager: LifecycleManager)
  extends CommitHandler(
    appUniqueId,
    conf,
    committedPartitionInfo,
    workerStatusTracker,
    sharedRpcPool)
  with Logging {

  class MultiSerdeVersionRpcContext(val ctx: RpcCallContext, val serdeVersion: SerdeVersion) {}

  private val getReducerFileGroupRequest =
    JavaUtils.newConcurrentHashMap[Int, util.Set[MultiSerdeVersionRpcContext]]()
  private[celeborn] val dataLostShuffleSet = ConcurrentHashMap.newKeySet[Int]()
  private val stageEndShuffleSet = ConcurrentHashMap.newKeySet[Int]()
  private val inProcessStageEndShuffleSet = ConcurrentHashMap.newKeySet[Int]()
  private val shuffleMapperAttempts = JavaUtils.newConcurrentHashMap[Int, Array[Int]]()
  private val stageEndTimeout = conf.clientPushStageEndTimeout
  private val mockShuffleLost = conf.testMockShuffleLost
  private val mockShuffleLostShuffle = conf.testMockShuffleLostShuffle

  private val rpcCacheSize = conf.clientRpcCacheSize
  private val rpcCacheConcurrencyLevel = conf.clientRpcCacheConcurrencyLevel
  private val rpcCacheExpireTime = conf.clientRpcCacheExpireTime

  private val shuffleIntegrityCheckEnabled = conf.clientShuffleIntegrityCheckEnabled
  // partitionId-shuffleId -> number of mappers that have written to this reducer (partition + shuffle)
  private val commitMetadataForReducer =
    JavaUtils.newConcurrentHashMap[Integer, Array[CommitMetadata]]
  private val skewPartitionCompletenessValidator =
    JavaUtils.newConcurrentHashMap[Int, PartitionCompletenessValidator]()

  private val getReducerFileGroupResponseBroadcastEnabled = conf.getReducerFileGroupBroadcastEnabled
  private val getReducerFileGroupResponseBroadcastMiniSize =
    conf.getReducerFileGroupBroadcastMiniSize

  // noinspection UnstableApiUsage
  private val getReducerFileGroupRpcCache: Cache[Int, ByteBuffer] = CacheBuilder.newBuilder()
    .concurrencyLevel(rpcCacheConcurrencyLevel)
    .expireAfterWrite(rpcCacheExpireTime, TimeUnit.MILLISECONDS)
    .maximumSize(rpcCacheSize)
    .build().asInstanceOf[Cache[Int, ByteBuffer]]

  private val newShuffleId2PushFailedBatchMapFunc
      : function.Function[Int, util.HashMap[String, LocationPushFailedBatches]] =
    new util.function.Function[Int, util.HashMap[String, LocationPushFailedBatches]]() {
      override def apply(s: Int): util.HashMap[String, LocationPushFailedBatches] = {
        new util.HashMap[String, LocationPushFailedBatches]()
      }
    }

  private val uniqueId2PushFailedBatchMapFunc
      : function.Function[String, LocationPushFailedBatches] =
    new util.function.Function[String, LocationPushFailedBatches]() {
      override def apply(s: String): LocationPushFailedBatches = {
        new LocationPushFailedBatches()
      }
    }

  override def getPartitionType(): PartitionType = {
    PartitionType.REDUCE
  }

  override def isStageEnd(shuffleId: Int): Boolean = {
    stageEndShuffleSet.contains(shuffleId)
  }

  override def isStageEndOrInProcess(shuffleId: Int): Boolean = {
    inProcessStageEndShuffleSet.contains(shuffleId) ||
    stageEndShuffleSet.contains(shuffleId)
  }

  override def isStageDataLost(shuffleId: Int): Boolean = {
    if (mockShuffleLost) {
      mockShuffleLostShuffle == shuffleId
    } else {
      dataLostShuffleSet.contains(shuffleId)
    }
  }

  override def isPartitionInProcess(shuffleId: Int, partitionId: Int): Boolean = {
    isStageEndOrInProcess(shuffleId)
  }

  override def setStageEnd(shuffleId: Int): Unit = {
    getReducerFileGroupRequest synchronized {
      stageEndShuffleSet.add(shuffleId)
    }

    val requests = getReducerFileGroupRequest.remove(shuffleId)
    // Set empty HashSet during register shuffle.
    // In case of stage with no shuffle data, register shuffle will not be called,
    // so here we still need to check null.
    if (requests != null && !requests.isEmpty) {
      requests.asScala.foreach(replyGetReducerFileGroup(_, shuffleId))
    }
  }

  override def removeExpiredShuffle(shuffleId: Int): Unit = {
    dataLostShuffleSet.remove(shuffleId)
    stageEndShuffleSet.remove(shuffleId)
    inProcessStageEndShuffleSet.remove(shuffleId)
    shuffleMapperAttempts.remove(shuffleId)
    commitMetadataForReducer.remove(shuffleId)
    skewPartitionCompletenessValidator.remove(shuffleId)
    super.removeExpiredShuffle(shuffleId)
  }

  override def tryFinalCommit(
      shuffleId: Int,
      recordWorkerFailure: ShuffleFailedWorkers => Unit): Boolean = {
    if (isStageEnd(shuffleId)) {
      logInfo(s"[handleStageEnd] Shuffle $shuffleId already ended!")
      return false
    } else {
      inProcessStageEndShuffleSet.synchronized {
        if (inProcessStageEndShuffleSet.contains(shuffleId)) {
          logWarning(s"[handleStageEnd] Shuffle $shuffleId is in process!")
          return false
        } else {
          inProcessStageEndShuffleSet.add(shuffleId)
        }
      }
    }

    // ask allLocations workers holding partitions to commit files
    val allocatedWorkers = shuffleAllocatedWorkers.get(shuffleId)
    val (dataLost, commitFailedWorkers) = handleFinalCommitFiles(shuffleId, allocatedWorkers)
    recordWorkerFailure(commitFailedWorkers)
    // reply
    if (!dataLost) {
      logInfo(s"Succeed to handle stageEnd for $shuffleId.")
      // record in stageEndShuffleSet
      setStageEnd(shuffleId)
    } else {
      logError(s"Failed to handle stageEnd for $shuffleId, lost file!")
      dataLostShuffleSet.add(shuffleId)
      // record in stageEndShuffleSet
      setStageEnd(shuffleId)
    }
    inProcessStageEndShuffleSet.remove(shuffleId)
    true
  }

  private def handleFinalCommitFiles(
      shuffleId: Int,
      allocatedWorkers: util.Map[String, ShufflePartitionLocationInfo])
      : (Boolean, ShuffleFailedWorkers) = {
    val shuffleCommittedInfo = committedPartitionInfo.get(shuffleId)

    // commit files
    val parallelCommitResult = parallelCommitFiles(shuffleId, allocatedWorkers, None)

    // check all inflight request complete
    waitInflightRequestComplete(shuffleCommittedInfo)

    // check data lost
    val dataLost = checkDataLost(
      shuffleId,
      shuffleCommittedInfo.failedPrimaryPartitionIds,
      shuffleCommittedInfo.failedReplicaPartitionIds)

    // collect result
    if (!dataLost) {
      collectResult(
        shuffleId,
        shuffleCommittedInfo,
        getPartitionUniqueIds(shuffleCommittedInfo.committedPrimaryIds),
        getPartitionUniqueIds(shuffleCommittedInfo.committedReplicaIds),
        parallelCommitResult.primaryPartitionLocationMap,
        parallelCommitResult.replicaPartitionLocationMap)
    }

    (dataLost, parallelCommitResult.commitFilesFailedWorkers)
  }

  override def getUnhandledPartitionLocations(
      shuffleId: Int,
      shuffleCommittedInfo: ShuffleCommittedInfo): mutable.Set[PartitionLocation] = {
    shuffleCommittedInfo.unhandledPartitionLocations.asScala.filterNot { partitionLocation =>
      shuffleCommittedInfo.handledPartitionLocations.contains(partitionLocation)
    }
  }

  private def waitInflightRequestComplete(shuffleCommittedInfo: ShuffleCommittedInfo): Unit = {
    while (shuffleCommittedInfo.allInFlightCommitRequestNum.get() > 0) {
      Thread.sleep(1000)
    }
  }

  private def getPartitionUniqueIds(ids: ConcurrentHashMap[Int, util.List[String]])
      : util.Iterator[String] = {
    ids.asScala.flatMap(_._2.asScala).toIterator.asJava
  }

  /**
   * For reduce partition shuffle type If shuffle registered and corresponding map finished, reply true.
   * For map partition shuffle type always return false
   * reduce partition type
   *
   * @param shuffleId
   * @param mapId
   * @return
   */
  override def isMapperEnded(shuffleId: Int, mapId: Int): Boolean = {
    shuffleMapperAttempts.containsKey(shuffleId) && shuffleMapperAttempts.get(shuffleId)(
      mapId) != -1
  }

  override def getMapperAttempts(shuffleId: Int): Array[Int] = {
    shuffleMapperAttempts.get(shuffleId)
  }

  override def finishMapperAttempt(
      shuffleId: Int,
      mapId: Int,
      attemptId: Int,
      numMappers: Int,
      partitionId: Int,
      pushFailedBatches: util.Map[String, LocationPushFailedBatches],
      recordWorkerFailure: ShuffleFailedWorkers => Unit,
      numPartitions: Int,
      crc32PerPartition: Array[Int],
      bytesWrittenPerPartition: Array[Long]): (Boolean, Boolean) = {
    val (mapperAttemptFinishedSuccess, allMapperFinished) = shuffleMapperAttempts.synchronized {
      if (getMapperAttempts(shuffleId) == null) {
        logDebug(s"[handleMapperEnd] $shuffleId not registered, create one.")
        initMapperAttempts(shuffleId, numMappers, numPartitions)
      }

      val attempts = shuffleMapperAttempts.get(shuffleId)
      if (attempts(mapId) < 0) {
        attempts(mapId) = attemptId

        if (null != pushFailedBatches && !pushFailedBatches.isEmpty) {
          val pushFailedBatchesMap = shufflePushFailedBatches.computeIfAbsent(
            shuffleId,
            newShuffleId2PushFailedBatchMapFunc)
          for ((partitionUniqId, locationPushFailedBatches) <- pushFailedBatches.asScala) {
            val partitionPushFailedBatches = pushFailedBatchesMap.computeIfAbsent(
              partitionUniqId,
              uniqueId2PushFailedBatchMapFunc)
            partitionPushFailedBatches.merge(locationPushFailedBatches)
          }
        }
        // Mapper with this attemptId finished, also check all other mapper finished or not.
        (true, ClientUtils.areAllMapperAttemptsFinished(attempts))
      } else {
        // Mapper with another attemptId finished, skip this request
        (false, false)
      }
    }
    if (shuffleIntegrityCheckEnabled && mapperAttemptFinishedSuccess) {
      val commitMetadataArray = commitMetadataForReducer.get(shuffleId)
      checkState(
        commitMetadataArray != null,
        "commitMetadataArray can only be null if shuffleId %s is not registered!",
        shuffleId)
      for (i <- 0 until numPartitions) {
        if (bytesWrittenPerPartition(i) != 0) {
          commitMetadataArray(i).addCommitData(
            crc32PerPartition(i),
            bytesWrittenPerPartition(i))
        }
      }
    }
    (mapperAttemptFinishedSuccess, allMapperFinished)
  }

  override def registerShuffle(
      shuffleId: Int,
      numMappers: Int,
      isSegmentGranularityVisible: Boolean,
      numPartitions: Int): Unit = {
    super.registerShuffle(shuffleId, numMappers, isSegmentGranularityVisible, numPartitions)
    getReducerFileGroupRequest.put(shuffleId, new util.HashSet[MultiSerdeVersionRpcContext]())
    initMapperAttempts(shuffleId, numMappers, numPartitions)
  }

  override def finishPartition(
      shuffleId: Int,
      partitionId: Int,
      startMapIndex: Int,
      endMapIndex: Int,
      actualCommitMetadata: CommitMetadata): (Boolean, String) = {
    logDebug(s"finish Partition call: shuffleId: $shuffleId, " +
      s"partitionId: $partitionId, " +
      s"startMapIndex: $startMapIndex " +
      s"endMapIndex: $endMapIndex, " +
      s"actualCommitMetadata: $actualCommitMetadata")
    val map = commitMetadataForReducer.get(shuffleId)
    checkState(
      map != null,
      "CommitMetadata map cannot be null for a registered shuffleId: %d",
      shuffleId)
    val expectedCommitMetadata = map(partitionId)
    if (endMapIndex == Integer.MAX_VALUE) {
      // complete partition available
      val bool = CommitMetadata.checkCommitMetadata(actualCommitMetadata, expectedCommitMetadata)
      var message = ""
      if (!bool) {
        message =
          s"CommitMetadata mismatch for shuffleId: $shuffleId partitionId: $partitionId expected: $expectedCommitMetadata actual: $actualCommitMetadata"
      } else {
        logInfo(
          s"CommitMetadata matched for shuffleID : $shuffleId, partitionId: $partitionId expected: $expectedCommitMetadata actual: $actualCommitMetadata")
      }
      return (bool, message)
    }

    val splitSkewPartitionWithoutMapRange =
      ClientUtils.readSkewPartitionWithoutMapRange(conf, startMapIndex, endMapIndex)

    val validator = skewPartitionCompletenessValidator.computeIfAbsent(
      shuffleId,
      new java.util.function.Function[Int, PartitionCompletenessValidator] {
        override def apply(key: Int): PartitionCompletenessValidator =
          new PartitionCompletenessValidator()
      })
    validator.validateSubPartition(
      partitionId,
      startMapIndex,
      endMapIndex,
      actualCommitMetadata,
      expectedCommitMetadata,
      shuffleMapperAttempts.get(shuffleId).length,
      splitSkewPartitionWithoutMapRange)
  }

  private def initMapperAttempts(shuffleId: Int, numMappers: Int, numPartitions: Int): Unit = {
    shuffleMapperAttempts.synchronized {
      if (!shuffleMapperAttempts.containsKey(shuffleId)) {
        val attempts = new Array[Int](numMappers)
        0 until numMappers foreach (idx => attempts(idx) = -1)
        shuffleMapperAttempts.put(shuffleId, attempts)
      }
      if (shuffleIntegrityCheckEnabled) {
        commitMetadataForReducer.put(shuffleId, Array.fill(numPartitions)(new CommitMetadata()))
      }
    }
  }

  private def replyGetReducerFileGroup(
      context: MultiSerdeVersionRpcContext,
      shuffleId: Int): Unit = {
    replyGetReducerFileGroup(context.ctx, shuffleId, context.serdeVersion)
  }

  private def replyGetReducerFileGroup(
      context: RpcCallContext,
      shuffleId: Int,
      serdeVersion: SerdeVersion): Unit = {
    if (isStageDataLost(shuffleId)) {
      context.reply(
        GetReducerFileGroupResponse(
          StatusCode.SHUFFLE_DATA_LOST,
          JavaUtils.newConcurrentHashMap(),
          Array.empty,
          new util.HashSet[Integer]()))
    } else {
      // LocalNettyRpcCallContext is for the UTs
      if (context.isInstanceOf[LocalNettyRpcCallContext]) {
        var response = GetReducerFileGroupResponse(
          StatusCode.SUCCESS,
          reducerFileGroupsMap.getOrDefault(shuffleId, JavaUtils.newConcurrentHashMap()),
          getMapperAttempts(shuffleId),
          serdeVersion = serdeVersion)

        // only check whether broadcast enabled for the UTs
        if (getReducerFileGroupResponseBroadcastEnabled) {
          response = broadcastGetReducerFileGroup(shuffleId, response)
        }

        context.reply(response)
      } else {
        val cachedMsg = getReducerFileGroupRpcCache.get(
          shuffleId,
          new Callable[ByteBuffer]() {
            override def call(): ByteBuffer = {
              val returnedMsg = GetReducerFileGroupResponse(
                StatusCode.SUCCESS,
                reducerFileGroupsMap.getOrDefault(shuffleId, JavaUtils.newConcurrentHashMap()),
                getMapperAttempts(shuffleId),
                pushFailedBatches =
                  shufflePushFailedBatches.getOrDefault(
                    shuffleId,
                    new util.HashMap[String, LocationPushFailedBatches]()),
                serdeVersion = serdeVersion)

              val serializedMsg =
                context.asInstanceOf[RemoteNettyRpcCallContext].nettyEnv.serialize(returnedMsg)
              logInfo(
                s"Shuffle $shuffleId GetReducerFileGroupResponse size " + serializedMsg.capacity())

              if (getReducerFileGroupResponseBroadcastEnabled &&
                serializedMsg.capacity() >= getReducerFileGroupResponseBroadcastMiniSize) {
                val broadcastMsg = broadcastGetReducerFileGroup(shuffleId, returnedMsg)
                if (broadcastMsg != returnedMsg) {
                  val serializedBroadcastMsg =
                    context.asInstanceOf[RemoteNettyRpcCallContext].nettyEnv.serialize(broadcastMsg)
                  logInfo(s"Shuffle $shuffleId GetReducerFileGroupResponse size" +
                    s" ${serializedMsg.capacity()} reached the broadcast threshold" +
                    s" $getReducerFileGroupResponseBroadcastMiniSize," +
                    s" the broadcast response size is ${serializedBroadcastMsg.capacity()}.")
                  serializedBroadcastMsg
                } else {
                  serializedMsg
                }
              } else {
                serializedMsg
              }
            }
          })
        context.asInstanceOf[RemoteNettyRpcCallContext].callback.onSuccess(cachedMsg)
      }
    }
  }

  private def broadcastGetReducerFileGroup(
      shuffleId: Int,
      response: GetReducerFileGroupResponse): GetReducerFileGroupResponse = {
    lifecycleManager.broadcastGetReducerFileGroupResponse(shuffleId, response) match {
      case Some(broadcastBytes) if broadcastBytes.nonEmpty =>
        GetReducerFileGroupResponse(
          response.status,
          broadcast = broadcastBytes,
          serdeVersion = response.serdeVersion)
      case _ => response
    }
  }

  override def handleGetReducerFileGroup(
      context: RpcCallContext,
      shuffleId: Int,
      serdeVersion: SerdeVersion): Unit = {
    // Quick return for ended stage, avoid occupy sync lock.
    if (isStageEnd(shuffleId)) {
      replyGetReducerFileGroup(context, shuffleId, serdeVersion)
    } else {
      getReducerFileGroupRequest.synchronized {
        // If setStageEnd() called after isStageEnd and before got lock, should reply here.
        if (isStageEnd(shuffleId)) {
          replyGetReducerFileGroup(context, shuffleId, serdeVersion)
        } else {
          getReducerFileGroupRequest.get(shuffleId).add(new MultiSerdeVersionRpcContext(
            context,
            serdeVersion))
        }
      }
    }
  }

  override def handleGetStageEnd(context: RpcCallContext, shuffleId: Int): Unit = {
    context.reply(PbGetStageEndResponse.newBuilder().setStageEnd(isStageEnd(shuffleId)).build())
  }

  override def waitStageEnd(shuffleId: Int): (Boolean, Long) = {
    var timeout = stageEndTimeout
    val delta = 100
    while (!isStageEnd(shuffleId) && timeout > 0) {
      Thread.sleep(delta)
      timeout = timeout - delta
    }

    (timeout <= 0, stageEndTimeout - timeout)
  }
}
