chore: PR 1.2 Add framework-agnostic core package for v3 #356
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 implements the Core-Adapter Architecture for v3, separating framework-agnostic validation logic from transport-specific adapters. Key Features: - Core struct with CheckToken method for pure validation logic - Options pattern with error-returning option functions - Type-safe context helpers using generics (GetClaims[T]) - Unexported contextKey int to prevent collisions (Go best practice) - Structured error types with error codes - Logger interface for observability - 100% test coverage Changes: - Add core/core.go: Framework-agnostic validation engine - Add core/option.go: Options pattern with validation - Add core/errors.go: Structured errors and error codes - Add core/context.go: Type-safe context helpers - Add core/core_test.go: Comprehensive tests This enables future support for multiple frameworks (HTTP, gRPC, Gin, Echo, etc.) by wrapping the Core with transport-specific adapters. Part of PR 1.2 in v3 Phase 1 implementation.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## v3-dev #356 +/- ##
=========================================
Coverage ? 97.72%
=========================================
Files ? 13
Lines ? 396
Branches ? 0
=========================================
Hits ? 387
Misses ? 6
Partials ? 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
developerkunal
changed the title
2 tasks
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.
📝 Checklist
🔧 Changes
This PR introduces a framework-agnostic validation engine that separates validation logic from transport-specific concerns, enabling support for multiple frameworks (HTTP, gRPC, Gin, Echo, etc.).
New Package:
core/Types Added:
Core- Framework-agnostic validation engineTokenValidatorinterface - Interface for JWT validationLoggerinterface - Optional logging interfaceValidationError- Structured error type with error codesOption- Error-returning option functionsFunctions Added:
New(opts ...Option) (*Core, error)- Constructor with options patternCheckToken(ctx, token) (any, error)- Pure validation logicGetClaims[T](ctx) (T, error)- Type-safe generic claims retrievalSetClaims(ctx, claims) context.Context- Helper to store claimsHasClaims(ctx) bool- Check if claims existWithValidator(TokenValidator) Option- Required optionWithCredentialsOptional(bool) Option- Configure optional credentialsWithLogger(Logger) Option- Configure loggingKey Features:
📚 References
🔬 Testing
Test Coverage:
Tests Include:
Run Tests:
All tests pass with 100% coverage.