Skip to content

Commit 9d3b564

Browse files
docs(benchmarks): update readme with protected route benchmarks
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
1 parent f992216 commit 9d3b564

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

benchmarks/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,22 @@ BenchmarkHealthEndpoint-10 15085 78187 ns/op 7146 B/op 80 allocs/o
3535

3636
## Benchmark Scope
3737

38-
Currently covered routes:
38+
### Public Routes
3939
- `GET /health`: Basic health check performance.
4040
- `GET /v1/auth/google`: Google OAuth initiation performance.
4141
- `GET /v1/auth/microsoft`: Microsoft OAuth initiation performance.
4242

43-
*Note: Protected routes requiring JWT or M2M tokens are currently excluded from this minimal implementation.*
43+
### Protected Routes
44+
These benchmarks test authenticated endpoints using a pre-generated JWT token with test data (User, Organization, Event):
45+
46+
- `BenchmarkGetMe`: Get current authenticated user profile.
47+
- `BenchmarkGetUser`: Retrieve a specific user by ID.
48+
- `BenchmarkListOrganizations`: List all organizations.
49+
- `BenchmarkCreateOrganization`: Create a new organization.
50+
- `BenchmarkGetOrganization`: Retrieve organization details by ID.
51+
- `BenchmarkListEvents`: List all events.
52+
- `BenchmarkCreateEvent`: Create a new event.
53+
- `BenchmarkGetEvent`: Retrieve event details by ID.
4454

4555
## Output Files
4656

@@ -51,7 +61,6 @@ These files are ignored by git to keep the repository clean.
5161

5262
## Future Enhancements
5363

54-
- **Protected Routes**: Add benchmarks for authenticated endpoints.
5564
- **Regression Detection**: Compare current runs against a baseline.
5665
- **Performance Thresholds**: Define p99 latency targets and fail benchmarks if exceeded.
5766
- **Concurrent Load Testing**: Use multiple goroutines to simulate concurrent users.

0 commit comments

Comments
 (0)