Merge pull request #70 from KonferCA/feat/64/user-role-enum

Feat/64/user role enum

.sqlc/migrations/20241108045258_create_users_table.sql

@@ -18,4 +18,4 @@ CREATE TABLE users (
 -- +goose Down
 -- +goose StatementBegin
 DROP TABLE users;
--- +goose StatementEnd
+-- +goose StatementEnd

.sqlc/migrations/20241116191633_user_role_enum.sql

@@ -0,0 +1,17 @@
+-- +goose Up
+-- +goose StatementBegin
+BEGIN;
+
+CREATE TYPE user_role AS ENUM ('admin', 'startup_owner', 'investor');
+
+COMMIT;
+-- +goose StatementEnd
+
+-- +goose Down
+-- +goose StatementBegin
+BEGIN;
+
+DROP TYPE user_role;
+
+COMMIT;
+-- +goose StatementEnd

.sqlc/migrations/20241116192218_alter_users_role_col.sql

@@ -0,0 +1,29 @@
+-- +goose Up
+-- +goose StatementBegin
+BEGIN;
+
+ALTER TABLE users ADD COLUMN role_enum user_role NOT NULL;
+
+UPDATE users
+SET role_enum = role::user_role;
+
+ALTER TABLE users DROP COLUMN role;
+ALTER TABLE users RENAME COLUMN role_enum TO role;
+
+COMMIT;
+-- +goose StatementEnd
+
+-- +goose Down
+-- +goose StatementBegin
+BEGIN;
+
+ALTER TABLE users ADD COLUMN role_varchar VARCHAR(50) NOT NULL;
+
+UPDATE users
+SET  role_varchar = role::text;
+
+ALTER TABLE users DROP COLUMN role;
+ALTER TABLE users RENAME COLUMN role_varchar TO role;
+
+COMMIT;
+-- +goose StatementEnd

internal/jwt/generate.go

@@ -4,6 +4,7 @@ import (
 	"os"
 	"time"
 
+	"github.com/KonferCA/NoKap/db"
 	golangJWT "github.com/golang-jwt/jwt/v5"
 )
 
@@ -13,7 +14,7 @@ const (
 )
 
 // Generates JWT tokens for the given user. Returns the access token, refresh token and error (nil if no error)
-func Generate(userID string, role string) (string, string, error) {
+func Generate(userID string, role db.UserRole) (string, string, error) {
 	accessToken, err := generateToken(userID, role, ACCESS_TOKEN_TYPE, time.Now().Add(10*time.Minute))
 	if err != nil {
 		return "", "", err
@@ -28,7 +29,7 @@ func Generate(userID string, role string) (string, string, error) {
 }
 
 // Private helper method to generate a token.
-func generateToken(userID, role, tokenType string, exp time.Time) (string, error) {
+func generateToken(userID string, role db.UserRole, tokenType string, exp time.Time) (string, error) {
 	claims := JWTClaims{
 		UserID:    userID,
 		Role:      role,

internal/jwt/jwt_test.go

@@ -5,6 +5,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/KonferCA/NoKap/db"
 	golangJWT "github.com/golang-jwt/jwt/v5"
 	"github.com/stretchr/testify/assert"
 )
@@ -14,7 +15,7 @@ func TestJWT(t *testing.T) {
 	os.Setenv("JWT_SECRET", "secret")
 
 	userID := "some-user-id"
-	role := "user"
+	role := db.UserRole("user")
 	exp := time.Now().Add(5 * time.Minute)
 
 	t.Run("generate access token", func(t *testing.T) {

internal/jwt/types.go

@@ -1,10 +1,13 @@
 package jwt
 
-import golangJWT "github.com/golang-jwt/jwt/v5"
+import (
+	"github.com/KonferCA/NoKap/db"
+	golangJWT "github.com/golang-jwt/jwt/v5"
+)
 
 type JWTClaims struct {
-	UserID    string `json:"user_id"`
-	Role      string `json:"role"`
-	TokenType string `json:"token_type"`
+	UserID    string      `json:"user_id"`
+	Role      db.UserRole `json:"role"`
+	TokenType string      `json:"token_type"`
 	golangJWT.RegisteredClaims
 }

internal/middleware/jwt_test.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"testing"
 
+	"github.com/KonferCA/NoKap/db"
 	"github.com/KonferCA/NoKap/internal/jwt"
 	"github.com/labstack/echo/v4"
 	"github.com/stretchr/testify/assert"
@@ -24,7 +25,7 @@ func TestProtectAPIForAccessToken(t *testing.T) {
 
 	// generate valid tokens
 	userID := "user-id"
-	role := "user-role"
+	role := db.UserRole("user-role")
 	accessToken, refreshToken, err := jwt.Generate(userID, role)
 	assert.Nil(t, err)
 
@@ -103,7 +104,7 @@ func TestProtectAPIForRefreshToken(t *testing.T) {
 
 	// generate valid tokens
 	userID := "user-id"
-	role := "user-role"
+	role := db.UserRole("user-role")
 	accessToken, refreshToken, err := jwt.Generate(userID, role)
 	assert.Nil(t, err)
 

internal/middleware/req_validator.go

@@ -5,6 +5,7 @@ import (
 	"net/http"
 	"reflect"
 
+	"github.com/KonferCA/NoKap/db"
 	"github.com/go-playground/validator/v10"
 	"github.com/labstack/echo/v4"
 	"github.com/rs/zerolog/log"
@@ -29,7 +30,9 @@ func (rv *RequestBodyValidator) Validate(i interface{}) error {
 // Creates a new request validator that can be set to an Echo instance
 // and used for validating request bodies with c.Validate()
 func NewRequestBodyValidator() *RequestBodyValidator {
-	return &RequestBodyValidator{validator: validator.New()}
+	v := validator.New()
+	v.RegisterValidation("valid_user_role", validateUserRole)
+	return &RequestBodyValidator{validator: v}
 }
 
 // Middleware that validates the incoming request body with the given structType.
@@ -57,3 +60,31 @@ func ValidateRequestBody(structType reflect.Type) echo.MiddlewareFunc {
 		}
 	}
 }
+
+// validateUserRole validates the "valid_user_role" tag using the
+// the generated valid method from SQLc.
+func validateUserRole(fl validator.FieldLevel) bool {
+	field := fl.Field()
+
+	// handle string type
+	if field.Kind() == reflect.String {
+		str := field.String()
+		ur := db.UserRole(str)
+		return ur.Valid()
+	}
+
+	// handle db.UserRole type
+	if field.Type() == reflect.TypeOf(db.UserRole("")) {
+		ur := field.Interface().(db.UserRole)
+		return ur.Valid()
+
+	}
+
+	// handle pointer to db.UserRole
+	if field.Type() == reflect.TypeOf((*db.UserRole)(nil)) && !field.IsNil() {
+		ur := field.Interface().(*db.UserRole)
+		return ur.Valid()
+	}
+
+	return false
+}