Logging Metadata #52
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| package com.juul.tuulbox.logging | ||
|
|
||
| /** | ||
| * Marker interface to strongly type metadata with its key. Proper usage is | ||
| * to create `object`s or `enum class`es when implementing this type. | ||
| */ | ||
| public interface Key<T : Any> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| package com.juul.tuulbox.logging | ||
|
|
||
| internal class Metadata : ReadMetadata, WriteMetadata { | ||
| private val storedData = mutableMapOf<Key<*>, Any>() | ||
|
|
||
| @Suppress("UNCHECKED_CAST") | ||
| public override operator fun <T : Any> get(key: Key<T>): T? = | ||
| storedData[key] as? T | ||
|
|
||
| public override operator fun <T : Any> set(key: Key<T>, value: T) { | ||
| storedData[key] = value | ||
| } | ||
|
|
||
| public override fun copy(): Metadata = Metadata().also { copy -> | ||
| copy.storedData += this.storedData | ||
| } | ||
|
|
||
| internal fun clear() { | ||
| storedData.clear() | ||
| } | ||
|
|
||
| override fun equals(other: Any?): Boolean = other is Metadata && storedData == other.storedData | ||
| override fun hashCode(): Int = storedData.hashCode() | ||
| } | ||
|
|
||
| /** | ||
| * Additional data associated with a log. It's important that [Logger] instances do NOT hold onto references | ||
| * to [ReadMetadata] arguments after the function returns. If a [ReadMetadata] reference must be kept after | ||
| * function return, create a [copy]. | ||
| */ | ||
| public interface ReadMetadata { | ||
| public operator fun <T : Any> get(key: Key<T>): T? | ||
| public fun copy(): ReadMetadata | ||
| } | ||
|
|
||
| /** | ||
| * Additional data associated with a log. It's important that [Log] calls do NOT hold onto references | ||
| * to [WriteMetadata] arguments after the lambda returns. | ||
| */ | ||
| public interface WriteMetadata { | ||
| public operator fun <T : Any> set(key: Key<T>, value: T) | ||
| } |
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,19 @@ | ||
| package com.juul.tuulbox.logging | ||
|
|
||
| import kotlinx.atomicfu.locks.reentrantLock | ||
| import kotlinx.atomicfu.locks.withLock | ||
|
|
||
| /** While a [Pool] is logically thread safe, Kotlin/Native's memory model requires @ThreadLocal on instances of this. */ | ||
| internal class Pool<T>( | ||
| private val factory: () -> T, | ||
| private val refurbish: (T) -> Unit, | ||
| ) { | ||
| private val lock = reentrantLock() | ||
| private val cache = ArrayDeque<T>() | ||
|
There was a problem hiding this comment. Does the queue (as apposed to an There was a problem hiding this comment. Re. Re.
The solution here, albeit ugly, should be fast on every platform. Effectively...
There was a problem hiding this comment. Thanks for the incredibly thorough explanation. Super clever approach with the There was a problem hiding this comment. And yet, somehow, despite writing a small essay, I managed to miss the original question. It should be safe to nest log calls, both inside a |
||
|
|
||
| fun borrow(): T = lock.withLock { cache.removeLastOrNull() } ?: factory() | ||
| fun recycle(value: T) { | ||
| refurbish(value) | ||
| lock.withLock { cache.addLast(value) } | ||
| } | ||
| } | ||
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TIL of
::<class_name>constructor syntax, so cool!