refactor: Remove GetPrimaryIndexDocKey from collection interface (sou…

…rcenetwork#279)

* Remove GetPrimaryIndexDocKey from collection interface

No real reason for this to be on here, and it exposes internal types

* Remove commented out code

client/core.go

@@ -79,7 +79,6 @@ type Collection interface {
 
 	WithTxn(core.Txn) Collection
 
-	GetPrimaryIndexDocKey(core.DataStoreKey) core.DataStoreKey
 	GetAllDocKeys(ctx context.Context) (<-chan DocKeysResult, error)
 }
 

db/base/descriptions.go

@@ -58,6 +58,10 @@ func (col CollectionDescription) GetField(name string) (FieldDescription, bool)
 	return FieldDescription{}, false
 }
 
+func (c CollectionDescription) GetPrimaryIndex() IndexDescription {
+	return c.Indexes[0]
+}
+
 func (c CollectionDescription) getIndexDocKey(key core.DataStoreKey, indexID uint32) core.DataStoreKey {
 	return core.DataStoreKey{
 		CollectionId: c.IDString(),
@@ -66,7 +70,7 @@ func (c CollectionDescription) getIndexDocKey(key core.DataStoreKey, indexID uin
 }
 
 func (c CollectionDescription) getPrimaryIndexDocKey(key core.DataStoreKey) core.DataStoreKey {
-	return c.getIndexDocKey(key, c.Indexes[0].ID)
+	return c.getIndexDocKey(key, c.GetPrimaryIndex().ID)
 }
 
 func (c CollectionDescription) getFieldKey(key core.DataStoreKey, fieldName string) core.DataStoreKey {
@@ -87,6 +91,13 @@ func (c CollectionDescription) GetPrimaryIndexDocKeyForCRDT(ctype core.CType, ke
 	return core.DataStoreKey{}, errors.New("Invalid CRDT type")
 }
 
+func (c CollectionDescription) GetPrimaryIndexDocKey(key core.DataStoreKey) core.DataStoreKey {
+	return core.DataStoreKey{
+		CollectionId: fmt.Sprint(c.ID),
+		IndexId:      fmt.Sprint(c.GetPrimaryIndex().ID),
+	}.WithInstanceInfo(key)
+}
+
 // IndexDescription describes an Index on a Collection
 // and its associated metadata.
 type IndexDescription struct {

db/collection.go

@@ -792,10 +792,6 @@ func (c *Collection) commitImplicitTxn(ctx context.Context, txn core.Txn) error
 	return nil
 }
 
-func (c *Collection) GetPrimaryIndexDocKey(key core.DataStoreKey) core.DataStoreKey {
-	return c.getPrimaryIndexDocKey(key)
-}
-
 func (c *Collection) getPrimaryIndexDocKey(key core.DataStoreKey) core.DataStoreKey {
 	return core.DataStoreKey{
 		CollectionId: fmt.Sprint(c.colID),

db/fetcher/versioned.go

@@ -426,11 +426,3 @@ func NewVersionedSpan(dockey core.DataStoreKey, version cid.Cid) core.Spans {
 	// Todo: Dont abuse DataStoreKey for version cid!
 	return core.Spans{core.NewSpan(dockey, core.DataStoreKey{DocKey: version.String()})}
 }
-
-// func createMerkleCRDT(ctype core.CType, key ds.Key, store core.MultiStore) (crdt.MerkleCRDT, error) {
-// 	key := vf.col.GetPrimaryIndexDocKey(vf.key.Key).ChildString(core.COMPOSITE_ID)
-// 	compCRDT, err = crdt.DefaultFactory.InstanceWithStores(vf.store, core.COMPOSITE, key)
-// 	if err != nil {
-// 		return err
-// 	}
-// }

net/process.go

@@ -92,15 +92,15 @@ func initCRDTForType(ctx context.Context, txn core.MultiStore, col client.Collec
 	var ctype core.CType
 	if field == "" { // empty field name implies composite type
 		ctype = core.COMPOSITE
-		key = col.GetPrimaryIndexDocKey(docKey).WithFieldId(core.COMPOSITE_NAMESPACE)
+		key = col.Description().GetPrimaryIndexDocKey(docKey).WithFieldId(core.COMPOSITE_NAMESPACE)
 	} else {
 		fd, ok := col.Description().GetField(field)
 		if !ok {
 			return nil, fmt.Errorf("Couldn't find field %s for doc %s", field, docKey)
 		}
 		ctype = fd.Typ
 		fieldID := fd.ID.String()
-		key = col.GetPrimaryIndexDocKey(docKey).WithFieldId(fieldID)
+		key = col.Description().GetPrimaryIndexDocKey(docKey).WithFieldId(fieldID)
 	}
 	log.Debug(ctx, "Got CRDT Type", logging.NewKV("CType", ctype), logging.NewKV("Field", field))
 	return crdt.DefaultFactory.InstanceWithStores(txn, col.SchemaID(), nil, ctype, key)