OLD | NEW |
---|---|
1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 package dscache | 5 package dscache |
6 | 6 |
7 import ( | 7 import ( |
8 ds "github.com/luci/gae/service/datastore" | 8 ds "github.com/luci/gae/service/datastore" |
9 "github.com/luci/gae/service/info" | 9 "github.com/luci/gae/service/info" |
10 mc "github.com/luci/gae/service/memcache" | 10 mc "github.com/luci/gae/service/memcache" |
11 "github.com/luci/luci-go/common/mathrand" | 11 "github.com/luci/luci-go/common/mathrand" |
12 "golang.org/x/net/context" | 12 "golang.org/x/net/context" |
13 ) | 13 ) |
14 | 14 |
15 type key int | 15 type key int |
16 | 16 |
17 var dsTxnCacheKey key | 17 var dsTxnCacheKey key |
18 | 18 |
19 // FilterRDS installs a caching RawDatastore filter in the context. | 19 // FilterRDS installs a caching RawDatastore filter in the context. |
20 // | 20 // |
21 // shardsForKey is a user-controllable function which calculates the number of | 21 // shardsForKey is a user-controllable function which calculates the number of |
22 // shards to use for a certain datastore key. The provided key will always be | 22 // shards to use for a certain datastore key. The provided key will always be |
23 // valid and complete. | 23 // valid and complete. |
24 // | 24 // |
25 // The # of shards returned may be between 1 and 256. Values above this range | 25 // The # of shards returned may be between 1 and 256. Values above this range |
26 // will be clamped into that range. A return value of 0 means that NO cache | 26 // will be clamped into that range. A return value of 0 means that NO cache |
27 // operations should be done for this key, regardless of the dscache.enable | 27 // operations should be done for this key, regardless of the dscache.enable |
28 // setting. | 28 // setting. |
29 // | 29 // |
30 // If shardsForKey is nil, the value of DefaultShards is used for all keys. | 30 // If shardsForKey is nil, the value of DefaultShards is used for all keys. |
iannucci
2016/01/12 19:11:01
I'd change the comment here to mention that it's c
Vadim Sh.
2016/01/12 19:16:31
Done.
| |
31 func FilterRDS(c context.Context, shardsForKey func(*ds.Key) int) context.Contex t { | 31 func FilterRDS(c context.Context, shardsForKey func(*ds.Key) int) context.Contex t { |
32 if !IsGloballyEnabled(c) { | 32 if !IsGloballyEnabled(c) { |
33 return c | 33 return c |
34 } | 34 } |
35 return AlwaysFilterRDS(c, shardsForKey) | |
36 } | |
35 | 37 |
38 // AlwaysFilterRDS installs a caching RawDatastore filter in the context. | |
39 // | |
40 // Unlike FilterRDS it doesn't check GlobalConfig via IsGloballyEnabled call, | |
41 // assuming caller already knows whether filter should be applied or not. | |
42 func AlwaysFilterRDS(c context.Context, shardsForKey func(*ds.Key) int) context. Context { | |
36 return ds.AddRawFilters(c, func(c context.Context, ds ds.RawInterface) d s.RawInterface { | 43 return ds.AddRawFilters(c, func(c context.Context, ds ds.RawInterface) d s.RawInterface { |
37 i := info.Get(c) | 44 i := info.Get(c) |
38 | 45 |
39 sc := &supportContext{ | 46 sc := &supportContext{ |
40 i.AppID(), | 47 i.AppID(), |
41 i.GetNamespace(), | 48 i.GetNamespace(), |
42 c, | 49 c, |
43 mc.Get(c), | 50 mc.Get(c), |
44 mathrand.Get(c), | 51 mathrand.Get(c), |
45 shardsForKey, | 52 shardsForKey, |
46 } | 53 } |
47 | 54 |
48 v := c.Value(dsTxnCacheKey) | 55 v := c.Value(dsTxnCacheKey) |
49 if v == nil { | 56 if v == nil { |
50 return &dsCache{ds, sc} | 57 return &dsCache{ds, sc} |
51 } | 58 } |
52 return &dsTxnCache{ds, v.(*dsTxnState), sc} | 59 return &dsTxnCache{ds, v.(*dsTxnState), sc} |
53 }) | 60 }) |
54 } | 61 } |
OLD | NEW |