Skip to content

Commit b394921

Browse files
committed
docs: sync planning and code review docs to main
- v1.0.0: add integration test plan for sanitization (Task 1.1.6), Sprint P1 DoD - v0.5.0: task list, roadmap, S4/S5 detailed tasks - code-review: sprint-s4-code-review, sprint-s5-code-review (recommendation #2 documented for v1.0.0) - prd: v1-roadmap updates
1 parent ed58866 commit b394921

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

.cursor/dev-planning/tasks/v1.0.0/tasks-v1.0.0-roadmap.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626

2727
- [ ] 1.1 Implement log sanitization
2828
- Issue: [#12](https://github.com/adriannoes/asap-protocol/issues/12)
29-
- Goal: Redact tokens/secrets from logs, add debug mode
29+
- Goal: Redact tokens/secrets from logs, add debug mode, integration tests for production scenarios
30+
- Note: v0.5.0 delivered basic sanitization (unit tests); v1.0.0 adds debug mode + E2E validation
3031
- Details: [Security Detailed - Task 1.1](./tasks-v1.0.0-security-detailed.md#task-11-implement-log-sanitization)
3132

3233
- [ ] 1.2 Add handler security documentation
@@ -39,7 +40,8 @@
3940

4041
### Definition of Done
4142
- [ ] Tokens/secrets redacted from logs
42-
- [ ] Debug mode working
43+
- [ ] Debug mode working (ASAP_DEBUG env var)
44+
- [ ] Integration tests validate sanitization in E2E scenarios (auth fail, nonce replay, connection errors)
4345
- [ ] Path traversal detection working
4446
- [ ] Test coverage >95%
4547
- [ ] Issue #12 closed

.cursor/dev-planning/tasks/v1.0.0/tasks-v1.0.0-security-detailed.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,18 @@
5656
- Test: Non-sensitive preserved
5757
- Test: Debug mode shows all
5858

59-
- [ ] 1.1.6 Commit
59+
- [ ] 1.1.6 Add integration tests for sanitization in production-like scenarios
60+
- **Context**: v0.5.0 implemented basic sanitization (sanitize_token, sanitize_nonce, sanitize_url) with comprehensive unit tests (19 tests, 100% coverage). This task adds E2E validation in realistic scenarios.
61+
- File: `tests/observability/test_logging_integration.py` (NEW)
62+
- Test: Auth failure logs show `Bearer sk_live_...` not full token
63+
- Test: Nonce replay logs show `01HXA...` not full nonce
64+
- Test: Client connection failure logs show `https://user:***@...` not password
65+
- Test: Debug mode logs full data, production mode sanitizes
66+
- Setup: Real server with structlog, capture logs, assert on log strings
67+
- Rationale: Validates sanitization works in full request/response cycle, catches edge cases missed by unit tests
68+
- **Note**: v0.5.0 unit tests sufficient for release; integration tests justify effort when observability is complete
69+
70+
- [ ] 1.1.7 Commit
6071
- Command: `git commit -m "feat(observability): add log sanitization for sensitive data"`
6172
- Close issue #12
6273

0 commit comments

Comments
 (0)