cache rewrite #11

HopeBaron · 2023-04-06T14:20:43Z

This PR is to:

Implement indexing for cache items in kord
Reflection-free implementation
Introduce a obverver-like relationship on discards instead of descriptions

lukellmann · 2023-04-14T12:27:17Z

could you provide some examples how you think this all should be used (maybe also compared to the old cache api)? that way it will be easier to review because i would know what i'm looking at and what the intention was.

HopeBaron · 2023-04-14T13:48:34Z

@lukellmann
https://gist.github.com/HopeBaron/8417dbbbfa814be381b8c8498f4ba534
Above is a full example
output:

{SnowflakeSetIndex(snowflakes=[1, 123])=MemberData(guildId=1, userId=123)}
{SnowflakeSetIndex(snowflakes=[123])=UserData(userId=123)}
{}
{}

api/src/commonMain/kotlin/dev/kord/cache/api/observables/TypedCache.kt

api/src/commonMain/kotlin/dev/kord/cache/api/observables/Relation.kt

api/src/commonMain/kotlin/dev/kord/cache/api/observables/IndexFactory.kt

lukellmann · 2023-04-15T17:39:37Z

api/src/commonMain/kotlin/dev/kord/cache/api/observables/Index.kt

@@ -0,0 +1,5 @@
+package dev.kord.cache.api.observables
+
+interface Index: Comparable<Index> {


what does this index do? why is it comparable? would something like Identifier / Id / Key be a better name?

it may be composed of mutliple craitera thus I thought Index was a good name.

lukellmann · 2023-04-15T17:45:29Z

api/src/commonMain/kotlin/dev/kord/cache/api/observables/EntryCache.kt

+/**
+ * A cache that associates a [Value] with an [Index].
+ */
+public interface EntryCache<Value : Any> {


should it be generic over the index too? if i understand this right EntryCache is a specialized Map and Index is like a key for a Value

the Entrycache doesn't have to be a map
you can implement a cache using a set data structure so it didn't make sense to provide an Index specially that "Indexing" is techincally optional and we don't really care about the key

yeah but EntryCache could still have a generic for the concrete Index type (the Index interface wouldn't even be needed then)

I've rewritten a possibly better implementation?

api/src/commonMain/kotlin/dev/kord/cache/api/observables/EntryCache.kt

lukellmann · 2023-04-15T17:58:00Z

api/src/commonMain/kotlin/dev/kord/cache/api/observables/EntryCache.kt

+     * Returns the [Relation] object for this cache, which contains information about any other
+     * caches that are observing this one.
+     */
+    public suspend fun getRelations(): Relation<Value>


what would this be used for? Relation just has discard and to, both can be done from EntryCache too

lukellmann · 2023-04-15T17:58:53Z

api/src/commonMain/kotlin/dev/kord/cache/api/observables/EntryCache.kt

+    /**
+     * Returns a defensive copy of the cache entries as a [Map] of [Index] to [Value].
+     */
+    public suspend fun asMap(): Map<Index, Value>


so it gives a copied snapshot? what would we use this for?

it should give a non-mutable type; I think returning the underlaying type is moer optimal than to copy the whole cache over.

api/src/commonMain/kotlin/dev/kord/cache/api/observables/DataCache.kt

lukellmann · 2023-04-16T18:03:33Z

api/src/commonMain/kotlin/dev/kord/cache/api/observables/Cache.kt

+    /**
+     * Removes any cached value [T] that satisfies the given [transform] function.
+     * @param transform A function that takes a value of type [T] and returns a boolean.
+     */


this is now in the wrong place, should be above removeIf

lukellmann · 2023-04-16T18:04:36Z

api/src/commonMain/kotlin/dev/kord/cache/api/observables/Cache.kt

+    public suspend fun firstOrNull(transform: (T) -> Boolean): T?
+
+
+    public suspend fun removeIf(transform: (T) -> Boolean)


Suggested change

public suspend fun firstOrNull(transform: (T) -> Boolean): T?

public suspend fun removeIf(transform: (T) -> Boolean)

public suspend fun firstOrNull(predicate: (T) -> Boolean): T?

public suspend fun removeIf(predicate: (T) -> Boolean)

i think predicate is a better name and also commonly used in e.g. stdlib

api/src/commonMain/kotlin/dev/kord/cache/api/observables/Cache.kt

api/src/commonMain/kotlin/dev/kord/cache/api/observables/EntryCache.kt

api/src/commonMain/kotlin/dev/kord/cache/api/observables/MapEntryCache.kt

lukellmann · 2023-04-16T18:10:17Z

api/src/commonMain/kotlin/dev/kord/cache/api/observables/Relation.kt

+ *
+ * @param T the type of the first entity in the relation.
+ */
+public interface Relation<T: Any> {


does this need to be a public interface now? it's no longer exposed by the other public interfaces so it could now just be an implementation detail

It may be provided to customize the deletion process.
I've already added it to the implementation
What do you suggest we do with this one?

lukellmann

i think it would be a good idea to try using this rewrite in a new branch of the kord repo (using maven local for cache builds). that way we'll see whether some operations we require are still missing and how this new api would by used

lukellmann · 2023-04-17T00:26:37Z

api/src/commonMain/kotlin/dev/kord/cache/api/observables/DataCache.kt

+    /**
+     * Returns the value associated with the given [key] in the cache, or null if no such entry exists.
+     */
+    suspend fun get(key: Key): Value?


Suggested change

suspend fun get(key: Key): Value?

suspend operator fun get(key: Key): Value?

lukellmann · 2023-04-17T00:27:26Z

api/src/commonMain/kotlin/dev/kord/cache/api/observables/DataCache.kt

+/**
+ * A cache for a map of entries where each [Value] is associated with a unique [Key].
+ * */
+interface DataCache<Key : Any, Value : Any> {


could Cache be a better name? it seems obvious that it caches data

lukellmann · 2023-04-17T00:30:00Z

api/src/commonMain/kotlin/dev/kord/cache/api/observables/DataCache.kt

+    /**
+     * Returns a [Map] containing all entries in the cache.
+     */
+    suspend fun getAll(): Map<Key, Value>


hm, i'm not sure if we really need this

lukellmann · 2023-04-17T00:33:03Z

api/src/commonMain/kotlin/dev/kord/cache/api/observables/DataCache.kt

+/**
+ * A cache for a map of entries where each [Value] is associated with a unique [Key].
+ * */
+interface DataCache<Key : Any, Value : Any> {


a function that's still missing is something that can return multiple values, i suggest a signature like:

fun filter(predicate: (Value) -> Boolean): Flow<Value>

lukellmann · 2023-04-17T00:41:07Z

api/src/commonMain/kotlin/dev/kord/cache/api/observables/DataCache.kt

+     * @param key The key to associate the [value] with.
+     * @param value The value to be cached.
+     */
+    public suspend fun put(key: Key, value: Value)


Suggested change

public suspend fun put(key: Key, value: Value)

public suspend operator fun set(key: Key, value: Value)

lukellmann · 2023-04-17T10:45:03Z

what i just realized is a problem with Cache.filter and Cache.firstOrNull: these will always have O(n) complexity because all objects have to be accessed to be filtered.

HopeBaron · 2023-04-17T11:12:18Z

Yeah but the implementation doesn't specify a Key no more
if you are looking for something you can identify you can easily add that sort of data to your key.
Create a key out of it, and get it.

This will allow us to perform intermediate sort operations

cache rewrite? [Needs folder restructure]

1f38c59

HopeBaron changed the title ~~cache rewrite? [Needs folder restructure]~~ cache rewrite Apr 6, 2023

HopeBaron requested review from DRSchlaubi and lukellmann April 6, 2023 14:21

HopeBaron added 3 commits April 6, 2023 23:37

yeet these suspends

92006dd

Add implementations

aeee531

Stately Concurrent Map

01d98ad

optimizations

e5672d6

remove old discard logic

6b704e0

lukellmann reviewed Apr 15, 2023

View reviewed changes

HopeBaron added 2 commits April 16, 2023 00:20

apply factory and discard -> remove changes

4d569b2

rename get and remove toMap call

c648eb5

lukellmann reviewed Apr 15, 2023

View reviewed changes

api/src/commonMain/kotlin/dev/kord/cache/api/observables/DataCache.kt Outdated Show resolved Hide resolved

restructure cache interfaces

dbe4d50

lukellmann reviewed Apr 16, 2023

View reviewed changes

what about this?

e58e3a7

lukellmann reviewed Apr 17, 2023

View reviewed changes

changes

c65823a

HopeBaron added 3 commits April 17, 2023 16:52

no intermediate collections please.

ad761b5

Sequence Instead of Flow

828be4c

This will allow us to perform intermediate sort operations

why call entries?

5187036

		@@ -0,0 +1,5 @@
		package dev.kord.cache.api.observables

		interface Index: Comparable<Index> {

		public suspend fun firstOrNull(transform: (T) -> Boolean): T?


		public suspend fun removeIf(transform: (T) -> Boolean)

	suspend fun get(key: Key): Value?
	suspend operator fun get(key: Key): Value?

	public suspend fun put(key: Key, value: Value)
	public suspend operator fun set(key: Key, value: Value)

Uh oh!

cache rewrite #11

Are you sure you want to change the base?

cache rewrite #11

Uh oh!

Conversation

HopeBaron commented Apr 6, 2023

Uh oh!

lukellmann commented Apr 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

HopeBaron commented Apr 14, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukellmann left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukellmann commented Apr 17, 2023

Uh oh!

HopeBaron commented Apr 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lukellmann commented Apr 14, 2023 •

edited

Loading