arangodb/tests/Aql/RowFetcherHelper.h

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2018 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 Tobias Goedderz
/// @author Michael Hackstein
/// @author Heiko Kernbach
/// @author Jan Christoph Uhde
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGOD_AQL_TESTS_ROW_FETCHER_HELPER_H
#define ARANGOD_AQL_TESTS_ROW_FETCHER_HELPER_H

#include "Aql/AllRowsFetcher.h"
#include "Aql/AqlItemBlockManager.h"
#include "Aql/ConstFetcher.h"
#include "Aql/ExecutionBlock.h"
#include "Aql/ExecutionState.h"
#include "Aql/InputAqlItemRow.h"
#include "Aql/ResourceUsage.h"
#include "Aql/SingleRowFetcher.h"
#include "Aql/VelocyPackHelper.h"

#include <Basics/Common.h>
#include <velocypack/Buffer.h>
#include <velocypack/Builder.h>
#include <velocypack/Slice.h>

namespace arangodb {

namespace aql {
class AqlItemBlock;
class AqlItemBlockManager;
class InputAqlItemRow;
class AqlItemMatrix;
}  // namespace aql

namespace tests {
namespace aql {

/**
 * @brief Mock for SingleRowFetcher
 */
template <bool passBlocksThrough>
class SingleRowFetcherHelper
    : public arangodb::aql::SingleRowFetcher<passBlocksThrough> {
 public:
  SingleRowFetcherHelper(arangodb::aql::AqlItemBlockManager& manager,
                         size_t blockSize, bool returnsWaiting,
                         arangodb::aql::SharedAqlItemBlockPtr input);

  // backwards compatible constructor
  SingleRowFetcherHelper(arangodb::aql::AqlItemBlockManager& manager,
                         std::shared_ptr<arangodb::velocypack::Buffer<uint8_t>> const& vPackBuffer,
                         bool returnsWaiting);

  virtual ~SingleRowFetcherHelper();

  // NOLINTNEXTLINE google-default-arguments
  std::pair<arangodb::aql::ExecutionState, arangodb::aql::InputAqlItemRow> fetchRow(
      size_t atMost = arangodb::aql::ExecutionBlock::DefaultBatchSize()) override;

  uint64_t nrCalled() { return _nrCalled; }

  size_t totalSkipped() const { return _totalSkipped; }

  std::pair<arangodb::aql::ExecutionState, size_t> skipRows(size_t atMost) override;

  std::pair<arangodb::aql::ExecutionState, arangodb::aql::SharedAqlItemBlockPtr> fetchBlockForPassthrough(
      size_t atMost) override;

  bool isDone() const { return _returnedDone; }

  arangodb::aql::AqlItemBlockManager& itemBlockManager() { return _itemBlockManager; }

 private:
  arangodb::aql::SharedAqlItemBlockPtr& getItemBlock() { return _itemBlock; }
  arangodb::aql::SharedAqlItemBlockPtr const& getItemBlock() const { return _itemBlock; }

  void nextRow() {
    _curRowIndex++;
    _curIndexInBlock = (_curIndexInBlock + 1) % _blockSize;
  }

  bool wait() {
    // Wait on the first row of every block, if applicable
    if (_returnsWaiting && _curIndexInBlock == 0) {
      // If the insert succeeds, we have not yet waited at this index.
      bool const waitNow = _didWaitAt.insert(_curRowIndex).second;

      return waitNow;
    }

    return false;
  }

 private:
  bool _returnedDone = false;
  bool const _returnsWaiting;
  uint64_t _nrItems;
  uint64_t _nrCalled{};
  size_t _skipped{};
  size_t _totalSkipped{};
  size_t _curIndexInBlock{};
  size_t _curRowIndex{};
  size_t _blockSize;
  std::unordered_set<size_t> _didWaitAt;
  arangodb::aql::AqlItemBlockManager& _itemBlockManager;
  arangodb::aql::SharedAqlItemBlockPtr _itemBlock;
  arangodb::aql::InputAqlItemRow _lastReturnedRow{arangodb::aql::CreateInvalidInputRowHint{}};
};

/**
 * @brief Mock for AllRowsFetcher
 */
class AllRowsFetcherHelper : public arangodb::aql::AllRowsFetcher {
 public:
  AllRowsFetcherHelper(std::shared_ptr<arangodb::velocypack::Buffer<uint8_t>> vPackBuffer,
                       bool returnsWaiting);
  ~AllRowsFetcherHelper();

  std::pair<arangodb::aql::ExecutionState, arangodb::aql::AqlItemMatrix const*> fetchAllRows() override;

 private:
  std::shared_ptr<arangodb::velocypack::Buffer<uint8_t>> _vPackBuffer;
  arangodb::velocypack::Slice _data;
  bool _returnedDone = false;
  bool _returnsWaiting;
  uint64_t _nrItems;
  arangodb::aql::RegisterCount _nrRegs;
  uint64_t _nrCalled;
  arangodb::aql::ResourceMonitor _resourceMonitor;
  arangodb::aql::AqlItemBlockManager _itemBlockManager;
  std::unique_ptr<arangodb::aql::AqlItemMatrix> _matrix;
};

class ConstFetcherHelper : public arangodb::aql::ConstFetcher {
 public:
  ConstFetcherHelper(arangodb::aql::AqlItemBlockManager& itemBlockManager,
                     std::shared_ptr<arangodb::velocypack::Buffer<uint8_t>> vPackBuffer);
  virtual ~ConstFetcherHelper();

  std::pair<arangodb::aql::ExecutionState, arangodb::aql::InputAqlItemRow> fetchRow() override;

 private:
  std::shared_ptr<arangodb::velocypack::Buffer<uint8_t>> _vPackBuffer;
  arangodb::velocypack::Slice _data;
};

}  // namespace aql
}  // namespace tests
}  // namespace arangodb

#endif