feat(verify): Add new command to verify queries and migrations #2986
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kyleconroy
changed the title
andrewmbenton
previously requested changes
Nov 17, 2023
Comment on lines
+78
to
+85
| func annotate() map[string]string { | ||
| labels := map[string]string{} | ||
| for _, ev := range envvars { | ||
| key := strings.ReplaceAll(strings.ToLower(ev), "_", ".") | ||
| labels[key] = os.Getenv(ev) | ||
| } | ||
| outs, err := readOutputs(up.dir, result) | ||
| return labels | ||
| } |
There was a problem hiding this comment.
I guess it's frowned upon these days but this seems like a case for init()
internal/cmd/push.go
Outdated
| var pushCmd = &cobra.Command{ | ||
| Use: "push", | ||
| Aliases: []string{"upload"}, | ||
| Short: "Push the schema, queries, and configuration to your project", |
There was a problem hiding this comment.
This used to be "...for this project" which is maybe not ideal but I think is clearer than "...to your project"
internal/cmd/push.go
Outdated
| } | ||
| p := &pusher{} | ||
| if err := Process(ctx, p, dir, filename, opts); err != nil { | ||
| os.Exit(1) |
There was a problem hiding this comment.
Should just be return err no?
internal/cmd/verify.go
Outdated
|
|
||
| var verifyCmd = &cobra.Command{ | ||
| Use: "verify", | ||
| Short: "Verify schema, queries, and configuration against main", |
There was a problem hiding this comment.
I don't think "against main" means anything here. I don't have a better idea at the moment, but I think just saying "Verify schema, queries, and configuration for this project" would be fine for now.
internal/cmd/verify.go
Outdated
Comment on lines
45
to
46
| // hmmm | ||
| os.Exit(1) |
There was a problem hiding this comment.
Is there a reason we can't just return err here?
Only generate one output pair per queryset for upload / verify
kyleconroy
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
push
We've renamed the upload sub-command to push. Using
uploadis supported for now, but please switch over to usingpush. We changed the data sent along in a push request. Upload used to include the configuration file, migrations, queries, and all generated code. Push drops the generated code in favor of including the [plugin.GenerateRequest], which is the protobuf message we pass to codegen plugins.We now pass along annotations for each push. By default, we include these environment variables if they are present:
Like upload, push should be run when you tag a release of your application. We run it on every push to main, as we continuously deploy those commits.
verify
The verify command, building on top of the push command, ensures migrations are safe to deploy. Verify sends your current schema and queries to sqlc cloud. There, we run the queries for your latest push against your new schema changes. This check catches backwards incompatible schema changes for existing queries.