refactor: Cleanup parsing logic

client/request/aggregate.go

@@ -0,0 +1,29 @@
+// Copyright 2022 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package request
+
+import "github.com/sourcenetwork/defradb/client"
+
+type Aggregate struct {
+	Field
+
+	Targets []*AggregateTarget
+}
+
+type AggregateTarget struct {
+	HostName  string
+	ChildName client.Option[string]
+
+	Limit   client.Option[uint64]
+	Offset  client.Option[uint64]
+	OrderBy client.Option[OrderBy]
+	Filter  client.Option[Filter]
+}

client/request/commit.go

@@ -0,0 +1,48 @@
+// Copyright 2022 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package request
+
+import "github.com/sourcenetwork/defradb/client"
+
+var (
+	_ Selection = (*CommitSelect)(nil)
+)
+
+type CommitSelect struct {
+	Field
+
+	DocKey    client.Option[string]
+	FieldName client.Option[string]
+	Cid       client.Option[string]
+	Depth     client.Option[uint64]
+
+	Limit   client.Option[uint64]
+	Offset  client.Option[uint64]
+	OrderBy client.Option[OrderBy]
+	GroupBy client.Option[GroupBy]
+
+	Fields []Selection
+}
+
+func (c CommitSelect) ToSelect() *Select {
+	return &Select{
+		Field: Field{
+			Name:  c.Name,
+			Alias: c.Alias,
+		},
+		Limit:   c.Limit,
+		Offset:  c.Offset,
+		OrderBy: c.OrderBy,
+		GroupBy: c.GroupBy,
+		Fields:  c.Fields,
+		Root:    CommitSelection,
+	}
+}

query/graphql/parser/types/types.go → client/request/consts.go

@@ -8,65 +8,20 @@
 // by the Apache License, Version 2.0, included in the file
 // licenses/APL.txt.
 
-/*
-Package types defines the GraphQL types used by the query service.
-*/
-package types
-
-import "github.com/graphql-go/graphql/language/ast"
-
-type (
-	OrderDirection string
-
-	SelectionType int
-
-	// Enum for different types of read Select queries
-	SelectQueryType int
-
-	OrderCondition struct {
-		// field may be a compound field statement
-		// since the order statement allows ordering on
-		// sub objects.
-		//
-		// Given the statement: {order: {author: {birthday: DESC}}}
-		// The field value would be "author.birthday"
-		// and the direction would be "DESC"
-		Field     string
-		Direction OrderDirection
-	}
-
-	GroupBy struct {
-		Fields []string
-	}
-
-	OrderBy struct {
-		Conditions []OrderCondition
-		Statement  *ast.ObjectValue
-	}
-
-	Limit struct {
-		Limit  int64
-		Offset int64
-	}
-
-	OptionalDocKeys struct {
-		HasValue bool
-		Value    []string
-	}
-)
+package request
 
 const (
 	// GQL special field, returns the host object's type name
 	// https://spec.graphql.org/October2021/#sec-Type-Name-Introspection
 	TypeNameFieldName = "__typename"
 
-	Cid     = "cid"
-	Data    = "data"
-	DocKey  = "dockey"
-	DocKeys = "dockeys"
-	Field   = "field"
-	Id      = "id"
-	Ids     = "ids"
+	Cid       = "cid"
+	Data      = "data"
+	DocKey    = "dockey"
+	DocKeys   = "dockeys"
+	FieldName = "field"
+	Id        = "id"
+	Ids       = "ids"
 
 	FilterClause  = "filter"
 	GroupByClause = "groupBy"
@@ -85,6 +40,7 @@ const (
 	ExplainLabel = "explain"
 
 	LatestCommitsQueryName = "latestCommits"
+	CommitsQueryName       = "commits"
 
 	CommitTypeName  = "Commit"
 	LinksFieldName  = "links"
@@ -99,17 +55,6 @@ const (
 	DESC = OrderDirection("DESC")
 )
 
-const (
-	ScanQuery = iota
-	VersionedScanQuery
-)
-
-const (
-	NoneSelection = iota
-	ObjectSelection
-	CommitSelection
-)
-
 var (
 	NameToOrderDirection = map[string]OrderDirection{
 		string(ASC):  ASC,
@@ -132,6 +77,11 @@ var (
 		AverageFieldName: {},
 	}
 
+	CommitQueries = map[string]struct{}{
+		LatestCommitsQueryName: {},
+		CommitsQueryName:       {},
+	}
+
 	VersionFields = []string{
 		HeightFieldName,
 		CidFieldName,

client/request/doc.go

@@ -0,0 +1,14 @@
+// Copyright 2022 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+/*
+Package request defines the GraphQL types used by the query service.
+*/
+package request

client/request/field.go

@@ -0,0 +1,19 @@
+// Copyright 2022 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package request
+
+import "github.com/sourcenetwork/defradb/client"
+
+// Field implements Selection
+type Field struct {
+	Name  string
+	Alias client.Option[string]
+}

client/request/filter.go

@@ -0,0 +1,20 @@
+// Copyright 2022 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package request
+
+// Filter contains the parsed condition map to be
+// run by the Filter Evaluator.
+// @todo: Cache filter structure for faster condition
+// evaluation.
+type Filter struct {
+	// parsed filter conditions
+	Conditions map[string]any
+}

client/request/group.go

@@ -0,0 +1,15 @@
+// Copyright 2022 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package request
+
+type GroupBy struct {
+	Fields []string
+}

client/request/mutation.go

@@ -0,0 +1,57 @@
+// Copyright 2022 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package request
+
+import "github.com/sourcenetwork/defradb/client"
+
+type MutationType int
+
+const (
+	NoneMutationType = MutationType(iota)
+	CreateObjects
+	UpdateObjects
+	DeleteObjects
+)
+
+// Mutation is a field on the MutationType
+// of a graphql query. It includes all the possible
+// arguments and all
+//
+// @todo: Change name to ObjectMutation to indicate
+// generated object mutation actions
+type Mutation struct {
+	Field
+	Type MutationType
+
+	// Schema is the target schema/collection
+	// if this mutation is on an object.
+	Schema string
+
+	IDs    client.Option[[]string]
+	Filter client.Option[Filter]
+	Data   string
+
+	Fields []Selection
+}
+
+// ToSelect returns a basic Select object, with the same Name, Alias, and Fields as
+// the Mutation object. Used to create a Select planNode for the mutation return objects.
+func (m Mutation) ToSelect() *Select {
+	return &Select{
+		Field: Field{
+			Name:  m.Schema,
+			Alias: m.Alias,
+		},
+		Fields:  m.Fields,
+		DocKeys: m.IDs,
+		Filter:  m.Filter,
+	}
+}

client/request/order.go

@@ -0,0 +1,31 @@
+// Copyright 2022 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package request
+
+type (
+	OrderDirection string
+
+	OrderCondition struct {
+		// field may be a compound field statement
+		// since the order statement allows ordering on
+		// sub objects.
+		//
+		// Given the statement: {order: {author: {birthday: DESC}}}
+		// The field value would be "author.birthday"
+		// and the direction would be "DESC"
+		Fields    []string
+		Direction OrderDirection
+	}
+
+	OrderBy struct {
+		Conditions []OrderCondition
+	}
+)

client/request/request.go

@@ -0,0 +1,23 @@
+// Copyright 2022 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package request
+
+type Request struct {
+	Queries   []*OperationDefinition
+	Mutations []*OperationDefinition
+}
+
+type Selection any
+
+type OperationDefinition struct {
+	Selections []Selection
+	IsExplain  bool
+}