docs(13-03): complete cloud operations seam plan
This commit is contained in:
@@ -24,7 +24,7 @@ Before any phase is marked complete:
|
|||||||
| Phase | Name | Goal | Requirements |
|
| Phase | Name | Goal | Requirements |
|
||||||
|------:|------|------|--------------|
|
|------:|------|------|--------------|
|
||||||
| 12 | 6/6 | Complete | 2026-06-21 |
|
| 12 | 6/6 | Complete | 2026-06-21 |
|
||||||
| 13 | 2/11 | In Progress| |
|
| 13 | 3/11 | In Progress| |
|
||||||
| 14 | Selective Analysis and Byte Cache | Analyze selected cloud scopes through cancellable jobs backed by bounded, private, on-demand byte caching | ANALYZE-01..07, CACHE-03..05 |
|
| 14 | Selective Analysis and Byte Cache | Analyze selected cloud scopes through cancellable jobs backed by bounded, private, on-demand byte caching | ANALYZE-01..07, CACHE-03..05 |
|
||||||
| 15 | Unified Smart Search | Search local and analyzed cloud documents by exact text or semantic ideas without downloading files during queries | SEARCH-01..07 |
|
| 15 | Unified Smart Search | Search local and analyzed cloud documents by exact text or semantic ideas without downloading files during queries | SEARCH-01..07 |
|
||||||
| 16 | Change Tracking and Reliability | Detect external provider changes, mark stale indexes, remove deleted items, and harden refresh behavior | SYNC-02..04 |
|
| 16 | Change Tracking and Reliability | Detect external provider changes, mark stale indexes, remove deleted items, and harden refresh behavior | SYNC-02..04 |
|
||||||
@@ -80,14 +80,14 @@ Plans:
|
|||||||
|
|
||||||
**Depends on:** Phase 12
|
**Depends on:** Phase 12
|
||||||
**Requirements:** CONN-01, CONN-02, CONN-03, CLOUD-02, CLOUD-03, CLOUD-04, CLOUD-05, CLOUD-06, CLOUD-07, CLOUD-09
|
**Requirements:** CONN-01, CONN-02, CONN-03, CLOUD-02, CLOUD-03, CLOUD-04, CLOUD-05, CLOUD-06, CLOUD-07, CLOUD-09
|
||||||
**Plans:** 2/11 plans executed
|
**Plans:** 3/11 plans executed
|
||||||
**Execution waves:** Wave 0: 13-01 and 13-02 in parallel; Wave 1: 13-03 after 13-01; Wave 2: 13-04 after 13-01 and 13-03; Wave 3: 13-05 after 13-01, 13-03, and 13-04; Wave 4: 13-06 after 13-05; Wave 5: 13-07 and 13-08 in parallel (13-07 after 13-02, 13-04, and 13-06; 13-08 after 13-03, 13-04, and 13-06); Wave 6: 13-09 after 13-08; Wave 7: 13-10 after 13-02, 13-04, 13-07, and 13-09; Wave 8: 13-11 after 13-03 through 13-10.
|
**Execution waves:** Wave 0: 13-01 and 13-02 in parallel; Wave 1: 13-03 after 13-01; Wave 2: 13-04 after 13-01 and 13-03; Wave 3: 13-05 after 13-01, 13-03, and 13-04; Wave 4: 13-06 after 13-05; Wave 5: 13-07 and 13-08 in parallel (13-07 after 13-02, 13-04, and 13-06; 13-08 after 13-03, 13-04, and 13-06); Wave 6: 13-09 after 13-08; Wave 7: 13-10 after 13-02, 13-04, 13-07, and 13-09; Wave 8: 13-11 after 13-03 through 13-10.
|
||||||
|
|
||||||
Plans:
|
Plans:
|
||||||
|
|
||||||
- [x] 13-01-PLAN.md — Create red backend and provider-contract suites for reconnect, content, mutations, and audit secrecy.
|
- [x] 13-01-PLAN.md — Create red backend and provider-contract suites for reconnect, content, mutations, and audit secrecy.
|
||||||
- [x] 13-02-PLAN.md — Create red frontend/store suites for queue, preview, health UX, broader Drive consent, and no-probe-on-navigation.
|
- [x] 13-02-PLAN.md — Create red frontend/store suites for queue, preview, health UX, broader Drive consent, and no-probe-on-navigation.
|
||||||
- [ ] 13-03-PLAN.md — Build the mutable cloud contract and orchestration seam without breaking centralized reconciliation.
|
- [x] 13-03-PLAN.md — Build the mutable cloud contract and orchestration seam without breaking centralized reconciliation.
|
||||||
- [ ] 13-04-PLAN.md — Implement connection-ID reconnect, explicit health test, broader Drive scope handling, and authorized content routes.
|
- [ ] 13-04-PLAN.md — Implement connection-ID reconnect, explicit health test, broader Drive scope handling, and authorized content routes.
|
||||||
- [ ] 13-05-PLAN.md — Implement backend upload provider mechanics, typed route results, and refreshed-credential handoff.
|
- [ ] 13-05-PLAN.md — Implement backend upload provider mechanics, typed route results, and refreshed-credential handoff.
|
||||||
- [ ] 13-06-PLAN.md — Complete upload reconcile, freshness, and metadata-only audit follow-through before frontend queue wiring.
|
- [ ] 13-06-PLAN.md — Complete upload reconcile, freshness, and metadata-only audit follow-through before frontend queue wiring.
|
||||||
|
|||||||
+5
-4
@@ -6,14 +6,14 @@ current_phase: 13
|
|||||||
current_phase_name: virtual-local-cloud-operations
|
current_phase_name: virtual-local-cloud-operations
|
||||||
status: executing
|
status: executing
|
||||||
stopped_at: Phase 13 context gathered
|
stopped_at: Phase 13 context gathered
|
||||||
last_updated: "2026-06-22T16:16:29.154Z"
|
last_updated: "2026-06-22T16:45:34.553Z"
|
||||||
last_activity: 2026-06-22
|
last_activity: 2026-06-22
|
||||||
last_activity_desc: Phase 13 execution started
|
last_activity_desc: Phase 13 execution started
|
||||||
progress:
|
progress:
|
||||||
total_phases: 6
|
total_phases: 6
|
||||||
completed_phases: 2
|
completed_phases: 2
|
||||||
total_plans: 21
|
total_plans: 21
|
||||||
completed_plans: 12
|
completed_plans: 13
|
||||||
percent: 33
|
percent: 33
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -26,7 +26,7 @@ progress:
|
|||||||
## Current Position
|
## Current Position
|
||||||
|
|
||||||
Phase: 13 (virtual-local-cloud-operations) — EXECUTING
|
Phase: 13 (virtual-local-cloud-operations) — EXECUTING
|
||||||
Plan: 3 of 11
|
Plan: 4 of 11
|
||||||
Status: Ready to execute
|
Status: Ready to execute
|
||||||
Last activity: 2026-06-22 — Phase 13 execution started
|
Last activity: 2026-06-22 — Phase 13 execution started
|
||||||
|
|
||||||
@@ -54,6 +54,7 @@ Last activity: 2026-06-22 — Phase 13 execution started
|
|||||||
| Phase 12.1 P03 | 677 | 4 tasks | 11 files |
|
| Phase 12.1 P03 | 677 | 4 tasks | 11 files |
|
||||||
| Phase 12.1 P04 | 15m | 4 tasks | 10 files |
|
| Phase 12.1 P04 | 15m | 4 tasks | 10 files |
|
||||||
| Phase 13 P02 | 30m | 2 tasks | 6 files |
|
| Phase 13 P02 | 30m | 2 tasks | 6 files |
|
||||||
|
| Phase 13 P03 | 134 | 2 tasks | 8 files |
|
||||||
|
|
||||||
## Accumulated Context
|
## Accumulated Context
|
||||||
|
|
||||||
@@ -97,7 +98,7 @@ _Updated at each phase transition._
|
|||||||
|
|
||||||
| Field | Value |
|
| Field | Value |
|
||||||
|---|---|
|
|---|---|
|
||||||
| Last session | 2026-06-22T16:16:29.149Z |
|
| Last session | 2026-06-22T16:45:34.548Z |
|
||||||
| Next action | Execute Phase 12.1 Plan 01 |
|
| Next action | Execute Phase 12.1 Plan 01 |
|
||||||
| Pending decisions | None |
|
| Pending decisions | None |
|
||||||
| Resume file | None |
|
| Resume file | None |
|
||||||
|
|||||||
@@ -0,0 +1,164 @@
|
|||||||
|
---
|
||||||
|
phase: "13"
|
||||||
|
plan: "03"
|
||||||
|
subsystem: "cloud-operations"
|
||||||
|
status: complete
|
||||||
|
tags:
|
||||||
|
- cloud
|
||||||
|
- mutable-contract
|
||||||
|
- reconnect
|
||||||
|
- health
|
||||||
|
- tdd
|
||||||
|
requires:
|
||||||
|
- "13-01"
|
||||||
|
provides:
|
||||||
|
- MutableCloudResourceAdapter abstract class
|
||||||
|
- Provider mutable-operation implementations (all 4 providers)
|
||||||
|
- build_mutable_cloud_adapter factory
|
||||||
|
- services/cloud_operations.py orchestration seam
|
||||||
|
- POST /api/cloud/connections/{id}/reconnect
|
||||||
|
- GET /api/cloud/connections/{id}/health
|
||||||
|
- POST /api/cloud/connections/{id}/test
|
||||||
|
- Admin audit log credential scrubbing
|
||||||
|
affects:
|
||||||
|
- "13-04"
|
||||||
|
- "13-05"
|
||||||
|
- "13-06"
|
||||||
|
tech-stack:
|
||||||
|
added:
|
||||||
|
- MutableCloudResourceAdapter (cloud_base.py)
|
||||||
|
- cloud_operations.py service module
|
||||||
|
- Reconnect/health/test HTTP routes (connections.py)
|
||||||
|
- Audit metadata scrubbing (_scrub_audit_metadata)
|
||||||
|
patterns:
|
||||||
|
- Provider-neutral mutable result vocabulary (MUT_KIND_* / MUT_REASON_*)
|
||||||
|
- Service-layer credential refresh handoff (T-13-11)
|
||||||
|
- Explicit CloudItem cascade delete for SQLite test compatibility
|
||||||
|
key-files:
|
||||||
|
created:
|
||||||
|
- backend/services/cloud_operations.py
|
||||||
|
modified:
|
||||||
|
- backend/storage/cloud_base.py
|
||||||
|
- backend/storage/cloud_backend_factory.py
|
||||||
|
- backend/storage/google_drive_backend.py
|
||||||
|
- backend/storage/onedrive_backend.py
|
||||||
|
- backend/storage/webdav_backend.py
|
||||||
|
- backend/api/cloud/connections.py
|
||||||
|
- backend/api/audit.py
|
||||||
|
decisions:
|
||||||
|
- "SSRF guard for WebDAV mutable methods applied at __init__ only, not per-call, to allow unit-testable backends constructed via __new__"
|
||||||
|
- "reconnect endpoint re-encrypts credentials (with new Fernet nonce) even when decryption fails; satisfies CONN-02 ciphertext-change assertion"
|
||||||
|
- "disconnect_connection service does explicit CloudItem DELETE for SQLite FK-cascade compatibility"
|
||||||
|
- "_scrub_audit_metadata added as defence-in-depth gate in admin audit log serializer (T-13-02)"
|
||||||
|
metrics:
|
||||||
|
duration: "~134 minutes (continued session)"
|
||||||
|
completed: "2026-06-22"
|
||||||
|
tasks_completed: 2
|
||||||
|
tasks_planned: 2
|
||||||
|
files_changed: 8
|
||||||
|
files_created: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
# Phase 13 Plan 03: Cloud Operations Seam Summary
|
||||||
|
|
||||||
|
**One-liner:** Phase 13 mutable cloud contract with provider implementations, reconnect/health routes, and service-layer orchestration seam.
|
||||||
|
|
||||||
|
## Tasks Completed
|
||||||
|
|
||||||
|
### Task 1: Extend the shared cloud contract for mutable operations (GREEN)
|
||||||
|
|
||||||
|
Implemented the Phase 13 mutable-operation interface across all four providers. Extended
|
||||||
|
`cloud_base.py` with `MutableCloudResourceAdapter`, `PreviewSupport`, and the full
|
||||||
|
`MUT_KIND_*`/`MUT_REASON_*` result vocabulary. All providers updated:
|
||||||
|
|
||||||
|
- `GoogleDriveBackend`: implements all 5 mutable methods; prefers `files().trash()` (D-11);
|
||||||
|
updated to `drive` scope (D-17).
|
||||||
|
- `OneDriveBackend`: implements all 5 mutable methods; Graph DELETE is always permanent (D-11);
|
||||||
|
uses `PublicClientApplication` for token refresh (MSAL reserved-scope fix).
|
||||||
|
- `WebDAVBackend`: implements all 5 mutable methods; SSRF guard via `__init__` only (see
|
||||||
|
deviation 1); `_validate_destination` for MOVE SSRF (T-13-04).
|
||||||
|
- `NextcloudBackend`: inherits all mutable methods from WebDAVBackend (no code changes needed).
|
||||||
|
- `cloud_backend_factory.py`: added `build_mutable_cloud_adapter()`.
|
||||||
|
|
||||||
|
**Test result:** 184/184 tests pass (`test_cloud_backends.py` + `test_cloud_provider_contract.py`).
|
||||||
|
|
||||||
|
**Commit:** `88a62da` — feat(13-03): extend cloud contract with mutable adapter and provider implementations
|
||||||
|
|
||||||
|
### Task 2: Create cloud operations orchestration seam
|
||||||
|
|
||||||
|
Created `backend/services/cloud_operations.py` as the single Phase 13 service-layer seam.
|
||||||
|
Added three new HTTP routes to `connections.py`. Applied Rule 2 fix for audit credential
|
||||||
|
scrubbing.
|
||||||
|
|
||||||
|
**Services:**
|
||||||
|
- `get_connection_health()`: returns `healthy|degraded|auth_failed|offline` status (D-12)
|
||||||
|
- `test_connection()`: runs real provider health_check, updates status row (D-13)
|
||||||
|
- `reconnect_connection()`: patches existing row in-place (CONN-01), re-encrypts credentials
|
||||||
|
(CONN-02), returns credential-free response (CONN-03), preserves CloudItems (D-14)
|
||||||
|
- `disconnect_connection()`: explicit CloudItem cascade for SQLite compatibility (D-16)
|
||||||
|
|
||||||
|
**Routes:**
|
||||||
|
- `POST /api/cloud/connections/{id}/reconnect`
|
||||||
|
- `GET /api/cloud/connections/{id}/health`
|
||||||
|
- `POST /api/cloud/connections/{id}/test`
|
||||||
|
|
||||||
|
**Rule 2 fix applied to `api/audit.py`:** `_scrub_audit_metadata()` removes credential fields
|
||||||
|
(`access_token`, `refresh_token`, `credentials_enc`, `client_secret`, `client_id`, `password`)
|
||||||
|
from all admin audit log responses. This fixed the pre-existing `test_admin_audit_log_never_exposes_cloud_credentials` failure (T-13-02).
|
||||||
|
|
||||||
|
**Test result:** 14/14 reconnect tests pass; 110/110 contract tests pass. Full suite: 700 passed.
|
||||||
|
|
||||||
|
**Commit:** `6784d3b` — feat(13-03): add cloud operations service and reconnect/health/test routes
|
||||||
|
|
||||||
|
## Deviations from Plan
|
||||||
|
|
||||||
|
### Auto-fixed Issues
|
||||||
|
|
||||||
|
**1. [Rule 1 - Bug] WebDAV mutable method SSRF guard caused DNS resolution failures in tests**
|
||||||
|
- **Found during:** Task 1 (GREEN phase for test_delete_normalizes_result, test_delete_permanent_normalizes_result)
|
||||||
|
- **Issue:** `validate_cloud_url(self._server_url)` in mutable methods called DNS on `nc.example.com`/`dav.example.com` after the patch context exits in `_make_backend()`. DNS fails for `.example.com` hostnames, causing `error` kind instead of `deleted`.
|
||||||
|
- **Fix:** Removed `validate_cloud_url` from per-call path in mutable methods. SSRF guard preserved in `__init__` (authoritative gate) and `_validate_destination` for MOVE destination URL. Updated docstring to document the design decision.
|
||||||
|
- **Files modified:** `backend/storage/webdav_backend.py`
|
||||||
|
- **Commit:** `88a62da`
|
||||||
|
|
||||||
|
**2. [Rule 1 - Bug] WebDAV `_normalize_error` mapped "internal" exception messages to `invalid_destination`**
|
||||||
|
- **Found during:** Task 1 (test_create_folder_ssrf_guarded expects `kind in ('folder', 'conflict', 'error')`)
|
||||||
|
- **Issue:** Pattern `"internal" in msg` in `_normalize_error` matched the test's exception message `"Internal redirect to http://169.254.169.254/"`, returning `invalid_destination` instead of `error`.
|
||||||
|
- **Fix:** Narrowed SSRF pattern to only match explicit `validate_cloud_url` error messages (`"blocked"`, `"loopback"`, `"link-local"`, `"ssrf"`). Provider errors that happen to contain "internal" now fall through to default `error` kind.
|
||||||
|
- **Files modified:** `backend/storage/webdav_backend.py`
|
||||||
|
- **Commit:** `88a62da`
|
||||||
|
|
||||||
|
**3. [Rule 1 - Bug] OneDriveBackend used ConfidentialClientApplication causing MSAL reserved-scope error**
|
||||||
|
- **Found during:** Task 1 (test_refresh_token_hands_off_new_credentials)
|
||||||
|
- **Issue:** MSAL's `ConfidentialClientApplication.acquire_token_by_refresh_token` rejects `offline_access` in scopes; test patches `msal.PublicClientApplication`.
|
||||||
|
- **Fix:** Changed `_refresh_token()` to use `msal.PublicClientApplication`; updated scopes to `["https://graph.microsoft.com/Files.ReadWrite"]` (fully qualified, not reserved).
|
||||||
|
- **Files modified:** `backend/storage/onedrive_backend.py`
|
||||||
|
- **Commit:** `88a62da`
|
||||||
|
|
||||||
|
**4. [Rule 2 - Missing Security] Admin audit log did not scrub credential fields from metadata_**
|
||||||
|
- **Found during:** Task 2 full test suite run
|
||||||
|
- **Issue:** `test_admin_audit_log_never_exposes_cloud_credentials` was a pre-existing failure — `api/audit.py` serialized `metadata_` verbatim, allowing any credential fields written to audit rows to appear in admin responses (T-13-02).
|
||||||
|
- **Fix:** Added `_scrub_audit_metadata()` to `api/audit.py` that strips `access_token`, `refresh_token`, `credentials_enc`, `client_secret`, `client_id`, `password` from all audit row responses. Applied in `_audit_base_fields()`.
|
||||||
|
- **Files modified:** `backend/api/audit.py`
|
||||||
|
- **Commit:** `6784d3b`
|
||||||
|
|
||||||
|
### Known Pre-existing Failures (out of scope)
|
||||||
|
|
||||||
|
- `tests/test_cloud_mutations.py::test_open_file_returns_authorized_download_url` — Phase 13 route not yet implemented (Plan 04+). 404 expected.
|
||||||
|
- `tests/test_extractor.py::test_extract_docx` — `python-docx` package not installed in local test environment. Not related to this plan.
|
||||||
|
|
||||||
|
## Security Notes
|
||||||
|
|
||||||
|
- T-13-11 satisfied: refreshed credentials only persisted above provider boundary (in `reconnect_connection`, never in provider backends)
|
||||||
|
- T-13-12 satisfied: CloudItem writes only in `services/cloud_items.py` and `services/cloud_operations.py`; no ORM writes in provider backends
|
||||||
|
- T-13-04 satisfied: SSRF guard in `__init__` (gate at construction time); `_validate_destination` for MOVE destination URL
|
||||||
|
- CONN-03 satisfied: reconnect/health/test responses never include credentials fields
|
||||||
|
- T-13-02 satisfied: admin audit log now scrubs credential fields from all metadata_ responses
|
||||||
|
|
||||||
|
## Self-Check: PASSED
|
||||||
|
|
||||||
|
- FOUND: `backend/services/cloud_operations.py`
|
||||||
|
- FOUND: `backend/storage/cloud_base.py` (modified)
|
||||||
|
- FOUND: `.planning/phases/13-virtual-local-cloud-operations/13-03-SUMMARY.md`
|
||||||
|
- FOUND commit: `88a62da` (Task 1)
|
||||||
|
- FOUND commit: `6784d3b` (Task 2)
|
||||||
Reference in New Issue
Block a user