Files

8.8 KiB

description, kind
description kind
Anonymous per-harness-home identity for users and maintainers tracing how telemetry, feedback acknowledgement, and DeepSeek provider requests correlate records. package-library

@deepseek-ai/dsh-anonymous-user-id

English | 中文

Summary

Every harness home gets one anonymous id that telemetry, feedback, and DeepSeek requests attach to their records, so receiving systems can tell that records came from the same installation without learning who the user is. The id is a random UUID stored in $DSH_HOME/.anonymous-user-id (~/.dsh by default); it appears automatically the first time one of those features runs, stays stable across restarts, and is created fresh if you delete the file. Separate harness homes never share an id, and no machine or account detail goes into it. Use it whenever you want to correlate records from one installation without an account; it cannot join records across different homes.

Table of Contents


Use this package

When you want the records your installation sends out to be recognizable as coming from the same harness home — telemetry, feedback, and DeepSeek requests all carry one shared id — this package is what provides it. There is nothing to install or configure: the id appears automatically, and the shipped feedback, telemetry, and DeepSeek features already use it. Do not use it to identify a user or to join records across different homes; it is anonymous and home-scoped.

What the id does for you

Three things your installation sends out carry the same id, so records line up across all of them:

  • Session telemetry — your telemetry exports carry the id as the user.id resource attribute, so a collector can group an installation's records.
  • Feedback — each feedback acknowledgement names the anonymous installation that recorded it.
  • DeepSeek requests — every provider request carries the x-deepseek-harness-user-id header, so usage can be attributed per installation.

Observing and resetting the id

The id lives in $DSH_HOME/.anonymous-user-id (~/.dsh by default) as a plain UUID text file. Delete that file to get a fresh id at the next launch; the running process keeps its current id until it exits. Separate harness homes keep separate ids, and no machine or account detail ever goes into the value.

Using it in your own package

When you build a feature that should share the installation's anonymous id, import the value once and reuse it — telemetry, feedback, and DeepSeek already use the same id, so your records line up with theirs:

import { getOrCreateAnonymousUserId } from '@deepseek-ai/dsh-anonymous-user-id'

const userId = getOrCreateAnonymousUserId() // stable for the process lifetime

The value is stable for the process and matches what the built-in features use; it changes only when the file is deleted and a later launch mints a replacement. Even when the home directory cannot be written, the value still works for the current run, so records keep flowing.


Understand the implementation

Implementation internals — click to expand

This section explains the design decisions behind the package and points at the code that realizes them; the observable behavior is fully covered in Use this package.

Design philosophy

  • Random, never derived. The id comes from crypto.randomUUID(); it is never derived from the hostname, network address, git remote, or any other identifying source, so anonymity is a property of the mint.
  • Synchronous and memoized. One process touches the disk once: reads and writes are synchronous, and the result is memoized per resolved file path.
  • Best-effort persistence. A write failure still returns a usable id for the run, so telemetry and feedback never block on an unwritable home.
  • Library, not plugin. There is no Cordis plugin entry or config; the invariant companion installs an empty installer because the package owns no event stream or public mutable relation to compare without creating the id as a side effect.

Source map

File Role
src/index.ts Library entry: getOrCreateAnonymousUserId, file persistence, per-path memoization
src/invariant.ts Invariant companion with an empty installer (no runtime invariant; the only relation is private and side-effecting)
tests/anonymous-user-id.spec.ts Exercised behavior: mint, persistence, corruption, concurrency, memoization
tests/invariant.spec.ts Companion registration through the invariants service

The API

The package exposes one function that returns the installation's anonymous id, minting and persisting it on first use; the exact signature, options, and defaults live in src/index.ts.

Storage contract

The file is a bare UUID line named by ANONYMOUS_USER_ID_FILE_NAME, validated against a UUID pattern on read. A first writer uses exclusive creation (wx); a concurrent loser rereads and adopts the winner's value. A corrupt or unreadable file falls through to mint-and-overwrite. Memoization is keyed by resolved file path, so distinct homes never share an id.


Further Exploration

Read these pages when the package-level contract is not enough. They move from the identity group map to the home-path resolution this package builds on and the features that use the id.


Model Experience

None, as the shared identifier reaches DeepSeek only as model-hidden HTTP metadata and registers nothing model-facing.

KV Cache effect

None; the transport header changes neither tokens nor the model-visible prefix.

Known Limitations and Deferred Work

These limits describe when the id is a poor fit or needs special attention. They are current package constraints, not a general comparison of anonymity approaches or a task backlog.

  • No recovery after deletion — losing the file mints a new anonymous identity by design; recovery would require stable derivation material that weakens anonymity.
  • Best-effort concurrency — a reader landing in the narrow interval between a concurrent process's exclusive create and completed write can use a different in-memory UUID for that run; later launches converge on the persisted value.
  • No cross-home identity — different $DSH_HOME values cannot be correlated.
  • Configured DeepSeek gateways receive the iddsh-llm-deepseek sends the stable header to its resolved baseURL, including deployment overrides, independently of telemetry sharing mode.
  • Deleting the file does not reset the current process — memoization keeps the run's id until the next launch.

Dev Note

Working context for maintainers — click to expand

This Dev Note is working context for maintainers: open questions and directions that are not decided. It is explicitly non-authoritative — shipped behavior, limits, and accepted rationale live in the sections above and the package code, and conclusions migrate there once they stabilize.

Open: file-format evolution

The persistence contract is a bare UUID line with no version marker. Adding a second value beside the id, or wrapping the line in a container, has no migration story for existing files; a versioned line format is one way to make such a change safe.

Open: invariant coverage

The invariant companion registers an empty installer because no relation can be checked without creating the id as a side effect. A future invariant could compare a re-read of the persisted file against the memoized id at a safe observation point.