/*
 * 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.texera.amber.engine.architecture.controller.promisehandlers

import com.twitter.util.Future
import org.apache.texera.amber.engine.architecture.controller.{
  ControllerAsyncRPCHandlerInitializer,
  ExecutionStateUpdate
}
import org.apache.texera.amber.engine.architecture.rpc.controlcommands.{
  AsyncRPCContext,
  EmptyRequest,
  QueryStatisticsRequest,
  StatisticsUpdateTarget
}
import org.apache.texera.amber.engine.architecture.rpc.controlreturns.EmptyReturn
import org.apache.texera.amber.engine.common.virtualidentity.util.SELF

/** indicate a worker has completed its execution
  * i.e. received and processed all data from upstreams
  * note that this doesn't mean all the output of this worker
  * has been received by the downstream workers.
  *
  * possible sender: worker
  */
trait WorkerExecutionCompletedHandler {
  this: ControllerAsyncRPCHandlerInitializer =>

  override def workerExecutionCompleted(
      msg: EmptyRequest,
      ctx: AsyncRPCContext
  ): Future[EmptyReturn] = {

    // after worker execution is completed, query statistics immediately one last time
    // because the worker might be killed before the next query statistics interval
    // and the user sees the last update before completion
    val statsRequest =
      controllerInterface.controllerInitiateQueryStatistics(
        QueryStatisticsRequest(Seq(ctx.sender), StatisticsUpdateTarget.BOTH_UI_AND_PERSISTENCE),
        mkContext(SELF)
      )

    Future
      .collect(Seq(statsRequest))
      .flatMap(_ => {
        // if entire workflow is completed, clean up
        if (cp.workflowExecution.isCompleted) {
          // after query result come back: send completed event, cleanup ,and kill workflow
          sendToClient(ExecutionStateUpdate(cp.workflowExecution.getState))
          cp.controllerTimerService.disableStatusUpdate()
          cp.controllerTimerService.disableRuntimeStatisticsCollection()
        }
      })
    EmptyReturn()
  }
}
