don't use "unsigned" property flag with relation IDs

Ivan Dlugos · Ivan Dlugos · commit 6ec9a9f7942d · 2021-03-29T16:20:11.000+02:00
diff --git a/internal/generator/model/property.go b/internal/generator/model/property.go
@@ -80,11 +80,13 @@ func (property *Property) Validate() error {
 }
 
 func (property *Property) finalize() error {
-	if property.IsIdProperty() {
-		// IDs must not be tagged unsigned for compatibility reasons
+	if property.Type == PropertyTypeRelation || property.IsIdProperty() {
+		// IDs must not be tagged unsigned for model compatibility (across language bindings)
 		property.Flags = property.Flags & ^PropertyFlagUnsigned
+	}
 
-		// always stored as Long
+	if property.IsIdProperty() {
+		// always stored IDs as Long, regardless of their type in the code/declaration
 		property.Type = PropertyTypeLong
 	}
 
diff --git a/test/comparison/testdata/fbs/typeful/c/objectbox-model.h.expected b/test/comparison/testdata/fbs/typeful/c/objectbox-model.h.expected
@@ -55,7 +55,7 @@ static inline OBX_model* create_obx_model() {
     obx_model_property(model, "float", OBXPropertyType_Float, 21, 1929546706668609706);
     obx_model_property(model, "double", OBXPropertyType_Double, 22, 6392442863481646880);
     obx_model_property(model, "relId", OBXPropertyType_Relation, 23, 3706853784096366226);
-    obx_model_property_flags(model, (OBXPropertyFlags) (OBXPropertyFlags_INDEXED | OBXPropertyFlags_INDEX_PARTIAL_SKIP_ZERO | OBXPropertyFlags_UNSIGNED));
+    obx_model_property_flags(model, (OBXPropertyFlags) (OBXPropertyFlags_INDEXED | OBXPropertyFlags_INDEX_PARTIAL_SKIP_ZERO));
     obx_model_property_relation(model, "AnnotatedEntity", 1, 2627038740284806767);
     obx_model_entity_last_property_id(model, 23, 3706853784096366226);
     
@@ -68,7 +68,7 @@ static inline OBX_model* create_obx_model() {
     obx_model_property_index_id(model, 2, 959367522974354090);
     obx_model_property(model, "time", OBXPropertyType_Date, 3, 2914295034816259174);
     obx_model_property(model, "relId", OBXPropertyType_Relation, 4, 1395437218309923052);
-    obx_model_property_flags(model, (OBXPropertyFlags) (OBXPropertyFlags_INDEXED | OBXPropertyFlags_INDEX_PARTIAL_SKIP_ZERO | OBXPropertyFlags_UNSIGNED));
+    obx_model_property_flags(model, (OBXPropertyFlags) (OBXPropertyFlags_INDEXED | OBXPropertyFlags_INDEX_PARTIAL_SKIP_ZERO));
     obx_model_property_relation(model, "Typeful", 3, 6745438398739480977);
     obx_model_property(model, "unique", OBXPropertyType_String, 5, 2897681629866238117);
     obx_model_property_flags(model, (OBXPropertyFlags) (OBXPropertyFlags_INDEX_HASH | OBXPropertyFlags_UNIQUE));
diff --git a/test/comparison/testdata/fbs/typeful/cpp/objectbox-model.h.expected b/test/comparison/testdata/fbs/typeful/cpp/objectbox-model.h.expected
@@ -55,7 +55,7 @@ static inline OBX_model* create_obx_model() {
     obx_model_property(model, "float", OBXPropertyType_Float, 21, 1929546706668609706);
     obx_model_property(model, "double", OBXPropertyType_Double, 22, 6392442863481646880);
     obx_model_property(model, "relId", OBXPropertyType_Relation, 23, 3706853784096366226);
-    obx_model_property_flags(model, (OBXPropertyFlags) (OBXPropertyFlags_INDEXED | OBXPropertyFlags_INDEX_PARTIAL_SKIP_ZERO | OBXPropertyFlags_UNSIGNED));
+    obx_model_property_flags(model, (OBXPropertyFlags) (OBXPropertyFlags_INDEXED | OBXPropertyFlags_INDEX_PARTIAL_SKIP_ZERO));
     obx_model_property_relation(model, "AnnotatedEntity", 1, 2627038740284806767);
     obx_model_entity_last_property_id(model, 23, 3706853784096366226);
     
@@ -68,7 +68,7 @@ static inline OBX_model* create_obx_model() {
     obx_model_property_index_id(model, 2, 959367522974354090);
     obx_model_property(model, "time", OBXPropertyType_Date, 3, 2914295034816259174);
     obx_model_property(model, "relId", OBXPropertyType_Relation, 4, 1395437218309923052);
-    obx_model_property_flags(model, (OBXPropertyFlags) (OBXPropertyFlags_INDEXED | OBXPropertyFlags_INDEX_PARTIAL_SKIP_ZERO | OBXPropertyFlags_UNSIGNED));
+    obx_model_property_flags(model, (OBXPropertyFlags) (OBXPropertyFlags_INDEXED | OBXPropertyFlags_INDEX_PARTIAL_SKIP_ZERO));
     obx_model_property_relation(model, "Typeful", 3, 6745438398739480977);
     obx_model_property(model, "unique", OBXPropertyType_String, 5, 2897681629866238117);
     obx_model_property_flags(model, (OBXPropertyFlags) (OBXPropertyFlags_INDEX_HASH | OBXPropertyFlags_UNIQUE));
diff --git a/test/comparison/testdata/fbs/typeful/objectbox-model.json.expected b/test/comparison/testdata/fbs/typeful/objectbox-model.json.expected
@@ -131,7 +131,7 @@
           "name": "relId",
           "indexId": "1:2627038740284806767",
           "type": 11,
-          "flags": 8712,
+          "flags": 520,
           "relationTarget": "AnnotatedEntity"
         }
       ]
@@ -165,7 +165,7 @@
           "name": "relId",
           "indexId": "3:6745438398739480977",
           "type": 11,
-          "flags": 8712,
+          "flags": 520,
           "relationTarget": "Typeful"
         },
         {
diff --git a/test/comparison/testdata/go/relations/byid.obx.go.expected b/test/comparison/testdata/go/relations/byid.obx.go.expected
@@ -53,7 +53,7 @@ func (taskRelId_EntityInfo) AddToModel(model *objectbox.Model) {
 	model.Property("Id", 6, 1, 6044372234677422456)
 	model.PropertyFlags(1)
 	model.Property("Group", 11, 2, 8274930044578894929)
-	model.PropertyFlags(8712)
+	model.PropertyFlags(520)
 	model.PropertyRelation("Group", 1, 1543572285742637646)
 	model.EntityLastPropertyId(2, 8274930044578894929)
 }
diff --git a/test/comparison/testdata/go/relations/bypointer.obx.go.expected b/test/comparison/testdata/go/relations/bypointer.obx.go.expected
@@ -53,7 +53,7 @@ func (taskRelPtr_EntityInfo) AddToModel(model *objectbox.Model) {
 	model.Property("Id", 6, 1, 8325060299420976708)
 	model.PropertyFlags(1)
 	model.Property("Group", 11, 2, 7837839688282259259)
-	model.PropertyFlags(8712)
+	model.PropertyFlags(520)
 	model.PropertyRelation("Group", 2, 2518412263346885298)
 	model.EntityLastPropertyId(2, 7837839688282259259)
 }
diff --git a/test/comparison/testdata/go/relations/byvalue.obx.go.expected b/test/comparison/testdata/go/relations/byvalue.obx.go.expected
@@ -53,7 +53,7 @@ func (taskRelValue_EntityInfo) AddToModel(model *objectbox.Model) {
 	model.Property("Id", 6, 1, 2339563716805116249)
 	model.PropertyFlags(1)
 	model.Property("Group", 11, 2, 7144924247938981575)
-	model.PropertyFlags(8712)
+	model.PropertyFlags(520)
 	model.PropertyRelation("Group", 3, 161231572858529631)
 	model.EntityLastPropertyId(2, 7144924247938981575)
 }
diff --git a/test/comparison/testdata/go/relations/embedded.obx.go.expected b/test/comparison/testdata/go/relations/embedded.obx.go.expected
@@ -59,7 +59,7 @@ func (taskRelEmbedded_EntityInfo) AddToModel(model *objectbox.Model) {
 	model.Property("Id", 6, 1, 7373105480197164748)
 	model.PropertyFlags(1)
 	model.Property("Group", 11, 2, 3287288577352441706)
-	model.PropertyFlags(8712)
+	model.PropertyFlags(520)
 	model.PropertyRelation("Group", 4, 3930927879439176946)
 	model.EntityLastPropertyId(2, 3287288577352441706)
 	model.Relation(1, 4706154865122290029, GroupBinding.Id, GroupBinding.Uid)
diff --git a/test/comparison/testdata/go/relations/objectbox-model.json.expected b/test/comparison/testdata/go/relations/objectbox-model.json.expected
@@ -55,7 +55,7 @@
           "name": "Group",
           "indexId": "1:1543572285742637646",
           "type": 11,
-          "flags": 8712,
+          "flags": 520,
           "relationTarget": "Group"
         }
       ]
@@ -76,7 +76,7 @@
           "name": "Group",
           "indexId": "2:2518412263346885298",
           "type": 11,
-          "flags": 8712,
+          "flags": 520,
           "relationTarget": "Group"
         }
       ]
@@ -97,7 +97,7 @@
           "name": "Group",
           "indexId": "3:161231572858529631",
           "type": 11,
-          "flags": 8712,
+          "flags": 520,
           "relationTarget": "Group"
         }
       ]
@@ -118,7 +118,7 @@
           "name": "Group",
           "indexId": "4:3930927879439176946",
           "type": 11,
-          "flags": 8712,
+          "flags": 520,
           "relationTarget": "Group"
         }
       ],
diff --git a/test/comparison/testdata/go/rename-relation/byid.obx.go.expected b/test/comparison/testdata/go/rename-relation/byid.obx.go.expected
@@ -53,7 +53,7 @@ func (taskRelId_EntityInfo) AddToModel(model *objectbox.Model) {
 	model.Property("Id", 6, 1, 2259404117704393152)
 	model.PropertyFlags(1)
 	model.Property("GroupNew", 11, 2, 6050128673802995827)
-	model.PropertyFlags(8712)
+	model.PropertyFlags(520)
 	model.PropertyRelation("Group", 1, 501233450539197794)
 	model.EntityLastPropertyId(2, 6050128673802995827)
 }
diff --git a/test/comparison/testdata/go/rename-relation/bypointer.obx.go.expected b/test/comparison/testdata/go/rename-relation/bypointer.obx.go.expected
@@ -53,7 +53,7 @@ func (taskRelPtr_EntityInfo) AddToModel(model *objectbox.Model) {
 	model.Property("Id", 6, 1, 2669985732393126063)
 	model.PropertyFlags(1)
 	model.Property("GroupNew", 11, 2, 1774932891286980153)
-	model.PropertyFlags(8712)
+	model.PropertyFlags(520)
 	model.PropertyRelation("Group", 2, 6044372234677422456)
 	model.EntityLastPropertyId(2, 1774932891286980153)
 }
diff --git a/test/comparison/testdata/go/rename-relation/byvalue.obx.go.expected b/test/comparison/testdata/go/rename-relation/byvalue.obx.go.expected
@@ -53,7 +53,7 @@ func (taskRelValue_EntityInfo) AddToModel(model *objectbox.Model) {
 	model.Property("Id", 6, 1, 1543572285742637646)
 	model.PropertyFlags(1)
 	model.Property("GroupNew", 11, 2, 2661732831099943416)
-	model.PropertyFlags(8712)
+	model.PropertyFlags(520)
 	model.PropertyRelation("Group", 3, 8325060299420976708)
 	model.EntityLastPropertyId(2, 2661732831099943416)
 }
diff --git a/test/comparison/testdata/go/rename-relation/embedded.obx.go.expected b/test/comparison/testdata/go/rename-relation/embedded.obx.go.expected
@@ -59,7 +59,7 @@ func (taskRelEmbedded_EntityInfo) AddToModel(model *objectbox.Model) {
 	model.Property("Id", 6, 1, 2518412263346885298)
 	model.PropertyFlags(1)
 	model.Property("Group", 11, 2, 5617773211005988520)
-	model.PropertyFlags(8712)
+	model.PropertyFlags(520)
 	model.PropertyRelation("Group", 4, 2339563716805116249)
 	model.EntityLastPropertyId(2, 5617773211005988520)
 	model.Relation(3, 6392442863481646880, GroupBinding.Id, GroupBinding.Uid)
diff --git a/test/comparison/testdata/go/rename-relation/objectbox-model.json.expected b/test/comparison/testdata/go/rename-relation/objectbox-model.json.expected
@@ -19,7 +19,7 @@
           "name": "GroupNew",
           "indexId": "1:501233450539197794",
           "type": 11,
-          "flags": 8712,
+          "flags": 520,
           "relationTarget": "Group"
         }
       ]
@@ -40,7 +40,7 @@
           "name": "GroupNew",
           "indexId": "2:6044372234677422456",
           "type": 11,
-          "flags": 8712,
+          "flags": 520,
           "relationTarget": "Group"
         }
       ]
@@ -61,7 +61,7 @@
           "name": "GroupNew",
           "indexId": "3:8325060299420976708",
           "type": 11,
-          "flags": 8712,
+          "flags": 520,
           "relationTarget": "Group"
         }
       ]
@@ -82,7 +82,7 @@
           "name": "Group",
           "indexId": "4:2339563716805116249",
           "type": 11,
-          "flags": 8712,
+          "flags": 520,
           "relationTarget": "Group"
         }
       ],
diff --git a/test/comparison/testdata/go/sync/objectbox-model.json.expected b/test/comparison/testdata/go/sync/objectbox-model.json.expected
@@ -20,7 +20,7 @@
           "name": "PropertyRel",
           "indexId": "1:3390393562759376202",
           "type": 11,
-          "flags": 8712,
+          "flags": 520,
           "relationTarget": "SyncedRelTarget"
         }
       ],
diff --git a/test/comparison/testdata/go/sync/synced.obx.go.expected b/test/comparison/testdata/go/sync/synced.obx.go.expected
@@ -60,7 +60,7 @@ func (syncedEntity_EntityInfo) AddToModel(model *objectbox.Model) {
 	model.Property("Id", 6, 1, 6050128673802995827)
 	model.PropertyFlags(1)
 	model.Property("PropertyRel", 11, 2, 501233450539197794)
-	model.PropertyFlags(8712)
+	model.PropertyFlags(520)
 	model.PropertyRelation("SyncedRelTarget", 1, 3390393562759376202)
 	model.EntityLastPropertyId(2, 501233450539197794)
 	model.Relation(1, 2669985732393126063, SyncedRelTargetBinding.Id, SyncedRelTargetBinding.Uid)
diff --git a/test/comparison/testdata/go/task/bypointer.obx.go.expected b/test/comparison/testdata/go/task/bypointer.obx.go.expected
@@ -80,7 +80,7 @@ func (task_EntityInfo) AddToModel(model *objectbox.Model) {
 	model.Property("Date", 10, 4, 1774932891286980153)
 	model.PropertyFlags(8192)
 	model.Property("GroupId", 11, 5, 6044372234677422456)
-	model.PropertyFlags(8712)
+	model.PropertyFlags(520)
 	model.PropertyRelation("Group", 2, 8274930044578894929)
 	model.EntityLastPropertyId(5, 6044372234677422456)
 }
diff --git a/test/comparison/testdata/go/task/objectbox-model.json.expected b/test/comparison/testdata/go/task/objectbox-model.json.expected
@@ -37,7 +37,7 @@
           "name": "GroupId",
           "indexId": "2:8274930044578894929",
           "type": 11,
-          "flags": 8712,
+          "flags": 520,
           "relationTarget": "Group"
         }
       ]

Original file line number	Diff line number	Diff line change
`@@ -80,11 +80,13 @@ func (property *Property) Validate() error {`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`func (property *Property) finalize() error {`
`83`		`- if property.IsIdProperty() {`
`84`		`- // IDs must not be tagged unsigned for compatibility reasons`
	`83`	`+ if property.Type == PropertyTypeRelation \|\| property.IsIdProperty() {`
	`84`	`+ // IDs must not be tagged unsigned for model compatibility (across language bindings)`
`85`	`85`	`property.Flags = property.Flags & ^PropertyFlagUnsigned`
	`86`	`+ }`
`86`	`87`
`87`		`- // always stored as Long`
	`88`	`+ if property.IsIdProperty() {`
	`89`	`+ // always stored IDs as Long, regardless of their type in the code/declaration`
`88`	`90`	`property.Type = PropertyTypeLong`
`89`	`91`	`}`
`90`	`92`
Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@`
`131`	`131`	`"name": "relId",`
`132`	`132`	`"indexId": "1:2627038740284806767",`
`133`	`133`	`"type": 11,`
`134`		`- "flags": 8712,`
	`134`	`+ "flags": 520,`
`135`	`135`	`"relationTarget": "AnnotatedEntity"`
`136`	`136`	`}`
`137`	`137`	`]`
`@@ -165,7 +165,7 @@`
`165`	`165`	`"name": "relId",`
`166`	`166`	`"indexId": "3:6745438398739480977",`
`167`	`167`	`"type": 11,`
`168`		`- "flags": 8712,`
	`168`	`+ "flags": 520,`
`169`	`169`	`"relationTarget": "Typeful"`
`170`	`170`	`},`
`171`	`171`	`{`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ func (taskRelId_EntityInfo) AddToModel(model *objectbox.Model) {`
`53`	`53`	`model.Property("Id", 6, 1, 6044372234677422456)`
`54`	`54`	`model.PropertyFlags(1)`
`55`	`55`	`model.Property("Group", 11, 2, 8274930044578894929)`
`56`		`- model.PropertyFlags(8712)`
	`56`	`+ model.PropertyFlags(520)`
`57`	`57`	`model.PropertyRelation("Group", 1, 1543572285742637646)`
`58`	`58`	`model.EntityLastPropertyId(2, 8274930044578894929)`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ func (taskRelPtr_EntityInfo) AddToModel(model *objectbox.Model) {`
`53`	`53`	`model.Property("Id", 6, 1, 8325060299420976708)`
`54`	`54`	`model.PropertyFlags(1)`
`55`	`55`	`model.Property("Group", 11, 2, 7837839688282259259)`
`56`		`- model.PropertyFlags(8712)`
	`56`	`+ model.PropertyFlags(520)`
`57`	`57`	`model.PropertyRelation("Group", 2, 2518412263346885298)`
`58`	`58`	`model.EntityLastPropertyId(2, 7837839688282259259)`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ func (taskRelValue_EntityInfo) AddToModel(model *objectbox.Model) {`
`53`	`53`	`model.Property("Id", 6, 1, 2339563716805116249)`
`54`	`54`	`model.PropertyFlags(1)`
`55`	`55`	`model.Property("Group", 11, 2, 7144924247938981575)`
`56`		`- model.PropertyFlags(8712)`
	`56`	`+ model.PropertyFlags(520)`
`57`	`57`	`model.PropertyRelation("Group", 3, 161231572858529631)`
`58`	`58`	`model.EntityLastPropertyId(2, 7144924247938981575)`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@`
`55`	`55`	`"name": "Group",`
`56`	`56`	`"indexId": "1:1543572285742637646",`
`57`	`57`	`"type": 11,`
`58`		`- "flags": 8712,`
	`58`	`+ "flags": 520,`
`59`	`59`	`"relationTarget": "Group"`
`60`	`60`	`}`
`61`	`61`	`]`
`@@ -76,7 +76,7 @@`
`76`	`76`	`"name": "Group",`
`77`	`77`	`"indexId": "2:2518412263346885298",`
`78`	`78`	`"type": 11,`
`79`		`- "flags": 8712,`
	`79`	`+ "flags": 520,`
`80`	`80`	`"relationTarget": "Group"`
`81`	`81`	`}`
`82`	`82`	`]`
`@@ -97,7 +97,7 @@`
`97`	`97`	`"name": "Group",`
`98`	`98`	`"indexId": "3:161231572858529631",`
`99`	`99`	`"type": 11,`
`100`		`- "flags": 8712,`
	`100`	`+ "flags": 520,`
`101`	`101`	`"relationTarget": "Group"`
`102`	`102`	`}`
`103`	`103`	`]`
`@@ -118,7 +118,7 @@`
`118`	`118`	`"name": "Group",`
`119`	`119`	`"indexId": "4:3930927879439176946",`
`120`	`120`	`"type": 11,`
`121`		`- "flags": 8712,`
	`121`	`+ "flags": 520,`
`122`	`122`	`"relationTarget": "Group"`
`123`	`123`	`}`
`124`	`124`	`],`