fix(tests): Migrate permission system from web to sanctum guard #133
+23
−6
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
- Update RoleApiTest.php: Add guard_name='sanctum' to all Permission and Role creation - Update PersonApiTest.php: Change guard_name from 'web' to 'sanctum' - Add $guard_name='sanctum' property to User model with PHPDoc type hint - Resolves guard mismatch causing 403 Forbidden errors in permission checks - All 207 tests passing (623 assertions) Fixes #126 Fixes #127 Fixes #128 Fixes #129 Part of: #125
💡 Tip: Consider Using Draft PRsBenefits of opening PRs as drafts initially:
How to convert:
This is just a friendly reminder - feel free to continue as is! 😊 |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a critical guard mismatch in the permission system by migrating from 'web' to 'sanctum' guard, resolving 403 Forbidden errors in API authentication. The change ensures that Spatie Laravel-Permission guards align with the Sanctum authentication used in API routes.
Key changes:
- Added explicit
guard_name='sanctum'to all test Role and Permission creations - Added
$guard_name = 'sanctum'property to the User model - Updated CHANGELOG with comprehensive migration details
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tests/Feature/RoleApiTest.php | Added guard_name='sanctum' to Role and Permission creation in test setup |
| tests/Feature/PersonApiTest.php | Changed Permission guard_name from 'web' to 'sanctum' in test setup |
| app/Models/User.php | Added $guard_name='sanctum' property with documentation explaining Spatie integration |
| CHANGELOG.md | Documented the guard migration fix with technical details and issue references |
💡 Tip: Consider Using Draft PRsBenefits of opening PRs as drafts initially:
How to convert:
This is just a friendly reminder - feel free to continue as is! 😊 |
This was referenced Nov 9, 2025
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.
Summary
Fixes guard mismatch in test files and User model by explicitly declaring 'sanctum' guard for all permissions and the User model. Resolves 403 Forbidden errors in RBAC tests.
Related Issues
Fixes #126 (RoleApiTest)
Fixes #127 (PersonApiTest - was already partially fixed with 'web')
Fixes #128 (Covered by RoleApiTest)
Fixes #129 (User Model $guard_name)
Part of: #125 (EPIC: Guard Migration)
Changes
Test Files (Guard Declaration)
'guard_name' => 'sanctum'to 3 Permission::create() + 1 Role::create()'guard_name'from 'web' to 'sanctum' (2 permissions)Model (Guard Declaration)
protected $guard_name = 'sanctum'with PHPDoc @var string type hintDocumentation
Technical Context
Problem:
givePermissionTo()uses User model's guard, not permission's guardSolution:
Both User model AND permissions must explicitly use 'sanctum' guard.
Testing
Results:
Impact
✅ Architecture Semantically Correct: Token-auth uses sanctum guard
✅ Self-Documenting Code: Explicit guard declaration
✅ Zero Technical Debt: No guard mismatch confusion
✅ Unblocks RBAC Phase 4: Issue #108 can proceed
4-Pass Review
✅ Pass 1 - Comprehensive: PSR-12, PHPDoc, tests, CHANGELOG
✅ Pass 2 - Deep Dive: Domain policy, REUSE 3.3, security
✅ Pass 3 - Best Practices: Hidden files, governance
✅ Pass 4 - Security: No secrets, .gitignore complete
Pre-Merge Checklist