xinmi/internal/types/const.go

package types

// ContextKey defines a type for context keys to avoid string collision
type ContextKey string

const (
	// TenantIDContextKey is the context key for tenant ID
	TenantIDContextKey ContextKey = "TenantID"
	// TenantInfoContextKey is the context key for tenant information
	TenantInfoContextKey ContextKey = "TenantInfo"
	// RequestIDContextKey is the context key for request ID
	RequestIDContextKey ContextKey = "RequestID"
	// LoggerContextKey is the context key for logger
	LoggerContextKey ContextKey = "Logger"
	// UserContextKey is the context key for user information
	UserContextKey ContextKey = "User"
	// UserIDContextKey is the context key for user ID
	UserIDContextKey ContextKey = "UserID"
	// PrincipalContextKey is the context key for the terminal caller principal.
	PrincipalContextKey ContextKey = "Principal"
	// TenantAPIKeyScopeContextKey carries per-API-key operation and KB scopes.
	TenantAPIKeyScopeContextKey ContextKey = "TenantAPIKeyScope"
	// AccessPolicySnapshotContextKey carries workspace module and resource restrictions.
	AccessPolicySnapshotContextKey ContextKey = "AccessPolicySnapshot"
	// TenantRoleContextKey is the context key for the caller's TenantRole
	// in the currently active tenant (loaded by the auth middleware from
	// the tenant_members table). See TenantRoleFromContext.
	TenantRoleContextKey ContextKey = "TenantRole"
	// SessionTenantIDContextKey is the context key for session owner's tenant ID.
	// When set (e.g. in pipeline with shared agent), session/message lookups use this instead of TenantIDContextKey.
	SessionTenantIDContextKey ContextKey = "SessionTenantID"
	// SessionIDContextKey carries the current session ID through the chat pipeline
	// so that stateful sandbox backends (notably CubeSandbox) can route script
	// execution to the persistent, per-session MicroVM instance.
	SessionIDContextKey ContextKey = "SessionID"
	// SandboxTenantIDContextKey carries the tenant that owns the session whose
	// sandbox is being addressed, which is NOT always the tenant in
	// TenantIDContextKey: a shared agent runs under the agent owner's tenant so
	// that models/KBs/named sandbox configs resolve in the sharing workspace.
	//
	// The session→sandbox binding must stay keyed by the session owner instead,
	// because session deletion tears the sandbox down from a plain HTTP request
	// that only ever knows the session's own tenant. Keying the binding on the
	// borrowed tenant would leave that teardown looking up a key nobody wrote,
	// abandoning a paused MicroVM that keeps billing. It is deliberately a
	// distinct key from SessionTenantIDContextKey, which also re-scopes
	// session/message repository lookups. See SandboxTenantIDFromContext.
	SandboxTenantIDContextKey ContextKey = "SandboxTenantID"
	// EmbedQueryContextKey is the context key for embedding query text
	EmbedQueryContextKey ContextKey = "EmbedQuery"
	// WikiEditSourceContextKey carries who is authoring the current wiki
	// page write (user / agent / revert). Absent means the wiki ingest
	// pipeline. See types.WithWikiEditSource.
	WikiEditSourceContextKey ContextKey = "WikiEditSource"
	// LanguageContextKey is the context key for user language preference (e.g. "zh-CN", "en-US")
	LanguageContextKey ContextKey = "Language"
	// EmbedVisitorContextKey is the anonymous visitor id for embed OAuth isolation.
	EmbedVisitorContextKey ContextKey = "EmbedVisitorID"
	// EmbedChannelContextKey stores the authenticated embed channel (an
	// *EmbedChannel) on the request context. Declared here rather than in the
	// middleware that authenticates it, for the same reason as
	// LangfuseTraceContextKey: the clone table in context_clone.go has to name
	// every context key, and middleware imports this package, so a key
	// declared there could only be referred to by its raw string value.
	EmbedChannelContextKey ContextKey = "EmbedChannel"
	// LangfuseTraceContextKey carries the active Langfuse *Trace across the
	// request lifecycle. Defined here (not inside the langfuse package) so
	// that logger.CloneContext can preserve it without importing langfuse.
	LangfuseTraceContextKey ContextKey = "LangfuseTrace"
	// SystemAdminContextKey is the context key indicating whether the user is a system administrator
	SystemAdminContextKey ContextKey = "SystemAdmin"
	// BackgroundTaskContextKey marks a context whose model calls originate from
	// an asynq background worker (document parse / summary / question / graph /
	// multimodal enrichment) rather than a user-facing HTTP request. The chat
	// concurrency governor uses this to throttle only background LLM traffic,
	// leaving interactive chat latency untouched. See WithBackgroundTask.
	BackgroundTaskContextKey ContextKey = "BackgroundTask"
	// LLMCallPurposeContextKey labels the product-level reason for a model
	// request (for example agent_round or wiki_page_modify).
	LLMCallPurposeContextKey ContextKey = "LLMCallPurpose"
	// LLMPromptPrefixFingerprintContextKey carries a non-sensitive hash of the
	// intended reusable prompt prefix for cache diagnostics.
	LLMPromptPrefixFingerprintContextKey ContextKey = "LLMPromptPrefixFingerprint"
	// MCPOAuthNonInteractiveContextKey marks a request whose channel cannot
	// resolve an in-conversation MCP OAuth prompt (e.g. an IM bot: there is no
	// live client to click "Authorize" and call the resolve endpoint). When set,
	// the agent emits a one-shot authorization notice and continues instead of
	// blocking until the OAuth wait times out. See IsMCPOAuthNonInteractive.
	MCPOAuthNonInteractiveContextKey ContextKey = "MCPOAuthNonInteractive"
	// ChatParserEngineContextKey carries the resolved parser engine
	// from the agent's ChatParserEngineRules for chat attachment processing.
	ChatParserEngineContextKey ContextKey = "ChatParserEngine"
)

// String returns the string representation of the context key
func (c ContextKey) String() string {
	return string(c)
}