eliasdb/graphql/query.go

/*
 * EliasDB
 *
 * Copyright 2016 Matthias Ladkau. All rights reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

/*
Package graphql contains the main API for GraphQL.

Example GraphQL query:

{
	Person @withValue(name : "Marvin") {
		key
		kind
		name
	}
}
*/
package graphql

import (
	"fmt"

	"devt.de/krotik/common/lang/graphql/parser"
	"devt.de/krotik/eliasdb/graph"
	"devt.de/krotik/eliasdb/graphql/interpreter"
)

/*
RunQuery runs a GraphQL query against a given graph database. The query parameter
needs to have the following fields:

	operationName - Operation to Execute (string)
	query         - Query document (string)
	variables     - Variables map (map[string]interface{})

Set the readOnly flag if the query should only be allowed to do read operations.
*/
func RunQuery(name string, part string, query map[string]interface{},
	gm *graph.Manager, callbackHandler interpreter.SubscriptionCallbackHandler,
	readOnly bool) (map[string]interface{}, error) {

	var ok bool
	var vars map[string]interface{}

	// Make sure all info is present on the query object

	for _, op := range []string{"operationName", "query", "variables"} {
		if _, ok := query[op]; !ok {
			return nil, fmt.Errorf("Mandatory field '%s' missing from query object", op)
		}
	}

	// Nil pointer become empty strings

	if query["operationName"] == nil {
		query["operationName"] = ""
	}
	if query["query"] == nil {
		query["query"] = ""
	}

	if vars, ok = query["variables"].(map[string]interface{}); !ok {
		vars = make(map[string]interface{})
	}

	// Create runtime provider

	rtp := interpreter.NewGraphQLRuntimeProvider(name, part, gm,
		fmt.Sprint(query["operationName"]), vars, callbackHandler, readOnly)

	// Parse the query and annotate the AST with runtime components

	ast, err := parser.ParseWithRuntime(name, fmt.Sprint(query["query"]), rtp)

	if err == nil {

		if err = ast.Runtime.Validate(); err == nil {

			// Evaluate the query

			return ast.Runtime.Eval()
		}
	}

	return nil, err
}

/*
ParseQuery parses a GraphQL query and return its Abstract Syntax Tree.
*/
func ParseQuery(name string, query string) (*parser.ASTNode, error) {
	ast, err := parser.ParseWithRuntime(name, query, nil)

	if err != nil {
		return nil, err
	}

	return ast, nil
}