Skip to content

Commit 8b9516a

Browse files
committed
feat: sdk upgrade to new keys (#116)
1 parent 80dab97 commit 8b9516a

File tree

14 files changed

+1669
-267
lines changed

14 files changed

+1669
-267
lines changed

.github/workflows/tests.yml

Lines changed: 0 additions & 42 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 78 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,78 @@
1-
# Changelog
2-
3-
All notable changes to this project will be documented in this file.
4-
5-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7-
8-
## [2.8.1] - 2022-02-25
9-
### Changed
10-
- provide a fallback for masked fields list in case someone updated the package and didn't clear their cache (it happens)
11-
12-
## [2.8.0] - 2022-02-25
13-
### Changed
14-
- using Laravel HTTP client instead of Guzzle
15-
- fixed missing Cache facade
16-
- simplifed the Laravel Octane check
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [6.0.0] - 2025-10-10
9+
10+
### Breaking Changes
11+
12+
- **Updated to treblle-php v5**: Upgraded core dependency from treblle-php v4 to v5
13+
- **Configuration key changes**:
14+
- `TREBLLE_PROJECT_ID` is now `TREBLLE_API_KEY`
15+
- `TREBLLE_API_KEY` is now `TREBLLE_SDK_TOKEN`
16+
- Config file keys updated: `project_id``api_key`, `api_key``sdk_token`
17+
- **Middleware parameter change**: Dynamic middleware parameter changed from `project_id` to `api_key`
18+
- Old: `Route::middleware(['treblle:project-id-1'])`
19+
- New: `Route::middleware(['treblle:api-key-1'])`
20+
- **Exception method changes**:
21+
- `TreblleException::missingProjectId()` renamed to `TreblleException::missingApiKey()`
22+
- Added new `TreblleException::missingSdkToken()` method
23+
- **Helper classes removed**: No longer using custom `HeaderProcessor` - now uses `Treblle\Php\Helpers\HeaderFilter` from core SDK
24+
- **Data masking class changed**: Now uses `Treblle\Php\Helpers\SensitiveDataMasker` instead of `FieldMasker`
25+
26+
### Added
27+
28+
- Support for Laravel 11+ via Orchestra Testbench ^9, ^10, ^11
29+
- Laravel 12 compatibility
30+
- Updated SDK version to 6.0
31+
- Comprehensive README with detailed examples
32+
- Complete `claude.md` documentation for contributors
33+
34+
### Changed
35+
36+
- Data providers now use `SensitiveDataMasker` from treblle-php v5
37+
- Header filtering now uses `HeaderFilter::filter()` from treblle-php v5
38+
- Updated composer dependencies for latest Laravel versions
39+
40+
### Migration Guide
41+
42+
1. Update your `.env` file:
43+
```shell
44+
# Old configuration (v5.x)
45+
TREBLLE_API_KEY=your_old_api_key
46+
TREBLLE_PROJECT_ID=your_old_project_id
47+
48+
# New configuration (v6.0)
49+
TREBLLE_SDK_TOKEN=your_old_api_key
50+
TREBLLE_API_KEY=your_old_project_id
51+
```
52+
53+
2. If using dynamic middleware parameters, update route definitions:
54+
```php
55+
// Old (v5.x)
56+
Route::middleware(['treblle:project-id-1'])->group(function () { ... });
57+
58+
// New (v6.0)
59+
Route::middleware(['treblle:api-key-1'])->group(function () { ... });
60+
```
61+
62+
3. Republish the config file (optional but recommended):
63+
```bash
64+
php artisan vendor:publish --provider="Treblle\Laravel\TreblleServiceProvider" --force
65+
```
66+
67+
4. Clear caches:
68+
```bash
69+
php artisan config:clear
70+
php artisan cache:clear
71+
```
72+
73+
> For a complete upgrade guide with troubleshooting tips, see the "Upgrading from v5.x to v6.0" section in [README.md](README.md#upgrading-from-v5x-to-v60)
74+
75+
## [5.0.0] - Previous Release
76+
77+
- Initial release with treblle-php v4 support
78+
- Laravel 10 compatibility

0 commit comments

Comments
 (0)