Skip to content

fix(transport): mint an eventId the caller did not supply - #9

Merged
zaytcevcom merged 1 commit into
mainfrom
fix/ensure-event-id
Sep 17, 2026
Merged

zaytcevcom merged 1 commit into
mainfrom
fix/ensure-event-id

Conversation

@zaytcevcom

Copy link
Copy Markdown
Contributor

Зачем

Ingest дедуплицирует событие по eventId — первичный ключ и ON CONFLICT DO NOTHING, без TTL. Но поле необязательно: если payload приходит без него, сервер чеканит свежий id на каждый запрос, и ретрай сохраняет событие дважды. То есть гарантия, на которую опирается только что сведённая политика ретраев, держалась на вызывающем.

finalizeIngestEvent закрывает конвейер DuckBugProvider, но мимо него проходят три живых пути:

  1. прямой вызов сервиса;
  2. sendLog(event, { skipPrivacyPipeline: true }) — им пользуется сам DuckSDK;
  3. beforeSend-хук, вернувший событие без поля.

Где вставлено

sendLog и sendError — choke point транспорта. Ниже вставлять бессмысленно: в postJsonWithRetry приходит уже либо один item, либо массив батча.

Существующий eventId не перезаписывается, заменяется только пустой.

Правка теста, о которой надо сказать прямо

Четыре существующих теста утверждали, что тело запроса равно ровно тому объекту, что дал вызывающий. Это фиксировало баг: любое место вставки id меняет тело. Теперь сравнение идёт с полями вызывающего плюс eventId, то есть собственные данные вызывающего по-прежнему проверяются точно.

Красный до правки

bun test tests/DuckBug/DuckBugService.test.ts   → exit 1
10 pass, 3 fail
  mints a uuid4 eventId for a log sent without one
  mints a uuid4 eventId for an error sent without one
  mints a distinct eventId per batched event
  → Received value must be a string: undefined

Формат проверяется не на глаз: тесты матчат значение регуляркой серверного правила uuid4 (строчные, версия 4, вариант RFC), плюс закреплено, что два подряд события получают разные id.

Что стоит знать

ensureEventId бросает, если в рантайме нет crypto.randomUUID. Раньше это могло прилететь только на пути finalizeIngestEvent, теперь — и на skipPrivacyPipeline. Поведение оставлено: тихо ронять id в трекере ошибок хуже. Но это расширение зоны броска, и если нужна мягкая деградация — решать надо сразу для трёх SDK, а не здесь.

Граница гарантии: она стоит до транспорта. Прямой вызов HTTPTransport.Send в обход провайдера по-прежнему не защищён, и это правильная граница — транспорт не должен править данные события.

Гейты

lint (biome ci, 84 файла) → 0 · typecheck (tsc --noEmit) → 0 · test (bun test) → 0, 153 pass, 0 fail.

Оговорка по среде: bun на хосте нет, а установленные node_modules собраны под linux-arm64 из контейнера. Чтобы прогнать гейты, bun и biome поставлены в скретчпад, ни репозиторий, ни глобальные пакеты не трогались. Версия bun не та, что в CI-образе.

Та же щель в PHP

DuckBugProvider::preparePayload снимает приватные секции, зовёт beforeSend, чистит null — и ни разу не касается eventId. Единственный генератор приватный и вызывается только из Client::buildBasePayload(). Интеграции (Monolog, Laravel, Symfony, PSR-15) идут через ядро и потому закрыты, а прямой DuckBugProvider::create($dsn)->captureEvent(...) — нет. Заводится отдельно.

🤖 Generated with Claude Code

Ingest deduplicates on eventId, but the field is optional: a payload that
arrives without one gets a fresh id minted per request, so a retry stores
the event twice. finalizeIngestEvent covers the DuckBugProvider pipeline,
and three live paths go around it — calling the service directly, sending
with skipPrivacyPipeline (which DuckSDK itself uses), and a beforeSend hook
that returns an event without the field.

sendLog and sendError are the transport's choke point, so the id is ensured
there. Lower down is not meaningful: postJsonWithRetry already holds either
a single item or a batch array.

An existing id is never overwritten; a blank one is replaced.

Four existing tests asserted that the request body equalled exactly the
object the caller passed. That was pinning the bug — any place to insert an
id changes the body. They now compare against the caller's fields plus an
eventId, so the caller's own data is still matched exactly.

Worth knowing: ensureEventId throws where crypto.randomUUID is absent, which
until now could only happen on the finalizeIngestEvent path and can now
happen on skipPrivacyPipeline too. Dropping the id silently in an error
tracker is worse, so the throw stays — but softening it is a decision for
all three SDKs at once, not for this one.
@zaytcevcom
zaytcevcom merged commit a1c8bb4 into main Sep 17, 2026
1 check passed
@zaytcevcom
zaytcevcom deleted the fix/ensure-event-id branch September 17, 2026 06:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant