feat: extend protobuf schema with more fields and protovalidate validation constraints

Author: arkadiusjonczek

README.md

@@ -4,13 +4,13 @@ This demo is about to demonstrate how to use protobuf and protovalidate with RES
 
 ## Requirements
 
-To generate the go files for the protobuf definitions you need `buf`.
+To generate the go files for the protobuf definitions you need `buf` installed.
 
 ## Usage
 
 ### Protobuf
 
-To generate the go files for the protobuf definitions run:
+To generate the go files to `pkg/proto/demo/v1` for the protobuf definitions located under `proto/demo/v1` run:
 
 ```shell
 buf generate
@@ -29,5 +29,17 @@ go run cmd/server/main.go
 Then request the server with:
 
 ```shell
-curl localhost:8080/customer
+curl -XPOST --json '{}' localhost:8080/customer
+```
+
+## Routes
+
+The following CRUD routes are available:
+
+```shell
+GET    localhost:8080/customer
+POST   localhost:8080/customer
+GET    localhost:8080/customer/{id}
+PUT    localhost:8080/customer/{id}
+DELETE localhost:8080/customer/{id}
 ```

cmd/server/main.go

@@ -1,11 +1,13 @@
 package main
 
 import (
-	"github.com/arkadiusjonczek/go-rest-api-protobuf-protovalidate-demo.git/internal/pkg/app"
-	v1 "github.com/arkadiusjonczek/go-rest-api-protobuf-protovalidate-demo.git/pkg/proto/demo/v1"
-	"github.com/bufbuild/protovalidate-go"
 	"log"
 	"net/http"
+
+	"github.com/bufbuild/protovalidate-go"
+
+	"github.com/arkadiusjonczek/go-rest-api-protobuf-protovalidate-demo.git/internal/pkg/app"
+	v1 "github.com/arkadiusjonczek/go-rest-api-protobuf-protovalidate-demo.git/pkg/proto/demo/v1"
 )
 
 const (

internal/pkg/app/decoder.go

@@ -13,6 +13,8 @@ type Decoder[E Entity] interface {
 
 var _ Decoder[v1.Customer] = (*CustomerDecoder)(nil)
 
+// CustomerDecoder is a conrete implementation which doesn't use generics
+// because protojson and protovalidate has problems with generics
 type CustomerDecoder struct {
 	unmarshalOptions *protojson.UnmarshalOptions
 	protovalidate    *protovalidate.Validator

pkg/proto/demo/v1/customer.pb.go

@@ -7,6 +7,18 @@ option go_package = "demo/v1";
 import "buf/validate/validate.proto";
 
 message Customer {
+  option (buf.validate.message).cel = {
+    id: "age_required",
+    message: "age has to be set",
+    expression: "has(this.age)"
+  };
+
+  option (buf.validate.message).cel = {
+    id: "age_max",
+    message: "age has to be gt 0 and lt 120",
+    expression: "this.age > 0 && this.age < 120"
+  };
+
   string name = 1 [
     (buf.validate.field).required = true,
     (buf.validate.field).string = {
@@ -15,5 +27,26 @@ message Customer {
     }
   ];
 
-  string test_name = 2;
+  string username = 2 [
+    (buf.validate.field).cel = {
+      id: "username_format",
+      message: "username must be 3 - 16 characters long and only contain letters and digits",
+      // `this.matches` match the string against a regex pattern, and evaluates to a bool.
+      expression: "this.matches('^[A-Za-z0-9]{3,16}$')"
+    }
+  ];
+
+  string email = 3 [
+    (buf.validate.field).cel = {
+      id: "valid_email",
+      message: "email must be a valid email",
+      expression: "this.isEmail()"
+    }
+  ];
+
+  uint32 age = 4;
+
+  string agree = 5 [
+    (buf.validate.field).string.const = "I agree to the terms and conditions."
+  ];
 }