feat: Add a common Seam::Error base for SDK errors - #585
Open
razor-x wants to merge 1 commit into
Open
Conversation
Every error the SDK raised descended directly from StandardError, so a caller could not rescue everything the SDK raises in one clause the way the other Seam SDKs allow. Add Seam::Error and make the API, option, token, action attempt, and serialization errors subclass it. Svix's verification error stays Svix's own class, as documented. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SQW83gyXeUG61RDrHEky97
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
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.
Problem
Every error the ruby SDK raises descended directly from
StandardError(Http::ApiError,ActionAttemptError,SeamInvalidOptionsError,SeamInvalidTokenError,UnserializableParamError), so a caller could not rescue everything the SDK raises in one clause. The python (seamapi/python#634,SeamError) and PHP (SeamException) waves made that promise true; ruby could not.Change
New
Seam::Error < StandardErrorinlib/seam/errors.rb; the five existing error roots subclass it. Non-breaking:StandardErrorremains an ancestor of all of them.Seam::WebhookVerificationErrorstays Svix's own class, as the README documents. README's Error Handling section opens with the one-rescue promise.When #574 (
Seam::Http::InvalidResponseError) and #578 (Seam::InvalidWebhookPayloadError) land, this PR will be updated to reparent those two as well, so it should merge last.Tests
New
spec/seam_error_spec.rbasserts every SDK error class is aSeam::Error, that the svix error is not, and that an option error raised by the client is rescued asSeam::Error.Revert-check against
main: 10 failures.🤖 Generated with Claude Code
https://claude.ai/code/session_01SQW83gyXeUG61RDrHEky97
Generated by Claude Code