feat: Implement user context management and worker pool creation in context

Author: mt1976

contextHandler/contextHandler_getset.go

@@ -16,10 +16,10 @@ import (
 // tokenKey        = new(cfg.GetSecuritySessionKey_Token())
 // expiryPeriodKey = new(cfg.GetSecuritySessionKey_ExpiryPeriod())
 
-func AddWorkerPoolToContext(ctx context.Context, pool pond.Pool) context.Context {
-	logHandler.Trace.Printf("Setting Worker Pool in Context: %v=%v", WorkerPoolKey.name, pool)
-	return context.WithValue(ctx, WorkerPoolKey, pool)
-}
+// func AddWorkerPoolToContext(ctx context.Context, pool pond.Pool) context.Context {
+// 	logHandler.Trace.Printf("Setting Worker Pool in Context: %v=%v", WorkerPoolKey.name, pool)
+// 	return context.WithValue(ctx, WorkerPoolKey, pool)
+// }
 
 func GetWorkerPool(ctx context.Context) (pond.Pool, error) {
 	logHandler.Trace.Printf("Retrieving Worker Pool from Context: %v", godump.DumpStr(ctx))

contextHandler/contextHandler_helpers.go

@@ -2,8 +2,13 @@ package contextHandler
 
 import (
 	"context"
+	"fmt"
+	"os/user"
+	"runtime"
 	"strings"
 
+	"github.com/alitto/pond/v2"
+	"github.com/goforj/godump"
 	"github.com/mt1976/frantic-core/logHandler"
 )
 
@@ -29,3 +34,82 @@ func Debug(c context.Context, name string) {
 	logHandler.Trace.Printf("[%v] DEBUG ENDS", name)
 	logHandler.Trace.Printf("[%v] DEBUG ENDS", name)
 }
+
+func AddUserContext(ctx context.Context, userID, userName string) context.Context {
+	existingUserID := GetSession_UserKey(ctx)
+	existingUserName := GetSession_UserCode(ctx)
+
+	logHandler.Trace.Printf("Existing User Context: %v=%v - %v=%v", "userID", existingUserID, "userName", existingUserName)
+	if existingUserID != "" && existingUserName != "" {
+		logHandler.Event.Printf("User Context already exists: %v=%v - %v=%v", "userID", existingUserID, "userName", existingUserName)
+		return ctx
+	}
+
+	if userID == "" || userName == "" {
+		currentUser := GetUserDetails()
+		userID = currentUser.Uid
+		userName = currentUser.Username
+	}
+
+	userCode := userID + "_" + userName
+	userKey := userID
+
+	ctx = SetSession_UserKey(ctx, userKey)
+	ctx = SetSession_UserCode(ctx, userCode)
+
+	logHandler.Trace.Printf("User Context Added: %v(%v)=%v(%v)", userCode, GetSession_UserCode(ctx), userKey, GetSession_UserKey(ctx))
+
+	return ctx
+}
+
+func GetUserDetails() *user.User {
+	currentUser, err := user.Current()
+	if err != nil {
+		logHandler.Error.Fatalln(err.Error())
+	}
+	// if running on windows, the UID is in the format of "S-1-5-21-3849575818-2607088806-4266749144", we need to convert it to a more readable format
+	if runningOnWindows() {
+		// Example UID on windows "S-1-5-21-3849575818-2607088806-4266749144"
+		// Tokenize the UID
+		tkID := strings.Split(currentUser.Uid, "-")
+		// Concatenate the token in 0, 1, 2, 3
+		currentUser.Uid = fmt.Sprintf("%s%s%s%s", tkID[0], tkID[1], tkID[2], tkID[3])
+	}
+	return currentUser
+}
+
+func runningOnWindows() bool {
+	return strings.Contains(strings.ToLower(runtime.GOOS), "windows")
+}
+
+func NewWorkerPool(ctx context.Context, poolName string, poolSize int) context.Context {
+	// Define a reasonable number of workers for the worker pool. This can be adjusted based on the expected load and performance requirements. For a typical application, starting with 10 workers is a good balance between concurrency and resource usage.
+	noWorkers := poolSize
+
+	logHandler.Event.Println("Creating Worker Pool...")
+	ctx = addWorkerPoolName(ctx, poolName)
+	workerPool := pond.NewPool(noWorkers, pond.WithContext(ctx), pond.WithQueueSize(noWorkers*3))
+	// Now add the pool to the context so it can be used by the jobs
+	ctx = context.WithValue(ctx, WorkerPoolKey, workerPool)
+	defer workerPool.StopAndWait()
+	logHandler.Event.Printf("Worker Pool Created with %d workers", noWorkers)
+
+	return ctx
+}
+
+var workerPoolNameKey = new("WorkerPoolName")
+
+func addWorkerPoolName(ctx context.Context, poolName string) context.Context {
+	logHandler.Trace.Printf("Setting Worker Pool Name in Context: %v=%v", workerPoolNameKey.name, poolName)
+	return context.WithValue(ctx, workerPoolNameKey, poolName)
+}
+
+func GetWorkerPoolName(ctx context.Context) string {
+	logHandler.Trace.Printf("Retrieving Worker Pool Name from Context: %v", godump.DumpStr(ctx))
+	value := ctx.Value(workerPoolNameKey)
+	if value == nil {
+		logHandler.Warning.Printf("Worker pool name (%v) requested but not found in context, returning empty string", workerPoolNameKey.name)
+		return ""
+	}
+	return value.(string)
+}