refactor(engine): simplify internal engine (#333)

- provide payload in engine.Do instead of just a query
- rename client to engine
- use same consistent engine interface everywhere

engine/engine.go

@@ -23,7 +23,7 @@ func New(schema string, hasBinaryTargets bool) *QueryEngine {
 type Engine interface {
 	Connect() error
 	Disconnect() error
-	Do(ctx context.Context, query string, into interface{}) error
+	Do(ctx context.Context, payload interface{}, into interface{}) error
 	Name() string
 }
 

engine/mock/do.go

@@ -4,17 +4,20 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+
+	"github.com/prisma/prisma-client-go/engine"
 )
 
-func (e *Engine) Do(ctx context.Context, query string, v interface{}) error {
+func (e *Engine) Do(ctx context.Context, payload interface{}, v interface{}) error {
 	e.expMu.Lock()
 	defer e.expMu.Unlock()
 
 	expectations := *e.expectations
 
 	var n = -1
 	for i, e := range expectations {
-		if e.Query.Build() == query {
+		req := payload.(engine.GQLRequest)
+		if e.Query.Build() == req.Query {
 			n = i
 			break
 		}

engine/protocol.go

@@ -17,9 +17,8 @@ type Data struct {
 
 // GQLRequest is the payload for GraphQL queries
 type GQLRequest struct {
-	Query         string                 `json:"query"`
-	Variables     map[string]interface{} `json:"variables"`
-	OperationName *string                `json:"operationName"`
+	Query     string                 `json:"query"`
+	Variables map[string]interface{} `json:"variables"`
 }
 
 // GQLError is a GraphQL Error

engine/request.go

@@ -20,15 +20,10 @@ var internalDeleteNotFoundMessage = "Error occurred during query execution:\nInt
 	" \\'0\\'\", Some(QueryGraphBuilderError(RecordNotFound(\"Record to delete does not exist.\"))))"
 
 // Do sends the http Request to the query engine and unmarshals the response
-func (e *QueryEngine) Do(ctx context.Context, query string, v interface{}) error {
+func (e *QueryEngine) Do(ctx context.Context, payload interface{}, v interface{}) error {
 	startReq := time.Now()
 
-	payload := GQLRequest{
-		Query:     query,
-		Variables: map[string]interface{}{},
-	}
-
-	body, err := e.Request(ctx, "POST", "/", &payload)
+	body, err := e.Request(ctx, "POST", "/", payload)
 	if err != nil {
 		return fmt.Errorf("request failed: %w", err)
 	}

generator/builder/builder.go

@@ -6,6 +6,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/prisma/prisma-client-go/engine"
 	"github.com/prisma/prisma-client-go/logger"
 )
 
@@ -42,20 +43,15 @@ type Field struct {
 	Fields []Field
 }
 
-type Client interface {
-	Do(ctx context.Context, query string, into interface{}) error
-	Name() string
-}
-
 func NewQuery() Query {
 	return Query{
 		Start: time.Now(),
 	}
 }
 
 type Query struct {
-	// Client is the generic Photon Client
-	Client Client
+	// Engine holds the implementation of how queries are processed
+	Engine engine.Engine
 
 	// Operation describes the PQL operation: query, mutation or subscription
 	Operation string
@@ -208,23 +204,27 @@ func (q Query) buildFields(list bool, wrapList bool, fields []Field) string {
 }
 
 func (q Query) Exec(ctx context.Context, v interface{}) error {
-	if q.Client == nil {
+	if q.Engine == nil {
 		panic("client.Connect() needs to be called before sending queries")
 	}
 
-	s := q.Build()
+	query := q.Build()
 
 	// TODO use specific log level
 	if logger.Enabled {
-		logger.Debug.Printf("prisma query: `%s`", s)
+		logger.Debug.Printf("prisma query: `%q`", query)
 	}
 
-	logger.Debug.Printf("[timing] building %s", time.Since(q.Start))
+	logger.Debug.Printf("[timing] building %q", time.Since(q.Start))
 
-	err := q.Client.Do(ctx, s, v)
+	payload := engine.GQLRequest{
+		Query:     query,
+		Variables: map[string]interface{}{},
+	}
+	err := q.Engine.Do(ctx, payload, v)
 	now := time.Now()
 	totalDuration := now.Sub(q.Start)
-	logger.Debug.Printf("[timing] TOTAL %s", totalDuration)
+	logger.Debug.Printf("[timing] TOTAL %q", totalDuration)
 	return err
 }
 

generator/raw/execute_raw.go

@@ -9,7 +9,7 @@ import (
 
 func (r Actions) ExecuteRaw(query string, params ...interface{}) ExecuteExec {
 	return ExecuteExec{
-		query: raw(r.Client, "executeRaw", query, params...),
+		query: raw(r.Engine, "executeRaw", query, params...),
 	}
 }
 

generator/raw/query_raw.go

@@ -10,7 +10,7 @@ import (
 
 func (r Actions) QueryRaw(query string, params ...interface{}) QueryExec {
 	return QueryExec{
-		query: raw(r.Client, "queryRaw", query, params...),
+		query: raw(r.Engine, "queryRaw", query, params...),
 	}
 }
 

generator/raw/raw.go

@@ -1,16 +1,17 @@
 package raw
 
 import (
+	"github.com/prisma/prisma-client-go/engine"
 	"github.com/prisma/prisma-client-go/generator/builder"
 )
 
 type Actions struct {
-	Client builder.Client
+	Engine engine.Engine
 }
 
-func raw(client builder.Client, action string, query string, params ...interface{}) builder.Query {
+func raw(engine engine.Engine, action string, query string, params ...interface{}) builder.Query {
 	q := builder.NewQuery()
-	q.Client = client
+	q.Engine = engine
 	q.Operation = "mutation"
 	q.Method = action
 

generator/run.go

@@ -128,7 +128,7 @@ func Run(input *Root) error {
 
 		if input.Generator.Config.DisableGitignore != "true" {
 			// generate a gitignore into the folder
-			var gitignore = "# gitignore generated by Prisma Client Go. DO NOT EDIT.\n*_gen.go\n"
+			var gitignore = "# gitignore generated by Prisma Engine Go. DO NOT EDIT.\n*_gen.go\n"
 			if err := ioutil.WriteFile(path.Join(input.Generator.Output, ".gitignore"), []byte(gitignore), 0644); err != nil {
 				return fmt.Errorf("could not write .gitignore: %w", err)
 			}

generator/templates/actions/create.gotpl

@@ -17,7 +17,7 @@
 	) {{ $result }} {
 		var v {{ $result }}
 		v.query = builder.NewQuery()
-		v.query.Client = r.client
+		v.query.Engine = r.client
 
 		v.query.Operation = "mutation"
 		v.query.Method = "createOne"

generator/templates/actions/find.gotpl

@@ -45,7 +45,7 @@
 				) {{ $result }} {
 					var v {{ $result }}
 					v.query = builder.NewQuery()
-					v.query.Client = r.client
+					v.query.Engine = r.client
 
 					v.query.Operation = "query"
 					v.query.Method = "find{{ $v.Name.GoCase }}"

generator/templates/client.gotpl

@@ -36,7 +36,7 @@ func NewClient() *PrismaClient {
 		c.{{ $model.Name.GoCase }} = {{ $model.Name.GoLowerCase }}Actions{client: c}
 	{{- end }}
 
-	c.Actions = &raw.Actions{Client: c}
+	c.Actions = &raw.Actions{Engine: c}
 
 	return c
 }
@@ -50,7 +50,7 @@ func newMockClient(expectations *[]mock.Expectation) *PrismaClient {
 		c.{{ $model.Name.GoCase }} = {{ $model.Name.GoLowerCase }}Actions{client: c}
 	{{- end }}
 
-	c.Actions = &raw.Actions{Client: c}
+	c.Actions = &raw.Actions{Engine: c}
 
 	return c
 }

jsonrpc/methods.go

@@ -1,6 +1,6 @@
 package jsonrpc
 
-// Manifest describes information for the Prisma Client Go generator for the Prisma CLI.
+// Manifest describes information for the Prisma Engine Go generator for the Prisma CLI.
 type Manifest struct {
 	PrettyName         string   `json:"prettyName"`
 	DefaultOutput      string   `json:"defaultOutput"`
@@ -9,7 +9,7 @@ type Manifest struct {
 	RequiresEngines    []string `json:"requiresEngines"`
 }
 
-// ManifestResponse sets the response Prisma Client Go returns when Prisma asks for the Manifest.
+// ManifestResponse sets the response Prisma Engine Go returns when Prisma asks for the Manifest.
 type ManifestResponse struct {
 	Manifest Manifest `json:"manifest"`
 }

test/test.go

@@ -26,12 +26,6 @@ type Database interface {
 	TeardownDatabase(t *testing.T, mockDBName string)
 }
 
-type Engine interface {
-	Connect() error
-	Disconnect() error
-	Do(context.Context, string, interface{}) error
-}
-
 var MySQL = mysql.MySQL
 var PostgreSQL = postgresql.PostgreSQL
 var SQLite = sqlite.SQLite
@@ -73,9 +67,13 @@ func Start(t *testing.T, db Database, e engine.Engine, queries []string) string
 		return ""
 	}
 
-	for _, b := range queries {
+	for _, q := range queries {
 		var response engine.GQLResponse
-		if err := e.Do(context.Background(), b, &response); err != nil {
+		payload := engine.GQLRequest{
+			Query:     q,
+			Variables: map[string]interface{}{},
+		}
+		if err := e.Do(context.Background(), payload, &response); err != nil {
 			End(t, db, e, mockDB)
 			t.Fatalf("could not send mock query %s", err)
 		}
@@ -92,7 +90,7 @@ func Start(t *testing.T, db Database, e engine.Engine, queries []string) string
 	return mockDB
 }
 
-func End(t *testing.T, db Database, e Engine, mockDBName string) {
+func End(t *testing.T, db Database, e engine.Engine, mockDBName string) {
 	defer teardown(t, db, mockDBName)
 
 	if err := e.Disconnect(); err != nil {