////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2019-2019 ArangoDB GmbH, Cologne, Germany
///
/// Licensed 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.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Michael Hackstein
////////////////////////////////////////////////////////////////////////////////

#include "DistributeConsumerNode.h"

#include "Aql/ClusterNodes.h"
#include "Aql/ExecutionBlock.h"
#include "Aql/IdExecutor.h"
#include "Aql/RegisterPlan.h"
#include "Aql/SingleRowFetcher.h"
#include "Basics/VelocyPackHelper.h"

using namespace arangodb;
using namespace arangodb::aql;
using namespace arangodb::basics;

DistributeConsumerNode::DistributeConsumerNode(ExecutionPlan* plan,
                                               arangodb::velocypack::Slice const& base)
    : ExecutionNode(plan, base),
      _distributeId(VelocyPackHelper::getStringValue(base, "distributeId", "")),
      _isResponsibleForInitializeCursor(
          base.get("isResponsibleForInitializeCursor").getBoolean()) {}

void DistributeConsumerNode::toVelocyPackHelper(VPackBuilder& nodes, unsigned flags,
                                                std::unordered_set<ExecutionNode const*>& seen) const {
  // Local variant
  toVelocyPackHelperInternal(nodes, flags, seen);
  // And close it:
  nodes.close();
}

void DistributeConsumerNode::toVelocyPackHelperInternal(
    VPackBuilder& nodes, unsigned flags, std::unordered_set<ExecutionNode const*>& seen) const {
  // call base class method
  ExecutionNode::toVelocyPackHelperGeneric(nodes, flags, seen);
  nodes.add("distributeId", VPackValue(_distributeId));
  nodes.add("isResponsibleForInitializeCursor", VPackValue(_isResponsibleForInitializeCursor));
}

std::unique_ptr<ExecutionBlock> DistributeConsumerNode::createBlock(
    ExecutionEngine& engine, std::unordered_map<ExecutionNode*, ExecutionBlock*> const&) const {
  TRI_ASSERT(hasDependency());
  ExecutionNode const* previousNode = getFirstDependency();
  TRI_ASSERT(previousNode != nullptr);
  TRI_ASSERT(getRegisterPlan()->nrRegs[previousNode->getDepth()] ==
             getRegisterPlan()->nrRegs[getDepth()]);
  IdExecutorInfos infos(getRegisterPlan()->nrRegs[getDepth()], calcRegsToKeep(),
                        getRegsToClear(), _distributeId, _isResponsibleForInitializeCursor);
  return std::make_unique<ExecutionBlockImpl<IdExecutor<BlockPassthrough::Enable, SingleRowFetcher<BlockPassthrough::Enable>>>>(
      &engine, this, std::move(infos));
}

void DistributeConsumerNode::cloneRegisterPlan(ScatterNode* dependency) {
  TRI_ASSERT(hasDependency());
  TRI_ASSERT(getFirstDependency() == dependency);
  _registerPlan = dependency->getRegisterPlan();
  _depth = dependency->getDepth();
  {
    auto later = dependency->getVarsUsedLater();
    setVarsUsedLater(later);
  }
  {
    auto valid = dependency->getVarsValid();
    setVarsValid(valid);
  }
  setVarUsageValid();
}