From 3fadaac69a813d8984a31fbb9d3a184a4a7253d2 Mon Sep 17 00:00:00 2001
From: SoXX <soxx@anthrove.art>
Date: Tue, 13 Aug 2024 14:01:48 +0200
Subject: [PATCH] fix: added documentation & fixed logging

---
 pkg/database/userSource.go | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

diff --git a/pkg/database/userSource.go b/pkg/database/userSource.go
index dc18af0..229c6ca 100644
--- a/pkg/database/userSource.go
+++ b/pkg/database/userSource.go
@@ -16,14 +16,6 @@ func CreateUserSource(ctx context.Context, userSource models.UserSource) (models
 	ctx, span, localLogger := utils.SetupTracing(ctx, tracer, "CreateUserSource")
 	defer span.End()
 
-	localLogger = localLogger.WithFields(log.Fields{
-		"user_source_id": userSource.ID,
-	})
-
-	span.SetAttributes(
-		attribute.String("user_source_id", string(userSource.SourceID)),
-	)
-
 	utils.HandleEvent(span, localLogger, "Starting user source creation")
 
 	if client == nil {
@@ -38,10 +30,25 @@ func CreateUserSource(ctx context.Context, userSource models.UserSource) (models
 		return models.UserSource{}, utils.HandleError(ctx, span, localLogger, result.Error)
 	}
 
+	localLogger = localLogger.WithFields(log.Fields{
+		"user_source_id": userSource.ID,
+	})
+
+	span.SetAttributes(
+		attribute.String("user_source_id", string(userSource.SourceID)),
+	)
+
 	utils.HandleEvent(span, localLogger, "User source created successfully")
 	return userSource, nil
 }
 
+// UpdateUserSource updates the user source information in the database.
+// Only a few parameter can be updated:
+//   - AccountID
+//   - ScrapeTimeInterval
+//   - AccountUsername
+//   - LastScrapeTime
+//   - AccountValidate
 func UpdateUserSource(ctx context.Context, userSource models.UserSource) error {
 	ctx, span, localLogger := utils.SetupTracing(ctx, tracer, "UpdateUserSource")
 	defer span.End()