feat(server): add migration to add new fields to project collection [VIZ-2269] (#1830)

Author: wilfredmulenga

server/internal/infrastructure/mongo/migration/250925135245_add_project_metadata_fields.go

@@ -0,0 +1,75 @@
+package migration
+
+import (
+	"context"
+	"log"
+	"time"
+
+	"github.com/reearth/reearthx/mongox"
+	"go.mongodb.org/mongo-driver/bson"
+	"go.mongodb.org/mongo-driver/bson/primitive"
+)
+
+func AddProjectMetadataFields(ctx context.Context, c DBClient) error {
+	projectCol := c.WithCollection("project")
+
+	return projectCol.Find(ctx, bson.M{}, &mongox.BatchConsumer{
+		Size: 1000,
+		Callback: func(rows []bson.Raw) error {
+			log.Printf("Processing batch of %d projects\n", len(rows))
+
+			ids := make([]string, 0, len(rows))
+			newRows := make([]interface{}, 0, len(rows))
+
+			for _, row := range rows {
+				var project map[string]interface{}
+				if err := bson.Unmarshal(row, &project); err != nil {
+					log.Printf("Error unmarshaling project: %v\n", err)
+					continue
+				}
+
+				id, ok := project["id"].(string)
+				if !ok {
+					log.Printf("Skipping project with missing or invalid id\n")
+					continue
+				}
+
+				// Check if the new fields already exist
+				if _, exists := project["created_at"]; exists {
+					log.Printf("Project %s already has metadata fields, skipping\n", id)
+					continue
+				}
+
+				// Use existing updatedat as created_at if available, otherwise use current time
+				now := time.Now()
+				createdAt := now
+				if updatedat, exists := project["updatedat"]; exists {
+					// Handle both time.Time and primitive.DateTime types
+					switch v := updatedat.(type) {
+					case time.Time:
+						createdAt = v
+					case primitive.DateTime:
+						createdAt = v.Time()
+					default:
+						log.Printf("Warning: updatedat field has unexpected type %T for project %s, using current time\n", v, id)
+					}
+				}
+
+				// Add the new fields
+				project["created_at"] = createdAt
+				project["topics"] = []string{}
+				project["star_count"] = 0
+				project["starred_by"] = []string{}
+
+				ids = append(ids, id)
+				newRows = append(newRows, project)
+				log.Printf("Updated project %s with new metadata fields\n", id)
+			}
+
+			if len(newRows) > 0 {
+				return projectCol.SaveAll(ctx, ids, newRows)
+			}
+			return nil
+		},
+	})
+}

server/internal/infrastructure/mongo/migration/250925135245_add_project_metadata_fields_test.go

@@ -0,0 +1,129 @@
+package migration
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/reearth/reearthx/mongox"
+	"github.com/reearth/reearthx/mongox/mongotest"
+	"github.com/stretchr/testify/assert"
+	"go.mongodb.org/mongo-driver/bson"
+	"go.mongodb.org/mongo-driver/bson/primitive"
+)
+
+func TestAddProjectMetadataFields(t *testing.T) {
+	ctx := context.Background()
+	db := mongotest.Connect(t)(t)
+	client := mongox.NewClientWithDatabase(db)
+
+	// Setup: Insert test projects
+	projectColl := client.WithCollection("project").Client()
+	now := time.Now()
+	var err error
+
+	testProjects := []bson.M{
+		{
+			"id":        "project1",
+			"workspace": "workspace1",
+			"name":      "Test Project 1",
+			"updatedat": primitive.NewDateTimeFromTime(now.Add(-24 * time.Hour)),
+		},
+		{
+			"id":        "project2",
+			"workspace": "workspace2",
+			"name":      "Test Project 2",
+			"updatedat": primitive.NewDateTimeFromTime(now.Add(-48 * time.Hour)),
+		},
+	}
+
+	_, err = projectColl.InsertMany(ctx, []interface{}{testProjects[0], testProjects[1]})
+	assert.NoError(t, err)
+
+	// Run migration
+	err = AddProjectMetadataFields(ctx, client)
+	assert.NoError(t, err)
+
+	// Verify results
+	cursor, err := projectColl.Find(ctx, bson.M{})
+	assert.NoError(t, err)
+	defer cursor.Close(ctx)
+
+	projects := []bson.M{}
+	err = cursor.All(ctx, &projects)
+	assert.NoError(t, err)
+	assert.Len(t, projects, 2)
+
+	for _, project := range projects {
+		// Check that new fields were added
+		assert.Contains(t, project, "created_at")
+		assert.Contains(t, project, "topics")
+		assert.Contains(t, project, "star_count")
+		assert.Contains(t, project, "starred_by")
+
+		// Check that updatedat field is still present (unchanged)
+		assert.Contains(t, project, "updatedat")
+
+		// Verify field types and values
+		assert.IsType(t, primitive.DateTime(0), project["created_at"])
+		assert.IsType(t, primitive.DateTime(0), project["updatedat"])
+		assert.IsType(t, primitive.A{}, project["topics"])
+		assert.IsType(t, int32(0), project["star_count"])
+		assert.IsType(t, primitive.A{}, project["starred_by"])
+
+		// Verify topics is empty array
+		topics := project["topics"].(primitive.A)
+		assert.Len(t, topics, 0)
+
+		// Verify star_count is 0
+		assert.Equal(t, int32(0), project["star_count"])
+
+		// Verify starred_by is empty array
+		starredBy := project["starred_by"].(primitive.A)
+		assert.Len(t, starredBy, 0)
+	}
+}
+
+func TestAddProjectMetadataFields_AlreadyMigrated(t *testing.T) {
+	ctx := context.Background()
+	db := mongotest.Connect(t)(t)
+	client := mongox.NewClientWithDatabase(db)
+
+	// Setup: Insert project that's already been migrated
+	projectColl := client.WithCollection("project").Client()
+
+	testProject := bson.M{
+		"id":         "project1",
+		"workspace":  "workspace1",
+		"name":       "Test Project 1",
+		"created_at": primitive.NewDateTimeFromTime(time.Date(2023, 1, 1, 0, 0, 0, 0, time.UTC)),
+		"topics":     []string{"existing", "topics"},
+		"star_count": 5,
+		"starred_by": []string{"user1", "user2"},
+	}
+
+	_, err := projectColl.InsertOne(ctx, testProject)
+	assert.NoError(t, err)
+
+	// Run migration
+	err = AddProjectMetadataFields(ctx, client)
+	assert.NoError(t, err)
+
+	// Verify the existing values weren't changed
+	var result bson.M
+	err = projectColl.FindOne(ctx, bson.M{"id": "project1"}).Decode(&result)
+	assert.NoError(t, err)
+
+	assert.Equal(t, primitive.NewDateTimeFromTime(time.Date(2023, 1, 1, 0, 0, 0, 0, time.UTC)), result["created_at"])
+	assert.Equal(t, int32(5), result["star_count"])
+
+	topics := result["topics"].(primitive.A)
+	assert.Len(t, topics, 2)
+	assert.Equal(t, "existing", topics[0])
+	assert.Equal(t, "topics", topics[1])
+
+	starredBy := result["starred_by"].(primitive.A)
+	assert.Len(t, starredBy, 2)
+	assert.Equal(t, "user1", starredBy[0])
+	assert.Equal(t, "user2", starredBy[1])
+}