initial

Author: michele

.gitignore

@@ -21,3 +21,17 @@
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
+
+
+target
+
+#idea-generated
+.idea
+*.iml
+
+#eclipse-generated
+.settings/
+.classpath
+.project
+
+node_modules

pom.xml

@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ DISCLAIMER
+  ~ Copyright 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
+  ~
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>com.arangodb</groupId>
+    <artifactId>arangodb-graphql</artifactId>
+    <version>1.0-SNAPSHOT</version>
+
+    <properties>
+        <java.version>1.8</java.version>
+        <maven.compiler.source>1.8</maven.compiler.source>
+        <maven.compiler.target>1.8</maven.compiler.target>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.graphql-java</groupId>
+            <artifactId>graphql-java</artifactId>
+            <version>11.0</version>
+        </dependency>
+        <dependency>
+            <groupId>com.arangodb</groupId>
+            <artifactId>arangodb-java-driver</artifactId>
+            <version>6.0.0</version>
+        </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.12</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>2.15.0</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-library</artifactId>
+            <version>1.3</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+</project>

src/main/java/com/arangodb/graphql/ArangoDataFetcher.java

@@ -0,0 +1,111 @@
+/*
+ * DISCLAIMER
+ * Copyright 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
+ *
+ */
+
+package com.arangodb.graphql;
+
+import com.arangodb.graphql.context.ArangoGraphQLContext;
+import com.arangodb.graphql.context.SelectedFieldCollector;
+import com.arangodb.graphql.generator.ArangoQueryGeneratorChain;
+import com.arangodb.graphql.query.ArangoTraversalQuery;
+import com.arangodb.graphql.query.ArangoTraversalQueryExecutor;
+import com.arangodb.graphql.query.result.ArangoTraversalQueryResult;
+import graphql.schema.DataFetcher;
+import graphql.schema.DataFetchingEnvironment;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.time.Duration;
+import java.time.Instant;
+import java.util.List;
+import java.util.Map;
+import java.util.function.Function;
+
+/**
+ * A DataFetcher implementation that
+ *
+ * 1. Converts the incoming GraphQL query to a native AQL query
+ * 2. Executes the query on Arango
+ * 3. Marshals the result of a collection of paths from Arango back to the format prescribed by the GraphQL query
+ *
+ * @author Colin Findlay
+ *
+ */
+public class ArangoDataFetcher implements DataFetcher {
+
+    private final Logger logger = LoggerFactory.getLogger(this.getClass());
+
+    private ArangoQueryGeneratorChain queryGenerator;
+
+    private ArangoTraversalQueryExecutor queryExecutor;
+
+    /**
+     * Default Constructor
+     * @param queryGenerator A query generator chain
+     * @param queryExecutor A query executor
+     */
+    public ArangoDataFetcher(ArangoQueryGeneratorChain queryGenerator, ArangoTraversalQueryExecutor queryExecutor) {
+        this.queryGenerator = queryGenerator;
+        this.queryExecutor = queryExecutor;
+    }
+
+    private ArangoTraversalQuery createQuery(DataFetchingEnvironment dataFetchingEnvironment){
+        logger.debug("Converting incoming GraphQL Query to AQL Query");
+        Instant start = Instant.now();
+        SelectedFieldCollector collector = new SelectedFieldCollector(dataFetchingEnvironment);
+        ArangoGraphQLContext ctx = new ArangoGraphQLContext(dataFetchingEnvironment, collector);
+        ArangoTraversalQuery query = queryGenerator.execute(ctx);
+        Instant finish = Instant.now();
+        long duration = Duration.between(start, finish).toMillis();
+        logger.debug("Query Generation Completed in {}ms", duration);
+        logger.trace("Generated Query: \n{}", query.getAql());
+        return query;
+    }
+
+    private ArangoTraversalQueryResult executeQuery(ArangoTraversalQuery query){
+        logger.debug("Begin Query Execution and Result Processing");
+        Instant start = Instant.now();
+        ArangoTraversalQueryResult result = queryExecutor.execute(query);
+        Instant finish = Instant.now();
+        long duration = Duration.between(start, finish).toMillis();
+        logger.debug("Query Execution and Result Processing Completed in {}ms", duration);
+        logger.debug("Query returned {} paths", result.size());
+        return result;
+    }
+
+    private List<Map> processResult(ArangoTraversalQueryResult result){
+        logger.debug("Converting paths to GraphQL Query Response");
+        Instant start = Instant.now();
+        List<Map> convertedResult = result.getResult();
+        Instant finish = Instant.now();
+        long duration = Duration.between(start, finish).toMillis();
+        logger.debug("Response conversion completed in {}ms", duration);
+        logger.debug("GraphQL Query Response has {} elements", convertedResult.size());
+        return convertedResult;
+    }
+
+    @Override
+    public Object get(DataFetchingEnvironment dataFetchingEnvironment) throws Exception {
+
+        ArangoTraversalQuery query = createQuery(dataFetchingEnvironment);
+        ArangoTraversalQueryResult result = executeQuery(query);
+        return processResult(result);
+    }
+
+}

src/main/java/com/arangodb/graphql/context/ArangoEdgeTraversalDirection.java

@@ -0,0 +1,79 @@
+/*
+ * DISCLAIMER
+ * Copyright 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
+ *
+ */
+
+package com.arangodb.graphql.context;
+
+import com.arangodb.model.TraversalOptions;
+
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * Class that represents the traversal direction of an edge.
+ *
+ * @author Colin Findlay
+ */
+public class ArangoEdgeTraversalDirection {
+
+    private Set<TraversalOptions.Direction> directions;
+
+    public ArangoEdgeTraversalDirection() {
+        directions = new HashSet<>();
+    }
+
+    /**
+     *  Push a direction into a set of all directions for this edge
+     *
+     * @param direction The direction of this edge
+     */
+    public void push(TraversalOptions.Direction direction) {
+        directions.add(direction);
+    }
+
+    /**
+     * Compute the direction of traversals on this edge
+     *
+     * @return If the set contains both OUTBOUND and INBOUND directions the direction will be any, if it contains only
+     * INBOUND the driection will be INBOUND, otherwise the direction will be OUTBOUND
+     */
+    public TraversalOptions.Direction direction() {
+
+        if (isAny()) {
+            return TraversalOptions.Direction.any;
+        }
+
+        if (isInbound()) {
+            return TraversalOptions.Direction.inbound;
+        }
+
+        return TraversalOptions.Direction.outbound;
+
+    }
+
+    private boolean isAny() {
+        return directions.contains(TraversalOptions.Direction.any) ||
+                (directions.contains(TraversalOptions.Direction.inbound) &&
+                        directions.contains(TraversalOptions.Direction.outbound));
+    }
+
+    private boolean isInbound() {
+        return directions.contains(TraversalOptions.Direction.inbound);
+    }
+}

src/main/java/com/arangodb/graphql/context/ArangoFilter.java

@@ -0,0 +1,56 @@
+/*
+ * DISCLAIMER
+ * Copyright 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
+ *
+ */
+
+package com.arangodb.graphql.context;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.List;
+
+/**
+ * This class represents a filter, filtering a specific key for one of the supplied values
+ *
+ * @author Colin Findlay
+ */
+public class ArangoFilter {
+
+    private final String key;
+
+    private final List values;
+
+    public ArangoFilter(String key, Object value) {
+        this.key = key;
+        if (value instanceof Collection) {
+            this.values = new ArrayList((Collection) value);
+        } else {
+            this.values = Arrays.asList(value);
+        }
+    }
+
+    public String getKey() {
+        return key;
+    }
+
+    public List getValues() {
+        return values;
+    }
+
+}

src/main/java/com/arangodb/graphql/context/ArangoFilterGroup.java

@@ -0,0 +1,59 @@
+/*
+ * DISCLAIMER
+ * Copyright 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
+ *
+ */
+
+package com.arangodb.graphql.context;
+
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+/**
+ * This class represents a group of filters
+ * @author Colin Findlay
+ * @see ArangoFilter
+ */
+public class ArangoFilterGroup {
+
+    private List<ArangoFilter> filters;
+
+    private int depth;
+
+    public ArangoFilterGroup(List<ArangoFilter> filters, int depth) {
+        this.filters = filters;
+        this.depth = depth;
+    }
+
+    public ArangoFilterGroup(Map<String, Object> arguments, int depth) {
+        this.filters = arguments.entrySet()
+                .stream()
+                .map(e -> new ArangoFilter(e.getKey(), e.getValue()))
+                .collect(Collectors.toList());
+        this.depth = depth;
+    }
+
+    public int getDepth() {
+        return depth;
+    }
+
+    public List<ArangoFilter> getFilters() {
+        return filters;
+    }
+
+}