envoyproxy/protoc-gen-validate (#20)

Author: kevinmichaelchen

Makefile

@@ -5,6 +5,9 @@ all:
 
 .PHONY: gen-proto
 gen-proto:
+	buf lint idl
+	buf format idl -w
+	buf mod update idl
 	buf generate idl
 
 .PHONY: gen-models

buf.gen.yaml

@@ -8,4 +8,9 @@ plugins:
     out: internal/idl
     opt:
       - require_unimplemented_servers=false
-      - paths=source_relative
+      - paths=source_relative
+  - remote: buf.build/jirkad/plugins/protoc-gen-validate:v0.6.7
+    out: internal/idl
+    opt:
+      - paths=source_relative
+      - lang=go

docs/CONTRIBUTING.md

@@ -124,4 +124,20 @@ dispatch=# select driver_id from driver_location ;
  WBG-Chimu-Bistro
  WBG-Birria-Landia
 (16 rows)
-```
+```
+
+## JetBrains Protobuf Import Paths
+In `Languages & Frameworks > Protocol Buffers`, import the `./idl` directory.
+
+Install envoyproxy/protoc-gen-validate into your `GOPATH`.
+```
+$ go env -json GOPATH GOROOT                
+{
+	"GOPATH": "/Users/kevinchen/go",
+	"GOROOT": "/opt/homebrew/Cellar/go/1.18.2/libexec"
+}
+
+$ go install github.com/envoyproxy/protoc-gen-validate@latest
+```
+
+Add an import path for `${GOPATH}/pkg/mod/github.com/envoyproxy/protoc-gen-validate@v0.6.7`.

go.mod

@@ -4,6 +4,7 @@ go 1.18
 
 require (
 	github.com/XSAM/otelsql v0.14.1
+	github.com/envoyproxy/protoc-gen-validate v0.1.0
 	github.com/friendsofgo/errors v0.9.2
 	github.com/go-ozzo/ozzo-validation/v4 v4.3.0
 	github.com/google/go-cmp v0.5.8

go.sum

@@ -113,6 +113,7 @@ github.com/envoyproxy/go-control-plane v0.9.9-0.20210217033140-668b12f5399d/go.m
 github.com/envoyproxy/go-control-plane v0.9.9-0.20210512163311-63b5d3c536b0/go.mod h1:hliV/p42l8fGbc6Y9bQ70uLwIvmJyVE5k4iMKlh8wCQ=
 github.com/envoyproxy/go-control-plane v0.9.10-0.20210907150352-cf90f659a021/go.mod h1:AFq3mo9L8Lqqiid3OhADV3RfLJnjiw63cSpi+fDTRC0=
 github.com/envoyproxy/go-control-plane v0.10.2-0.20220325020618-49ff273808a1/go.mod h1:KJwIaB5Mv44NWtYuAOFCVOjcI94vtpEz2JU/D2v6IjE=
+github.com/envoyproxy/protoc-gen-validate v0.1.0 h1:EQciDnbrYxy13PgWoY8AqoxGiPrpgBZ1R8UNe3ddc+A=
 github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
 github.com/ericlagergren/decimal v0.0.0-20181231230500-73749d4874d5 h1:HQGCJNlqt1dUs/BhtEKmqWd6LWS+DWYVxi9+Jo4r0jE=
 github.com/ericlagergren/decimal v0.0.0-20181231230500-73749d4874d5/go.mod h1:1yj25TwtUlJ+pfOu9apAVaM1RWfZGg+aFpd4hPQZekQ=

idl/buf.lock

@@ -0,0 +1,7 @@
+# Generated by buf. DO NOT EDIT.
+version: v1
+deps:
+  - remote: buf.build
+    owner: envoyproxy
+    repository: protoc-gen-validate
+    commit: dc09a417d27241f7b069feae2cd74a0e

idl/buf.yaml

@@ -1,4 +1,6 @@
 version: v1
+deps:
+  - buf.build/envoyproxy/protoc-gen-validate:0e25aabb25c0709aff19aea176a1da13328b12fb
 breaking:
   use:
     - FILE

idl/coop/drivers/dispatch/v1beta1/api.proto

@@ -6,6 +6,7 @@ import "coop/drivers/dispatch/v1beta1/driver.proto";
 import "coop/drivers/dispatch/v1beta1/latlng.proto";
 import "coop/drivers/dispatch/v1beta1/trip.proto";
 import "google/protobuf/duration.proto";
+import "validate/validate.proto";
 
 option go_package = "github.com/kevinmichaelchen/api-dispatch/internal/idl/coop/drivers/dispatch/v1beta1";
 
@@ -24,21 +25,30 @@ service DispatchService {
 }
 
 message UpdateDriverLocationsRequest {
-  repeated DriverLocation locations = 1;
+  repeated DriverLocation locations = 1 [(validate.rules).repeated = {
+    min_items: 1,
+    max_items: 1000
+  }];
 }
 
 message UpdateDriverLocationsResponse {}
 
 message CreateTripsRequest {
-  repeated Trip trips = 1;
+  repeated Trip trips = 1 [(validate.rules).repeated = {
+    min_items: 1,
+    max_items: 1000
+  }];
 }
 
 message CreateTripsResponse {}
 
 message GetNearestDriversRequest {
   // trip pickup location
   LatLng pickup_location = 1;
-  int32 limit = 2;
+  int32 limit = 2 [(validate.rules).int32 = {
+    gt: 0,
+    lte: 1000
+  }];
 }
 
 message GetNearestDriversResponse {
@@ -48,10 +58,15 @@ message GetNearestDriversResponse {
 
 message GetNearestTripsRequest {
   oneof driver {
+    option (validate.required) = true;
+
     string driver_id = 1;
     LatLng driver_location = 2;
   }
-  int32 limit = 3;
+  int32 limit = 3 [(validate.rules).int32 = {
+    gt: 0,
+    lte: 1000
+  }];
 }
 
 message GetNearestTripsResponse {

idl/coop/drivers/dispatch/v1beta1/driver.proto

@@ -4,11 +4,12 @@ package coop.drivers.dispatch.v1beta1;
 
 import "coop/drivers/dispatch/v1beta1/latlng.proto";
 import "google/protobuf/timestamp.proto";
+import "validate/validate.proto";
 
 option go_package = "github.com/kevinmichaelchen/api-dispatch/internal/idl/coop/drivers/dispatch/v1beta1";
 
 message DriverLocation {
-  string driver_id = 1;
-  google.protobuf.Timestamp most_recent_heartbeat = 2;
-  LatLng current_location = 3;
+  string driver_id = 1 [(validate.rules).string.min_len = 1];
+  google.protobuf.Timestamp most_recent_heartbeat = 2 [(validate.rules).timestamp.required = true];
+  LatLng current_location = 3 [(validate.rules).message.required = true];
 }

idl/coop/drivers/dispatch/v1beta1/latlng.proto

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package coop.drivers.dispatch.v1beta1;
 
+import "validate/validate.proto";
+
 option go_package = "github.com/kevinmichaelchen/api-dispatch/internal/idl/coop/drivers/dispatch/v1beta1";
 
 // An object that represents a latitude/longitude pair. This is expressed as a
@@ -11,8 +13,14 @@ option go_package = "github.com/kevinmichaelchen/api-dispatch/internal/idl/coop/
 // standard</a>. Values must be within normalized ranges.
 message LatLng {
   // The latitude in degrees. It must be in the range [-90.0, +90.0].
-  double latitude = 1;
+  double latitude = 1 [(validate.rules).double = {
+    gte: -90,
+    lte: 90
+  }];
 
   // The longitude in degrees. It must be in the range [-180.0, +180.0].
-  double longitude = 2;
+  double longitude = 2 [(validate.rules).double = {
+    gte: -180,
+    lte: 180
+  }];
 }