Skip to content

feat(compiler): Parse query parameter metadata from comments #2850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrewmbenton merged 12 commits into from
Oct 16, 2023
Merged

feat(compiler): Parse query parameter metadata from comments #2850

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4db5c66
feat(compiler): Parse query parameter metadata from comments
andrewmbenton Oct 12, 2023
655c28f
update comment stripping, fix a test
andrewmbenton Oct 13, 2023
97b0571
parse `@param` name correctly
andrewmbenton Oct 13, 2023
767db2c
add a test for metadata param parsing
andrewmbenton Oct 13, 2023
2fdb3fa
use a word scanner for flag and param comment line parsing
andrewmbenton Oct 13, 2023
a6c0d23
forgot that I partially cleaned comments already
andrewmbenton Oct 13, 2023
f83ed99
slightly more useful metadata test output
andrewmbenton Oct 13, 2023
20ff7f1
drop unnecessary metadata test cases
andrewmbenton Oct 13, 2023
689832c
walk back changes, implement comment cleaning in source package
andrewmbenton Oct 13, 2023
49e8e36
cleanup
andrewmbenton Oct 13, 2023
c1fce0b
simplify diff
andrewmbenton Oct 13, 2023
0269502
ensure at least one test case for parsing @whatever without a leading…
andrewmbenton Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
use a word scanner for flag and param comment line parsing
  • Loading branch information
@andrewmbenton
andrewmbenton committed Oct 13, 2023
commit 2fdb3fa6e70a27aec8adafea81f46bbd94f24298
57 changes: 39 additions & 18 deletions internal/metadata/meta.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,32 +123,53 @@ func ParseQueryMetadata(rawSql string, commentStyle CommentSyntax) (Metadata, er
}

md.Comments = comments
md.Params, md.Flags = parseParamsAndFlags(md.Comments)

var err error
md.Params, md.Flags, err = parseParamsAndFlags(md.Comments)
if err != nil {
return md, err
}

return md, s.Err()
}

func parseParamsAndFlags(comments []string) (map[string]string, map[string]bool) {
func parseParamsAndFlags(comments []string) (map[string]string, map[string]bool, error) {
params := make(map[string]string)
flags := make(map[string]bool)

for _, line := range comments {
cleanLine := strings.TrimPrefix(line, "--")
cleanLine = strings.TrimPrefix(cleanLine, "/*")
cleanLine = strings.TrimPrefix(cleanLine, "#")
cleanLine = strings.TrimSuffix(cleanLine, "*/")
cleanLine = strings.TrimSpace(cleanLine)
if strings.HasPrefix(cleanLine, "@") {
parts := strings.SplitN(cleanLine, " ", 2)
name := parts[0]
switch name {
case "@param":
paramParts := strings.SplitN(parts[1], " ", 2)
params[paramParts[0]] = paramParts[1]
default:
flags[name] = true
}
s := bufio.NewScanner(strings.NewReader(line))
s.Split(bufio.ScanWords)

s.Scan() // The first token is always the comment indicator, e.g. "--"
s.Scan()
token := s.Text()

if !strings.HasPrefix(token, "@") {
continue
}

switch token {
case "@param":
s.Scan()
name := s.Text()
var rest []string
for s.Scan() {
paramToken := s.Text()
if paramToken == "*/" {
break
}
rest = append(rest, paramToken)
}
params[name] = strings.Join(rest, " ")
default:
flags[token] = true
}

if s.Err() != nil {
return params, flags, s.Err()
}
}
return params, flags

return params, flags, nil
}
32 changes: 29 additions & 3 deletions internal/metadata/meta_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ func TestParseQueryParams(t *testing.T) {
"-- name: CreateFoo :one",
"-- @param foo_id UUID",
},
{
"/* name: CreateFoo :one */",
"/* @param foo_id UUID */",
},
{
"# name: CreateFoo :one",
"# @param foo_id UUID",
},
{
"-- name: CreateFoo :one",
"-- @param foo_id UUID",
Expand All @@ -76,13 +84,20 @@ func TestParseQueryParams(t *testing.T) {
"-- @param @invalid UUID",
},
} {
params, _ := parseParamsAndFlags(comments)
params, _, err := parseParamsAndFlags(comments)
if err != nil {
t.Error("expected comments to parse:", err)
}

_, ok := params["foo_id"]
pt, ok := params["foo_id"]
if !ok {
t.Errorf("expected param not found")
}

if pt != "UUID" {
t.Error("unexpected param metadata:", pt)
}

_, ok = params["invalid"]
if ok {
t.Errorf("unexpected param found")
Expand All @@ -96,6 +111,14 @@ func TestParseQueryFlags(t *testing.T) {
"-- name: CreateFoo :one",
"-- @flag-foo",
},
{
"/* name: CreateFoo :one */",
"/* @flag-foo */",
},
{
"# name: CreateFoo :one",
"# @flag-foo",
},
{
"-- name: CreateFoo :one",
"-- @flag-foo @flag-bar",
Expand All @@ -106,7 +129,10 @@ func TestParseQueryFlags(t *testing.T) {
"-- @flag-foo",
},
} {
_, flags := parseParamsAndFlags(comments)
_, flags, err := parseParamsAndFlags(comments)
if err != nil {
t.Error("expected comments to parse:", err)
}

if !flags["@flag-foo"] {
t.Errorf("expected flag not found")
Expand Down