Deprecate dotted fields in data documents (#1313)

Closes #659.
FerretDB · Oct 28, 2022 · 05be2d5 · 05be2d5 · vercel · Oct 28, 2022
1 parent f996a91
commit 05be2d5
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/internal/types/document_validation.go b/internal/types/document_validation.go
@@ -55,7 +55,12 @@ func (d *Document) ValidateData() error {
 
 		// Tests for this case are in `dance`.
 		if strings.Contains(key, "$") {
-			return newValidationError(fmt.Errorf("invalid key: %q (key must not contain $)", key))
+			return newValidationError(fmt.Errorf("invalid key: %q (key must not contain '$' sign)", key))
+		}
+
+		// Tests for this case are in `dance`.
+		if strings.Contains(key, ".") {
+			return newValidationError(fmt.Errorf("invalid key: %q (key must not contain '.' sign)", key))
 		}
 
 		if _, ok := duplicateChecker[key]; ok {

diff --git a/internal/types/document_validation_test.go b/internal/types/document_validation_test.go
@@ -43,9 +43,13 @@ func TestDocumentValidateData(t *testing.T) {
 			doc:    must.NotFail(NewDocument("\xf4\x90\x80\x80", "bar")), //  the key is out of range for UTF-8
 			reason: errors.New(`invalid key: "\xf4\x90\x80\x80" (not a valid UTF-8 string)`),
 		},
-		"KeyContains$": {
+		"KeyContainsDollarSign": {
 			doc:    must.NotFail(NewDocument("$v", "bar")),
-			reason: errors.New(`invalid key: "$v" (key must not contain $)`),
+			reason: errors.New(`invalid key: "$v" (key must not contain '$' sign)`),
+		},
+		"KeyContainsDotSign": {
+			doc:    must.NotFail(NewDocument("v.foo", "bar")),
+			reason: errors.New(`invalid key: "v.foo" (key must not contain '.' sign)`),
 		},
 		"Inf+": {
 			doc:    must.NotFail(NewDocument("v", math.Inf(1))),

diff --git a/website/docs/diff.md b/website/docs/diff.md
@@ -8,7 +8,7 @@ sidebar_position: 6
 
 1. FerretDB uses the same protocol error names and codes, but the exact error messages may be different in some cases.
 2. FerretDB does not support NUL (`\0`) characters in strings.
-3. Document keys must not contain `$` sign.
+3. Document keys must not contain `$` or `.` signs.
 4. Database and collection names restrictions:
    * name cannot start with the reserved prefix `_ferretdb_`;
    * database name must not include non-latin letters, spaces, dots, dollars or dashes;