Add compat package for standard error interface compatibility #4
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
This commit introduces a new compat sub-package that provides mirror functions for errx's core wrapping and classification operations, but accepts standard Go error interface instead of requiring errx.Classified types. Key features: - compat.Wrap() and compat.Classify() accept error interface - Internal conversion to errx.Classified preserves error identity - Seamless integration with all errx features (sentinels, displayable, attributes) - Full compatibility with errors.Is() and errors.As() Benefits: - Easier migration from existing error handling code - Better integration with third-party libraries using standard errors - More flexible for codebases preferring standard error interface Tradeoffs: - Less type safety compared to main package - Slight overhead from additional wrapping layer - Intentionally excludes stacktrace mirrors (use stacktrace.Here() explicitly) Documentation: - Comprehensive package documentation explaining design decisions - README.md with usage examples and tradeoffs - 16 unit tests + 8 example tests (all passing) - Updated parent README.md with compat package information This addresses feedback about the main package being too restrictive while maintaining the benefits of the sealed interface pattern in the core package.
There was a problem hiding this comment.
Pull request overview
This PR introduces a new compat sub-package that provides wrapper functions accepting standard Go error interface instead of requiring errx.Classified types, addressing feedback about the main package being too restrictive.
Changes:
- Created
compatsub-package withWrap()andClassify()functions that accept standard errors - Implemented internal
errorWrappertype to convert standard errors toerrx.Classified - Added comprehensive documentation, tests (16 unit tests + 8 examples), and README
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| compat/compat.go | Core implementation with errorWrapper and conversion functions |
| compat/compat_test.go | Unit tests covering all functionality including edge cases |
| compat/example_test.go | Example tests demonstrating usage patterns |
| compat/README.md | Package documentation with usage examples and design rationale |
| README.md | Updated main README to document the compat package |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Remove unused receiver parameter in IsClassified method - Fix whitespace/formatting issues (gofmt)
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR introduces a new
compatsub-package that provides compatibility functions accepting standard Goerrorinterface instead of requiringerrx.Classifiedtypes. This addresses feedback about the main package being too restrictive while maintaining the benefits of the sealed interface pattern in the core package.Type of Change
Related Issues
This addresses criticism about the main package requiring
errx.Classifiedtypes, making it harder to work with standard errors and third-party libraries.Changes Made
compatsub-package withWrap()andClassify()functionserrorinterface for classificationserrorWrappertype converts standard errors toerrx.Classifiedcompat/README.mdwith usage examples and guidanceREADME.mdto document the compat packageCHANGELOG.mdwith compat package additionsTesting
Test Coverage
go test ./...)go test -race ./...)Manual Testing
All 24 tests in the compat package pass (16 unit tests + 8 examples). The package integrates seamlessly with existing errx features including sentinels, displayable errors, and attributes.
Documentation
Code Quality
golangci-lint run)go vetpassesgo fmthas been runBreaking Changes
Does this PR introduce breaking changes?
This is a purely additive change. The new compat package is optional and does not affect existing code.
Performance Impact
The compat package has slightly more overhead than the main package due to the additional wrapping layer that converts standard errors to
errx.Classified. This is an acceptable tradeoff for the flexibility it provides. Users who need maximum performance should continue using the main package.Additional Notes
Design Decisions:
stacktrace.Here()usage when stack traces are needederrorWrapperto convert standard errors toerrx.Classifiedwhile preserving error identityUse Cases:
Tradeoffs:
Checklist