Split off serialization and key functions to their own packages.

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 store schema.
         store *memStore
@@ skipping 47 matching lines @@
 
 func (d *dataStoreData) catchupIndexes() {
         d.rwlock.Lock()
         defer d.rwlock.Unlock()
         d.snap = d.store.Snapshot()
 }
 
 /////////////////////////// indicies(dataStoreData) ////////////////////////////
 
 func groupMetaKey(key ds.Key) []byte {
-        return keyBytes(ds.WithoutContext,
-                ds.NewKey("", "", "__entity_group__", "", 1, ds.KeyRoot(key)))
+        return keyBytes(serialize.WithoutContext,
+                dskey.New("", "", "__entity_group__", "", 1, dskey.Root(key)))
 }
 
 func groupIDsKey(key ds.Key) []byte {
-        return keyBytes(ds.WithoutContext,
-                ds.NewKey("", "", "__entity_group_ids__", "", 1, ds.KeyRoot(key)))
+        return keyBytes(serialize.WithoutContext,
+                dskey.New("", "", "__entity_group_ids__", "", 1, dskey.Root(key)))
 }
 
 func rootIDsKey(kind string) []byte {
-        return keyBytes(ds.WithoutContext,
-                ds.NewKey("", "", "__entity_root_ids__", kind, 0, nil))
+        return keyBytes(serialize.WithoutContext,
+                dskey.New("", "", "__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)
                         if err != nil {
                                 panic(err) // memory corruption
                         }
                         pl, ok := pm["__version__"]
                         if ok && len(pl) > 0 && pl[0].Type() == ds.PTInt {
                                 return pl[0].Value().(int64)
                         }
                         panic(fmt.Errorf("__version__ property missing or wrong: %v", pm))
                 }
         }
         return 0
 }
 
 func incrementLocked(ents *memCollection, key []byte) int64 {
         ret := curVersion(ents, key) + 1
         buf := &bytes.Buffer{}
-        ds.PropertyMap{"__version__": {ds.MkPropertyNI(ret)}}.Write(
-                buf, ds.WithContext)
+        serialize.WritePropertyMap(buf, serialize.WithContext, ds.PropertyMap{
+                "__version__": {ds.MkPropertyNI(ret)}})
         ents.Set(key, buf.Bytes())
         return ret
 }
 
 func (d *dataStoreData) entsKeyLocked(key ds.Key) (*memCollection, ds.Key) {
         coll := "ents:" + key.Namespace()
         ents := d.store.GetCollection(coll)
         if ents == nil {
                 ents = d.store.SetCollection(coll, nil)
         }
 
-        if ds.KeyIncomplete(key) {
+        if dskey.Incomplete(key) {
                 idKey := []byte(nil)
                 if key.Parent() == nil {
                         idKey = rootIDsKey(key.Kind())
                 } else {
                         idKey = groupIDsKey(key)
                 }
                 id := incrementLocked(ents, idKey)
-                key = ds.NewKey(key.AppID(), key.Namespace(), key.Kind(), "", id, key.Parent())
+                key = dskey.New(key.AppID(), key.Namespace(), key.Kind(), "", id, key.Parent())
         }
 
         return ents, key
 }
 
 func (d *dataStoreData) putMulti(keys []ds.Key, vals []ds.PropertyMap, cb ds.PutMultiCB) {
         for i, k := range keys {
                 buf := &bytes.Buffer{}
                 pmap, _ := vals[i].Save(false)
-                pmap.Write(buf, ds.WithoutContext)
+                serialize.WritePropertyMap(buf, serialize.WithoutContext, pmap)
                 dataBytes := buf.Bytes()
 
                 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(ds.WithoutContext, ret))
+                        old := ents.Get(keyBytes(serialize.WithoutContext, ret))
                         oldPM := ds.PropertyMap(nil)
                         if old != nil {
                                 if oldPM, err = rpmWoCtx(old, ret.Namespace()); err != nil {
                                         return
                                 }
                         }
                         updateIndicies(d.store, ret, oldPM, pmap)
-                        ents.Set(keyBytes(ds.WithoutContext, ret), dataBytes)
+                        ents.Set(keyBytes(serialize.WithoutContext, ret), dataBytes)
                         return
                 }()
                 if cb != nil {
                         cb(k, err)
                 }
         }
 }
 
 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(ds.WithoutContext, k))
+                pdata := ents.Get(keyBytes(serialize.WithoutContext, 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) {
                 s := d.takeSnapshot()
 
                 return s.GetCollection("ents:" + keys[0].Namespace()), nil
         })
         return nil
 }
 
 func (d *dataStoreData) delMulti(keys []ds.Key, cb ds.DeleteMultiCB) {
         toDel := make([][]byte, 0, len(keys))
         for _, k := range keys {
-                toDel = append(toDel, keyBytes(ds.WithoutContext, k))
+                toDel = append(toDel, keyBytes(serialize.WithoutContext, k))
         }
         ns := keys[0].Namespace()
 
         d.rwlock.Lock()
         defer d.rwlock.Unlock()
 
         ents := d.store.GetCollection("ents:" + ns)
 
         for i, k := range keys {
                 if ents != nil {
@@ skipping 18 matching lines @@
 }
 
 func (d *dataStoreData) canApplyTxn(obj memContextObj) bool {
         // TODO(riannucci): implement with Flush/FlushRevert for persistance.
 
         txn := obj.(*txnDataStoreData)
         for rk, muts := range txn.muts {
                 if len(muts) == 0 { // read-only
                         continue
                 }
-                k, err := ds.ReadKey(bytes.NewBufferString(rk), ds.WithContext, "", "")
+                k, err := serialize.ReadKey(bytes.NewBufferString(rk), serialize.WithContext, "", "")
                 if err != nil {
                         panic(err)
                 }
 
                 entKey := "ents:" + k.Namespace()
                 mkey := groupMetaKey(k)
                 entsHead := d.store.GetCollection(entKey)
                 entsSnap := txn.snap.GetCollection(entKey)
                 vHead := curVersion(entsHead, mkey)
                 vSnap := curVersion(entsSnap, mkey)
@@ skipping 98 matching lines @@
 //
 //   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(ds.WithContext, ds.KeyRoot(key)))
+        rk := string(keyBytes(serialize.WithContext, dskey.Root(key)))
 
         td.Lock()
         defer td.Unlock()
 
         if _, ok := td.muts[rk]; !ok {
                 limit := 1
                 if td.isXG {
                         limit = xgEGLimit
                 }
                 if len(td.muts)+1 > limit {
@@ skipping 42 matching lines @@
 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(ctx ds.KeyContext, key ds.Key) []byte {
+func keyBytes(ctx serialize.KeyContext, key ds.Key) []byte {
         buf := &bytes.Buffer{}
-        ds.WriteKey(buf, ctx, key)
+        serialize.WriteKey(buf, ctx, key)
         return buf.Bytes()
 }
 
 func rpmWoCtx(data []byte, ns string) (ds.PropertyMap, error) {
-        ret := ds.PropertyMap{}
-        err := ret.Read(bytes.NewBuffer(data), ds.WithoutContext, globalAppID, ns)
-        return ret, err
+        return serialize.ReadPropertyMap(bytes.NewBuffer(data),
+                serialize.WithoutContext, globalAppID, ns)
 }
 
 func rpm(data []byte) (ds.PropertyMap, error) {
-        ret := ds.PropertyMap{}
-        err := ret.Read(bytes.NewBuffer(data), ds.WithContext, "", "")
-        return ret, err
+        return serialize.ReadPropertyMap(bytes.NewBuffer(data),
+                serialize.WithContext, "", "")
 }
 
 type keyitem interface {
         Key() ds.Key
 }