feat: Add collectionId field to commit field (#1235)

Add collectionID field to commit 
Commits can be grouped and ordered by collectionID

To retrieve a value for collectionID the method 
GetCollectionByVersionID is added to db interface.

client/db.go

@@ -81,6 +81,7 @@ type Store interface {
 
 	GetCollectionByName(context.Context, string) (Collection, error)
 	GetCollectionBySchemaID(context.Context, string) (Collection, error)
+	GetCollectionByVersionID(context.Context, string) (Collection, error)
 	GetAllCollections(context.Context) ([]Collection, error)
 
 	ExecRequest(context.Context, string) *RequestResult

client/request/consts.go

@@ -47,6 +47,7 @@ const (
 	HeightFieldName          = "height"
 	CidFieldName             = "cid"
 	DockeyFieldName          = "dockey"
+	CollectionIDFieldName    = "collectionID"
 	SchemaVersionIDFieldName = "schemaVersionId"
 	DeltaFieldName           = "delta"
 
@@ -88,6 +89,7 @@ var (
 		HeightFieldName,
 		CidFieldName,
 		DockeyFieldName,
+		CollectionIDFieldName,
 		SchemaVersionIDFieldName,
 		DeltaFieldName,
 	}

core/key.go

@@ -57,7 +57,7 @@ type Key interface {
 
 // DataStoreKey is a type that represents a key in the database.
 type DataStoreKey struct {
-	CollectionId string
+	CollectionID string
 	InstanceType InstanceType
 	DocKey       string
 	FieldId      string
@@ -144,7 +144,7 @@ func NewDataStoreKey(key string) (DataStoreKey, error) {
 		return dataStoreKey, ErrInvalidKey
 	}
 
-	dataStoreKey.CollectionId = elements[0]
+	dataStoreKey.CollectionID = elements[0]
 	dataStoreKey.InstanceType = InstanceType(elements[1])
 	dataStoreKey.DocKey = elements[2]
 	if numberOfElements == 4 {
@@ -272,8 +272,8 @@ func (k HeadStoreKey) WithFieldId(fieldId string) HeadStoreKey {
 func (k DataStoreKey) ToString() string {
 	var result string
 
-	if k.CollectionId != "" {
-		result = result + "/" + k.CollectionId
+	if k.CollectionID != "" {
+		result = result + "/" + k.CollectionID
 	}
 	if k.InstanceType != "" {
 		result = result + "/" + string(k.InstanceType)
@@ -297,22 +297,22 @@ func (k DataStoreKey) ToDS() ds.Key {
 }
 
 func (k DataStoreKey) Equal(other DataStoreKey) bool {
-	return k.CollectionId == other.CollectionId &&
+	return k.CollectionID == other.CollectionID &&
 		k.DocKey == other.DocKey &&
 		k.FieldId == other.FieldId &&
 		k.InstanceType == other.InstanceType
 }
 
 func (k DataStoreKey) ToPrimaryDataStoreKey() PrimaryDataStoreKey {
 	return PrimaryDataStoreKey{
-		CollectionId: k.CollectionId,
+		CollectionId: k.CollectionID,
 		DocKey:       k.DocKey,
 	}
 }
 
 func (k PrimaryDataStoreKey) ToDataStoreKey() DataStoreKey {
 	return DataStoreKey{
-		CollectionId: k.CollectionId,
+		CollectionID: k.CollectionId,
 		DocKey:       k.DocKey,
 	}
 }
@@ -506,8 +506,8 @@ func (k DataStoreKey) PrefixEnd() DataStoreKey {
 		newKey.InstanceType = InstanceType(bytesPrefixEnd([]byte(k.InstanceType)))
 		return newKey
 	}
-	if k.CollectionId != "" {
-		newKey.CollectionId = string(bytesPrefixEnd([]byte(k.CollectionId)))
+	if k.CollectionID != "" {
+		newKey.CollectionID = string(bytesPrefixEnd([]byte(k.CollectionID)))
 		return newKey
 	}
 	return newKey

core/key_test.go

@@ -46,7 +46,7 @@ func TestNewDataStoreKey_ReturnsCollectionIdAndIndexIdAndDocKeyAndFieldIdAndInst
 	assert.Equal(
 		t,
 		DataStoreKey{
-			CollectionId: collectionId,
+			CollectionID: collectionId,
 			DocKey:       docKey,
 			FieldId:      fieldId,
 			InstanceType: InstanceType(instanceType)},
@@ -77,7 +77,7 @@ func TestNewDataStoreKey_GivenAShortObjectMarker(t *testing.T) {
 	assert.Equal(
 		t,
 		DataStoreKey{
-			CollectionId: collectionId,
+			CollectionID: collectionId,
 			DocKey:       docKey,
 			InstanceType: InstanceType(instanceType)},
 		result)

db/base/collection_keys.go

@@ -20,14 +20,14 @@ import (
 // MakeIndexPrefix generates a key prefix for the given collection/index descriptions
 func MakeCollectionKey(col client.CollectionDescription) core.DataStoreKey {
 	return core.DataStoreKey{
-		CollectionId: col.IDString(),
+		CollectionID: col.IDString(),
 	}
 }
 
 // MakeIndexKey generates a key for the target dockey, using the collection/index description
 func MakeDocKey(col client.CollectionDescription, docKey string) core.DataStoreKey {
 	return core.DataStoreKey{
-		CollectionId: col.IDString(),
+		CollectionID: col.IDString(),
 		DocKey:       docKey,
 	}
 }

db/collection.go

@@ -364,7 +364,7 @@ func (db *db) validateUpdateCollection(
 // getCollectionByVersionId returns the [*collection] at the given [schemaVersionId] version.
 //
 // Will return an error if the given key is empty, or not found.
-func (db *db) getCollectionByVersionId(
+func (db *db) getCollectionByVersionID(
 	ctx context.Context,
 	txn datastore.Txn,
 	schemaVersionId string,
@@ -406,7 +406,7 @@ func (db *db) getCollectionByName(ctx context.Context, txn datastore.Txn, name s
 	}
 
 	schemaVersionId := string(buf)
-	return db.getCollectionByVersionId(ctx, txn, schemaVersionId)
+	return db.getCollectionByVersionID(ctx, txn, schemaVersionId)
 }
 
 // getCollectionBySchemaID returns an existing collection using the schema hash ID.
@@ -426,7 +426,7 @@ func (db *db) getCollectionBySchemaID(
 	}
 
 	schemaVersionId := string(buf)
-	return db.getCollectionByVersionId(ctx, txn, schemaVersionId)
+	return db.getCollectionByVersionID(ctx, txn, schemaVersionId)
 }
 
 // getAllCollections gets all the currently defined collections.
@@ -452,7 +452,7 @@ func (db *db) getAllCollections(ctx context.Context, txn datastore.Txn) ([]clien
 		}
 
 		schemaVersionId := string(res.Value)
-		col, err := db.getCollectionByVersionId(ctx, txn, schemaVersionId)
+		col, err := db.getCollectionByVersionID(ctx, txn, schemaVersionId)
 		if err != nil {
 			return nil, NewErrFailedToGetCollection(schemaVersionId, err)
 		}
@@ -1082,7 +1082,7 @@ func (c *collection) getPrimaryKeyFromDocKey(docKey client.DocKey) core.PrimaryD
 
 func (c *collection) getDSKeyFromDockey(docKey client.DocKey) core.DataStoreKey {
 	return core.DataStoreKey{
-		CollectionId: fmt.Sprint(c.colID),
+		CollectionID: fmt.Sprint(c.colID),
 		DocKey:       docKey.String(),
 		InstanceType: core.ValueKey,
 	}
@@ -1095,7 +1095,7 @@ func (c *collection) tryGetFieldKey(key core.PrimaryDataStoreKey, fieldName stri
 	}
 
 	return core.DataStoreKey{
-		CollectionId: key.CollectionId,
+		CollectionID: key.CollectionId,
 		DocKey:       key.DocKey,
 		FieldId:      strconv.FormatUint(uint64(fieldId), 10),
 	}, true

db/txn_db.go

@@ -123,6 +123,26 @@ func (db *explicitTxnDB) GetCollectionBySchemaID(
 	return db.getCollectionBySchemaID(ctx, db.txn, schemaID)
 }
 
+// GetCollectionByVersionID returns an existing collection using the schema version hash ID.
+func (db *implicitTxnDB) GetCollectionByVersionID(
+	ctx context.Context, schemaVersionID string,
+) (client.Collection, error) {
+	txn, err := db.NewTxn(ctx, true)
+	if err != nil {
+		return nil, err
+	}
+	defer txn.Discard(ctx)
+
+	return db.getCollectionByVersionID(ctx, txn, schemaVersionID)
+}
+
+// GetCollectionByVersionID returns an existing collection using the schema version hash ID.
+func (db *explicitTxnDB) GetCollectionByVersionID(
+	ctx context.Context, schemaVersionID string,
+) (client.Collection, error) {
+	return db.getCollectionByVersionID(ctx, db.txn, schemaVersionID)
+}
+
 // AddP2PCollection adds the given collection ID that the P2P system
 // subscribes to to the the persisted list. It will error if the provided
 // collection ID is invalid.

planner/commit.go

@@ -287,11 +287,12 @@ func (n *dagScanNode) dagBlockToNodeDoc(block blocks.Block) (core.Doc, []*ipld.L
 
 	schemaVersionId, ok := delta["SchemaVersionID"].(string)
 	if ok {
-		n.commitSelect.DocumentMapping.SetFirstOfName(&commit, "schemaVersionId", schemaVersionId)
+		n.commitSelect.DocumentMapping.SetFirstOfName(&commit,
+			request.SchemaVersionIDFieldName, schemaVersionId)
 	}
 
-	n.commitSelect.DocumentMapping.SetFirstOfName(&commit, "height", int64(prio))
-	n.commitSelect.DocumentMapping.SetFirstOfName(&commit, "delta", delta["Data"])
+	n.commitSelect.DocumentMapping.SetFirstOfName(&commit, request.HeightFieldName, int64(prio))
+	n.commitSelect.DocumentMapping.SetFirstOfName(&commit, request.DeltaFieldName, delta["Data"])
 
 	dockey, ok := delta["DocKey"].([]byte)
 	if !ok {
@@ -302,7 +303,16 @@ func (n *dagScanNode) dagBlockToNodeDoc(block blocks.Block) (core.Doc, []*ipld.L
 	if err != nil {
 		return core.Doc{}, nil, err
 	}
-	n.commitSelect.DocumentMapping.SetFirstOfName(&commit, "dockey", dockeyObj.DocKey)
+	n.commitSelect.DocumentMapping.SetFirstOfName(&commit,
+		request.DockeyFieldName, dockeyObj.DocKey)
+
+	collection, err := n.planner.db.GetCollectionByVersionID(n.planner.ctx, schemaVersionId)
+	if err != nil {
+		return core.Doc{}, nil, err
+	}
+
+	n.commitSelect.DocumentMapping.SetFirstOfName(&commit,
+		request.CollectionIDFieldName, int64(collection.ID()))
 
 	heads := make([]*ipld.Link, 0)
 
@@ -315,8 +325,8 @@ func (n *dagScanNode) dagBlockToNodeDoc(block blocks.Block) (core.Doc, []*ipld.L
 
 		for i, l := range nd.Links() {
 			link := linksMapping.NewDoc()
-			linksMapping.SetFirstOfName(&link, "name", l.Name)
-			linksMapping.SetFirstOfName(&link, "cid", l.Cid.String())
+			linksMapping.SetFirstOfName(&link, request.LinksNameFieldName, l.Name)
+			linksMapping.SetFirstOfName(&link, request.LinksCidFieldName, l.Cid.String())
 
 			links[i] = link
 		}

request/graphql/schema/types/commits.go

@@ -30,13 +30,14 @@ var (
 	// 	Height: Int
 	// 	CID: String
 	// 	Dockey: String
+	// 	CollectionID: Int
 	// 	SchemaVersionID: String
 	// 	Delta: String
 	// 	Previous: [Commit]
 	//  Links: [Commit]
 	// }
 	//
-	// Any self referential type needs to be initalized
+	// Any self referential type needs to be initialized
 	// inside the init() func
 	CommitObject = gql.NewObject(gql.ObjectConfig{
 		Name: request.CommitTypeName,
@@ -50,6 +51,9 @@ var (
 			"dockey": &gql.Field{
 				Type: gql.String,
 			},
+			"collectionID": &gql.Field{
+				Type: gql.Int,
+			},
 			"schemaVersionId": &gql.Field{
 				Type: gql.String,
 			},
@@ -110,6 +114,9 @@ var (
 				"dockey": &gql.InputObjectFieldConfig{
 					Type: OrderingEnum,
 				},
+				"collectionID": &gql.InputObjectFieldConfig{
+					Type: OrderingEnum,
+				},
 			},
 		},
 	)
@@ -118,9 +125,10 @@ var (
 		gql.EnumConfig{
 			Name: "commitFields",
 			Values: gql.EnumValueConfigMap{
-				"height": &gql.EnumValueConfig{Value: "height"},
-				"cid":    &gql.EnumValueConfig{Value: "cid"},
-				"dockey": &gql.EnumValueConfig{Value: "dockey"},
+				"height":       &gql.EnumValueConfig{Value: "height"},
+				"cid":          &gql.EnumValueConfig{Value: "cid"},
+				"dockey":       &gql.EnumValueConfig{Value: "dockey"},
+				"collectionID": &gql.EnumValueConfig{Value: "collectionID"},
 			},
 		},
 	)

tests/integration/query/commits/utils.go

@@ -22,8 +22,20 @@ const userCollectionGQLSchema = (`
 	}
 `)
 
+const companiesCollectionGQLSchema = (`
+	type companies {
+		Name: String
+	}
+`)
+
 func updateUserCollectionSchema() testUtils.SchemaUpdate {
 	return testUtils.SchemaUpdate{
 		Schema: userCollectionGQLSchema,
 	}
 }
+
+func updateCompaniesCollectionSchema() testUtils.SchemaUpdate {
+	return testUtils.SchemaUpdate{
+		Schema: companiesCollectionGQLSchema,
+	}
+}