pipe SQL errors into the existing onError method using a new SqlError class #768
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 3d7670c The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Claude Code ReviewSummary: Clean implementation that properly routes SQL errors through the existing error handling mechanism. The approach is solid and aligns well with the codebase patterns. Issues Found: None Analysis:
Testing: No dedicated tests for SqlError, but the class is simple enough and implicitly tested through existing sql method tests in oauth2-mcp-client.test.ts. Consider adding explicit error case tests if SQL error handling becomes critical in production. The PR is ready to merge. |
whoiskatrin
force-pushed
the
fix/customizable-sql-error-logger
branch
from
27b965b to
377299b
Compare
whoiskatrin
force-pushed
the
fix/customizable-sql-error-logger
branch
from
377299b to
42ec18c
Compare
Allow users to override onSqlError(query, error) to customize logging behavior for SQL errors instead of using console.error directly. Fixes #767
whoiskatrin
force-pushed
the
fix/customizable-sql-error-logger
branch
from
42ec18c to
7b72e17
Compare
commit: |
agents-git-bot bot
pushed a commit
to cloudflare/cloudflare-docs
that referenced
this pull request
Jan 6, 2026
Add documentation for the new onSqlError hook that allows users to customize SQL error logging behavior. This hook was added in cloudflare/agents#768 to replace hardcoded console.error calls. - Add onSqlError to the main Agent class API example - Add dedicated SQL error handling section with API signature - Include practical example showing integration with observability service - Explain when the hook is called and default behavior 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
agents-git-bot bot
pushed a commit
to cloudflare/cloudflare-docs
that referenced
this pull request
Jan 6, 2026
Adds documentation for the new onSqlError hook that allows users to customize SQL error logging behavior. The hook is called when SQL queries fail, giving users full control over error handling and logging. Related to cloudflare/agents#768 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
agents-git-bot bot
pushed a commit
to cloudflare/cloudflare-docs
that referenced
this pull request
Jan 6, 2026
Document the new onSqlError hook that allows users to customize SQL error logging behavior. This hook provides: - Ability to override the default console.error logging - Access to both the failed query and error details - Use cases for integrating with monitoring services Related PR: cloudflare/agents#768 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
| // Execute the SQL query with the provided values | ||
| return [...this.ctx.storage.sql.exec(query, ...values)] as T[]; | ||
| } catch (e) { | ||
| console.error(`failed to execute sql query: ${query}`, e); |
Contributor
There was a problem hiding this comment.
instead why don't we use our logger directly here?
Contributor
Author
There was a problem hiding this comment.
agree with piping, done that
Address review feedback by piping SQL errors through onError with a SqlError class that preserves query context, rather than adding a separate onSqlError hook. - Add SqlError class with query and cause properties - Update sql() catch block to throw onError(new SqlError(query, e)) - Remove onSqlError method Users can now handle SQL errors in onError by checking instanceof SqlError.
agents-git-bot bot
pushed a commit
to cloudflare/cloudflare-docs
that referenced
this pull request
Jan 6, 2026
Add documentation for the new onSqlError hook that allows developers to customize SQL error logging behavior in Agents. The hook is called before errors are thrown via onError, enabling custom logging, monitoring, or observability integrations. Changes: - Added onSqlError method signature to Agent class API reference - Included practical example showing custom error logging with context - Documented that errors are still thrown via onError after this hook Related PR: cloudflare/agents#768 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
agents-git-bot bot
pushed a commit
to cloudflare/cloudflare-docs
that referenced
this pull request
Jan 6, 2026
Document the new SqlError class that provides detailed information about failed SQL queries. This change syncs documentation for PR #768 which introduces SqlError for better error handling in the agents SDK. Changes: - Add SqlError section in API reference with properties and usage example - Add SQL Error Handling subsection under this.sql in agent-class.mdx - Update onError section to demonstrate SqlError handling - Add cross-references between related documentation sections Related: cloudflare/agents#768 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
agents-git-bot bot
pushed a commit
to cloudflare/cloudflare-docs
that referenced
this pull request
Jan 6, 2026
Add documentation for the new SqlError class that is thrown when SQL queries fail in Agents. This helps developers understand how to handle SQL-specific errors through the onError method. Related to cloudflare/agents#768 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
whoiskatrin
changed the title
threepointone
approved these changes
Jan 6, 2026
threepointone
approved these changes
Jan 6, 2026
Contributor
threepointone
left a comment
threepointone
left a comment
There was a problem hiding this comment.
approving pending CI
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Instead of adding a separate onSqlError hook, I implemented a cleaner approach (suggested by @threepointone) that pipes SQL errors into the existing onError method using a new SqlError class
Fixes #767