1
0
Fork 0
arangodb/tests/js/server/aql/aql-profiler-noncluster.js

423 lines
17 KiB
JavaScript

/*jshint globalstrict:true, strict:true, esnext: true */
"use strict";
////////////////////////////////////////////////////////////////////////////////
/// 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 Gödderz
////////////////////////////////////////////////////////////////////////////////
// contains common code for aql-profiler* tests
const profHelper = require("@arangodb/aql-profiler-test-helper");
const _ = require('lodash');
const db = require('@arangodb').db;
const jsunity = require("jsunity");
////////////////////////////////////////////////////////////////////////////////
/// @file test suite for AQL tracing/profiling: noncluster tests
/// Contains tests for EnumerateCollectionBlock, IndexBlock and TraversalBlock.
/// The main test suite (including comments) is in aql-profiler.js.
////////////////////////////////////////////////////////////////////////////////
function ahuacatlProfilerTestSuite () {
// import some names from profHelper directly into our namespace:
const colName = profHelper.colName;
const edgeColName = profHelper.edgeColName;
const viewName = profHelper.viewName;
const defaultBatchSize = profHelper.defaultBatchSize;
const { CalculationNode, CollectNode, DistributeNode, EnumerateCollectionNode,
EnumerateListNode, EnumerateViewNode, FilterNode, GatherNode, IndexNode,
InsertNode, LimitNode, NoResultsNode, RemoteNode, RemoveNode, ReplaceNode,
ReturnNode, ScatterNode, ShortestPathNode, SingletonNode, SortNode,
SubqueryNode, TraversalNode, UpdateNode, UpsertNode } = profHelper;
const { CalculationBlock, CountCollectBlock, DistinctCollectBlock,
EnumerateCollectionBlock, EnumerateListBlock, FilterBlock,
HashedCollectBlock, IndexBlock, LimitBlock, NoResultsBlock, RemoteBlock,
ReturnBlock, ShortestPathBlock, SingletonBlock, SortBlock,
SortedCollectBlock, SortingGatherBlock, SubqueryBlock, TraversalBlock,
UnsortingGatherBlock, RemoveBlock, InsertBlock, UpdateBlock, ReplaceBlock,
UpsertBlock, ScatterBlock, DistributeBlock, IResearchViewUnorderedBlock,
IResearchViewBlock, IResearchViewOrderedBlock } = profHelper;
return {
////////////////////////////////////////////////////////////////////////////////
/// @brief set up
////////////////////////////////////////////////////////////////////////////////
setUp : function () {
},
////////////////////////////////////////////////////////////////////////////////
/// @brief tear down
////////////////////////////////////////////////////////////////////////////////
tearDown : function () {
db._drop(colName);
db._drop(edgeColName);
db._dropView(viewName);
},
////////////////////////////////////////////////////////////////////////////////
/// @brief test EnumerateCollectionBlock
////////////////////////////////////////////////////////////////////////////////
/*testEnumerateCollectionBlock1: function () {
const col = db._create(colName);
const prepare = (rows) => {
col.truncate();
col.insert(_.range(1, rows + 1).map((i) => ({value: i})));
};
const bind = () => ({'@col': colName});
const query = `FOR d IN @@col RETURN d.value`;
const genNodeList = (rows, batches) => {
if (db._engine().name === 'mmfiles') {
// mmfiles lies about hasMore when asked for exactly the number of
// arguments left in the collection, so we have 1 more call when
// defaultBatchSize divides the actual number of rows.
// rocksdb on the other hand is exact.
batches = Math.floor(rows / defaultBatchSize) + 1;
}
return [
{type: SingletonBlock, calls: 1, items: 1},
{type: EnumerateCollectionBlock, calls: batches, items: rows},
{type: CalculationBlock, calls: batches, items: rows},
{type: ReturnBlock, calls: batches, items: rows}
];
};
profHelper.runDefaultChecks(
{query, genNodeList, prepare, bind}
);
},
////////////////////////////////////////////////////////////////////////////////
/// @brief test IndexBlock
////////////////////////////////////////////////////////////////////////////////
testIndexBlock1 : function () {
const col = db._create(colName);
col.ensureIndex({ type: "hash", fields: [ "value" ] });
const prepare = (rows) => {
col.truncate();
col.insert(_.range(1, rows + 1).map((i) => ({value: i})));
};
const bind = (rows) => ({'@col': colName, rows});
const query = `FOR i IN 1..@rows FOR d IN @@col FILTER i == d.value RETURN d.value`;
const genNodeList = (rows, batches) => {
// IndexBlock returns HASMORE when asked for the exact number of items
// it has left. This could be improved.
const optimalBatches = Math.ceil(rows / defaultBatchSize);
const maxIndexBatches = Math.floor(rows / defaultBatchSize) + 1;
const indexBatches = [optimalBatches, maxIndexBatches];
return [
{type: SingletonBlock, calls: 1, items: 1},
{type: CalculationBlock, calls: 1, items: 1},
{type: EnumerateListBlock, calls: batches, items: rows},
{type: IndexBlock, calls: indexBatches, items: rows},
{type: CalculationBlock, calls: indexBatches, items: rows},
{type: ReturnBlock, calls: indexBatches, items: rows}
];
};
profHelper.runDefaultChecks(
{query, genNodeList, prepare, bind}
);
},
////////////////////////////////////////////////////////////////////////////////
/// @brief test IndexBlock, asking for every third document
////////////////////////////////////////////////////////////////////////////////
testIndexBlock2 : function () {
const col = db._create(colName);
col.ensureIndex({ type: "hash", fields: [ "value" ] });
const prepare = (rows) => {
col.truncate();
col.insert(_.range(1, rows + 1).map((i) => ({value: i})));
};
const bind = (rows) => ({'@col': colName, rows});
const query = `FOR i IN 0..FLOOR(@rows / 3)
FOR d IN @@col
FILTER i*3+1 == d.value
RETURN d.value`;
const genNodeList = (rows) => {
const enumRows = Math.floor(rows / 3) + 1;
const enumBatches = Math.ceil(enumRows / defaultBatchSize);
const indexRows = Math.ceil(rows / 3);
const optimalBatches = Math.ceil(indexRows / defaultBatchSize);
// IndexBlock returns HASMORE when asked for the exact number of items
// it has left. This could be improved.
const maxIndexBatches = Math.max(1, Math.floor(indexRows / defaultBatchSize) + 1);
// Number of calls made to the index block. See comment for
// maxIndexBatches. As of now, maxIndexBatches is exact, but we don't
// want to fail when this improves.
const indexBatches = [
optimalBatches,
maxIndexBatches
];
return [
{type: SingletonBlock, calls: 1, items: 1},
{type: CalculationBlock, calls: 1, items: 1},
{type: EnumerateListBlock, calls: enumBatches, items: enumRows},
{type: IndexBlock, calls: indexBatches, items: indexRows},
{type: CalculationBlock, calls: indexBatches, items: indexRows},
{type: ReturnBlock, calls: indexBatches, items: indexRows}
];
};
profHelper.runDefaultChecks(
{query, genNodeList, prepare, bind}
);
},*/
////////////////////////////////////////////////////////////////////////////////
/// @brief test TraversalBlock: traverse a tree
////////////////////////////////////////////////////////////////////////////////
testTraversalBlock1: function () {
const col = db._createDocumentCollection(colName);
const edgeCol = db._createEdgeCollection(edgeColName);
const prepare = (rows) => {
profHelper.createBinaryTree(col, edgeCol, rows);
};
const query = `FOR v IN 0..@rows OUTBOUND @root @@edgeCol RETURN v`;
const rootNodeId = `${colName}/1`;
const bind = rows => ({
rows: rows,
root: rootNodeId,
'@edgeCol': edgeColName,
});
const genNodeList = (rows, batches) => {
return [
{type: SingletonBlock, calls: 1, items: 1},
{type: TraversalBlock, calls: rows % defaultBatchSize === 0 ? batches + 1 : batches, items: rows},
{type: ReturnBlock, calls: rows % defaultBatchSize === 0 ? batches + 1 : batches, items: rows}
];
};
profHelper.runDefaultChecks(
{query, genNodeList, prepare, bind}
);
},
////////////////////////////////////////////////////////////////////////////////
/// @brief test TraversalBlock: traverse ~half a tree
////////////////////////////////////////////////////////////////////////////////
testTraversalBlock2: function () {
const col = db._createDocumentCollection(colName);
const edgeCol = db._createEdgeCollection(edgeColName);
const prepare = (rows) => {
profHelper.createBinaryTree(col, edgeCol, rows);
};
const query = `FOR v IN 0..@depth OUTBOUND @root @@edgeCol RETURN v`;
const rootNodeId = `${colName}/1`;
// actual tree depth:
// const treeDepth = rows => Math.ceil(Math.log2(rows));
// tree is perfect up to this depth:
const maxFullDepth = rows => Math.floor(Math.log2(rows));
// substract one to get rid of ~half the nodes, but never go below 0
const depth = rows => Math.max(0, maxFullDepth(rows) - 1);
const bind = rows => ({
depth: depth(rows),
root: rootNodeId,
'@edgeCol': edgeColName,
});
const visitedNodes = rows => Math.pow(2, depth(rows)+1)-1;
const genNodeList = (rows, batches) => {
rows = visitedNodes(rows);
batches = Math.ceil(rows / defaultBatchSize);
return [
{type: SingletonBlock, calls: 1, items: 1},
{type: TraversalBlock, calls: batches, items: rows},
{type: ReturnBlock, calls: batches, items: rows}
];
};
profHelper.runDefaultChecks(
{query, genNodeList, prepare, bind}
);
},
////////////////////////////////////////////////////////////////////////////////
/// @brief test TraversalBlock: skip ~half a tree
////////////////////////////////////////////////////////////////////////////////
testTraversalBlock3: function () {
const col = db._createDocumentCollection(colName);
const edgeCol = db._createEdgeCollection(edgeColName);
const prepare = (rows) => {
profHelper.createBinaryTree(col, edgeCol, rows);
};
const query = `FOR v IN @depth..@rows OUTBOUND @root @@edgeCol RETURN v`;
const rootNodeId = `${colName}/1`;
// actual tree depth:
// const treeDepth = rows => Math.ceil(Math.log2(rows));
// tree is perfect up to this depth:
const maxFullDepth = rows => Math.floor(Math.log2(rows));
// substract one to leave ~half the nodes, but never go below 0
const depth = rows => Math.max(0, maxFullDepth(rows) - 1);
const bind = rows => ({
rows: rows,
depth: depth(rows),
root: rootNodeId,
'@edgeCol': edgeColName,
});
const skippedNodes = rows => Math.pow(2, depth(rows))-1;
const visitedNodes = rows => rows - skippedNodes(rows);
const genNodeList = (rows, batches) => {
rows = visitedNodes(rows);
batches = Math.max(1, Math.ceil(rows / defaultBatchSize));
return [
{type: SingletonBlock, calls: 1, items: 1},
{type: TraversalBlock, calls: batches, items: rows},
{type: ReturnBlock, calls: batches, items: rows}
];
};
profHelper.runDefaultChecks(
{query, genNodeList, prepare, bind}
);
},
////////////////////////////////////////////////////////////////////////////////
/// @brief test EnumerateViewBlock1
////////////////////////////////////////////////////////////////////////////////
testEnumerateViewBlock1: function () {
const col = db._create(colName);
const view = db._createView(viewName, "arangosearch", { links: { [colName]: { includeAllFields: true } } });
const prepare = (rows) => {
col.truncate();
col.insert(_.range(1, rows + 1).map((i) => ({value: i})));
};
const bind = () => ({'@view': viewName});
const query = `FOR d IN @@view SEARCH d.value != 0 OPTIONS { waitForSync: true } RETURN d.value`;
const genNodeList = (rows, batches) => {
// EnumerateViewBlock returns HASMORE when asked for the exact number
// of items it has left. This could be improved.
const optimalBatches = Math.ceil(rows / defaultBatchSize);
const maxViewBatches = Math.floor(rows / defaultBatchSize) + 1;
const viewBatches = [optimalBatches, maxViewBatches];
return [
{type: SingletonBlock, calls: 1, items: 1},
{type: EnumerateViewNode, calls: viewBatches, items: rows},
{type: CalculationBlock, calls: rows % defaultBatchSize === 0 ? batches + 1 : batches, items: rows},
{type: ReturnBlock, calls: rows % defaultBatchSize === 0 ? batches + 1 : batches, items: rows}
];
};
profHelper.runDefaultChecks(
{query, genNodeList, prepare, bind}
);
},
////////////////////////////////////////////////////////////////////////////////
/// @brief test EnumerateViewBlock2
////////////////////////////////////////////////////////////////////////////////
testEnumerateViewBlock2: function () {
const col = db._create(colName);
const view = db._createView(viewName, "arangosearch", { links: { [colName]: { includeAllFields: true } } });
const prepare = (rows) => {
col.truncate();
col.insert(_.range(1, rows + 1).map((i) => ({value: i})));
};
const bind = () => ({'@view': viewName});
const query = `FOR d IN @@view SEARCH d.value != 0 OPTIONS { waitForSync: true } SORT d.value DESC RETURN d.value`;
const genNodeList = (rows, batches) => {
// EnumerateViewBlock returns HASMORE when asked for the exact number
// of items it has left. This could be improved.
const optimalBatches = Math.ceil(rows / defaultBatchSize);
const maxViewBatches = Math.floor(rows / defaultBatchSize) + 1;
const viewBatches = [optimalBatches, maxViewBatches];
return [
{type: SingletonBlock, calls: 1, items: 1},
{type: EnumerateViewNode, calls: viewBatches, items: rows},
{type: CalculationBlock, calls: rows % defaultBatchSize === 0 ? batches + 1 : batches, items: rows},
{type: SortBlock, calls: batches, items: rows},
{type: ReturnBlock, calls: batches, items: rows}
];
};
profHelper.runDefaultChecks(
{query, genNodeList, prepare, bind}
);
},
////////////////////////////////////////////////////////////////////////////////
/// @brief test EnumerateViewBlock3
////////////////////////////////////////////////////////////////////////////////
testEnumerateViewBlock3: function () {
const col = db._create(colName);
const view = db._createView(viewName, "arangosearch", { links: { [colName]: { includeAllFields: true } } });
const prepare = (rows) => {
col.truncate();
col.insert(_.range(1, rows + 1).map((i) => ({value: i})));
};
const bind = () => ({'@view': viewName});
const query = `FOR d IN @@view SEARCH d.value != 0 OPTIONS { waitForSync: true } SORT TFIDF(d) ASC, BM25(d) RETURN d.value`;
const genNodeList = (rows, batches) => {
// EnumerateViewBlock returns HASMORE when asked for the exact number
// of items it has left. This could be improved.
const optimalBatches = Math.ceil(rows / defaultBatchSize);
const maxViewBatches = Math.floor(rows / defaultBatchSize) + 1;
const viewBatches = [optimalBatches, maxViewBatches];
return [
{type: SingletonBlock, calls: 1, items: 1},
{type: EnumerateViewNode, calls: viewBatches, items: rows},
{type: SortBlock, calls: batches, items: rows},
{type: CalculationBlock, calls: batches, items: rows},
{type: ReturnBlock, calls: batches, items: rows}
];
};
profHelper.runDefaultChecks(
{query, genNodeList, prepare, bind}
);
},
};
}
////////////////////////////////////////////////////////////////////////////////
/// @brief executes the test suite
////////////////////////////////////////////////////////////////////////////////
jsunity.run(ahuacatlProfilerTestSuite);
return jsunity.done();