Skip to content

fix(otel): prevent infinite retry loops on unicode hex escape errors #2337

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.

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
merged 6 commits into from
Aug 2, 2025

Conversation

nicktrn
Copy link
Collaborator

@nicktrn nicktrn commented Aug 2, 2025

Summary

Fixed infinite retry loops in OTEL log ingestion caused by Unicode validation errors in PostgreSQL. The issue occurred when malformed Unicode data in telemetry logs triggered "lone leading surrogate in
hex escape" and "unexpected end of hex escape" errors, which were not properly handled by the DynamicFlushScheduler's retry logic.

Changes

Unicode Error Handling

  • Added specific handling for PrismaClientKnownRequestError with Unicode/hex escape error messages
  • Implemented bisection logic for Unicode errors to isolate problematic events while preserving clean data
  • Created isUnicodeError() helper function for reusable Unicode error detection
  • Added getPrismaErrorDetails() helper for type-safe error detail extraction

Observability Improvements

  • Added span attributes for better error tracking: prisma_error_type, prisma_error_code
  • Enhanced error logging with structured details for both known and unknown Prisma errors

Prisma Logging Improvements

  • Converted Prisma logs from unstructured stdout to structured JSON events
  • Added optional PRISMA_LOG_TO_STDOUT environment variable to control error output format. If it equals "1" we log straight to stdout instead of using structured logs, this is helpful when running locally.
  • Added clientType field to distinguish between writer and reader client logs

Root Cause

The recent DynamicFlushScheduler enhancements added retry logic that re-queued failed batches, but didn't account for Unicode serialization errors that are permanent data issues rather than transient
failures. This caused problematic batches to retry indefinitely.

Resolution

Unicode errors now trigger the same bisection strategy used for other data issues, recursively splitting batches until individual problematic events are isolated and dropped, allowing clean events to be
successfully inserted.

Copy link

changeset-bot bot commented Aug 2, 2025

⚠️ No Changeset found

Latest commit: eba648b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Aug 2, 2025

Walkthrough

The changes update Prisma client initialization and logging in the database server module, enhancing log configuration and forwarding structured log events to a central logger with metadata. Logging behavior is now controlled by environment variables for error and verbose query logs. In the event repository, error handling for batch inserts is refactored: new helper functions classify retriable Prisma errors, extract error details, and detect Unicode-related errors. The retry logic is clarified to bisect batches on certain error types, with improved logging and span attribute reporting. The unit test workflow shard count is reduced from 10 to 8. A comprehensive integration test suite for RunsRepository.listRuns with Clickhouse is added, while a previously existing suite with overlapping tests is largely removed except for one test on the rootOnly filter. No changes were made to exported or public entity declarations.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~40 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7c7632d and eba648b.

📒 Files selected for processing (3)
  • .github/workflows/unit-tests-webapp.yml (1 hunks)
  • apps/webapp/test/runsRepository.part1.test.ts (1 hunks)
  • apps/webapp/test/runsRepository.part2.test.ts (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .github/workflows/unit-tests-webapp.yml
🧰 Additional context used
📓 Path-based instructions (4)
**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

**/*.{ts,tsx}: Always prefer using isomorphic code like fetch, ReadableStream, etc. instead of Node.js specific code
For TypeScript, we usually use types over interfaces
Avoid enums
No default exports, use function declarations

Files:

  • apps/webapp/test/runsRepository.part2.test.ts
  • apps/webapp/test/runsRepository.part1.test.ts
**/*.test.{ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

Our tests are all vitest

Files:

  • apps/webapp/test/runsRepository.part2.test.ts
  • apps/webapp/test/runsRepository.part1.test.ts
{packages/core,apps/webapp}/**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

We use zod a lot in packages/core and in the webapp

Files:

  • apps/webapp/test/runsRepository.part2.test.ts
  • apps/webapp/test/runsRepository.part1.test.ts
apps/webapp/**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/webapp.mdc)

apps/webapp/**/*.{ts,tsx}: In the webapp, all environment variables must be accessed through the env export of env.server.ts, instead of directly accessing process.env.
When importing from @trigger.dev/core in the webapp, never import from the root @trigger.dev/core path; always use one of the subpath exports as defined in the package's package.json.

Files:

  • apps/webapp/test/runsRepository.part2.test.ts
  • apps/webapp/test/runsRepository.part1.test.ts
🧠 Learnings (12)
📓 Common learnings
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T17:49:24.468Z
Learning: Applies to internal-packages/database/**/*.{ts,tsx} : We use prisma in internal-packages/database for our database interactions using PostgreSQL
Learnt from: matt-aitken
PR: triggerdotdev/trigger.dev#2264
File: apps/webapp/app/services/runsRepository.server.ts:172-174
Timestamp: 2025-07-12T18:06:04.133Z
Learning: In apps/webapp/app/services/runsRepository.server.ts, the in-memory status filtering after fetching runs from Prisma is intentionally used as a workaround for ClickHouse data delays. This approach is acceptable because the result set is limited to a maximum of 100 runs due to pagination, making the performance impact negligible.
Learnt from: matt-aitken
PR: triggerdotdev/trigger.dev#2035
File: apps/webapp/app/v3/services/finalizeTaskRun.server.ts:99-103
Timestamp: 2025-05-12T17:23:05.574Z
Learning: Prisma ignores undefined values in update operations. When a field is set to undefined in a Prisma update operation's data object, Prisma will omit that field from the update rather than trying to set it to null or another value. This means there's no need to conditionally build update objects to exclude undefined values.
📚 Learning: in apps/webapp/app/services/runsrepository.server.ts, the in-memory status filtering after fetching ...
Learnt from: matt-aitken
PR: triggerdotdev/trigger.dev#2264
File: apps/webapp/app/services/runsRepository.server.ts:172-174
Timestamp: 2025-07-12T18:06:04.133Z
Learning: In apps/webapp/app/services/runsRepository.server.ts, the in-memory status filtering after fetching runs from Prisma is intentionally used as a workaround for ClickHouse data delays. This approach is acceptable because the result set is limited to a maximum of 100 runs due to pagination, making the performance impact negligible.

Applied to files:

  • apps/webapp/test/runsRepository.part2.test.ts
  • apps/webapp/test/runsRepository.part1.test.ts
📚 Learning: applies to **/*.test.{ts,tsx} : our tests are all vitest...
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T17:49:24.468Z
Learning: Applies to **/*.test.{ts,tsx} : Our tests are all vitest

Applied to files:

  • apps/webapp/test/runsRepository.part2.test.ts
  • apps/webapp/test/runsRepository.part1.test.ts
📚 Learning: applies to apps/webapp/app/**/*.test.{ts,tsx} : tests in the webapp should only import classes and f...
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/webapp.mdc:0-0
Timestamp: 2025-07-18T17:49:47.180Z
Learning: Applies to apps/webapp/app/**/*.test.{ts,tsx} : Tests in the webapp should only import classes and functions from files matching `app/**/*.ts`, and those files should not use environment variables directly; all configuration should be passed as options.

Applied to files:

  • apps/webapp/test/runsRepository.part2.test.ts
  • apps/webapp/test/runsRepository.part1.test.ts
📚 Learning: applies to apps/webapp/app/**/*.test.{ts,tsx} : test files in the webapp should not import `env.serv...
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/webapp.mdc:0-0
Timestamp: 2025-07-18T17:49:47.180Z
Learning: Applies to apps/webapp/app/**/*.test.{ts,tsx} : Test files in the webapp should not import `env.server.ts`, either directly or indirectly. Tests should only import classes and functions from files matching `app/**/*.ts` of the webapp, and those files should not use environment variables directly; everything should be passed through as options instead.

Applied to files:

  • apps/webapp/test/runsRepository.part2.test.ts
  • apps/webapp/test/runsRepository.part1.test.ts
📚 Learning: do not use or add new code to the legacy run engine; focus on using and migrating to run engine 2.0 ...
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/webapp.mdc:0-0
Timestamp: 2025-07-18T17:49:47.180Z
Learning: Do not use or add new code to the legacy run engine; focus on using and migrating to Run Engine 2.0 in `@internal/run-engine`.

Applied to files:

  • apps/webapp/test/runsRepository.part2.test.ts
📚 Learning: in apps/webapp/app/services/environmentmetricsrepository.server.ts, the clickhouse methods (gettaska...
Learnt from: ericallam
PR: triggerdotdev/trigger.dev#2175
File: apps/webapp/app/services/environmentMetricsRepository.server.ts:202-207
Timestamp: 2025-06-14T08:07:46.625Z
Learning: In apps/webapp/app/services/environmentMetricsRepository.server.ts, the ClickHouse methods (getTaskActivity, getCurrentRunningStats, getAverageDurations) intentionally do not filter by the `tasks` parameter at the ClickHouse level, even though the tasks parameter is accepted by the public methods. This is done on purpose as there is not much benefit from adding that filtering at the ClickHouse layer.

Applied to files:

  • apps/webapp/test/runsRepository.part2.test.ts
  • apps/webapp/test/runsRepository.part1.test.ts
📚 Learning: applies to **/trigger/**/*.{ts,tsx,js,jsx} : when using realtime features, use the `runs.subscribeto...
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-07-18T17:50:25.014Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : When using Realtime features, use the `runs.subscribeToRun`, `runs.subscribeToRunsWithTag`, and `runs.subscribeToBatch` APIs as shown.

Applied to files:

  • apps/webapp/test/runsRepository.part2.test.ts
  • apps/webapp/test/runsRepository.part1.test.ts
📚 Learning: follow our tests.md guide for how to write tests in the monorepo...
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tests.mdc:0-0
Timestamp: 2025-07-18T17:50:29.888Z
Learning: Follow our tests.md guide for how to write tests in the monorepo

Applied to files:

  • apps/webapp/test/runsRepository.part1.test.ts
📚 Learning: applies to apps/webapp/app/services/**/*.server.ts : for testable services, separate service logic a...
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/webapp.mdc:0-0
Timestamp: 2025-07-18T17:49:47.180Z
Learning: Applies to apps/webapp/app/services/**/*.server.ts : For testable services, separate service logic and configuration, as exemplified by `realtimeClient.server.ts` (service) and `realtimeClientGlobal.server.ts` (configuration).

Applied to files:

  • apps/webapp/test/runsRepository.part1.test.ts
📚 Learning: applies to internal-packages/database/**/*.{ts,tsx} : we use prisma in internal-packages/database fo...
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T17:49:24.468Z
Learning: Applies to internal-packages/database/**/*.{ts,tsx} : We use prisma in internal-packages/database for our database interactions using PostgreSQL

Applied to files:

  • apps/webapp/test/runsRepository.part1.test.ts
📚 Learning: when running tests, it is often better to `cd` into the package directory and then run tests using `...
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/executing-commands.mdc:0-0
Timestamp: 2025-07-18T17:49:29.234Z
Learning: When running tests, it is often better to `cd` into the package directory and then run tests using `pnpm run test ...`.

Applied to files:

  • apps/webapp/test/runsRepository.part1.test.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (23)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
  • GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (14)
apps/webapp/test/runsRepository.part2.test.ts (7)

16-109: LGTM!

The test correctly validates the rootOnly filter functionality by creating both root and child runs and verifying that only the root run is returned when the filter is applied.


111-239: LGTM!

The test comprehensively validates the batchId filter by creating runs associated with different batches and one without any batch, then correctly verifying the filter returns only the run from the specified batch.


241-347: LGTM!

The test correctly validates filtering by multiple friendly IDs using the runId parameter, properly verifying that only the specified runs are returned.


349-455: LGTM!

The test correctly validates filtering by run IDs, properly verifying the mapping between friendly IDs used in the filter and the database IDs returned in the results.


457-571: LGTM!

The test correctly validates date range filtering by creating runs across different days and verifying that only runs within the specified time range are returned.


573-695: LGTM!

Excellent test design! The test comprehensively validates that multiple filters work together with AND logic by creating runs that match different subsets of criteria and verifying that only the run matching all filters is returned.


697-792: LGTM!

The test thoroughly validates pagination functionality by testing both initial page retrieval and cursor-based navigation, properly verifying the pagination metadata.

apps/webapp/test/runsRepository.part1.test.ts (7)

16-91: LGTM!

The test correctly validates the basic functionality of listing runs from ClickHouse, including proper verification of both run data and pagination metadata.


93-199: LGTM!

The test correctly validates filtering by task identifiers, creating runs with different identifiers and verifying that only the specified tasks are returned.


201-310: LGTM!

The test correctly validates filtering by task versions, creating runs with different versions of the same task and verifying that only the specified versions are returned.


312-421: LGTM!

The test correctly validates filtering by run statuses, creating runs with different statuses and verifying that only runs with the specified statuses are returned.


423-532: LGTM!

The test correctly validates filtering by tags, creating runs with different tag combinations and verifying that all runs containing the specified tag are returned.


534-642: LGTM!

The test correctly validates filtering by schedule ID, creating runs with different schedule IDs and one unscheduled run, then verifying that only the run with the specified schedule ID is returned.


644-748: LGTM!

The test correctly validates filtering by the isTest flag, creating both test and production runs and verifying that filtering works correctly for both true and false values.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/otel-hex-escape

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@nicktrn nicktrn merged commit 7b54c35 into main Aug 2, 2025
31 checks passed
@nicktrn nicktrn deleted the fix/otel-hex-escape branch August 2, 2025 15:54
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.

2 participants