dolphin: Implement named parameters via sqlc.arg() (#632)

* parser: Update to latest version of forked parser

* endtoend: Add sqlc_arg test case

* internal: Implement named arguments for MySQL

* cleanup

Author: kyleconroy

go.mod

@@ -16,4 +16,4 @@ require (
 	vitess.io/vitess v0.0.0-20200617014457-5ba6549015c0
 )
 
-replace github.com/pingcap/parser => github.com/kyleconroy/parser v0.0.0-20200727200926-0e04da0a60a6
+replace github.com/pingcap/parser => github.com/kyleconroy/parser v0.0.0-20200728181224-b006e3bf3ed9

go.sum

@@ -311,8 +311,8 @@ github.com/kr/pty v1.1.5/go.mod h1:9r2w37qlBe7rQ6e1fg1S/9xpWHSnaqNdHD3WcMdbPDA=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/krishicks/yaml-patch v0.0.10/go.mod h1:Sm5TchwZS6sm7RJoyg87tzxm2ZcKzdRE4Q7TjNhPrME=
-github.com/kyleconroy/parser v0.0.0-20200727200926-0e04da0a60a6 h1:fryw+mWaV81slq8BqQFia2hlVt1HA4v+8d0UM7VOe7E=
-github.com/kyleconroy/parser v0.0.0-20200727200926-0e04da0a60a6/go.mod h1:vQdbJqobJAgFyiRNNtXahpMoGWwPEuWciVEK5A20NS0=
+github.com/kyleconroy/parser v0.0.0-20200728181224-b006e3bf3ed9 h1:rSPG/3/wBoiniDxYd/BsAy+mLIi0MVfZMhXJr7TKVPA=
+github.com/kyleconroy/parser v0.0.0-20200728181224-b006e3bf3ed9/go.mod h1:vQdbJqobJAgFyiRNNtXahpMoGWwPEuWciVEK5A20NS0=
 github.com/lfittl/pg_query_go v1.0.0 h1:rcHZK5DBEUoxtO6dACP+UVCHKtA1ZsELBW0rSjOXMAE=
 github.com/lfittl/pg_query_go v1.0.0/go.mod h1:jcikG62RKf+NIWmbLzjjk73m4x6um2pKf3h+TJyINms=
 github.com/lib/pq v1.4.0 h1:TmtCFbH+Aw0AixwyttznSMQDgbR5Yed/Gg6S8Funrhc=

internal/compiler/parse.go

@@ -76,7 +76,7 @@ func (c *Compiler) parseQuery(stmt ast.Node, src string, o opts.Parser) (*Query,
 		return nil, err
 	}
 
-	raw, namedParams, edits := rewrite.NamedParameters(raw)
+	raw, namedParams, edits := rewrite.NamedParameters(c.conf.Engine, raw)
 	rvs := rangeVars(raw.Stmt)
 	refs := findParameters(raw.Stmt)
 	if o.UsePositionalParameters {

internal/debug/dump.go

@@ -12,7 +12,7 @@ func init() {
 	Active = os.Getenv("SQLCDEBUG") != ""
 }
 
-func Dump(n interface{}) {
+func Dump(n ...interface{}) {
 	if Active {
 		spew.Dump(n)
 	}

internal/endtoend/testdata/sqlc_arg/mysql/go/db.go

@@ -0,0 +1,7 @@
+CREATE TABLE foo (name text not null);
+
+/* name: FuncParamIdent :many */
+SELECT name FROM foo WHERE name = sqlc.arg(slug);
+
+/* name: FuncParamString :many */
+SELECT name FROM foo WHERE name = sqlc.arg('slug');

internal/endtoend/testdata/sqlc_arg/mysql/go/models.go

@@ -0,0 +1,12 @@
+{
+  "version": "1",
+  "packages": [
+    {
+      "engine": "_dolphin",
+      "path": "go",
+      "name": "querytest",
+      "schema": "query.sql",
+      "queries": "query.sql"
+    }
+  ]
+}

internal/endtoend/testdata/sqlc_arg/mysql/go/query.sql.go

@@ -0,0 +1,7 @@
+CREATE TABLE foo (name text not null);
+
+-- name: FuncParamIdent :many
+SELECT name FROM foo WHERE name = sqlc.arg(slug);
+
+-- name: FuncParamString :many
+SELECT name FROM foo WHERE name = sqlc.arg('slug');

internal/endtoend/testdata/sqlc_arg/mysql/query.sql

@@ -0,0 +1,12 @@
+{
+  "version": "1",
+  "packages": [
+    {
+      "engine": "postgresql",
+      "path": "go",
+      "name": "querytest",
+      "schema": "query.sql",
+      "queries": "query.sql"
+    }
+  ]
+}

internal/endtoend/testdata/sqlc_arg/mysql/sqlc.json

@@ -193,6 +193,34 @@ func (c *cc) convertFieldList(n *pcast.FieldList) *ast.List {
 	return &ast.List{Items: fields}
 }
 
+func (c *cc) convertFuncCallExpr(n *pcast.FuncCallExpr) *ast.FuncCall {
+	schema := n.Schema.String()
+	name := n.FnName.String()
+
+	// TODO: Deprecate the usage of Funcname
+	items := []ast.Node{}
+	if schema != "" {
+		items = append(items, &pg.String{Str: schema})
+	}
+	items = append(items, &pg.String{Str: name})
+
+	fn := &ast.FuncCall{
+		Args: &ast.List{},
+		Func: &ast.FuncName{
+			Schema: schema,
+			Name:   name,
+		},
+		Funcname: &ast.List{
+			Items: items,
+		},
+		Location: n.Offset,
+	}
+	for _, arg := range n.Args {
+		fn.Args.Items = append(fn.Args.Items, c.convert(arg))
+	}
+	return fn
+}
+
 func (c *cc) convertInsertStmt(n *pcast.InsertStmt) *pg.InsertStmt {
 	rels := c.convertTableRefsClause(n.Table)
 	if len(rels.Items) != 1 {
@@ -322,6 +350,14 @@ func (c *cc) convertUpdateStmt(n *pcast.UpdateStmt) *pg.UpdateStmt {
 	}
 }
 
+func (c *cc) convertValueExpr(n *driver.ValueExpr) *pg.A_Const {
+	return &pg.A_Const{
+		Val: &pg.String{
+			Str: n.Datum.GetString(),
+		},
+	}
+}
+
 func (c *cc) convertWildCardField(n *pcast.WildCardField) *pg.ColumnRef {
 	items := []ast.Node{}
 	if t := n.Table.String(); t != "" {
@@ -342,6 +378,9 @@ func (c *cc) convert(node pcast.Node) ast.Node {
 	case *driver.ParamMarkerExpr:
 		return c.convertParamMarkerExpr(n)
 
+	case *driver.ValueExpr:
+		return c.convertValueExpr(n)
+
 	case *pcast.AlterTableStmt:
 		return c.convertAlterTableStmt(n)
 
@@ -363,6 +402,9 @@ func (c *cc) convert(node pcast.Node) ast.Node {
 	case *pcast.ExistsSubqueryExpr:
 		return c.convertExistsSubqueryExpr(n)
 
+	case *pcast.FuncCallExpr:
+		return c.convertFuncCallExpr(n)
+
 	case *pcast.InsertStmt:
 		return c.convertInsertStmt(n)
 

internal/endtoend/testdata/sqlc_arg/postgresql/go/db.go

@@ -3,6 +3,7 @@ package rewrite
 import (
 	"fmt"
 
+	"github.com/kyleconroy/sqlc/internal/config"
 	"github.com/kyleconroy/sqlc/internal/source"
 	"github.com/kyleconroy/sqlc/internal/sql/ast"
 	"github.com/kyleconroy/sqlc/internal/sql/ast/pg"
@@ -41,7 +42,7 @@ func isNamedParamSignCast(node ast.Node) bool {
 	return astutils.Join(expr.Name, ".") == "@" && cast
 }
 
-func NamedParameters(raw *ast.RawStmt) (*ast.RawStmt, map[int]string, []source.Edit) {
+func NamedParameters(engine config.Engine, raw *ast.RawStmt) (*ast.RawStmt, map[int]string, []source.Edit) {
 	foundFunc := astutils.Search(raw, named.IsParamFunc)
 	foundSign := astutils.Search(raw, named.IsParamSign)
 	if len(foundFunc.Items)+len(foundSign.Items) == 0 {
@@ -72,16 +73,21 @@ func NamedParameters(raw *ast.RawStmt) (*ast.RawStmt, map[int]string, []source.E
 				})
 			}
 			// TODO: This code assumes that sqlc.arg(name) is on a single line
-			var old string
+			var old, replace string
 			if isConst {
 				old = fmt.Sprintf("sqlc.arg('%s')", param)
 			} else {
 				old = fmt.Sprintf("sqlc.arg(%s)", param)
 			}
+			if engine == config.EngineMySQL || engine == config.EngineXDolphin {
+				replace = "?"
+			} else {
+				replace = fmt.Sprintf("$%d", args[param])
+			}
 			edits = append(edits, source.Edit{
 				Location: fun.Location - raw.StmtLocation,
 				Old:      old,
-				New:      fmt.Sprintf("$%d", args[param]),
+				New:      replace,
 			})
 			return false