feat: Allow mutation of col sources via PatchCollection

db/collection.go

@@ -572,6 +572,47 @@
 		if err != nil {
 			return err
 		}
+
+		existingCol, ok := existingColsByID[col.ID]
+		if ok {
+			// Clear any existing migrations in the registry, using this semi-hacky way
+			// to avoid adding more functions to a public interface that we wish to remove.
+
+			for _, src := range existingCol.CollectionSources() {
+				if src.Transform.HasValue() {
+					err = db.LensRegistry().SetMigration(ctx, existingCol.ID, model.Lens{})
+					if err != nil {
+						return err
+					}
+				}
+			}
+			for _, src := range existingCol.QuerySources() {
+				if src.Transform.HasValue() {
+					err = db.LensRegistry().SetMigration(ctx, existingCol.ID, model.Lens{})
+					if err != nil {
+						return err
+					}
+				}
+			}
+		}
+
+		for _, src := range col.CollectionSources() {
+			if src.Transform.HasValue() {
+				err = db.LensRegistry().SetMigration(ctx, col.ID, src.Transform.Value())
+				if err != nil {
+					return err
+				}
+			}
+		}
+
+		for _, src := range col.QuerySources() {
+			if src.Transform.HasValue() {
+				err = db.LensRegistry().SetMigration(ctx, col.ID, src.Transform.Value())
+				if err != nil {
+					return err
+				}
+			}
+		}
 	}
 
 	return db.loadSchema(ctx, txn)
@@ -583,7 +624,7 @@
 ) error{
 	validateCollectionNameUnique,
 	validateSingleVersionActive,
-	validateSourcesNotModified,
+	validateSourcesNotRedefined,
 	validateIndexesNotModified,
 	validateFieldsNotModified,
 	validateIDNotZero,
@@ -646,7 +687,12 @@
 	return nil
 }
 
-func validateSourcesNotModified(
+// validateSourcesNotRedefined specifies the limitations on how the collection sources
+// can be mutated.
+//
+// Currently new sources cannot be added, existing cannot be removed, and CollectionSources
+// cannot be redirected to other collections.
+func validateSourcesNotRedefined(
 	oldColsByID map[uint32]client.CollectionDescription,
 	newColsByID map[uint32]client.CollectionDescription,
 ) error {
@@ -656,10 +702,28 @@
 			continue
 		}
 
-		// DeepEqual is temporary, as this validation is temporary, for example soon
-		// users will be able to be able to change the migration
-		if !reflect.DeepEqual(oldCol.Sources, newCol.Sources) {
-			return NewErrCollectionSourcesCannotBeMutated(newCol.ID)
+		newColSources := newCol.CollectionSources()
+		oldColSources := oldCol.CollectionSources()
+
+		if len(newColSources) != len(oldColSources) {
+			return NewErrCollectionSourcesCannotBeAddedRemoved(newCol.ID)
+		}
+
+		for i := range newColSources {
+			if newColSources[i].SourceCollectionID != oldColSources[i].SourceCollectionID {
+				return NewErrCollectionSourceIDMutated(
+					newCol.ID,
+					newColSources[i].SourceCollectionID,
+					oldColSources[i].SourceCollectionID,
+				)
+			}
+		}
+
+		newQuerySources := newCol.QuerySources()
+		oldQuerySources := oldCol.QuerySources()
+
+		if len(newQuerySources) != len(oldQuerySources) {
+			return NewErrCollectionSourcesCannotBeAddedRemoved(newCol.ID)
 		}
 	}
 

db/errors.go

@@ -85,7 +85,8 @@ const (
 	errInvalidViewQuery                         string = "the query provided is not valid as a View"
 	errCollectionAlreadyExists                  string = "collection already exists"
 	errMultipleActiveCollectionVersions         string = "multiple versions of same collection cannot be active"
-	errCollectionSourcesCannotBeMutated         string = "collection sources cannot be mutated"
+	errCollectionSourcesCannotBeAddedRemoved    string = "collection sources cannot be added or removed"
+	errCollectionSourceIDMutated                string = "collection source ID cannot be mutated"
 	errCollectionIndexesCannotBeMutated         string = "collection indexes cannot be mutated"
 	errCollectionFieldsCannotBeMutated          string = "collection fields cannot be mutated"
 	errCollectionRootIDCannotBeMutated          string = "collection root ID cannot be mutated"
@@ -113,7 +114,8 @@ var (
 	ErrInvalidViewQuery                         = errors.New(errInvalidViewQuery)
 	ErrCanNotIndexNonUniqueFields               = errors.New(errCanNotIndexNonUniqueFields)
 	ErrMultipleActiveCollectionVersions         = errors.New(errMultipleActiveCollectionVersions)
-	ErrCollectionSourcesCannotBeMutated         = errors.New(errCollectionSourcesCannotBeMutated)
+	ErrCollectionSourcesCannotBeAddedRemoved    = errors.New(errCollectionSourcesCannotBeAddedRemoved)
+	ErrCollectionSourceIDMutated                = errors.New(errCollectionSourceIDMutated)
 	ErrCollectionIndexesCannotBeMutated         = errors.New(errCollectionIndexesCannotBeMutated)
 	ErrCollectionFieldsCannotBeMutated          = errors.New(errCollectionFieldsCannotBeMutated)
 	ErrCollectionRootIDCannotBeMutated          = errors.New(errCollectionRootIDCannotBeMutated)
@@ -573,13 +575,22 @@ func NewErrMultipleActiveCollectionVersions(name string, root uint32) error {
 	)
 }
 
-func NewErrCollectionSourcesCannotBeMutated(colID uint32) error {
+func NewErrCollectionSourcesCannotBeAddedRemoved(colID uint32) error {
 	return errors.New(
-		errCollectionSourcesCannotBeMutated,
+		errCollectionSourcesCannotBeAddedRemoved,
 		errors.NewKV("CollectionID", colID),
 	)
 }
 
+func NewErrCollectionSourceIDMutated(colID uint32, newSrcID uint32, oldSrcID uint32) error {
+	return errors.New(
+		errCollectionSourceIDMutated,
+		errors.NewKV("CollectionID", colID),
+		errors.NewKV("NewCollectionSourceID", newSrcID),
+		errors.NewKV("OldCollectionSourceID", oldSrcID),
+	)
+}
+
 func NewErrCollectionIndexesCannotBeMutated(colID uint32) error {
 	return errors.New(
 		errCollectionIndexesCannotBeMutated,

tests/integration/collection_description/updates/add/sources_test.go

@@ -30,7 +30,7 @@ func TestColDescrUpdateAddSources_Errors(t *testing.T) {
 						{ "op": "add", "path": "/1/Sources/-", "value": {"SourceCollectionID": 1} }
 					]
 				`,
-				ExpectedError: "collection sources cannot be mutated. CollectionID: 1",
+				ExpectedError: "collection sources cannot be added or removed. CollectionID: 1",
 			},
 		},
 	}

tests/integration/collection_description/updates/remove/col_source_transform_test.go

@@ -0,0 +1,80 @@
+// Copyright 2024 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package remove
+
+import (
+	"testing"
+
+	"github.com/lens-vm/lens/host-go/config/model"
+	"github.com/sourcenetwork/immutable"
+
+	testUtils "github.com/sourcenetwork/defradb/tests/integration"
+	"github.com/sourcenetwork/defradb/tests/lenses"
+)
+
+func TestColDescrUpdateRemoveCollectionSourceTransform(t *testing.T) {
+	test := testUtils.TestCase{
+		Actions: []any{
+			testUtils.SchemaUpdate{
+				Schema: `
+					type Users {
+						name: String
+					}
+				`,
+			},
+			testUtils.CreateDoc{
+				Doc: `{
+					"name": "Shahzad"
+				}`,
+			},
+			testUtils.SchemaPatch{
+				Patch: `
+					[
+						{ "op": "add", "path": "/Users/Fields/-", "value": {"Name": "email", "Kind": 11} }
+					]
+				`,
+				Lens: immutable.Some(model.Lens{
+					Lenses: []model.LensModule{
+						{
+							Path: lenses.SetDefaultModulePath,
+							Arguments: map[string]any{
+								"dst":   "name",
+								"value": "Fred",
+							},
+						},
+					},
+				}),
+			},
+			testUtils.PatchCollection{
+				Patch: `
+					[
+						{ "op": "remove", "path": "/2/Sources/0/Transform" }
+					]
+				`,
+			},
+			testUtils.Request{
+				Request: `query {
+					Users {
+						name
+					}
+				}`,
+				// If the transform was not removed, `"Fred"` would have been returned
+				Results: []map[string]any{
+					{
+						"name": "Shahzad",
+					},
+				},
+			},
+		},
+	}
+
+	testUtils.ExecuteTestCase(t, test)
+}

tests/integration/collection_description/updates/replace/col_source_source_id_test.go

@@ -0,0 +1,53 @@
+// Copyright 2024 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package replace
+
+import (
+	"testing"
+
+	testUtils "github.com/sourcenetwork/defradb/tests/integration"
+)
+
+func TestColDescrUpdateReplaceCollectionSourceSourceCollectionID_Errors(t *testing.T) {
+	test := testUtils.TestCase{
+		Actions: []any{
+			testUtils.SchemaUpdate{
+				Schema: `
+					type Users {
+						name: String
+					}
+				`,
+			},
+			testUtils.CreateDoc{
+				Doc: `{
+					"name": "Shahzad"
+				}`,
+			},
+			testUtils.SchemaPatch{
+				Patch: `
+					[
+						{ "op": "add", "path": "/Users/Fields/-", "value": {"Name": "email", "Kind": 11} }
+					]
+				`,
+			},
+			testUtils.PatchCollection{
+				Patch: `
+					[
+						{ "op": "replace", "path": "/2/Sources/0/SourceCollectionID", "value": 3 }
+					]
+				`,
+				ExpectedError: "collection source ID cannot be mutated. CollectionID: 2, NewCollectionSourceID: 3, OldCollectionSourceID: 1",
+			},
+		},
+	}
+
+	testUtils.ExecuteTestCase(t, test)
+}

tests/integration/collection_description/updates/replace/col_source_transform_test.go

@@ -0,0 +1,88 @@
+// Copyright 2024 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package replace
+
+import (
+	"encoding/json"
+	"fmt"
+	"testing"
+
+	"github.com/lens-vm/lens/host-go/config/model"
+	"github.com/stretchr/testify/require"
+
+	testUtils "github.com/sourcenetwork/defradb/tests/integration"
+	"github.com/sourcenetwork/defradb/tests/lenses"
+)
+
+func TestColDescrUpdateReplaceCollectionSourceTransform(t *testing.T) {
+	transformCfgJson, err := json.Marshal(
+		model.Lens{
+			Lenses: []model.LensModule{
+				{
+					Path: lenses.SetDefaultModulePath,
+					Arguments: map[string]any{
+						"dst":   "name",
+						"value": "Fred",
+					},
+				},
+			},
+		},
+	)
+	require.NoError(t, err)
+
+	test := testUtils.TestCase{
+		Actions: []any{
+			testUtils.SchemaUpdate{
+				Schema: `
+					type Users {
+						name: String
+					}
+				`,
+			},
+			testUtils.CreateDoc{
+				Doc: `{
+					"name": "Shahzad"
+				}`,
+			},
+			testUtils.SchemaPatch{
+				Patch: `
+					[
+						{ "op": "add", "path": "/Users/Fields/-", "value": {"Name": "email", "Kind": 11} }
+					]
+				`,
+			},
+			testUtils.PatchCollection{
+				Patch: fmt.Sprintf(`
+						[
+							{ "op": "replace", "path": "/2/Sources/0/Transform", "value": %s }
+						]
+					`,
+					transformCfgJson,
+				),
+			},
+			testUtils.Request{
+				Request: `query {
+					Users {
+						name
+					}
+				}`,
+				// Without the new transform, `"Shahzad"` would have been returned
+				Results: []map[string]any{
+					{
+						"name": "Fred",
+					},
+				},
+			},
+		},
+	}
+
+	testUtils.ExecuteTestCase(t, test)
+}

tests/integration/collection_description/updates/replace/id_test.go

@@ -87,7 +87,7 @@ func TestColDescrUpdateReplaceID_WithExistingSameRoot_Errors(t *testing.T) {
 						{ "op": "replace", "path": "/2/ID", "value": 1 }
 					]
 				`,
-				ExpectedError: "collection sources cannot be mutated.",
+				ExpectedError: "collection sources cannot be added or removed.",
 			},
 		},
 	}