Refactor keys and queries in datastore service and implementation.

impl/memory/datastore_data.go

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package memory
 
 import (
         "bytes"
         "fmt"
         "sync"
         "sync/atomic"
 
         ds "github.com/luci/gae/service/datastore"
-        "github.com/luci/gae/service/datastore/dskey"
         "github.com/luci/gae/service/datastore/serialize"
         "github.com/luci/luci-go/common/errors"
         "golang.org/x/net/context"
 )
 
 //////////////////////////////// dataStoreData /////////////////////////////////
 
 type dataStoreData struct {
         rwlock sync.RWMutex
         // See README.md for head schema.
@@ skipping 49 matching lines @@
 }
 
 func (d *dataStoreData) catchupIndexes() {
         d.rwlock.Lock()
         defer d.rwlock.Unlock()
         d.snap = d.head.Snapshot()
 }
 
 /////////////////////////// indexes(dataStoreData) ////////////////////////////
 
-func groupMetaKey(key ds.Key) []byte {
-        return keyBytes(dskey.New("", "", "__entity_group__", "", 1, dskey.Root(key)))
+func groupMetaKey(key *ds.Key) []byte {
+        return keyBytes(ds.NewKey("", "", "__entity_group__", "", 1, key.Root()))
 }
 
-func groupIDsKey(key ds.Key) []byte {
-        return keyBytes(dskey.New("", "", "__entity_group_ids__", "", 1, dskey.Root(key)))
+func groupIDsKey(key *ds.Key) []byte {
+        return keyBytes(ds.NewKey("", "", "__entity_group_ids__", "", 1, key.Root()))
 }
 
 func rootIDsKey(kind string) []byte {
-        return keyBytes(dskey.New("", "", "__entity_root_ids__", kind, 0, nil))
+        return keyBytes(ds.NewKey("", "", "__entity_root_ids__", kind, 0, nil))
 }
 
 func curVersion(ents *memCollection, key []byte) int64 {
         if ents != nil {
                 if v := ents.Get(key); v != nil {
                         pm, err := rpm(v)
                         memoryCorruption(err)
 
                         pl, ok := pm["__version__"]
                         if ok && len(pl) > 0 && pl[0].Type() == ds.PTInt {
                                 return pl[0].Value().(int64)
                         }
 
                         memoryCorruption(fmt.Errorf("__version__ property missing or wrong: %v", pm))
                 }
         }
         return 0
 }
 
 func incrementLocked(ents *memCollection, key []byte) int64 {
         ret := curVersion(ents, key) + 1
         ents.Set(key, serialize.ToBytes(ds.PropertyMap{
                 "__version__": {ds.MkPropertyNI(ret)},
         }))
         return ret
 }
 
-func (d *dataStoreData) entsKeyLocked(key ds.Key) (*memCollection, ds.Key) {
+func (d *dataStoreData) entsKeyLocked(key *ds.Key) (*memCollection, *ds.Key) {
         coll := "ents:" + key.Namespace()
         ents := d.head.GetCollection(coll)
         if ents == nil {
                 ents = d.head.SetCollection(coll, nil)
         }
 
-        if dskey.Incomplete(key) {
+        if key.Incomplete() {
                 idKey := []byte(nil)
                 if key.Parent() == nil {
-                        idKey = rootIDsKey(key.Kind())
+                        idKey = rootIDsKey(key.Last().Kind)
                 } else {
                         idKey = groupIDsKey(key)
                 }
                 id := incrementLocked(ents, idKey)
-                key = dskey.New(key.AppID(), key.Namespace(), key.Kind(), "", id, key.Parent())
+                key = ds.NewKey(key.AppID(), key.Namespace(), key.Last().Kind, "", id, key.Parent())
         }
 
         return ents, key
 }
 
-func (d *dataStoreData) putMulti(keys []ds.Key, vals []ds.PropertyMap, cb ds.PutMultiCB) {
+func (d *dataStoreData) putMulti(keys []*ds.Key, vals []ds.PropertyMap, cb ds.PutMultiCB) {
         for i, k := range keys {
                 pmap, _ := vals[i].Save(false)
                 dataBytes := serialize.ToBytes(pmap)
 
-                k, err := func() (ret ds.Key, err error) {
+                k, err := func() (ret *ds.Key, err error) {
                         d.rwlock.Lock()
                         defer d.rwlock.Unlock()
 
                         ents, ret := d.entsKeyLocked(k)
                         incrementLocked(ents, groupMetaKey(ret))
 
                         old := ents.Get(keyBytes(ret))
                         oldPM := ds.PropertyMap(nil)
                         if old != nil {
                                 if oldPM, err = rpmWoCtx(old, ret.Namespace()); err != nil {
                                         return
                                 }
                         }
                         updateIndexes(d.head, ret, oldPM, pmap)
                         ents.Set(keyBytes(ret), dataBytes)
                         return
                 }()
                 if cb != nil {
                         cb(k, err)
                 }
         }
 }
 
-func getMultiInner(keys []ds.Key, cb ds.GetMultiCB, getColl func() (*memCollection, error)) error {
+func getMultiInner(keys []*ds.Key, cb ds.GetMultiCB, getColl func() (*memCollection, error)) error {
         ents, err := getColl()
         if err != nil {
                 return err
         }
         if ents == nil {
                 for range keys {
                         cb(nil, ds.ErrNoSuchEntity)
                 }
                 return nil
         }
 
         for _, k := range keys {
                 pdata := ents.Get(keyBytes(k))
                 if pdata == nil {
                         cb(nil, ds.ErrNoSuchEntity)
                         continue
                 }
                 cb(rpmWoCtx(pdata, k.Namespace()))
         }
         return nil
 }
 
-func (d *dataStoreData) getMulti(keys []ds.Key, cb ds.GetMultiCB) error {
-        getMultiInner(keys, cb, func() (*memCollection, error) {
+func (d *dataStoreData) getMulti(keys []*ds.Key, cb ds.GetMultiCB) error {
+        return getMultiInner(keys, cb, func() (*memCollection, error) {
                 s := d.takeSnapshot()
 
                 return s.GetCollection("ents:" + keys[0].Namespace()), nil
         })
-        return nil
 }
 
-func (d *dataStoreData) delMulti(keys []ds.Key, cb ds.DeleteMultiCB) {
+func (d *dataStoreData) delMulti(keys []*ds.Key, cb ds.DeleteMultiCB) {
         toDel := make([][]byte, 0, len(keys))
         for _, k := range keys {
                 toDel = append(toDel, keyBytes(k))
         }
         ns := keys[0].Namespace()
 
         d.rwlock.Lock()
         defer d.rwlock.Unlock()
 
         ents := d.head.GetCollection("ents:" + ns)
@@ skipping 24 matching lines @@
         // TODO(riannucci): implement with Flush/FlushRevert for persistance.
 
         txn := obj.(*txnDataStoreData)
         for rk, muts := range txn.muts {
                 if len(muts) == 0 { // read-only
                         continue
                 }
                 prop, err := serialize.ReadProperty(bytes.NewBufferString(rk), serialize.WithContext, "", "")
                 memoryCorruption(err)
 
-                k := prop.Value().(ds.Key)
+                k := prop.Value().(*ds.Key)
 
                 entKey := "ents:" + k.Namespace()
                 mkey := groupMetaKey(k)
                 entsHead := d.head.GetCollection(entKey)
                 entsSnap := txn.snap.GetCollection(entKey)
                 vHead := curVersion(entsHead, mkey)
                 vSnap := curVersion(entsSnap, mkey)
                 if vHead != vSnap {
                         return false
                 }
         }
         return true
 }
 
 func (d *dataStoreData) applyTxn(c context.Context, obj memContextObj) {
         txn := obj.(*txnDataStoreData)
         for _, muts := range txn.muts {
                 if len(muts) == 0 { // read-only
                         continue
                 }
                 // TODO(riannucci): refactor to do just 1 putMulti, and 1 delMulti
                 for _, m := range muts {
                         err := error(nil)
                         k := m.key
                         if m.data == nil {
-                                d.delMulti([]ds.Key{k},
+                                d.delMulti([]*ds.Key{k},
                                         func(e error) { err = e })
                         } else {
-                                d.putMulti([]ds.Key{m.key}, []ds.PropertyMap{m.data},
-                                        func(_ ds.Key, e error) { err = e })
+                                d.putMulti([]*ds.Key{m.key}, []ds.PropertyMap{m.data},
+                                        func(_ *ds.Key, e error) { err = e })
                         }
                         impossible(err)
                 }
         }
 }
 
 func (d *dataStoreData) mkTxn(o *ds.TransactionOptions) memContextObj {
         return &txnDataStoreData{
                 // alias to the main datastore's so that testing code can have primitive
                 // access to break features inside of transactions.
                 parent: d,
                 isXG:   o != nil && o.XG,
                 snap:   d.head.Snapshot(),
                 muts:   map[string][]txnMutation{},
         }
 }
 
 func (d *dataStoreData) endTxn() {}
 
 /////////////////////////////// txnDataStoreData ///////////////////////////////
 
 type txnMutation struct {
-        key  ds.Key
+        key  *ds.Key
         data ds.PropertyMap
 }
 
 type txnDataStoreData struct {
         sync.Mutex
 
         parent *dataStoreData
 
         // boolean 0 or 1, use atomic.*Int32 to access.
         closed int32
@@ skipping 39 matching lines @@
 // mutation.
 //
 //   if getOnly is true, don't record the actual mutation data, just ensure that
 //         the key is in an included entity group (or add an empty entry for that
 //         group).
 //
 //   if !getOnly && data == nil, this counts as a deletion instead of a Put.
 //
 // Returns an error if this key causes the transaction to cross too many entity
 // groups.
-func (td *txnDataStoreData) writeMutation(getOnly bool, key ds.Key, data ds.PropertyMap) error {
-        rk := string(keyBytes(dskey.Root(key)))
+func (td *txnDataStoreData) writeMutation(getOnly bool, key *ds.Key, data ds.PropertyMap) error {
+        rk := string(keyBytes(key.Root()))
 
         td.Lock()
         defer td.Unlock()
 
         if _, ok := td.muts[rk]; !ok {
                 limit := 1
                 if td.isXG {
                         limit = xgEGLimit
                 }
                 if len(td.muts)+1 > limit {
                         msg := "cross-group transaction need to be explicitly specified (xg=True)"
                         if td.isXG {
                                 msg = "operating on too many entity groups in a single transaction"
                         }
                         return errors.New(msg)
                 }
                 td.muts[rk] = []txnMutation{}
         }
         if !getOnly {
                 td.muts[rk] = append(td.muts[rk], txnMutation{key, data})
         }
 
         return nil
 }
 
-func (td *txnDataStoreData) putMulti(keys []ds.Key, vals []ds.PropertyMap, cb ds.PutMultiCB) {
+func (td *txnDataStoreData) putMulti(keys []*ds.Key, vals []ds.PropertyMap, cb ds.PutMultiCB) {
         for i, k := range keys {
                 func() {
                         td.parent.Lock()
                         defer td.parent.Unlock()
                         _, k = td.parent.entsKeyLocked(k)
                 }()
                 err := td.writeMutation(false, k, vals[i])
                 if cb != nil {
                         cb(k, err)
                 }
         }
 }
 
-func (td *txnDataStoreData) getMulti(keys []ds.Key, cb ds.GetMultiCB) error {
+func (td *txnDataStoreData) getMulti(keys []*ds.Key, cb ds.GetMultiCB) error {
         return getMultiInner(keys, cb, func() (*memCollection, error) {
                 err := error(nil)
                 for _, key := range keys {
                         err = td.writeMutation(true, key, nil)
                         if err != nil {
                                 return nil, err
                         }
                 }
                 return td.snap.GetCollection("ents:" + keys[0].Namespace()), nil
         })
 }
 
-func (td *txnDataStoreData) delMulti(keys []ds.Key, cb ds.DeleteMultiCB) error {
+func (td *txnDataStoreData) delMulti(keys []*ds.Key, cb ds.DeleteMultiCB) error {
         for _, k := range keys {
                 err := td.writeMutation(false, k, nil)
                 if cb != nil {
                         cb(err)
                 }
         }
         return nil
 }
 
-func keyBytes(key ds.Key) []byte {
+func keyBytes(key *ds.Key) []byte {
         return serialize.ToBytes(ds.MkProperty(key))
 }
 
 func rpmWoCtx(data []byte, ns string) (ds.PropertyMap, error) {
         return serialize.ReadPropertyMap(bytes.NewBuffer(data),
                 serialize.WithoutContext, globalAppID, ns)
 }
 
 func rpm(data []byte) (ds.PropertyMap, error) {
         return serialize.ReadPropertyMap(bytes.NewBuffer(data),
                 serialize.WithContext, "", "")
 }
-
-type keyitem interface {
-        Key() ds.Key
-}