-
Notifications
You must be signed in to change notification settings - Fork 0
feat: phase 22 — performance baselines completion #355
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
28 commits
Select commit
Hold shift + click to select a range
d76a624
docs(22): capture phase context
FSM1 b0eec83
docs(22): research phase domain
FSM1 e0ce3c6
docs(22): add validation strategy
FSM1 8818032
docs(22): create phase plan
FSM1 107823d
docs(22): update validation strategy with correct plan paths
FSM1 8da4fc9
test(22-01): add failing tests for perf instrumentation module
FSM1 36f835b
feat(22-01): implement perf.ts with environment-gated Performance API…
FSM1 6f458d7
test(22-03): add failing tests for threshold checking module
FSM1 d4dacae
test(22-02): add Playwright journey timing spec for 3 user journeys
FSM1 5a86234
feat(22-03): implement threshold checking module
FSM1 01d1104
docs(22-02): add journey timing baselines template for 3 user journeys
FSM1 868f610
feat(22-03): integrate threshold checks into all 5 load test scenarios
FSM1 1fc6cf6
feat(22-01): instrument 10 sdk-core functions with Performance API wr…
FSM1 0f60e0a
docs(22-02): complete journey timing baselines plan
FSM1 7cbed45
docs(22-03): create comprehensive capacity model document
FSM1 ee8621d
docs(22-01): complete SDK performance instrumentation plan
FSM1 17ecf67
docs(22-03): complete thresholds and capacity model plan
FSM1 afb70e3
docs(phase-22): complete phase execution
FSM1 b7fb166
docs(phase-22): evolve PROJECT.md after phase completion
FSM1 94fb2cb
refactor(22): clean up phase 22 code after review
FSM1 ad41d8e
docs(22): populate journey timing baselines from staging run
FSM1 128e8f2
fix(22): address PR review comments
FSM1 7f0bcf8
fix(22): address second round of PR review comments
FSM1 664f758
fix(22): change raw data code fence from json to text
FSM1 e730262
fix(22): fix misleading JSDoc on expectThresholdsPassed
FSM1 0d65774
merge: integrate main (Phase 21 completion) into phase 22 branch
FSM1 b778925
feat(22): instrument BYO pinFn path with ipfs:upload:byo perf marker
FSM1 fd80a77
refactor(22): rename ipfs:upload marker to ipfs:upload:cipherbox
FSM1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,12 +3,12 @@ gsd_state_version: 1.0 | |||||
| milestone: v1.1 | ||||||
| milestone_name: milestone | ||||||
| status: unknown | ||||||
| last_updated: '2026-03-25T01:34:07.674Z' | ||||||
| last_updated: '2026-03-25T01:50:49.360Z' | ||||||
| progress: | ||||||
| total_phases: 8 | ||||||
| completed_phases: 7 | ||||||
| total_plans: 39 | ||||||
| completed_plans: 39 | ||||||
| completed_phases: 8 | ||||||
| total_plans: 42 | ||||||
| completed_plans: 42 | ||||||
| --- | ||||||
|
|
||||||
| # Project State | ||||||
|
|
@@ -18,12 +18,12 @@ progress: | |||||
| See: .planning/PROJECT.md (updated 2026-03-07) | ||||||
|
|
||||||
| **Core value:** Zero-knowledge privacy -- files encrypted client-side, server never sees plaintext | ||||||
| **Current focus:** Phase 21 — byo-ipfs-node-support | ||||||
| **Current focus:** Phase 22 — performance-baselines-completion (complete) | ||||||
|
|
||||||
| ## Current Position | ||||||
|
|
||||||
| Phase: 21 (byo-ipfs-node-support) — EXECUTING | ||||||
| Plan: 4 of 4 | ||||||
| Phase: 22 (performance-baselines-completion) — COMPLETE | ||||||
| Plan: 3 of 3 (COMPLETE) | ||||||
|
|
||||||
| ## Performance Metrics | ||||||
|
|
||||||
|
|
@@ -70,6 +70,9 @@ Plan: 4 of 4 | |||||
| | 21 | 10 | 5min | 2 | 7 | | ||||||
| | 21 | 09 | 9min | 3 | 17 | | ||||||
| | 21 | 11 | 12min | 2 | 3 | | ||||||
| | 22 | 02 | 4min | 2 | 2 | | ||||||
| | 22 | 01 | 8min | 2 | 7 | | ||||||
| | 22 | 03 | 8min | 2 | 8 | | ||||||
|
|
||||||
| ## Accumulated Context | ||||||
|
|
||||||
|
|
@@ -139,6 +142,8 @@ Recent for v1.1: | |||||
| - pinWithMode treats Pinata like Kubo: direct upload bypasses CipherBox relay entirely | ||||||
| - Connection test probe order updated: Kubo -> Pinata -> PSA; pinata.cloud URLs skip Kubo probe | ||||||
| - BYO Pinata baselines: pin p50=2.0s (+47% vs local Kubo), tail latency p99 13.5% better, 98% CipherBox API load reduction per file | ||||||
| - perf.ts PERF_ENABLED evaluated once at module load (zero overhead in production); **CIPHERBOX_PERF** global for opt-in production debugging | ||||||
| - Load test thresholds set at 2-3x observed baselines; spike test most generous (15s/15%); vitest expect() for CI failure on breach | ||||||
|
||||||
| - Load test thresholds set at 2-3x observed baselines; spike test most generous (15s/15%); vitest expect() for CI failure on breach | |
| - Load test thresholds set at 2-3x observed baselines; spike test most generous (15s/15%); enforced via expectThresholdsPassed(...) which logs violations and throws on breach to fail CI |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| # Performance Baselines - Phase 22 (Journey Timing) | ||
|
|
||
| > End-to-end user journey timing captured via Playwright with real browser rendering. | ||
| > Timings include network, crypto, IPFS operations, and browser paint. | ||
|
|
||
| ## Capture Information | ||
|
|
||
| | Field | Value | | ||
| | ---------------- | ------------------------------------------------------------ | | ||
| | **Capture Date** | 2026-03-25 | | ||
| | **Environment** | Staging (api-staging.cipherbox.cc, app-staging.cipherbox.cc) | | ||
| | **Browser** | Chromium (Playwright managed, headless) | | ||
| | **Auth Method** | Mock wallet (EIP-1193 via @johanneskares/wallet-mock) | | ||
| | **Test File** | `tests/web-e2e/tests/journey-timing.spec.ts` | | ||
| | **API Version** | v0.27.0 (staging-cipher-box-v0.27.0-rc-1) | | ||
| | **VPS** | 4 vCPU, 8GB RAM (Hostinger) | | ||
|
|
||
| ## Journey 1: Login-to-Vault | ||
|
|
||
| Measures wall-clock time from clicking the wallet login button through vault metadata loading and file list rendering. | ||
|
|
||
| | Phase | Duration | | ||
| | --------------- | -------- | | ||
| | **Wallet Auth** | 23,483ms | | ||
| | **Vault Load** | 86ms | | ||
| | **Total** | 23,569ms | | ||
|
|
||
| Includes: Core Kit initialization wait, mock wallet connect, SIWE signature, backend JWT exchange, vault metadata IPNS resolve, file list React render. | ||
|
|
||
| **Note:** Wallet auth dominates at 99.6% of total time. This is Web3Auth Core Kit MPC initialization + Sapphire Devnet DKG key generation for a brand-new identity. Repeat logins (existing identity) are expected to be significantly faster (5-10s). | ||
|
|
||
| ## Journey 2: Upload-to-Visible | ||
|
|
||
| Measures wall-clock time from file input selection through the file appearing in the file list UI. | ||
|
|
||
| | Metric | Value | | ||
| | ------------------ | ------- | | ||
| | **File Size** | 100KB | | ||
| | **Total Duration** | 1,355ms | | ||
|
|
||
| Includes: AES-256-GCM encryption, IPFS ciphertext upload (pin), IPFS metadata upload (pin), IPNS file publish, folder metadata update, IPNS folder publish, React state update, file list re-render. | ||
|
|
||
| ## Journey 3: Share-to-Accessible | ||
|
|
||
| Measures wall-clock time from Alice initiating a share through Bob seeing the shared item in the Shared section. | ||
|
|
||
| | Phase | Duration | | ||
| | -------------------------- | -------- | | ||
| | **Share Create (Alice)** | 2,236ms | | ||
| | **Recipient Access (Bob)** | 803ms | | ||
| | **Total** | 3,039ms | | ||
|
|
||
| Includes: ECIES key wrapping for recipient, share key API call, share dialog UI interaction, Bob's navigation to Shared section, share list API fetch, shared item rendering. | ||
|
|
||
| ## Raw Data | ||
|
|
||
| ```text | ||
| JOURNEY_TIMING: {"journey":"login-to-vault","totalMs":23569,"phases":{"walletAuthMs":23483,"vaultLoadMs":86}} | ||
| JOURNEY_TIMING: {"journey":"upload-to-visible","totalMs":1355,"fileSizeBytes":102400} | ||
| JOURNEY_TIMING: {"journey":"share-to-accessible","totalMs":3039,"phases":{"shareCreateMs":2236,"recipientAccessMs":803}} | ||
| JOURNEY_TIMING: {"summary":true,"capturedAt":"2026-03-25T02:58:23.753Z","journeys":[{"journey":"login-to-vault","totalMs":23569,"phases":{"walletAuthMs":23483,"vaultLoadMs":86}},{"journey":"upload-to-visible","totalMs":1355,"fileSizeBytes":102400},{"journey":"share-to-accessible","totalMs":3039,"phases":{"shareCreateMs":2236,"recipientAccessMs":803}}]} | ||
| ``` | ||
|
|
||
| ## How to Recapture | ||
|
|
||
| Run the journey timing tests against staging: | ||
|
|
||
| ```bash | ||
| cd tests/web-e2e && npx playwright test journey-timing.spec.ts --config /tmp/pw-staging.config.ts | ||
| ``` | ||
|
|
||
| Or against localhost with API + frontend running: | ||
|
|
||
| ```bash | ||
| cd tests/web-e2e && pnpm exec playwright test tests/journey-timing.spec.ts | ||
| ``` | ||
|
|
||
| The test outputs structured JSON on each line prefixed with `JOURNEY_TIMING:`. The final summary line contains all journey results in a single JSON object. |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The state summary references a CIPHERBOX_PERF global flag, but the actual opt-in flag used by sdk-core perf gating is
globalThis.__CIPHERBOX_PERF__(double-underscore). This mismatch will mislead anyone trying to enable perf marks in production/debug builds; please update the flag name here to match the implementation.