Skip to content

docs: deduplicate callKey KDoc across the context promotion chain #126

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

Merged
OmarAlJarrah merged 1 commit into from
Jun 16, 2026
Merged

docs: deduplicate callKey KDoc across the context promotion chain #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions sdk-core/src/main/kotlin/org/dexpace/sdk/core/http/context/ExchangeContext.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ import org.dexpace.sdk.core.instrumentation.InstrumentationContext
*
* As the terminal link this is the context whose [close] should be called to evict the
* chain's [ContextStore] entry. In the normal flow the [callKey] is supplied by
* [RequestContext.toExchangeContext]. When this context is constructed directly off-chain, the
* [callKey] defaults to a freshly minted, call-unique key (`traceId:spanId:n`) — the same
* collision-safe derivation [DispatchContext] uses — so two directly-constructed contexts that
* share a trace/span id never collide in [ContextStore]. Two such default-constructed instances
* are therefore not structurally equal; pin an explicit [callKey] if you need equality.
* [RequestContext.toExchangeContext]. When this context is constructed directly off-chain it
* defaults to a freshly minted, call-unique key (`traceId:spanId:n`) via
* [DispatchContext.mintCallKey] — see [DispatchContext] for why the trace/span pair alone is not
* a collision-safe store key. One consequence of the minted default: two default-constructed
* instances are not structurally equal, since each mints a distinct key — pin an explicit
* [callKey] if you need equality.
*/
public data class ExchangeContext(
override val instrumentationContext: InstrumentationContext,
Expand Down
11 changes: 6 additions & 5 deletions sdk-core/src/main/kotlin/org/dexpace/sdk/core/http/context/RequestContext.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,12 @@ import org.dexpace.sdk.core.instrumentation.InstrumentationContext
* [DispatchContext] it was promoted from.
*
* In the normal flow the [callKey] is supplied by [DispatchContext.toRequestContext] so the
* whole chain shares one store slot. When this context is constructed directly off-chain, the
* [callKey] defaults to a freshly minted, call-unique key (`traceId:spanId:n`) — the same
* collision-safe derivation [DispatchContext] uses — so two directly-constructed contexts that
* share a trace/span id never collide in [ContextStore]. Two such default-constructed instances
* are therefore not structurally equal; pin an explicit [callKey] if you need equality.
* whole chain shares one store slot. When this context is constructed directly off-chain it
* defaults to a freshly minted, call-unique key (`traceId:spanId:n`) via
* [DispatchContext.mintCallKey] — see [DispatchContext] for why the trace/span pair alone is not
* a collision-safe store key. One consequence of the minted default: two default-constructed
* instances are not structurally equal, since each mints a distinct key — pin an explicit
* [callKey] if you need equality.
*/
public data class RequestContext(
override val instrumentationContext: InstrumentationContext,
Expand Down
Loading