test: add tests for excessive memory usage in traversal and collect fields

The tests currently assert that the memory limit is exceeded. This is expected and will be fixed in an upcoming commit by a performance improvement.

Author: Yogu

spec/regression/traversal-performance/default-context.json

@@ -0,0 +1,3 @@
+{
+  "authRoles": ["user"]
+}

spec/regression/traversal-performance/meta.json

@@ -0,0 +1,9 @@
+{
+  "databases": {
+    // performance is only relevant for arangodb
+    // in-memory has other ordering behavior so we would need to use orderBy, which affects performance tests
+    "in-memory": {
+      "ignore": true
+    }
+  }
+}

spec/regression/traversal-performance/model/model.graphqls

@@ -0,0 +1,40 @@
+type Super @rootEntity {
+    key: String @key
+    roots: [Root] @relation
+    rootChildren: [Child] @collect(path: "roots.children")
+    rootGrandchildren: [Grandchild] @collect(path: "roots.children.children")
+    rootExtensionGrandchildren: [ExtensionGrandchild]
+        @collect(path: "roots.children.extension.children")
+}
+
+type Root @rootEntity {
+    key: String @key
+    children: [Child]
+    grandchildren: [Grandchild] @collect(path: "children.children")
+    extensionGrandchildren: [ExtensionGrandchild] @collect(path: "children.extension.children")
+    payload: String
+}
+
+type Child @childEntity {
+    key: String
+    children: [Grandchild]
+    extension: Extension
+    parent: Root @parent
+    root: Root @root
+}
+
+type Extension @entityExtension {
+    children: [ExtensionGrandchild]
+}
+
+type Grandchild @childEntity {
+    key: String
+    parent: Child @parent
+    root: Root @root
+}
+
+type ExtensionGrandchild @childEntity {
+    key: String
+    root: Root @root
+    parent: Child @parent
+}

spec/regression/traversal-performance/model/permission-profiles.json

@@ -0,0 +1,12 @@
+{
+  "permissionProfiles": {
+    "default": {
+      "permissions": [
+        {
+          "roles": ["user"],
+          "access": "readWrite"
+        }
+      ]
+    }
+  }
+}

spec/regression/traversal-performance/test-data.ts

@@ -0,0 +1,37 @@
+import { InitTestDataContext } from '../init-test-data-context';
+import gql from 'graphql-tag';
+
+export default async function init(context: InitTestDataContext) {
+    await context.executeGraphql(
+        gql`
+            mutation Init($input: CreateSuperInput!) {
+                createSuper(input: $input) {
+                    key
+                }
+            }
+        `,
+        {
+            variables: {
+                input: {
+                    key: 'super1',
+                    createRoots: [...Array(10).keys()].map((rootIndex) => ({
+                        key: `root${rootIndex}`,
+                        payload: generateRandomString(1_000_000),
+                        children: [...Array(10).keys()].map((childIndex) => ({
+                            key: `child${rootIndex}_${childIndex}`,
+                        })),
+                    })),
+                },
+            },
+            authRoles: ['user'],
+        },
+    );
+}
+
+function generateRandomString(length: number): string {
+    return Array(Math.floor(length / 2))
+        .fill(0)
+        .map(() => Math.floor(Math.random() * 256))
+        .map((b) => ('0' + b.toString(16)).slice(-2))
+        .join('');
+}

spec/regression/traversal-performance/tests/test-memory-limit/aql/ExpectedToFail.aql

@@ -0,0 +1,13 @@
+LET v_root1 = FIRST((
+  FOR v_root2
+  IN @@roots
+  FILTER (v_root2.`key` == @var1)
+  LIMIT @var2
+  RETURN v_root2
+))
+RETURN {
+  "Root": (IS_NULL(v_root1) ? null : {
+    "payload": v_root1.`payload`,
+    "key": v_root1.`key`
+  })
+}

spec/regression/traversal-performance/tests/test-memory-limit/aql/ExpectedToSucceed.aql

@@ -0,0 +1,12 @@
+LET v_super1 = FIRST((
+  FOR v_super2
+  IN @@supers
+  FILTER (v_super2.`key` == @var1)
+  LIMIT @var2
+  RETURN v_super2
+))
+RETURN {
+  "Super": (IS_NULL(v_super1) ? null : {
+    "key": v_super1.`key`
+  })
+}

spec/regression/traversal-performance/tests/test-memory-limit/result.json

@@ -0,0 +1,28 @@
+{
+  "ExpectedToSucceed": {
+    "data": {
+      "Super": {
+        "key": "super1"
+      }
+    }
+  },
+  "ExpectedToFail": {
+    "errors": [
+      {
+        "message": "AQL: query would use more memory than allowed [node #12: IndexNode] [node #6: LimitNode] [node #14: SubqueryEndNode] [node #9: CalculationNode] [node #10: CalculationNode] [node #11: ReturnNode] (while executing)",
+        "locations": [
+          {
+            "line": 8,
+            "column": 5
+          }
+        ],
+        "path": [
+          "Root"
+        ]
+      }
+    ],
+    "data": {
+      "Root": null
+    }
+  }
+}

spec/regression/traversal-performance/tests/test-memory-limit/test.graphql

@@ -0,0 +1,12 @@
+query ExpectedToSucceed {
+    Super(key: "super1") {
+        key
+    }
+}
+
+query ExpectedToFail {
+    Root(key: "root1") {
+        payload
+        key
+    }
+}

spec/regression/traversal-performance/tests/traversal-performance/aql/RelationAndFieldTraversal.aql

@@ -0,0 +1,23 @@
+WITH @@roots
+LET v_super1 = FIRST((
+  FOR v_super2
+  IN @@supers
+  FILTER (v_super2.`key` == @var1)
+  LIMIT @var2
+  RETURN v_super2
+))
+RETURN {
+  "Super": (IS_NULL(v_super1) ? null : {
+    "rootChildren": (
+      FOR v_child1
+      IN (
+        FOR v_node1, v_edge1, v_path1 IN @var3..@var4 OUTBOUND v_super1 @@supers_roots
+        FILTER v_node1 != null
+        RETURN v_node1.`children`[*]
+      )[**]
+      RETURN {
+        "key": v_child1.`key`
+      }
+    )
+  })
+}