@rivascva/dt-idl 1.1.80 → 1.1.82

package/go/jwt/constants.go

@@ -0,0 +1,6 @@
+package jwt
+
+import "time"
+
+// DefaultServiceTokenDuration is the default duration for service tokens.
+const DefaultServiceTokenDuration = 30 * time.Minute

package/go/jwt/jwt.go

@@ -2,6 +2,7 @@ package jwt
 
 import (
 	"fmt"
+	"time"
 
 	"github.com/golang-jwt/jwt/v5"
 )
@@ -19,3 +20,31 @@ func ValidateToken(token string, secret string) (*jwt.Token, error) {
 
 	return parsedToken, nil
 }
+
+// NewUserToken creates a new JWT token for the given user id.
+func NewUserToken(secret string, issuer string, userId string, duration time.Duration) (string, error) {
+	return newToken(secret, "user", issuer, userId, duration)
+}
+
+// NewServiceToken creates a new JWT token for the given service.
+func NewServiceToken(secret string, issuer string, service string, duration time.Duration) (string, error) {
+	return newToken(secret, "service", issuer, service, duration)
+}
+
+// newToken creates a new JWT token.
+func newToken(secret string, ttype string, issuer string, subject string, duration time.Duration) (string, error) {
+	t := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
+		"type": ttype,
+		"iss":  issuer,
+		"sub":  subject,
+		"iat":  time.Now().UnixMilli(),
+		"exp":  time.Now().Add(duration).UnixMilli(),
+	})
+
+	s, err := t.SignedString([]byte(secret))
+	if err != nil {
+		return "", fmt.Errorf("unable to sign the JWT token: %w", err)
+	}
+
+	return s, nil
+}

package/go/log/log.go

@@ -39,19 +39,19 @@ func NewLog() *Log {
 }
 
 func (l *Log) Info(ctx context.Context, m any) {
-	l.info.Println(toJson(m, kvsWithContext(ctx, l.kvs), "info"))
+	l.info.Println(toJson(ctx, m, l.kvs, "info"))
 }
 
 func (l *Log) Warn(ctx context.Context, m any) {
-	l.warn.Println(toJson(m, kvsWithContext(ctx, l.kvs), "warn"))
+	l.warn.Println(toJson(ctx, m, l.kvs, "warn"))
 }
 
 func (l *Log) Error(ctx context.Context, m any) {
-	l.error.Println(toJson(m, kvsWithContext(ctx, l.kvs), "error"))
+	l.error.Println(toJson(ctx, m, l.kvs, "error"))
 }
 
 func (l *Log) Fatal(ctx context.Context, m any) {
-	l.error.Fatal(toJson(m, kvsWithContext(ctx, l.kvs), "error"))
+	l.error.Fatal(toJson(ctx, m, l.kvs, "error"))
 }
 
 func (l *Log) With(kvs ...any) Logger {
@@ -62,11 +62,9 @@ func (l *Log) With(kvs ...any) Logger {
 	// add the new key-value pairs into the new map
 	for i := 0; i < len(kvs); i += 2 {
 		k := fmt.Sprintf("%v", kvs[i])
-		v := ""
-		if i+1 < len(kvs) {
-			v = fmt.Sprintf("%v", kvs[i+1])
+		if k != "" && i+1 < len(kvs) {
+			newkvs[k] = kvs[i+1]
 		}
-		newkvs[k] = v
 	}
 
 	return &Log{

package/go/log/utils.go

@@ -10,44 +10,40 @@ import (
 )
 
 // toJson converts the message and key-value pairs to a JSON string.
-func toJson(m any, kvs map[string]any, level string) string {
+func toJson(ctx context.Context, m any, kvs map[string]any, lvl string) string {
 	// copy the key-value pairs into a new map
-	out := make(map[string]any, len(kvs)+3)
+	out := make(map[string]any, len(kvs)+10)
 	maps.Copy(out, kvs)
 
 	// add the message
 	out["msg"] = m
 
 	// add the log level
-	out["level"] = level
+	out["level"] = lvl
 
 	// add the timestamp
 	out["timestamp"] = time.Now().UTC().Format(time.RFC3339)
 
-	// marshal the map to a JSON byte array
-	data, err := json.Marshal(out)
-	if err != nil {
-		return err.Error()
+	// add the actor id
+	if actorId, err := utils.GetActorIdFromContext(ctx); err == nil {
+		out["actorId"] = actorId
 	}
 
-	return string(data)
-}
-
-// kvsWithContext returns a new kvs map with added context metadata.
-func kvsWithContext(ctx context.Context, kvs map[string]any) map[string]any {
-	// copy the existing key-value pairs into a new map
-	newkvs := make(map[string]any, len(kvs)+2)
-	maps.Copy(newkvs, kvs)
+	// add the request path
+	if requestPath, err := utils.GetRequestPathFromContext(ctx); err == nil {
+		out["requestPath"] = requestPath
+	}
 
-	// add the user id to the key-value pairs
-	if userId, err := utils.GetUserIdFromContext(ctx); err == nil {
-		newkvs["userId"] = userId
+	// add the request id
+	if requestId, err := utils.GetRequestIdFromContext(ctx); err == nil {
+		out["requestId"] = requestId
 	}
 
-	// add the request path to the key-value pairs
-	if path, err := utils.GetPathFromContext(ctx); err == nil {
-		newkvs["path"] = path
+	// marshal the map to a JSON byte array
+	data, err := json.Marshal(out)
+	if err != nil {
+		return err.Error()
 	}
 
-	return newkvs
+	return string(data)
 }

package/go/middlewares/middlewares.go

@@ -10,6 +10,7 @@ import (
 	"github.com/RivasCVA/dt-idl/go/log"
 	"github.com/RivasCVA/dt-idl/go/models"
 	"github.com/RivasCVA/dt-idl/go/write"
+	"github.com/google/uuid"
 )
 
 // GetAuthMiddleware returns a middleware function that authenticates all requests, except for the login endpoints.
@@ -19,7 +20,7 @@ func GetAuthMiddleware(secret string) func(http.Handler) http.Handler {
 
 	return func(next http.Handler) http.Handler {
 		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-			// check if the request is a login endpoint
+			// check if the request path is a login endpoint
 			if slices.Contains([]string{"/v1/login", "/v1/login/provider"}, r.URL.Path) {
 				next.ServeHTTP(w, r)
 				return
@@ -49,13 +50,23 @@ func GetAuthMiddleware(secret string) func(http.Handler) http.Handler {
 	}
 }
 
-// ContextMiddleware adds helpful information to the request context.
-func ContextMiddleware(next http.Handler) http.Handler {
+// CommonContext adds shared values to the request context.
+func CommonContext(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		// set the path in the request context
-		ctx := context.WithValue(r.Context(), models.PathKey, r.URL.Path)
-		r = r.WithContext(ctx)
+		// get the request context
+		ctx := r.Context()
+
+		// set the request id in the request context
+		requestId := r.Header.Get("X-Request-Id")
+		if requestId == "" {
+			requestId = uuid.New().String()
+		}
+		ctx = context.WithValue(ctx, models.RequestIdKey, requestId)
 
+		// set the request path in the request context
+		ctx = context.WithValue(ctx, models.RequestPathKey, r.URL.Path)
+
+		r = r.WithContext(ctx)
 		next.ServeHTTP(w, r)
 	})
 }

package/go/models/constants.go

@@ -6,6 +6,15 @@ type ContextKey string
 const (
 	// TokenKey is the key used to set/get the JWT token in the request context.
 	TokenKey = ContextKey("token")
-	// PathKey is the key used to set/get the request path in the request context.
-	PathKey = ContextKey("path")
+	// RequestPathKey is the key used to set/get the request path in the request context.
+	RequestPathKey = ContextKey("requestPath")
+	// RequestIdKey is the key used to set/get the request id in the request context.
+	RequestIdKey = ContextKey("requestId")
+)
+
+type TokenType string
+
+const (
+	UserToken    TokenType = "user"
+	ServiceToken TokenType = "service"
 )

package/go/utils/context.go

@@ -18,31 +18,41 @@ func GetTokenFromContext(ctx context.Context) *jwt.Token {
 	return token
 }
 
-// GetUserIdFromContext retrieves the user id from the JTW token in the given context.
-func GetUserIdFromContext(ctx context.Context) (string, error) {
+// GetActorIdFromContext retrieves the actor id from the JTW token in the given context.
+// The actor id is the subject of the JWT token, and it represents the user id or service name that initiated the request.
+func GetActorIdFromContext(ctx context.Context) (string, error) {
 	// get the token from the context
 	token := GetTokenFromContext(ctx)
 	if token == nil {
 		return "", errors.New("token not found in the context")
 	}
 
-	// get the subject (userId) from the token
-	userId, err := token.Claims.GetSubject()
+	// get the subject from the token
+	subject, err := token.Claims.GetSubject()
 	if err != nil {
 		return "", fmt.Errorf("failed to get the subject from the token: %w", err)
 	}
-	if userId == "" {
-		return "", errors.New("user id not found in the token subject")
+	if subject == "" {
+		return "", errors.New("subject is empty in the token")
 	}
 
-	return userId, nil
+	return subject, nil
 }
 
-// GetPathFromContext retrieves the request path from the given context.
-func GetPathFromContext(ctx context.Context) (string, error) {
-	path, ok := ctx.Value(models.PathKey).(string)
+// GetRequestPathFromContext retrieves the request path from the given context.
+func GetRequestPathFromContext(ctx context.Context) (string, error) {
+	requestPath, ok := ctx.Value(models.RequestPathKey).(string)
 	if !ok {
-		return "", errors.New("path not found in the context")
+		return "", errors.New("request path not found in the context")
 	}
-	return path, nil
+	return requestPath, nil
+}
+
+// GetRequestIdFromContext retrieves the request id from the given context.
+func GetRequestIdFromContext(ctx context.Context) (string, error) {
+	requestId, ok := ctx.Value(models.RequestIdKey).(string)
+	if !ok {
+		return "", errors.New("request id not found in the context")
+	}
+	return requestId, nil
 }

package/go.mod

@@ -2,4 +2,7 @@ module github.com/RivasCVA/dt-idl
 
 go 1.23
 
-require github.com/golang-jwt/jwt/v5 v5.2.2
+require (
+	github.com/golang-jwt/jwt/v5 v5.2.2
+	github.com/google/uuid v1.6.0
+)

package/go.sum

@@ -1,2 +1,4 @@
 github.com/golang-jwt/jwt/v5 v5.2.2 h1:Rl4B7itRWVtYIHFrSNd7vhTiz9UpLdi6gZhZ3wEeDy8=
 github.com/golang-jwt/jwt/v5 v5.2.2/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivascva/dt-idl",
-  "version": "1.1.80",
+  "version": "1.1.82",
   "description": "Dream Trade - Interface Definition Language",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",