-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve Tower client caching via Tiered cache (#772)
Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com> Signed-off-by: munishchouhan <hrma017@gmail.com> Co-authored-by: munishchouhan <hrma017@gmail.com>
- Loading branch information
1 parent
13a5937
commit f0ca0f6
Showing
32 changed files
with
1,101 additions
and
118 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 27 additions & 0 deletions
27
src/main/groovy/io/seqera/wave/encoder/MoshiExchange.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| * Wave, containers provisioning service | ||
| * Copyright (c) 2023-2024, Seqera Labs | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package io.seqera.wave.encoder | ||
|
|
||
| /** | ||
| * Marker interface for Moshi encoded exchange objects | ||
| * | ||
| * @author Paolo Di Tommaso <paolo.ditommaso@gmail.com> | ||
| */ | ||
| interface MoshiExchange { | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
180 changes: 180 additions & 0 deletions
180
src/main/groovy/io/seqera/wave/store/cache/AbstractTieredCache.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| /* | ||
| * Wave, containers provisioning service | ||
| * Copyright (c) 2023-2024, Seqera Labs | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package io.seqera.wave.store.cache | ||
|
|
||
| import java.time.Duration | ||
| import java.util.concurrent.TimeUnit | ||
| import java.util.concurrent.locks.Lock | ||
| import java.util.concurrent.locks.ReentrantLock | ||
| import java.util.function.Function | ||
|
|
||
| import com.github.benmanes.caffeine.cache.AsyncCache | ||
| import com.github.benmanes.caffeine.cache.Caffeine | ||
| import com.github.benmanes.caffeine.cache.RemovalCause | ||
| import com.github.benmanes.caffeine.cache.RemovalListener | ||
| import groovy.transform.Canonical | ||
| import groovy.transform.CompileStatic | ||
| import groovy.util.logging.Slf4j | ||
| import io.seqera.wave.encoder.EncodingStrategy | ||
| import io.seqera.wave.encoder.MoshiEncodeStrategy | ||
| import io.seqera.wave.encoder.MoshiExchange | ||
| import org.jetbrains.annotations.Nullable | ||
| /** | ||
| * Implement a tiered-cache mechanism using a local caffeine cache as 1st level access | ||
| * and a 2nd-level cache backed on Redis. | ||
| * | ||
| * This allow the use in distributed deployment. Note however strong consistently is not guaranteed. | ||
| * | ||
| * @author Paolo Di Tommaso <paolo.ditommaso@gmail.com> | ||
| */ | ||
| @Slf4j | ||
| @CompileStatic | ||
| abstract class AbstractTieredCache<V extends MoshiExchange> implements TieredCache<String,V> { | ||
|
|
||
| @Canonical | ||
| static class Entry implements MoshiExchange { | ||
| MoshiExchange value | ||
| long expiresAt | ||
| } | ||
|
|
||
| private EncodingStrategy<Entry> encoder | ||
|
|
||
| // FIXME https://github.com/seqeralabs/wave/issues/747 | ||
| private AsyncCache<String,V> l1 | ||
|
|
||
| private final Duration ttl | ||
|
|
||
| private L2TieredCache<String,String> l2 | ||
|
|
||
| private final Lock sync = new ReentrantLock() | ||
|
|
||
| AbstractTieredCache(L2TieredCache<String,String> l2, MoshiEncodeStrategy encoder, Duration duration, long maxSize) { | ||
| log.info "Cache '${getName()}' config - prefix=${getPrefix()}; ttl=${duration}; max-size: ${maxSize}; l2=${l2}" | ||
| this.l2 = l2 | ||
| this.ttl = duration | ||
| this.encoder = encoder | ||
| this.l1 = Caffeine.newBuilder() | ||
| .expireAfterWrite(duration.toMillis(), TimeUnit.MILLISECONDS) | ||
| .maximumSize(maxSize) | ||
| .removalListener(removalListener0()) | ||
| .buildAsync() | ||
| } | ||
|
|
||
| abstract protected getName() | ||
|
|
||
| abstract protected String getPrefix() | ||
|
|
||
| private RemovalListener removalListener0() { | ||
| new RemovalListener() { | ||
| @Override | ||
| void onRemoval(@Nullable key, @Nullable value, RemovalCause cause) { | ||
| log.trace "Cache '${name}' removing key=$key; value=$value; cause=$cause" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| V get(String key) { | ||
| getOrCompute(key, null) | ||
| } | ||
|
|
||
| V getOrCompute(String key, Function<String,V> loader) { | ||
| log.trace "Cache '${name}' checking key=$key" | ||
| // Try L1 cache first | ||
| V value = l1.synchronous().getIfPresent(key) | ||
| if (value != null) { | ||
| log.trace "Cache '${name}' L1 hit (a) - key=$key => value=$value" | ||
| return value | ||
| } | ||
|
|
||
| sync.lock() | ||
| try { | ||
| value = l1.synchronous().getIfPresent(key) | ||
| if (value != null) { | ||
| log.trace "Cache '${name}' L1 hit (b) - key=$key => value=$value" | ||
| return value | ||
| } | ||
|
|
||
| // Fallback to L2 cache | ||
| value = l2Get(key) | ||
| if (value != null) { | ||
| log.trace "Cache '${name}' L2 hit - key=$key => value=$value" | ||
| // Rehydrate L1 cache | ||
| l1.synchronous().put(key, value) | ||
| return value | ||
| } | ||
|
|
||
| // still not value found, use loader function to fetch the value | ||
| if( value==null && loader!=null ) { | ||
| log.trace "Cache '${name}' invoking loader - key=$key" | ||
| value = loader.apply(key) | ||
| if( value!=null ) { | ||
| l1.synchronous().put(key,value) | ||
| l2Put(key,value) | ||
| } | ||
| } | ||
|
|
||
| log.trace "Cache '${name}' missing value - key=$key => value=${value}" | ||
| // finally return the value | ||
| return value | ||
| } | ||
| finally { | ||
| sync.unlock() | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| void put(String key, V value) { | ||
| assert key!=null, "Cache key argument cannot be null" | ||
| assert value!=null, "Cache value argument cannot be null" | ||
| log.trace "Cache '${name}' putting - key=$key; value=${value}" | ||
| l1.synchronous().put(key, value) | ||
| l2Put(key, value) | ||
| } | ||
|
|
||
| protected String key0(String k) { return getPrefix() + ':' + k } | ||
|
|
||
| protected V l2Get(String key) { | ||
| if( l2 == null ) | ||
| return null | ||
|
|
||
| final raw = l2.get(key0(key)) | ||
| if( raw == null ) | ||
| return null | ||
|
|
||
| final Entry payload = encoder.decode(raw) | ||
| if( System.currentTimeMillis() > payload.expiresAt ) { | ||
| log.trace "Cache '${name}' L2 exipired - key=$key => value=${payload.value}" | ||
| return null | ||
| } | ||
| return (V) payload.value | ||
| } | ||
|
|
||
| protected void l2Put(String key, V value) { | ||
| if( l2 != null ) { | ||
| final raw = encoder.encode(new Entry(value, ttl.toMillis() + System.currentTimeMillis())) | ||
| l2.put(key0(key), raw, ttl) | ||
| } | ||
| } | ||
|
|
||
| void invalidateAll() { | ||
| l1.synchronous().invalidateAll() | ||
| } | ||
|
|
||
| } |
41 changes: 41 additions & 0 deletions
41
src/main/groovy/io/seqera/wave/store/cache/L2TieredCache.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /* | ||
| * Wave, containers provisioning service | ||
| * Copyright (c) 2023-2024, Seqera Labs | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package io.seqera.wave.store.cache | ||
|
|
||
| import java.time.Duration | ||
|
|
||
| /** | ||
| * Define the interface for 2nd level tired cache | ||
| * | ||
| * @author Paolo Di Tommaso <paolo.ditommaso@gmail.com> | ||
| */ | ||
| interface L2TieredCache<K,V> extends TieredCache<K,V> { | ||
|
|
||
|
|
||
| /** | ||
| * Add a value in the cache with the specified key. If a value already exists is overridden | ||
| * with the new value. | ||
| * | ||
| * @param key The key of the value to be added. {@code null} is not allowed. | ||
| * @param value The value to be added in the cache for the specified key. {@code null} is not allowed. | ||
| * @param ttl The value time-to-live, after which the value is automatically evicted. | ||
| */ | ||
| void put(K key, V value, Duration ttl) | ||
|
|
||
| } |
Oops, something went wrong.