/*jshint globalstrict:false, strict:false, maxlen: 500 */
/*global assertEqual, assertNotEqual, assertTrue, assertFalse, AQL_EXECUTE, AQL_EXPLAIN */

////////////////////////////////////////////////////////////////////////////////
/// @brief tests for COLLECT w/ COUNT
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2010-2012 triagens 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 triAGENS GmbH, Cologne, Germany
///
/// @author Jan Steemann
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////

var jsunity = require("jsunity");
var db = require("@arangodb").db;
var internal = require("internal");
const isCluster = require("@arangodb/cluster").isCluster();

////////////////////////////////////////////////////////////////////////////////
/// @brief test suite
////////////////////////////////////////////////////////////////////////////////

function optimizerCollectMethodsTestSuite () {
  var c;

  return {
    setUp : function () {
      db._drop("UnitTestsCollection");
      c = db._create("UnitTestsCollection", { numberOfShards: 3 });

      for (var i = 0; i < 1500; ++i) {
        c.save({ group: "test" + (i % 10), value: i, haxe: "test" + i });
      }
    },

    tearDown : function () {
      db._drop("UnitTestsCollection");
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief number of plans
////////////////////////////////////////////////////////////////////////////////
    
    testHashedNumberOfPlans : function () {
      var queries = [
        "FOR j IN " + c.name() + " COLLECT value = j RETURN value",
        "FOR j IN " + c.name() + " COLLECT value = j WITH COUNT INTO l RETURN [ value, l ]"
      ];

      queries.forEach(function(query) {
        var plans = AQL_EXPLAIN(query, null, { allPlans: true, optimizer: { rules: [ "-all" ] } }).plans;

        assertEqual(2, plans.length);
      });
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief number of plans
////////////////////////////////////////////////////////////////////////////////

    testSortedNumberOfPlans : function () {
      c.ensureIndex({ type: "skiplist", fields: [ "value" ] }); 
      var queries = [
        "FOR j IN " + c.name() + " COLLECT value = j RETURN value",
        "FOR j IN " + c.name() + " COLLECT value = j WITH COUNT INTO l RETURN [ value, l ]"
      ];
      
      queries.forEach(function(query) {
        var plans = AQL_EXPLAIN(query, null, { allPlans: true, optimizer: { rules: [ "-all" ] } }).plans;

        assertEqual(2, plans.length);
      });
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief number of plans
////////////////////////////////////////////////////////////////////////////////

    testNumberOfPlansWithInto : function () {
      var queries = [
        "FOR j IN " + c.name() + " COLLECT value = j INTO g RETURN g",
        "FOR j IN " + c.name() + " COLLECT value = j INTO g = j.haxe RETURN g",
        "FOR j IN " + c.name() + " COLLECT value = j INTO g RETURN [ value, g ]",
        "FOR j IN " + c.name() + " COLLECT value = j INTO g KEEP j RETURN g"
      ];
      
      queries.forEach(function(query) {
        var plans = AQL_EXPLAIN(query, null, { allPlans: true, optimizer: { rules: [ "-all" ] } }).plans;

        assertEqual(1, plans.length);
      });
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief expect hash COLLECT
////////////////////////////////////////////////////////////////////////////////

    testHashed : function () {
      var queries = [
        [ "FOR j IN " + c.name() + " COLLECT value = j RETURN value", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.haxe RETURN value", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group RETURN value", 10 ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value RETURN [ value1, value2 ]", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group WITH COUNT INTO l RETURN [ value, l ]", 10 ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value WITH COUNT INTO l RETURN [ value1, value2, l ]", 1500 ]
      ];

      queries.forEach(function(query) {
        var plan = AQL_EXPLAIN(query[0]).plan;

        var aggregateNodes = 0;
        var sortNodes = 0;
        plan.nodes.map(function(node) {
          if (node.type === "CollectNode") {
            ++aggregateNodes;
            assertEqual("hash", node.collectOptions.method);
          }
          if (node.type === "SortNode") {
            ++sortNodes;
          }
        });
        
        assertEqual(isCluster ? 2 : 1, aggregateNodes);
        assertEqual(1, sortNodes);

        var results = AQL_EXECUTE(query[0]);
        assertEqual(query[1], results.json.length);
      });
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief expect hash COLLECT
////////////////////////////////////////////////////////////////////////////////

    testHashedWithNonSortedIndexMMFiles : function () {
      if (db._engine().name !== "mmfiles") {
        return;
      }
      
      c.ensureIndex({ type: "hash", fields: [ "group" ] }); 
      c.ensureIndex({ type: "hash", fields: [ "group", "value" ] }); 

      var queries = [
        [ "FOR j IN " + c.name() + " COLLECT value = j RETURN value", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.haxe RETURN value", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group RETURN value", 10 ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value RETURN [ value1, value2 ]", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group WITH COUNT INTO l RETURN [ value, l ]", 10 ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value WITH COUNT INTO l RETURN [ value1, value2, l ]", 1500 ]
      ];

      queries.forEach(function(query) {
        var plan = AQL_EXPLAIN(query[0]).plan;

        var aggregateNodes = 0;
        var sortNodes = 0;
        plan.nodes.map(function(node) {
          if (node.type === "CollectNode") {
            ++aggregateNodes;
            assertEqual("hash", node.collectOptions.method);
          }
          if (node.type === "SortNode") {
            ++sortNodes;
          }
        });
        
        assertEqual(isCluster ? 2 : 1, aggregateNodes);
        assertEqual(1, sortNodes);

        var results = AQL_EXECUTE(query[0]);
        assertEqual(query[1], results.json.length);
      });
    },
    
    
    ////////////////////////////////////////////////////////////////////////////////
    /// @brief expect hash COLLECT
    ////////////////////////////////////////////////////////////////////////////////
    
    testHashedWithNonSortedIndexRocksDB : function () {
      if (db._engine().name !== "rocksdb") {
        return;
      }
      
      c.ensureIndex({ type: "hash", fields: [ "group" ] });
      c.ensureIndex({ type: "hash", fields: [ "group", "value" ] });
      
      var queries = [
                     [ "FOR j IN " + c.name() + " COLLECT value = j RETURN value", 1500, false],
                     [ "FOR j IN " + c.name() + " COLLECT value = j.haxe RETURN value", 1500, false],
                     [ "FOR j IN " + c.name() + " COLLECT value = j.group RETURN value", 10, true],
                     [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value RETURN [ value1, value2 ]", 1500, true ],
                     [ "FOR j IN " + c.name() + " COLLECT value = j.group WITH COUNT INTO l RETURN [ value, l ]", 10, true ],
                     [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value WITH COUNT INTO l RETURN [ value1, value2, l ]", 1500, true ]
                     ];
      
      queries.forEach(function(query) {
          var plan = AQL_EXPLAIN(query[0]).plan;
          
          var aggregateNodes = 0;
          var sortNodes = 0;
          plan.nodes.map(function(node) {
            if (node.type === "CollectNode") {
              ++aggregateNodes;
              assertFalse(query[2] && node.collectOptions.method !== "sorted");
              assertEqual(query[2] ? "sorted" : "hash",
                         node.collectOptions.method, query[0]);
            }
            if (node.type === "SortNode") {
              ++sortNodes;
            }
          });

          assertEqual(isCluster ? 2 : 1, aggregateNodes);
          assertEqual(query[2] ? 0 : 1, sortNodes);
          
          var results = AQL_EXECUTE(query[0]);
          assertEqual(query[1], results.json.length);
       });
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief expect sorted COLLECT
////////////////////////////////////////////////////////////////////////////////

    testSortedIndex : function () {
      c.ensureIndex({ type: "skiplist", fields: [ "group" ] });
      c.ensureIndex({ type: "skiplist", fields: [ "group", "value" ] });

      var queries = [
        [ "FOR j IN " + c.name() + " COLLECT value = j.group RETURN value", 10 ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value RETURN [ value1, value2 ]", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group WITH COUNT INTO l RETURN [ value, l ]", 10 ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value WITH COUNT INTO l RETURN [ value1, value2, l ]", 1500 ]
      ];

      queries.forEach(function(query) {
        var plan = AQL_EXPLAIN(query[0]).plan;

        var aggregateNodes = 0;
        var sortNodes = 0;
        plan.nodes.map(function(node) {
          if (node.type === "CollectNode") {
            ++aggregateNodes;
            assertEqual("sorted", node.collectOptions.method);
          }
          if (node.type === "SortNode") {
            ++sortNodes;
          }
        });

        assertEqual(isCluster ? 2 : 1, aggregateNodes);
        assertEqual(0, sortNodes);

        var results = AQL_EXECUTE(query[0]);
        assertEqual(query[1], results.json.length);
      });
    },

    testSortedIndex2 : function () {
      c.ensureIndex({ type: "skiplist", fields: [ "group", "value" ] });

      var queries = [
        [ "FOR j IN " + c.name() + " COLLECT value = 1 RETURN value", 1 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j RETURN 1", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j RETURN value", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.value RETURN value", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.value WITH COUNT INTO l RETURN [ value, l ]", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value RETURN [ value1, value2 ]", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group WITH COUNT INTO l RETURN [ value, l ]", 10 ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value WITH COUNT INTO l RETURN [ value1, value2, l ]", 1500 ]
      ];

      queries.forEach(function(query) {
        let plan = AQL_EXPLAIN(query[0]).plan;

        let aggregateNodes = 0;
        plan.nodes.map(function(node) {
          if (node.type === "CollectNode") {
            ++aggregateNodes;
          }
        });

        assertEqual(isCluster ? 2 : 1, aggregateNodes);

        let results = AQL_EXECUTE(query[0]);
        assertEqual(query[1], results.json.length, query);
      });
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief expect hash COLLECT w/ sort node removed
////////////////////////////////////////////////////////////////////////////////

    testSortRemoval : function () {
      var queries = [
        [ "FOR j IN " + c.name() + " COLLECT value = j SORT null RETURN value", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.haxe SORT null RETURN value", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group SORT null RETURN value", 10 ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value SORT null RETURN [ value1, value2 ]", 1500 ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group WITH COUNT INTO l SORT null RETURN [ value, l ]", 10 ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value WITH COUNT INTO l SORT null RETURN [ value1, value2, l ]", 1500 ]
      ];

      queries.forEach(function(query) {
        var plan = AQL_EXPLAIN(query[0]).plan;

        var aggregateNodes = 0;
        var sortNodes = 0;
        plan.nodes.map(function(node) {
          if (node.type === "CollectNode") {
            ++aggregateNodes;
            assertEqual("hash", node.collectOptions.method);
          }
          if (node.type === "SortNode") {
            ++sortNodes;
          }
        });
        
        assertEqual(isCluster ? 2 : 1, aggregateNodes);
        assertEqual(0, sortNodes);

        var results = AQL_EXECUTE(query[0]);
        assertEqual(query[1], results.json.length);
      });
    },

    testSkip : function () {
      for (var i = 0; i < 10000; ++i) {
        c.insert({ value: "test" + i });
      }

      var query = "FOR doc IN " + c.name() + " COLLECT v = doc.value INTO group LIMIT 1, 2 RETURN group"; 
        
      var plan = AQL_EXPLAIN(query).plan;

      var aggregateNodes = 0;
      var sortNodes = 0;
      plan.nodes.map(function(node) {
        if (node.type === "CollectNode") {
          ++aggregateNodes;
          assertEqual("sorted", node.collectOptions.method);
        }
        if (node.type === "SortNode") {
          ++sortNodes;
        }
      });
        
      assertEqual(1, aggregateNodes);
      assertEqual(1, sortNodes);

      var result = AQL_EXECUTE(query).json;
      assertEqual(2, result.length);
      assertTrue(Array.isArray(result[0]));
      assertTrue(Array.isArray(result[1]));
      assertEqual(1, result[0].length);
      assertEqual(1, result[1].length);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test override of collect method
////////////////////////////////////////////////////////////////////////////////

    testOverrideMethodWithHashButHavingIndex : function () {
      c.ensureIndex({ type: "skiplist", fields: [ "group" ] }); 
      c.ensureIndex({ type: "skiplist", fields: [ "group", "value" ] }); 

      // the expectation is that the optimizer will still use the 'sorted' method here as there are
      // sorted indexes supporting it
      var queries = [
        [ "FOR j IN " + c.name() + " COLLECT value = j.group INTO g OPTIONS { method: 'hash' } RETURN [ value, g ]", "sorted" ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group INTO g OPTIONS { method: 'sorted' } RETURN [ value, g ]", "sorted" ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group INTO g RETURN [ value, g ]", "sorted" ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group OPTIONS { method: 'hash' } RETURN value", "hash" ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group OPTIONS { method: 'sorted' } RETURN value", "sorted" ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group RETURN value", "sorted" ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group OPTIONS { method: 'hash' } RETURN value", "hash" ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group OPTIONS { method: 'sorted' } RETURN value", "sorted" ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group RETURN value", "sorted" ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value OPTIONS { method: 'hash' } RETURN [ value1, value2 ]", "hash" ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value OPTIONS { method: 'sorted' } RETURN [ value1, value2 ]", "sorted" ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value RETURN [ value1, value2 ]", "sorted" ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group WITH COUNT INTO l OPTIONS { method: 'hash' } RETURN [ value, l ]", "hash" ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group WITH COUNT INTO l OPTIONS { method: 'sorted' } RETURN [ value, l ]", "sorted" ],
        [ "FOR j IN " + c.name() + " COLLECT value = j.group WITH COUNT INTO l RETURN [ value, l ]", "sorted" ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value WITH COUNT INTO l OPTIONS { method: 'hash' } RETURN [ value1, value2, l ]", "hash" ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value WITH COUNT INTO l OPTIONS { method: 'sorted' } RETURN [ value1, value2, l ]", "sorted" ],
        [ "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value WITH COUNT INTO l RETURN [ value1, value2, l ]", "sorted" ]
      ];

      queries.forEach(function(query) {
        var plan = AQL_EXPLAIN(query[0]).plan;

        var aggregateNodes = 0;
        var sortNodes = 0;
        let hasInto = false;
        plan.nodes.map(function(node) {
          if (node.type === "CollectNode") {
            ++aggregateNodes;
            assertEqual(query[1], node.collectOptions.method, query);
            if (node.outVariable && !node.count) {
              hasInto = true;
            }
          }
          if (node.type === "SortNode") {
            ++sortNodes;
          }
        });
       
        assertEqual((isCluster && !hasInto) ? 2 : 1, aggregateNodes);
        assertEqual(query[1] === 'hash' ? 1 : 0, sortNodes);
      });
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test override of collect method
////////////////////////////////////////////////////////////////////////////////

    testOverrideMethodSortedUsed : function () {
      // the expectation is that the optimizer will use the 'sorted' method here because we
      // explicitly ask for it
      var queries = [
        "FOR j IN " + c.name() + " COLLECT value = j.group INTO g OPTIONS { method: 'sorted' } RETURN [ value, g ]",
        "FOR j IN " + c.name() + " COLLECT value = j.group OPTIONS { method: 'sorted' } RETURN value",
        "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value OPTIONS { method: 'sorted' } RETURN [ value1, value2 ]",
        "FOR j IN " + c.name() + " COLLECT value = j.group WITH COUNT INTO l OPTIONS { method: 'sorted' } RETURN [ value, l ]",
        "FOR j IN " + c.name() + " COLLECT value1 = j.group, value2 = j.value WITH COUNT INTO l OPTIONS { method: 'sorted' } RETURN [ value1, value2, l ]"
      ];

      queries.forEach(function(query) {
        var plan = AQL_EXPLAIN(query).plan;

        var aggregateNodes = 0;
        var sortNodes = 0;
        let hasInto = false;
        plan.nodes.map(function(node) {
          if (node.type === "CollectNode") {
            ++aggregateNodes;
            assertEqual("sorted", node.collectOptions.method);
            if (node.outVariable && !node.count) {
              hasInto = true;
            }
          }
          if (node.type === "SortNode") {
            ++sortNodes;
          }
        });
        
        assertEqual((isCluster && !hasInto) ? 2 : 1, aggregateNodes);
        assertEqual(1, sortNodes);
      });
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test multiple collects in single query
////////////////////////////////////////////////////////////////////////////////

    testMultipleCollectsInSingleQuery : function () {
      // this will tell the optimizer to optimize the cloned plan with this specific rule again
      var result = AQL_EXECUTE("LET values1 = (FOR i IN 1..4 COLLECT x = i RETURN x)  LET values2 = (FOR i IN 2..6 COLLECT x = i RETURN x) RETURN [ values1, values2 ]").json[0];

      assertEqual([ 1, 2, 3, 4 ], result[0]);
      assertEqual([ 2, 3, 4, 5, 6 ], result[1]);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test collect result bigger than block size
////////////////////////////////////////////////////////////////////////////////

    testCollectResultBiggerThanBlocksize : function () {
      var result = AQL_EXECUTE("FOR doc IN " + c.name() + " COLLECT id = doc.value INTO g RETURN { id, g }").json;
      assertEqual(1500, result.length);
      
      result = AQL_EXECUTE("FOR doc IN " + c.name() + " COLLECT id = doc.group INTO g RETURN { id, g }").json;
      assertEqual(10, result.length);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test many collects
////////////////////////////////////////////////////////////////////////////////
   
    testManyCollects : function () {
      c.truncate();
      c.insert({ value: 3 });
      var q = "", g = [];
      for (var i = 0; i < 10; ++i) {
        q += "LET q" + i + " = (FOR doc IN " + c.name() + " COLLECT id = doc.value RETURN id) ";
        g.push("q" + i);
      }
      q += "RETURN INTERSECTION(" + g.join(", ") + ")";
      assertTrue(AQL_EXPLAIN(q, null).stats.plansCreated >= 128);
      var result = AQL_EXECUTE(q).json;
      assertEqual([3], result[0]);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test collect with offset
////////////////////////////////////////////////////////////////////////////////
 
    testCollectWithOffset : function () {
      // create a skiplist index so the optimizer can use the sorted collect
      c.ensureIndex({ type: "skiplist", fields: [ "value" ] });
      var query = "FOR doc IN " + c.name() + " COLLECT v = doc.value OPTIONS { method: 'sorted' } LIMIT 1001, 2 RETURN v";
        
      var plan = AQL_EXPLAIN(query).plan;

      // we want a sorted collect!
      var aggregateNodes = 0;
      let hasInto = false;
      plan.nodes.map(function(node) {
        assertNotEqual("SortNode", node.type);
        if (node.type === "CollectNode") {
          ++aggregateNodes;
          assertEqual("sorted", node.collectOptions.method);
          if (node.outVariable && !node.count) {
            hasInto = true;
          }
        }
      });
    
      assertEqual((isCluster && !hasInto) ? 2 : 1, aggregateNodes);
      
      var result = AQL_EXECUTE(query).json;
      assertEqual([ 1001, 1002 ], result);
    }
  
  };
}

////////////////////////////////////////////////////////////////////////////////
/// @brief executes the test suite
////////////////////////////////////////////////////////////////////////////////

jsunity.run(optimizerCollectMethodsTestSuite);

return jsunity.done();