Use wazero-based libpgquery wrapper in currently disabled environments

.github/workflows/ci.yml

@@ -14,9 +14,12 @@ jobs:
       with:
         go-version-file: go.mod
         check-latest: true
+
+    # Currently some tests rely on line endings so we only build
+    # without running.
     - run: go build ./...
 
-  darwin-build:
+  darwin-test:
     if: ${{ github.ref == 'refs/heads/main' }}
     runs-on: macos-latest
     steps:
@@ -25,7 +28,34 @@ jobs:
       with:
         go-version-file: go.mod
         check-latest: true
-    - run: go build ./...
+
+    - name: install sqlc-gen-test
+      run: go install github.com/sqlc-dev/sqlc-gen-test@v0.1.0
+
+    - name: install ./...
+      run: go install ./...
+
+    - run: go test ./...
+
+  linux-purego-test:
+    if: ${{ github.ref == 'refs/heads/main' }}
+    runs-on: macos-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-go@v4
+      with:
+        go-version-file: go.mod
+        check-latest: true
+
+    - name: install sqlc-gen-test
+      run: go install github.com/sqlc-dev/sqlc-gen-test@v0.1.0
+
+    - name: install ./...
+      run: go install ./...
+
+    - run: go test ./...
+      env:
+        CGO_ENABLED: '0'
 
   build:
     name: test

go.mod

@@ -20,13 +20,16 @@ require (
 	github.com/riza-io/grpc-go v0.2.0
 	github.com/spf13/cobra v1.8.0
 	github.com/spf13/pflag v1.0.5
+	github.com/wasilibs/go-pgquery v0.0.0-20231201074715-bbab8b1ab4a9
 	github.com/xeipuuv/gojsonschema v1.2.0
 	golang.org/x/sync v0.5.0
 	google.golang.org/grpc v1.59.0
 	google.golang.org/protobuf v1.31.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 
+require github.com/wasilibs/wazerox v0.0.0-20231117065139-b3503f4aeff6 // indirect
+
 require (
 	github.com/antlr4-go/antlr/v4 v4.13.0 // indirect
 	github.com/cznic/mathutil v0.0.0-20181122101859-297441e03548 // indirect

go.sum

@@ -185,6 +185,10 @@ github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO
 github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/wasilibs/go-pgquery v0.0.0-20231201074715-bbab8b1ab4a9 h1:JrDBgtPAsn6LC0EMn9jBaSFiZqVpKMa9hea47/nkaeA=
+github.com/wasilibs/go-pgquery v0.0.0-20231201074715-bbab8b1ab4a9/go.mod h1:kalxVxSjXzPXnzVrIsejhYyPa81QLKHbNnNSB8bL6q0=
+github.com/wasilibs/wazerox v0.0.0-20231117065139-b3503f4aeff6 h1:jwbU8u5TuXModzdEG4wI0g4FyuD7ROSttU86go5sPdU=
+github.com/wasilibs/wazerox v0.0.0-20231117065139-b3503f4aeff6/go.mod h1:IQNVyA4d1hWIe23mlMMuqXjyWMdndgSlNx6FqBkwPsM=
 github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f h1:J9EGpcZtP0E/raorCMxlFGSTBrsSlaDGf3jU/qvAE2c=
 github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU=
 github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 h1:EzJWgHovont7NscjpAxXsDA8S8BMYve8Y5+7cuRE7R0=

internal/codegen/sdk/utils.go

@@ -23,12 +23,14 @@ func Title(s string) string {
 // a backtick, replace it the following way:
 //
 // input:
-// 	SELECT `group` FROM foo
+//
+//	SELECT `group` FROM foo
 //
 // output:
-// 	SELECT ` + "`" + `group` + "`" + ` FROM foo
 //
-// The escaped string must be rendered inside an existing string literal
+//	SELECT ` + "`" + `group` + "`" + ` FROM foo
+//
+// # The escaped string must be rendered inside an existing string literal
 //
 // A string cannot be escaped twice
 func EscapeBacktick(s string) string {

internal/endtoend/endtoend_test.go

@@ -1,3 +1,7 @@
+// Currently requires cgo for wasmtime.
+//go:build cgo
+// +build cgo
+
 package main
 
 import (

internal/endtoend/fmt_test.go

@@ -8,7 +8,6 @@ import (
 	"strings"
 	"testing"
 
-	pg_query "github.com/pganalyze/pg_query_go/v4"
 	"github.com/sqlc-dev/sqlc/internal/debug"
 	"github.com/sqlc-dev/sqlc/internal/engine/postgresql"
 	"github.com/sqlc-dev/sqlc/internal/sql/ast"
@@ -40,7 +39,7 @@ func TestFormat(t *testing.T) {
 				}
 				query := query
 				t.Run(fmt.Sprintf("%d", i), func(t *testing.T) {
-					expected, err := pg_query.Fingerprint(string(query))
+					expected, err := postgresql.Fingerprint(string(query))
 					if err != nil {
 						t.Fatal(err)
 					}
@@ -52,12 +51,12 @@ func TestFormat(t *testing.T) {
 						t.Fatal("expected one statement")
 					}
 					if false {
-						r, err := pg_query.Parse(string(query))
+						r, err := postgresql.Parse(string(query))
 						debug.Dump(r, err)
 					}
 
 					out := ast.Format(stmts[0].Raw)
-					actual, err := pg_query.Fingerprint(out)
+					actual, err := postgresql.Fingerprint(out)
 					if err != nil {
 						t.Error(err)
 					}

internal/engine/postgresql/convert.go

@@ -1,12 +1,9 @@
-//go:build !windows && cgo
-// +build !windows,cgo
-
 package postgresql
 
 import (
 	"fmt"
 
-	pg "github.com/pganalyze/pg_query_go/v4"
+	pg "github.com/wasilibs/go-pgquery"
 
 	"github.com/sqlc-dev/sqlc/internal/sql/ast"
 )

internal/engine/postgresql/parse.go

@@ -1,6 +1,3 @@
-//go:build !windows && cgo
-// +build !windows,cgo
-
 package postgresql
 
 import (
@@ -9,9 +6,9 @@ import (
 	"io"
 	"strings"
 
-	nodes "github.com/pganalyze/pg_query_go/v4"
-	"github.com/pganalyze/pg_query_go/v4/parser"
+	nodes "github.com/wasilibs/go-pgquery"
 
+	"github.com/sqlc-dev/sqlc/internal/engine/postgresql/parser"
 	"github.com/sqlc-dev/sqlc/internal/source"
 	"github.com/sqlc-dev/sqlc/internal/sql/ast"
 	"github.com/sqlc-dev/sqlc/internal/sql/sqlerr"
@@ -154,7 +151,7 @@ func (p *Parser) Parse(r io.Reader) ([]ast.Statement, error) {
 	if err != nil {
 		return nil, err
 	}
-	tree, err := nodes.Parse(string(contents))
+	tree, err := parseNodes(string(contents))
 	if err != nil {
 		pErr := normalizeErr(err)
 		return nil, pErr

internal/engine/postgresql/parse_default.go

@@ -0,0 +1,38 @@
+//go:build !windows && cgo
+// +build !windows,cgo
+
+package postgresql
+
+import (
+	cgonodes "github.com/pganalyze/pg_query_go/v4"
+	wasinodes "github.com/wasilibs/go-pgquery"
+	"google.golang.org/protobuf/proto"
+)
+
+func parseNodes(input string) (*wasinodes.ParseResult, error) {
+	cgoRes, err := cgonodes.Parse(input)
+	if err != nil {
+		return nil, err
+	}
+
+	// It would be too tedious to maintain conversion logic in a way that
+	// can target the two types from different packages despite being identical.
+	// We go ahead and take a small performance hit by marshaling through
+	// protobuf to unify the types. We must use the wasilibs version because
+	// the upstream version requires cgo even when only accessing the proto.
+
+	resBytes, err := proto.Marshal(cgoRes)
+	if err != nil {
+		return nil, err
+	}
+
+	var wasiRes wasinodes.ParseResult
+	if err := proto.Unmarshal(resBytes, &wasiRes); err != nil {
+		return nil, err
+	}
+
+	return &wasiRes, nil
+}
+
+var Parse = parseNodes
+var Fingerprint = cgonodes.Fingerprint

internal/engine/postgresql/parse_wasi.go

@@ -0,0 +1,13 @@
+//go:build windows || !cgo
+// +build windows !cgo
+
+package postgresql
+
+import (
+	nodes "github.com/wasilibs/go-pgquery"
+)
+
+var parseNodes = nodes.Parse
+
+var Parse = parseNodes
+var Fingerprint = nodes.Fingerprint

internal/engine/postgresql/parser/parser_default.go

@@ -0,0 +1,8 @@
+//go:build !windows && cgo
+// +build !windows,cgo
+
+package parser
+
+import "github.com/pganalyze/pg_query_go/v4/parser"
+
+type Error = parser.Error

internal/engine/postgresql/parser/parser_wasi.go

@@ -0,0 +1,8 @@
+//go:build windows || !cgo
+// +build windows !cgo
+
+package parser
+
+import "github.com/wasilibs/go-pgquery/parser"
+
+type Error = parser.Error

internal/engine/postgresql/utils.go

@@ -1,10 +1,7 @@
-//go:build !windows && cgo
-// +build !windows,cgo
-
 package postgresql
 
 import (
-	nodes "github.com/pganalyze/pg_query_go/v4"
+	nodes "github.com/wasilibs/go-pgquery"
 )
 
 func isArray(n *nodes.TypeName) bool {