Add protovalidate as alternative to protoc-gen-validate #124

tstirrat15 · 2024-11-21T21:02:46Z

Description

I ran into this while looking into authzed-rb's implementation of validation. I hoped that it might solve that problem, but it turns out that there isn't a protovalidate implementation for ruby either (yet, I hope).

I think there's still value in bringing this in, though.

protoc-gen-validate is in maintenance mode: https://github.com/bufbuild/protoc-gen-validate?tab=readme-ov-file#-protoc-gen-validate-pgv

The library they want us to move to is protovalidate: https://github.com/bufbuild/protovalidate

This follows the steps in the migration guide to add annotations that are compatible with protovalidate and allow the downstream libs to use the protovalidate libs as desired.

Notes

The breaking change lint step is complaining, but I ran it locally and it's not code that we use directly or control:

➜  api git:(use-protovalidate-instead-of-protoc-gen-validate) buf breaking . --against https://github.com/authzed/api.git\#branch\=main
protoc-gen-openapiv2/options/openapiv2.proto:45:1:Previously present reserved range "[13]" on message "Swagger" is missing values: [13] were removed.
protoc-gen-openapiv2/options/openapiv2.proto:587:1:Previously present reserved range "[1]" on message "Tag" is missing values: [1] were removed.

It appears to be complaining about the proto provided by the grpc-gateway dep, and that version bump happened when I added the new dependency. I'm not particularly concerned about it breaking anything.

Changes

Update buf.yaml to v2
Run buf format over everything
Run the migration steps from the protovalidate repo: https://github.com/bufbuild/protovalidate/blob/main/docs/migrate.md

Notes

This does not remove support for protoc-gen-validate. We probably won't do that for a while yet. This should be a non-breaking change.

Testing

Review. See that our CI still passes.

Migrate files and re-add old validate temporarily

github-actions · 2025-03-13T16:38:02Z

The latest Buf updates on your PR. Results from workflow Lint / lint (pull_request).

Build	Format	Lint	Breaking	Updated (UTC)
`✅ passed`	`✅ passed`	`✅ passed`	`⏩ skipped`	Apr 15, 2025, 10:00 PM

josephschorr

LGTM

miparnisari · 2025-04-15T20:55:44Z

.github/workflows/release.yaml

-      - uses: "actions/checkout@v3"
-      - uses: "bufbuild/buf-setup-action@v1.32.2"
+      - uses: "actions/checkout@v4"
+      - uses: "bufbuild/buf-setup-action@v1.47.2"


buf-setup-action was deprecated in favor of buf-action: https://github.com/bufbuild/buf-setup-action#buf-setup-action

Yeah, I'm using it in the lint action. I can update this usage as well.

miparnisari · 2025-04-15T21:01:50Z

buf.yaml

@@ -1,15 +1,21 @@
 ---
-version: "v1"
+version: "v2"


I'm curious, did you use buf config migrate? https://buf.build/docs/migration-guides/migrate-v2-config-files

tstirrat15

Committing

tstirrat15 · 2025-03-12T22:22:56Z

authzed/api/materialize/v0/watchpermissions.proto

 import "authzed/api/v1/core.proto";

 option go_package = "github.com/authzed/authzed-go/proto/authzed/api/materialize/v0";
-option java_package = "com.authzed.api.materialize.v0";


These changes to imports are a part of running buf format

tstirrat15 · 2025-03-12T22:23:17Z

.github/workflows/lint.yaml

+      - uses: "bufbuild/buf-setup-action@v1.47.2"
        with:
-          version: "1.30.0"
+          github_token: "${{ github.token }}"


This authenticates our buf requests

tstirrat15 · 2025-03-12T22:23:29Z

.pre-commit-config.yaml

 repos:
  - repo: "https://github.com/bufbuild/buf"
-    rev: "v1.6.0"
+    rev: "v1.47.2"


So that we're linting with a recent version of buf

tstirrat15 · 2025-04-15T21:24:18Z

buf.yaml

@@ -1,15 +1,21 @@
 ---
-version: "v1"
+version: "v2"


tstirrat15 · 2025-04-15T21:24:51Z

.github/workflows/release.yaml

-      - uses: "actions/checkout@v3"
-      - uses: "bufbuild/buf-setup-action@v1.32.2"
+      - uses: "actions/checkout@v4"
+      - uses: "bufbuild/buf-setup-action@v1.47.2"


Yeah, I'm using it in the lint action. I can update this usage as well.

tstirrat15 changed the title ~~Use protovalidate instead of protoc gen validate~~ Add protovalidate as alternative to protoc-gen-validate Nov 22, 2024

tstirrat15 added 5 commits March 12, 2025 15:55

Use protovalidate instead of protoc-gen-validate, move to v2

4046325

Run buf format

90fb5bc

Migrate files and re-add old validate temporarily

Bump buf version used in lint

98d1b66

Use most recent version of buf

6455307

Bump action versions, use github token

0f29d31

tstirrat15 force-pushed the use-protovalidate-instead-of-protoc-gen-validate branch from 5199e7b to 0f29d31 Compare March 12, 2025 22:09

Fix merge conflicts

5fc57d9

tstirrat15 force-pushed the use-protovalidate-instead-of-protoc-gen-validate branch from bc7dbea to 6676de4 Compare March 13, 2025 16:37

tstirrat15 added the Buf Skip Breaking Used to mark a breaking buf change as expected label Mar 13, 2025

tstirrat15 mentioned this pull request Apr 15, 2025

Swap in protovalidate instead of protoc-gen-validate authzed/authzed-py#253

Merged

josephschorr previously approved these changes Apr 15, 2025

View reviewed changes

miparnisari previously approved these changes Apr 15, 2025

View reviewed changes

tstirrat15 commented Apr 15, 2025

View reviewed changes

Format

7ac2968

tstirrat15 dismissed stale reviews from miparnisari and josephschorr via 7ac2968 April 15, 2025 22:00

tstirrat15 force-pushed the use-protovalidate-instead-of-protoc-gen-validate branch from 6676de4 to 7ac2968 Compare April 15, 2025 22:00

josephschorr approved these changes Apr 15, 2025

View reviewed changes

miparnisari approved these changes Apr 15, 2025

View reviewed changes

tstirrat15 merged commit 0d17d5f into main Apr 15, 2025
3 checks passed

tstirrat15 deleted the use-protovalidate-instead-of-protoc-gen-validate branch April 15, 2025 22:25

github-actions bot locked and limited conversation to collaborators Apr 15, 2025

Add protovalidate as alternative to protoc-gen-validate #124

Add protovalidate as alternative to protoc-gen-validate #124

Uh oh!

Conversation

tstirrat15 commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Notes

Changes

Notes

Testing

Uh oh!

github-actions bot commented Mar 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

josephschorr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tstirrat15 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tstirrat15 commented Nov 21, 2024 •

edited

Loading

github-actions bot commented Mar 13, 2025 •

edited

Loading