Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a parameter cacheValuesOnly to Cache.make.* #160

Closed
wants to merge 2 commits into from
Closed

Add a parameter cacheValuesOnly to Cache.make.* #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1184a17
Add a parameter `storeOnlyIfValue` in Cache.make.*
kajebiii Sep 26, 2023
873e990
Rename to `cacheValuesOnly`
kajebiii Sep 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 36 additions & 8 deletions zio-cache/shared/src/main/scala/zio/cache/Cache.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,10 @@ object Cache {
def make[Key, Environment, Error, Value](
capacity: Int,
timeToLive: Duration,
lookup: Lookup[Key, Environment, Error, Value]
lookup: Lookup[Key, Environment, Error, Value],
cacheValuesOnly: Boolean = false
)(implicit trace: Trace): URIO[Environment, Cache[Key, Error, Value]] =
makeWith(capacity, lookup)(_ => timeToLive)
makeWith(capacity, lookup, cacheValuesOnly)(_ => timeToLive)

/**
* Constructs a new cache with the specified capacity, time to live, and
Expand All @@ -114,11 +115,12 @@ object Cache {
*/
def makeWith[Key, Environment, Error, Value](
capacity: Int,
lookup: Lookup[Key, Environment, Error, Value]
lookup: Lookup[Key, Environment, Error, Value],
cacheValuesOnly: Boolean = false
)(
timeToLive: Exit[Error, Value] => Duration
)(implicit trace: Trace): URIO[Environment, Cache[Key, Error, Value]] =
makeWithKey(capacity, lookup)(timeToLive, identity)
makeWithKey(capacity, lookup, cacheValuesOnly)(timeToLive, identity)

/**
* Constructs a new cache with the specified capacity, time to live, and
Expand All @@ -132,7 +134,8 @@ object Cache {
*/
def makeWithKey[In, Key, Environment, Error, Value](
capacity: Int,
lookup: Lookup[In, Environment, Error, Value]
lookup: Lookup[In, Environment, Error, Value],
cacheValuesOnly: Boolean = false
)(
timeToLive: Exit[Error, Value] => Duration,
keyBy: In => Key
Expand Down Expand Up @@ -267,7 +270,7 @@ object Cache {
get(in)
} else {
// Only trigger the lookup if we're still the current value, `completedResult`
lookupValueOf(in, promise).when {
lookupValueOf(in, promise, Some(completedResult)).when {
map.replace(k, completedResult, MapValue.Refreshing(promise, completedResult))
}
}
Expand All @@ -292,7 +295,11 @@ object Cache {
def size(implicit trace: Trace): UIO[Int] =
ZIO.succeed(map.size)

private def lookupValueOf(in: In, promise: Promise[Error, Value]): IO[Error, Value] =
private def lookupValueOf(
in: In,
promise: Promise[Error, Value],
rollbackResultIfError: Option[MapValue.Complete[Key, Error, Value]] = None
): IO[Error, Value] =
ZIO.suspendSucceed {
val key = keyBy(in)
lookup(in)
Expand All @@ -302,7 +309,28 @@ object Cache {
val now = Unsafe.unsafe(implicit u => clock.unsafe.instant())
val entryStats = EntryStats(now)

map.put(key, MapValue.Complete(new MapKey(key), exit, entryStats, now.plus(timeToLive(exit))))
if (!cacheValuesOnly)
map.put(
key,
MapValue.Complete(new MapKey(key), exit, entryStats, now.plus(timeToLive(exit)))
)
else {
exit match {
case Exit.Success(value) =>
map.put(
key,
MapValue.Complete(new MapKey(key), exit, entryStats, now.plus(timeToLive(exit)))
)
case Exit.Failure(cause) =>
rollbackResultIfError match {
case None =>
map.remove(key)
case Some(rollbackValue) =>
map.put(key, rollbackValue)
}
}
}

promise.done(exit) *> ZIO.done(exit)
}
.onInterrupt(promise.interrupt *> ZIO.succeed(map.remove(key)))
Expand Down
93 changes: 91 additions & 2 deletions zio-cache/shared/src/test/scala/zio/cache/CacheSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,17 @@ object CacheSpec extends ZIOSpecDefault {
_ <- cache.refresh(key)
val1 <- cache.get(key).either
_ <- cache.refresh(key)
val2 <- cache.get(key).either
failure2 <- cache.refresh(key).either
failure3 <- cache.get(key).either
_ <- cache.refresh(key)
val2 <- cache.get(key).either
val3 <- cache.get(key).either
} yield assert(failure1)(isLeft(equalTo(error))) &&
assert(failure2)(isLeft(equalTo(error))) &&
assert(failure3)(isLeft(equalTo(error))) &&
assert(val1)(isRight(equalTo(4))) &&
assert(val2)(isRight(equalTo(7)))
assert(val2)(isRight(equalTo(5))) &&
assert(val3)(isRight(equalTo(7)))
},
test("should get the value if the key doesn't exist in the cache") {
check(Gen.int) { salt =>
Expand All @@ -134,6 +138,91 @@ object CacheSpec extends ZIOSpecDefault {
}
}
),
suite("`refresh` method when storeOnlyIfValue is true")(
test("should update the cache with a new value") {
def inc(n: Int) = n * 10

def retrieve(multiplier: Ref[Int])(key: Int) =
multiplier
.updateAndGet(inc)
.map(key * _)

val seed = 1
val key = 123
for {
ref <- Ref.make(seed)
cache <- Cache.make(1, Duration.Infinity, Lookup(retrieve(ref)), cacheValuesOnly = true)
val1 <- cache.get(key)
_ <- cache.refresh(key)
_ <- cache.get(key)
val2 <- cache.get(key)
} yield assertTrue(val1 == inc(key)) && assertTrue(val2 == inc(val1))
},
test("should update the cache only if lookup return a value, not an error.") {

val error = new RuntimeException("Must be a multiple of 3")

def inc(n: Int) = n + 1

def retrieve(number: Ref[Int])(key: Int) =
number
.updateAndGet(inc)
.flatMap {
case n if n % 3 == 0 =>
ZIO.fail(error)
case n =>
ZIO.succeed(key * n)
}

val seed = 2
val key = 1
for {
ref <- Ref.make(seed)
cache <- Cache.make(1, Duration.Infinity, Lookup(retrieve(ref)), cacheValuesOnly = true)
failure1 <- cache.get(key).either
_ <- cache.refresh(key)
val1 <- cache.get(key).either
_ <- cache.refresh(key)
val2 <- cache.get(key).either
failure2 <- cache.refresh(key).either
val3 <- cache.get(key).either
_ <- cache.refresh(key)
val4 <- cache.get(key).either
} yield assert(failure1)(isLeft(equalTo(error))) &&
assert(failure2)(isLeft(equalTo(error))) &&
assert(val1)(isRight(equalTo(4))) &&
assert(val2)(isRight(equalTo(5))) &&
assert(val3)(isRight(equalTo(5))) &&
assert(val4)(isRight(equalTo(7)))
},
test("should update only if it is a value when the key doesn't exist in the cache") {

val error = new RuntimeException("Must be a multiple of 3")

def inc(n: Int) = n + 1

def retrieve(number: Ref[Int])(key: Int) =
number
.updateAndGet(inc)
.flatMap {
case n if n % 3 == 0 =>
ZIO.fail(error)
case n =>
ZIO.succeed(key * n)
}

val seed = 2
val key = 1
val cap = 30
for {
ref <- Ref.make(seed)
cache <- Cache.make(cap, Duration.Infinity, Lookup(retrieve(ref)), cacheValuesOnly = true)
count0 <- cache.size
_ <- ZIO.foreachDiscard(1 to cap)(key => cache.refresh(key).either)
count1 <- cache.size
} yield assertTrue(count0 == 0) && assertTrue(count1 == cap / 3 * 2)
}
),
test("size") {
check(Gen.int) { salt =>
for {
Expand Down