commonMain.com.apollographql.execution.internal.LruCache.kt Maven / Gradle / Ivy

Go to download
package com.apollographql.execution.internal

import com.apollographql.execution.Weigher

/**
 * Multiplatform LRU cache implementation.
 *
 * Implementation is based on usage of [LinkedHashMap] as a container for the cache and custom
 * double linked queue to track LRU property.
 *
 * [maxSize] - maximum size of the cache, can be anything bytes, number of entries etc. By default is number o entries.
 * [weigher] - to be called to calculate the estimated size (weight) of the cache entry defined by its [Key] and [Value].
 *             By default it returns 1.
 *
 * Cache trim performed only on new entry insertion.
 */
internal class LruCache(
    private val maxSize: Int,
    private val weigher: Weigher = { _, _ -> 1 },
) {
    private val cache = LinkedHashMap>(0, 0.75f)
    private var headNode: Node? = null
    private var tailNode: Node? = null
    private var size: Int = 0

    operator fun get(key: Key): Value? {
        val node = cache[key]
        if (node != null) {
            moveNodeToHead(node)
        }
        return node?.value
    }

    operator fun set(key: Key, value: Value) {
        val node = cache[key]
        if (node == null) {
            cache[key] = addNode(key, value)
        } else {
            node.value = value
            moveNodeToHead(node)
        }

        trim()
    }

    fun remove(key: Key): Value? {
        return removeUnsafe(key)
    }

    fun keys() = cache.keys

    private fun removeUnsafe(key: Key): Value? {
        val nodeToRemove = cache.remove(key)
        val value = nodeToRemove?.value
        if (nodeToRemove != null) {
            unlinkNode(nodeToRemove)
        }
        return value
    }

    fun remove(keys: Collection) {
        keys.forEach { key -> removeUnsafe(key) }
    }

    fun clear() {
        cache.clear()
        headNode = null
        tailNode = null
        size = 0
    }

    fun size(): Int {
        return size
    }

    fun dump(): Map {
        return cache.mapValues { (_, value) ->
            @Suppress("UNCHECKED_CAST")
            value.value as Value
        }
    }

    private fun trim() {
        var nodeToRemove = tailNode
        while (nodeToRemove != null && size > maxSize) {
            cache.remove(nodeToRemove.key)
            unlinkNode(nodeToRemove)
            nodeToRemove = tailNode
        }
    }

    private fun addNode(key: Key, value: Value?): Node {
        val node = Node(
            key = key,
            value = value,
            next = headNode,
            prev = null,
        )

        headNode = node

        if (node.next == null) {
            tailNode = headNode
        } else {
            node.next?.prev = headNode
        }

        size += weigher(key, value)

        return node
    }

    private fun moveNodeToHead(node: Node) {
        if (node.prev == null) {
            return
        }

        node.prev?.next = node.next

        if (node.next == null) {
            tailNode = node.prev
        } else {
            node.next?.prev = node.prev
        }

        node.next = headNode
        node.prev = null

        headNode?.prev = node
        headNode = node
    }

    private fun unlinkNode(node: Node) {
        if (node.prev == null) {
            this.headNode = node.next
        } else {
            node.prev?.next = node.next
        }

        if (node.next == null) {
            this.tailNode = node.prev
        } else {
            node.next?.prev = node.prev
        }

        size -= weigher(node.key!!, node.value)

        node.key = null
        node.value = null
        node.next = null
        node.prev = null
    }

    private class Node(
        var key: Key?,
        var value: Value?,
        var next: Node?,
        var prev: Node?,
    )
}