xithead 1.5.0 → 1.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/design-system/README.md +80 -0
- package/package.json +20 -1
- package/public/apple-touch-icon.png +0 -0
- package/public/logo-transparent.png +0 -0
- package/public/xithead.ps1 +937 -0
- package/scripts/README.md +77 -0
- package/scripts/audit_wheel_glibc_symbols.py +217 -0
- package/scripts/build-master-design-system.cjs +33 -0
- package/scripts/build_rust_extension.sh +58 -0
- package/scripts/changelog-gen.py +203 -0
- package/scripts/eval_output_shaper.py +235 -0
- package/scripts/export_kompress_v2_onnx.py +267 -0
- package/scripts/fixtures/anthropic_replay_body.json +133 -0
- package/scripts/fixtures/codex_response_create_frame.json +52 -0
- package/scripts/install-git-hooks.sh +104 -0
- package/scripts/install.ps1 +1809 -0
- package/scripts/install.sh +1673 -0
- package/scripts/pr-governance.py +297 -0
- package/scripts/record_fixtures.py +59 -0
- package/scripts/refresh_model_limits.sh +48 -0
- package/scripts/replay_codex_ws_load.py +445 -0
- package/scripts/repro_codex_replay.py +699 -0
- package/scripts/smoke_issue_327.py +233 -0
- package/scripts/sync-plugin-versions.py +116 -0
- package/scripts/tests/test_changelog_gen.py +302 -0
- package/scripts/tests/test_pr_governance.py +163 -0
- package/scripts/tests/test_pr_health_labels.py +94 -0
- package/scripts/tests/test_pr_health_workflow.py +14 -0
- package/scripts/tests/test_sync_plugin_versions.py +131 -0
- package/scripts/tests/test_version_sync.py +291 -0
- package/scripts/validate-workflows.sh +39 -0
- package/scripts/verify-versions.py +106 -0
- package/scripts/version-sync.py +207 -0
- package/tailwind.config.js +31 -0
- package/tsconfig.json +84 -0
- package/.actrc +0 -14
- package/.actrc.local.example +0 -15
- package/.changelog.md +0 -2
- package/.claude/agents/academic-anthropologist.md +0 -125
- package/.claude/agents/academic-geographer.md +0 -127
- package/.claude/agents/academic-historian.md +0 -123
- package/.claude/agents/academic-narratologist.md +0 -118
- package/.claude/agents/academic-psychologist.md +0 -118
- package/.claude/agents/academic-statistician.md +0 -144
- package/.claude/agents/accounts-payable-agent.md +0 -205
- package/.claude/agents/agentic-identity-trust.md +0 -394
- package/.claude/agents/agents-orchestrator.md +0 -367
- package/.claude/agents/automation-governance-architect.md +0 -216
- package/.claude/agents/blender-addon-engineer.md +0 -243
- package/.claude/agents/business-strategist.md +0 -488
- package/.claude/agents/change-management-consultant.md +0 -497
- package/.claude/agents/chief-financial-officer.md +0 -388
- package/.claude/agents/corporate-training-designer.md +0 -192
- package/.claude/agents/customer-service.md +0 -398
- package/.claude/agents/customer-success-manager.md +0 -460
- package/.claude/agents/data-consolidation-agent.md +0 -60
- package/.claude/agents/data-privacy-officer.md +0 -412
- package/.claude/agents/design-brand-guardian.md +0 -322
- package/.claude/agents/design-image-prompt-engineer.md +0 -236
- package/.claude/agents/design-inclusive-visuals-specialist.md +0 -73
- package/.claude/agents/design-persona-walkthrough.md +0 -272
- package/.claude/agents/design-ui-designer.md +0 -386
- package/.claude/agents/design-ui-finish-gate-reviewer.md +0 -217
- package/.claude/agents/design-ux-architect.md +0 -482
- package/.claude/agents/design-ux-researcher.md +0 -329
- package/.claude/agents/design-visual-storyteller.md +0 -149
- package/.claude/agents/design-whimsy-injector.md +0 -460
- package/.claude/agents/economy-designer.md +0 -156
- package/.claude/agents/engineering-ai-data-remediation-engineer.md +0 -211
- package/.claude/agents/engineering-ai-engineer.md +0 -146
- package/.claude/agents/engineering-api-platform-engineer.md +0 -181
- package/.claude/agents/engineering-ats-validator-architect.md +0 -383
- package/.claude/agents/engineering-autonomous-optimization-architect.md +0 -121
- package/.claude/agents/engineering-backend-architect.md +0 -255
- package/.claude/agents/engineering-china-network-engineer.md +0 -252
- package/.claude/agents/engineering-cms-developer.md +0 -536
- package/.claude/agents/engineering-code-reviewer.md +0 -76
- package/.claude/agents/engineering-codebase-onboarding-engineer.md +0 -173
- package/.claude/agents/engineering-data-engineer.md +0 -349
- package/.claude/agents/engineering-data-visualization-engineer.md +0 -151
- package/.claude/agents/engineering-database-optimizer.md +0 -188
- package/.claude/agents/engineering-database-reliability-engineer.md +0 -201
- package/.claude/agents/engineering-desktop-app-engineer.md +0 -209
- package/.claude/agents/engineering-developer-tooling-engineer.md +0 -153
- package/.claude/agents/engineering-devops-automator.md +0 -385
- package/.claude/agents/engineering-drupal-performance.md +0 -347
- package/.claude/agents/engineering-drupal-shopping-cart.md +0 -360
- package/.claude/agents/engineering-electrical-engineer.md +0 -575
- package/.claude/agents/engineering-email-intelligence-engineer.md +0 -390
- package/.claude/agents/engineering-embedded-firmware-engineer.md +0 -196
- package/.claude/agents/engineering-feishu-integration-developer.md +0 -606
- package/.claude/agents/engineering-filament-optimization-specialist.md +0 -283
- package/.claude/agents/engineering-finops-engineer.md +0 -164
- package/.claude/agents/engineering-frontend-developer.md +0 -257
- package/.claude/agents/engineering-gaussdb-expert.md +0 -334
- package/.claude/agents/engineering-git-workflow-master.md +0 -98
- package/.claude/agents/engineering-i18n-engineer.md +0 -214
- package/.claude/agents/engineering-identity-access-engineer.md +0 -217
- package/.claude/agents/engineering-incident-response-commander.md +0 -444
- package/.claude/agents/engineering-iot-fleet-engineer.md +0 -148
- package/.claude/agents/engineering-it-service-manager.md +0 -561
- package/.claude/agents/engineering-knowledge-graph-engineer.md +0 -372
- package/.claude/agents/engineering-llm-post-training-engineer.md +0 -166
- package/.claude/agents/engineering-minimal-change-engineer.md +0 -207
- package/.claude/agents/engineering-mobile-app-builder.md +0 -493
- package/.claude/agents/engineering-mobile-release-engineer.md +0 -164
- package/.claude/agents/engineering-multi-agent-systems-architect.md +0 -600
- package/.claude/agents/engineering-network-engineer.md +0 -245
- package/.claude/agents/engineering-orgscript-engineer.md +0 -113
- package/.claude/agents/engineering-payments-billing-engineer.md +0 -228
- package/.claude/agents/engineering-pdf-engine-architect.md +0 -696
- package/.claude/agents/engineering-platform-engineer.md +0 -270
- package/.claude/agents/engineering-privacy-engineer.md +0 -152
- package/.claude/agents/engineering-prompt-engineer.md +0 -209
- package/.claude/agents/engineering-rag-pipeline-engineer.md +0 -450
- package/.claude/agents/engineering-rapid-prototyper.md +0 -466
- package/.claude/agents/engineering-realtime-collaboration-engineer.md +0 -200
- package/.claude/agents/engineering-rust-refactoring-specialist.md +0 -313
- package/.claude/agents/engineering-search-relevance-engineer.md +0 -237
- package/.claude/agents/engineering-section-508-specialist.md +0 -339
- package/.claude/agents/engineering-senior-developer.md +0 -176
- package/.claude/agents/engineering-servicenow-developer-mentor.md +0 -180
- package/.claude/agents/engineering-software-architect.md +0 -112
- package/.claude/agents/engineering-solidity-smart-contract-engineer.md +0 -522
- package/.claude/agents/engineering-sre.md +0 -90
- package/.claude/agents/engineering-technical-writer.md +0 -393
- package/.claude/agents/engineering-universal-document-compiler.md +0 -370
- package/.claude/agents/engineering-uswds-developer.md +0 -340
- package/.claude/agents/engineering-video-streaming-engineer.md +0 -151
- package/.claude/agents/engineering-voice-ai-integration-engineer.md +0 -584
- package/.claude/agents/engineering-webassembly-engineer.md +0 -153
- package/.claude/agents/engineering-wechat-mini-program-developer.md +0 -356
- package/.claude/agents/engineering-wordpress-performance.md +0 -346
- package/.claude/agents/engineering-wordpress-shopping-cart.md +0 -346
- package/.claude/agents/esg-sustainability-officer.md +0 -396
- package/.claude/agents/finance-bookkeeper-controller.md +0 -260
- package/.claude/agents/finance-financial-analyst.md +0 -234
- package/.claude/agents/finance-fpa-analyst.md +0 -263
- package/.claude/agents/finance-investment-researcher.md +0 -272
- package/.claude/agents/finance-tax-strategist.md +0 -239
- package/.claude/agents/game-audio-engineer.md +0 -264
- package/.claude/agents/game-designer.md +0 -167
- package/.claude/agents/gis-3d-scene-developer.md +0 -111
- package/.claude/agents/gis-analyst.md +0 -91
- package/.claude/agents/gis-bim-specialist.md +0 -108
- package/.claude/agents/gis-cartography-designer.md +0 -150
- package/.claude/agents/gis-drone-reality-mapping.md +0 -120
- package/.claude/agents/gis-geoai-ml-engineer.md +0 -105
- package/.claude/agents/gis-geoprocessing-specialist.md +0 -97
- package/.claude/agents/gis-qa-engineer.md +0 -133
- package/.claude/agents/gis-solution-engineer.md +0 -101
- package/.claude/agents/gis-spatial-data-engineer.md +0 -97
- package/.claude/agents/gis-spatial-data-scientist.md +0 -111
- package/.claude/agents/gis-technical-consultant.md +0 -86
- package/.claude/agents/gis-web-gis-developer.md +0 -108
- package/.claude/agents/godot-gameplay-scripter.md +0 -338
- package/.claude/agents/godot-multiplayer-engineer.md +0 -301
- package/.claude/agents/godot-shader-developer.md +0 -267
- package/.claude/agents/government-digital-presales-consultant.md +0 -363
- package/.claude/agents/grant-writer.md +0 -511
- package/.claude/agents/healthcare-aging-parent-care-companion.md +0 -414
- package/.claude/agents/healthcare-clinical-evidence-agent.md +0 -231
- package/.claude/agents/healthcare-customer-service.md +0 -389
- package/.claude/agents/healthcare-innovation-strategist.md +0 -433
- package/.claude/agents/healthcare-marketing-compliance.md +0 -395
- package/.claude/agents/healthcare-sovereign-health-systems-agent.md +0 -312
- package/.claude/agents/hospitality-guest-services.md +0 -603
- package/.claude/agents/hr-onboarding.md +0 -451
- package/.claude/agents/identity-graph-operator.md +0 -303
- package/.claude/agents/language-translator.md +0 -264
- package/.claude/agents/legal-billing-time-tracking.md +0 -569
- package/.claude/agents/legal-client-intake.md +0 -492
- package/.claude/agents/legal-document-review.md +0 -454
- package/.claude/agents/level-designer.md +0 -208
- package/.claude/agents/loan-officer-assistant.md +0 -555
- package/.claude/agents/lsp-index-engineer.md +0 -320
- package/.claude/agents/ma-integration-manager.md +0 -427
- package/.claude/agents/macos-spatial-metal-engineer.md +0 -337
- package/.claude/agents/marketing-aeo-foundations.md +0 -264
- package/.claude/agents/marketing-agentic-search-optimizer.md +0 -279
- package/.claude/agents/marketing-ai-citation-strategist.md +0 -172
- package/.claude/agents/marketing-app-store-optimizer.md +0 -321
- package/.claude/agents/marketing-baidu-seo-specialist.md +0 -226
- package/.claude/agents/marketing-bilibili-content-strategist.md +0 -199
- package/.claude/agents/marketing-book-co-author.md +0 -110
- package/.claude/agents/marketing-carousel-growth-engine.md +0 -204
- package/.claude/agents/marketing-china-ecommerce-operator.md +0 -283
- package/.claude/agents/marketing-china-market-localization-strategist.md +0 -283
- package/.claude/agents/marketing-content-creator.md +0 -54
- package/.claude/agents/marketing-cross-border-ecommerce.md +0 -259
- package/.claude/agents/marketing-developer-community-builder.md +0 -285
- package/.claude/agents/marketing-douyin-strategist.md +0 -149
- package/.claude/agents/marketing-email-strategist.md +0 -249
- package/.claude/agents/marketing-global-podcast-strategist.md +0 -206
- package/.claude/agents/marketing-growth-hacker.md +0 -54
- package/.claude/agents/marketing-instagram-curator.md +0 -113
- package/.claude/agents/marketing-kuaishou-strategist.md +0 -223
- package/.claude/agents/marketing-linkedin-content-creator.md +0 -214
- package/.claude/agents/marketing-livestream-commerce-coach.md +0 -305
- package/.claude/agents/marketing-multi-platform-publisher.md +0 -217
- package/.claude/agents/marketing-podcast-strategist.md +0 -277
- package/.claude/agents/marketing-pr-communications-manager.md +0 -473
- package/.claude/agents/marketing-private-domain-operator.md +0 -308
- package/.claude/agents/marketing-reddit-community-builder.md +0 -123
- package/.claude/agents/marketing-seo-specialist.md +0 -370
- package/.claude/agents/marketing-short-video-editing-coach.md +0 -412
- package/.claude/agents/marketing-social-media-strategist.md +0 -125
- package/.claude/agents/marketing-tiktok-strategist.md +0 -125
- package/.claude/agents/marketing-twitter-engager.md +0 -126
- package/.claude/agents/marketing-video-optimization-specialist.md +0 -119
- package/.claude/agents/marketing-wechat-official-account.md +0 -145
- package/.claude/agents/marketing-weibo-strategist.md +0 -240
- package/.claude/agents/marketing-x-twitter-intelligence-analyst.md +0 -161
- package/.claude/agents/marketing-xiaohongshu-specialist.md +0 -138
- package/.claude/agents/marketing-zhihu-strategist.md +0 -162
- package/.claude/agents/medical-billing-coding-specialist.md +0 -491
- package/.claude/agents/narrative-designer.md +0 -243
- package/.claude/agents/operations-manager.md +0 -399
- package/.claude/agents/organizational-psychologist.md +0 -391
- package/.claude/agents/paid-media-auditor.md +0 -71
- package/.claude/agents/paid-media-creative-strategist.md +0 -71
- package/.claude/agents/paid-media-paid-social-strategist.md +0 -71
- package/.claude/agents/paid-media-ppc-strategist.md +0 -71
- package/.claude/agents/paid-media-programmatic-buyer.md +0 -71
- package/.claude/agents/paid-media-search-query-analyst.md +0 -71
- package/.claude/agents/paid-media-tracking-specialist.md +0 -71
- package/.claude/agents/personal-growth-mentor.md +0 -159
- package/.claude/agents/product-behavioral-nudge-engine.md +0 -83
- package/.claude/agents/product-dx-engineer.md +0 -332
- package/.claude/agents/product-feedback-synthesizer.md +0 -119
- package/.claude/agents/product-manager.md +0 -469
- package/.claude/agents/product-sprint-prioritizer.md +0 -154
- package/.claude/agents/product-trend-researcher.md +0 -159
- package/.claude/agents/project-management-experiment-tracker.md +0 -198
- package/.claude/agents/project-management-jira-workflow-steward.md +0 -233
- package/.claude/agents/project-management-meeting-notes-specialist.md +0 -95
- package/.claude/agents/project-management-project-shepherd.md +0 -194
- package/.claude/agents/project-management-studio-operations.md +0 -200
- package/.claude/agents/project-management-studio-producer.md +0 -203
- package/.claude/agents/project-manager-senior.md +0 -135
- package/.claude/agents/real-estate-buyer-seller.md +0 -596
- package/.claude/agents/recruitment-specialist.md +0 -515
- package/.claude/agents/report-distribution-agent.md +0 -65
- package/.claude/agents/research-synthesist.md +0 -136
- package/.claude/agents/resume-tailor.md +0 -230
- package/.claude/agents/retail-customer-returns.md +0 -566
- package/.claude/agents/roblox-avatar-creator.md +0 -297
- package/.claude/agents/roblox-experience-designer.md +0 -306
- package/.claude/agents/roblox-systems-scripter.md +0 -332
- package/.claude/agents/sales-account-strategist.md +0 -227
- package/.claude/agents/sales-coach.md +0 -271
- package/.claude/agents/sales-data-extraction-agent.md +0 -67
- package/.claude/agents/sales-deal-strategist.md +0 -180
- package/.claude/agents/sales-discovery-coach.md +0 -225
- package/.claude/agents/sales-engineer.md +0 -182
- package/.claude/agents/sales-offer-lead-gen-strategist.md +0 -257
- package/.claude/agents/sales-outbound-strategist.md +0 -201
- package/.claude/agents/sales-outreach.md +0 -425
- package/.claude/agents/sales-pipeline-analyst.md +0 -267
- package/.claude/agents/sales-proposal-strategist.md +0 -217
- package/.claude/agents/security-ai-generated-code-auditor.md +0 -207
- package/.claude/agents/security-appsec-engineer.md +0 -536
- package/.claude/agents/security-architect.md +0 -307
- package/.claude/agents/security-blockchain-security-auditor.md +0 -482
- package/.claude/agents/security-cloud-security-architect.md +0 -576
- package/.claude/agents/security-compliance-auditor.md +0 -158
- package/.claude/agents/security-incident-responder.md +0 -450
- package/.claude/agents/security-penetration-tester.md +0 -399
- package/.claude/agents/security-secrets-credential-engineer.md +0 -189
- package/.claude/agents/security-senior-secops.md +0 -760
- package/.claude/agents/security-threat-detection-engineer.md +0 -553
- package/.claude/agents/security-threat-intelligence-analyst.md +0 -661
- package/.claude/agents/specialized-chief-of-staff.md +0 -279
- package/.claude/agents/specialized-civil-engineer.md +0 -356
- package/.claude/agents/specialized-codebase-archaeologist.md +0 -341
- package/.claude/agents/specialized-cultural-intelligence-strategist.md +0 -88
- package/.claude/agents/specialized-developer-advocate.md +0 -317
- package/.claude/agents/specialized-document-generator.md +0 -55
- package/.claude/agents/specialized-fedramp-rmf-compliance.md +0 -378
- package/.claude/agents/specialized-focus-music-architect.md +0 -175
- package/.claude/agents/specialized-french-consulting-market.md +0 -194
- package/.claude/agents/specialized-korean-business-navigator.md +0 -216
- package/.claude/agents/specialized-master-plan-architect.md +0 -157
- package/.claude/agents/specialized-mcp-builder.md +0 -260
- package/.claude/agents/specialized-model-qa.md +0 -528
- package/.claude/agents/specialized-pricing-analyst.md +0 -243
- package/.claude/agents/specialized-salesforce-architect.md +0 -182
- package/.claude/agents/specialized-strategy-duel-agent.md +0 -130
- package/.claude/agents/specialized-workflow-architect.md +0 -597
- package/.claude/agents/study-abroad-advisor.md +0 -282
- package/.claude/agents/supply-chain-strategist.md +0 -591
- package/.claude/agents/support-analytics-reporter.md +0 -387
- package/.claude/agents/support-executive-summary-generator.md +0 -212
- package/.claude/agents/support-finance-tracker.md +0 -480
- package/.claude/agents/support-infrastructure-maintainer.md +0 -628
- package/.claude/agents/support-legal-compliance-checker.md +0 -591
- package/.claude/agents/support-support-responder.md +0 -607
- package/.claude/agents/technical-artist.md +0 -233
- package/.claude/agents/terminal-integration-specialist.md +0 -70
- package/.claude/agents/testing-accessibility-auditor.md +0 -327
- package/.claude/agents/testing-api-tester.md +0 -334
- package/.claude/agents/testing-evidence-collector.md +0 -210
- package/.claude/agents/testing-performance-benchmarker.md +0 -283
- package/.claude/agents/testing-reality-checker.md +0 -249
- package/.claude/agents/testing-test-automation-engineer.md +0 -196
- package/.claude/agents/testing-test-results-analyzer.md +0 -330
- package/.claude/agents/testing-tool-evaluator.md +0 -416
- package/.claude/agents/testing-workflow-optimizer.md +0 -463
- package/.claude/agents/unity-architect.md +0 -271
- package/.claude/agents/unity-editor-tool-developer.md +0 -310
- package/.claude/agents/unity-multiplayer-engineer.md +0 -323
- package/.claude/agents/unity-shader-graph-artist.md +0 -269
- package/.claude/agents/unreal-multiplayer-architect.md +0 -364
- package/.claude/agents/unreal-systems-engineer.md +0 -322
- package/.claude/agents/unreal-technical-artist.md +0 -256
- package/.claude/agents/unreal-world-builder.md +0 -273
- package/.claude/agents/visionos-spatial-engineer.md +0 -54
- package/.claude/agents/xr-cockpit-interaction-specialist.md +0 -32
- package/.claude/agents/xr-immersive-developer.md +0 -32
- package/.claude/agents/xr-interface-architect.md +0 -32
- package/.claude/agents/zk-steward.md +0 -211
- package/.claude-plugin/marketplace.json +0 -30
- package/.commitlintrc.json +0 -26
- package/.devcontainer/Dockerfile +0 -24
- package/.devcontainer/devcontainer.json +0 -70
- package/.devcontainer/docker-compose.memory.yml +0 -42
- package/.devcontainer/memory-stack/devcontainer.json +0 -84
- package/.devcontainer/post-create.sh +0 -83
- package/.dockerignore +0 -23
- package/.env.act.example +0 -15
- package/.env.example +0 -171
- package/.eslintrc.json +0 -16
- package/.git-blame-ignore-revs +0 -10
- package/.gitattributes +0 -2
- package/.gitguardian.yaml +0 -50
- package/.githooks/pre-commit +0 -6
- package/.pre-commit-config.yaml +0 -30
- package/.release-please-config-xithead.json +0 -22
- package/.release-please-config.json +0 -44
- package/.release-please-manifest-xithead.json +0 -3
- package/.release-please-manifest.json +0 -3
- package/CODE_OF_CONDUCT.md +0 -133
- package/CONTRIBUTING.md +0 -133
- package/Cargo.lock +0 -5557
- package/Cargo.toml +0 -121
- package/Dockerfile +0 -38
- package/Dockerfile.proxy +0 -48
- package/ENTERPRISE.md +0 -5
- package/FEATURES_ADVANCED.md +0 -311
- package/Headroom-2.gif +0 -0
- package/HeadroomDemo-Fast.gif +0 -0
- package/MANIFEST.in +0 -4
- package/MODERNIZATION_GUIDE.md +0 -358
- package/Makefile +0 -140
- package/NOTICE +0 -43
- package/NPM_TOKEN_SETUP.md +0 -81
- package/PR.md +0 -170
- package/PUBLISH.md +0 -77
- package/README_FRONTEND.md +0 -196
- package/REALIGNMENT/00-overview.md +0 -53
- package/REALIGNMENT/01-bug-list.md +0 -421
- package/REALIGNMENT/02-architecture.md +0 -322
- package/REALIGNMENT/03-phase-A-lockdown.md +0 -420
- package/REALIGNMENT/04-phase-B-live-zone.md +0 -470
- package/REALIGNMENT/05-phase-C-rust-proxy.md +0 -329
- package/REALIGNMENT/06-phase-D-bedrock-vertex.md +0 -222
- package/REALIGNMENT/07-phase-E-cache-stabilization.md +0 -338
- package/REALIGNMENT/08-phase-F-auth-mode.md +0 -254
- package/REALIGNMENT/09-phase-G-rtk-observability.md +0 -194
- package/REALIGNMENT/10-phase-H-python-retirement.md +0 -214
- package/REALIGNMENT/11-phase-I-test-infra.md +0 -385
- package/REALIGNMENT/12-decisions-needed.md +0 -196
- package/REALIGNMENT/INDEX.md +0 -82
- package/REFACTORING_CAMPAIGN.md +0 -277
- package/RESTRUCTURE_PLAN.md +0 -100
- package/RUST_DEV.md +0 -361
- package/SECURITY.md +0 -65
- package/SETUP_AUTO_PUBLISH.md +0 -164
- package/TESTING-copilot-subscription.md +0 -153
- package/codecov.yml +0 -34
- package/crates/headroom-core/Cargo.toml +0 -165
- package/crates/headroom-core/benches/auth_mode.rs +0 -74
- package/crates/headroom-core/benches/ccr_store.rs +0 -224
- package/crates/headroom-core/benches/tokenizer.rs +0 -52
- package/crates/headroom-core/config/pipeline.toml +0 -151
- package/crates/headroom-core/proptest-regressions/transforms/tag_protector.txt +0 -9
- package/crates/headroom-core/src/auth_mode.rs +0 -250
- package/crates/headroom-core/src/cache_control.rs +0 -414
- package/crates/headroom-core/src/ccr/backends/in_memory.rs +0 -317
- package/crates/headroom-core/src/ccr/backends/mod.rs +0 -152
- package/crates/headroom-core/src/ccr/backends/redis.rs +0 -146
- package/crates/headroom-core/src/ccr/backends/sqlite.rs +0 -205
- package/crates/headroom-core/src/ccr/mod.rs +0 -119
- package/crates/headroom-core/src/compression_policy.rs +0 -505
- package/crates/headroom-core/src/lib.rs +0 -33
- package/crates/headroom-core/src/relevance/base.rs +0 -139
- package/crates/headroom-core/src/relevance/bm25.rs +0 -385
- package/crates/headroom-core/src/relevance/embedding.rs +0 -354
- package/crates/headroom-core/src/relevance/hybrid.rs +0 -364
- package/crates/headroom-core/src/relevance/mod.rs +0 -64
- package/crates/headroom-core/src/signals/keyword_detector.rs +0 -433
- package/crates/headroom-core/src/signals/line_importance.rs +0 -84
- package/crates/headroom-core/src/signals/mod.rs +0 -61
- package/crates/headroom-core/src/signals/tiered.rs +0 -141
- package/crates/headroom-core/src/tokenizer/estimator.rs +0 -152
- package/crates/headroom-core/src/tokenizer/hf_impl.rs +0 -314
- package/crates/headroom-core/src/tokenizer/mod.rs +0 -56
- package/crates/headroom-core/src/tokenizer/registry.rs +0 -342
- package/crates/headroom-core/src/tokenizer/tiktoken_impl.rs +0 -265
- package/crates/headroom-core/src/transforms/adaptive_sizer.rs +0 -610
- package/crates/headroom-core/src/transforms/anchor_selector.rs +0 -1189
- package/crates/headroom-core/src/transforms/content_detector.rs +0 -769
- package/crates/headroom-core/src/transforms/detection.rs +0 -222
- package/crates/headroom-core/src/transforms/diff_compressor.rs +0 -1685
- package/crates/headroom-core/src/transforms/live_zone.rs +0 -2967
- package/crates/headroom-core/src/transforms/log_compressor.rs +0 -1295
- package/crates/headroom-core/src/transforms/magika_detector.rs +0 -395
- package/crates/headroom-core/src/transforms/mod.rs +0 -64
- package/crates/headroom-core/src/transforms/pipeline/config.rs +0 -331
- package/crates/headroom-core/src/transforms/pipeline/mod.rs +0 -103
- package/crates/headroom-core/src/transforms/pipeline/offloads/diff_noise.rs +0 -524
- package/crates/headroom-core/src/transforms/pipeline/offloads/diff_offload.rs +0 -279
- package/crates/headroom-core/src/transforms/pipeline/offloads/json_offload.rs +0 -400
- package/crates/headroom-core/src/transforms/pipeline/offloads/log_offload.rs +0 -284
- package/crates/headroom-core/src/transforms/pipeline/offloads/mod.rs +0 -34
- package/crates/headroom-core/src/transforms/pipeline/offloads/search_offload.rs +0 -331
- package/crates/headroom-core/src/transforms/pipeline/orchestrator.rs +0 -848
- package/crates/headroom-core/src/transforms/pipeline/reformats/json_minifier.rs +0 -175
- package/crates/headroom-core/src/transforms/pipeline/reformats/log_template.rs +0 -545
- package/crates/headroom-core/src/transforms/pipeline/reformats/mod.rs +0 -12
- package/crates/headroom-core/src/transforms/pipeline/traits.rs +0 -338
- package/crates/headroom-core/src/transforms/recommendations.rs +0 -329
- package/crates/headroom-core/src/transforms/safety.rs +0 -215
- package/crates/headroom-core/src/transforms/search_compressor.rs +0 -902
- package/crates/headroom-core/src/transforms/smart_crusher/analyzer.rs +0 -1262
- package/crates/headroom-core/src/transforms/smart_crusher/anchors.rs +0 -407
- package/crates/headroom-core/src/transforms/smart_crusher/builder.rs +0 -263
- package/crates/headroom-core/src/transforms/smart_crusher/classifier.rs +0 -214
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/classifier.rs +0 -283
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/compactor.rs +0 -733
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/formatter.rs +0 -961
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/ir.rs +0 -252
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/mod.rs +0 -127
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/walker.rs +0 -397
- package/crates/headroom-core/src/transforms/smart_crusher/config.rs +0 -173
- package/crates/headroom-core/src/transforms/smart_crusher/constraints.rs +0 -159
- package/crates/headroom-core/src/transforms/smart_crusher/crusher.rs +0 -1665
- package/crates/headroom-core/src/transforms/smart_crusher/crushers.rs +0 -865
- package/crates/headroom-core/src/transforms/smart_crusher/error_keywords.rs +0 -77
- package/crates/headroom-core/src/transforms/smart_crusher/field_detect.rs +0 -393
- package/crates/headroom-core/src/transforms/smart_crusher/hashing.rs +0 -72
- package/crates/headroom-core/src/transforms/smart_crusher/mod.rs +0 -81
- package/crates/headroom-core/src/transforms/smart_crusher/observer.rs +0 -66
- package/crates/headroom-core/src/transforms/smart_crusher/orchestration.rs +0 -459
- package/crates/headroom-core/src/transforms/smart_crusher/outliers.rs +0 -507
- package/crates/headroom-core/src/transforms/smart_crusher/planning.rs +0 -904
- package/crates/headroom-core/src/transforms/smart_crusher/statistics.rs +0 -510
- package/crates/headroom-core/src/transforms/smart_crusher/stats_math.rs +0 -287
- package/crates/headroom-core/src/transforms/smart_crusher/traits.rs +0 -203
- package/crates/headroom-core/src/transforms/smart_crusher/types.rs +0 -263
- package/crates/headroom-core/src/transforms/tag_protector.rs +0 -1272
- package/crates/headroom-core/src/transforms/unidiff_detector.rs +0 -232
- package/crates/headroom-parity/Cargo.toml +0 -26
- package/crates/headroom-parity/examples/diff_fixture.rs +0 -66
- package/crates/headroom-parity/src/bin/parity_run.rs +0 -78
- package/crates/headroom-parity/src/lib.rs +0 -613
- package/crates/headroom-proxy/Cargo.toml +0 -119
- package/crates/headroom-proxy/data/model_prices_and_context_window.json +0 -39767
- package/crates/headroom-proxy/src/bedrock/auth_mode_layer.rs +0 -192
- package/crates/headroom-proxy/src/bedrock/envelope.rs +0 -239
- package/crates/headroom-proxy/src/bedrock/eventstream.rs +0 -769
- package/crates/headroom-proxy/src/bedrock/eventstream_to_sse.rs +0 -459
- package/crates/headroom-proxy/src/bedrock/invoke.rs +0 -735
- package/crates/headroom-proxy/src/bedrock/invoke_streaming.rs +0 -1098
- package/crates/headroom-proxy/src/bedrock/mod.rs +0 -66
- package/crates/headroom-proxy/src/bedrock/sigv4.rs +0 -324
- package/crates/headroom-proxy/src/bedrock/vendor.rs +0 -82
- package/crates/headroom-proxy/src/cache_stabilization/anthropic_cache_control.rs +0 -698
- package/crates/headroom-proxy/src/cache_stabilization/drift_detector.rs +0 -683
- package/crates/headroom-proxy/src/cache_stabilization/mod.rs +0 -61
- package/crates/headroom-proxy/src/cache_stabilization/openai_cache_key.rs +0 -600
- package/crates/headroom-proxy/src/cache_stabilization/tool_def_normalize.rs +0 -514
- package/crates/headroom-proxy/src/cache_stabilization/volatile_detector.rs +0 -720
- package/crates/headroom-proxy/src/compression/anthropic.rs +0 -92
- package/crates/headroom-proxy/src/compression/live_zone_anthropic.rs +0 -1311
- package/crates/headroom-proxy/src/compression/live_zone_openai.rs +0 -660
- package/crates/headroom-proxy/src/compression/live_zone_responses.rs +0 -678
- package/crates/headroom-proxy/src/compression/mod.rs +0 -127
- package/crates/headroom-proxy/src/compression/model_limits.rs +0 -211
- package/crates/headroom-proxy/src/config.rs +0 -646
- package/crates/headroom-proxy/src/error.rs +0 -69
- package/crates/headroom-proxy/src/handlers/chat_completions.rs +0 -100
- package/crates/headroom-proxy/src/handlers/conversations.rs +0 -241
- package/crates/headroom-proxy/src/handlers/mod.rs +0 -13
- package/crates/headroom-proxy/src/handlers/responses.rs +0 -256
- package/crates/headroom-proxy/src/headers.rs +0 -288
- package/crates/headroom-proxy/src/health.rs +0 -41
- package/crates/headroom-proxy/src/lib.rs +0 -21
- package/crates/headroom-proxy/src/main.rs +0 -141
- package/crates/headroom-proxy/src/observability/cache_hit_rate.rs +0 -340
- package/crates/headroom-proxy/src/observability/compression_ratio.rs +0 -158
- package/crates/headroom-proxy/src/observability/metric_names.rs +0 -174
- package/crates/headroom-proxy/src/observability/mod.rs +0 -68
- package/crates/headroom-proxy/src/observability/prometheus.rs +0 -394
- package/crates/headroom-proxy/src/observability/proxy_metrics.rs +0 -368
- package/crates/headroom-proxy/src/proxy.rs +0 -1619
- package/crates/headroom-proxy/src/responses_items.rs +0 -565
- package/crates/headroom-proxy/src/sse/anthropic.rs +0 -415
- package/crates/headroom-proxy/src/sse/framing.rs +0 -366
- package/crates/headroom-proxy/src/sse/mod.rs +0 -40
- package/crates/headroom-proxy/src/sse/openai_chat.rs +0 -231
- package/crates/headroom-proxy/src/sse/openai_responses.rs +0 -458
- package/crates/headroom-proxy/src/vertex/adc.rs +0 -315
- package/crates/headroom-proxy/src/vertex/envelope.rs +0 -167
- package/crates/headroom-proxy/src/vertex/mod.rs +0 -277
- package/crates/headroom-proxy/src/vertex/raw_predict.rs +0 -490
- package/crates/headroom-proxy/src/vertex/stream_raw_predict.rs +0 -49
- package/crates/headroom-proxy/src/websocket.rs +0 -246
- package/crates/headroom-py/Cargo.toml +0 -37
- package/crates/headroom-py/build.rs +0 -77
- package/crates/headroom-py/glibc_compat.c +0 -170
- package/crates/headroom-py/src/lib.rs +0 -1655
- package/deny.toml +0 -32
- package/docker/differential-network-capture/Dockerfile.runner +0 -14
- package/docker/differential-network-capture/docker-compose.yml +0 -142
- package/docker/differential-network-capture/run-claude-lane.sh +0 -24
- package/docker/docker-compose.native.yml +0 -44
- package/docker-bake.hcl +0 -88
- package/docker-compose.yml +0 -80
- package/e2e/_lib/make_shim.ps1 +0 -24
- package/e2e/_lib/make_shim.sh +0 -28
- package/e2e/docker-native-install.sh +0 -120
- package/e2e/init/Dockerfile +0 -79
- package/e2e/wrap/Dockerfile +0 -115
- package/examples/07-context-compression.ipynb +0 -279
- package/examples/deployment/macos-launchagent/com.headroom.proxy.plist.template +0 -65
- package/examples/deployment/macos-launchagent/install.sh +0 -227
- package/examples/deployment/macos-launchagent/shell-integration.sh +0 -74
- package/examples/deployment/macos-launchagent/uninstall.sh +0 -145
- package/headroom-savings.png +0 -0
- package/headroom_learn.gif +0 -0
- package/llms.txt +0 -67
- package/mkdocs.yml +0 -136
- package/npm/bin/xithead.js +0 -366
- package/npm/bin/xtream-head.js +0 -366
- package/npm/index.d.ts +0 -57
- package/npm/index.js +0 -139
- package/npm/package.json +0 -55
- package/npm/postinstall.js +0 -43
- package/plugins/headroom-agent-hooks/.claude-plugin/plugin.json +0 -17
- package/plugins/headroom-agent-hooks/hooks/hooks.json +0 -29
- package/plugins/headroom-oauth2/LICENSE +0 -3
- package/plugins/headroom-oauth2/SPEC.md +0 -115
- package/plugins/headroom-oauth2/pyproject.toml +0 -48
- package/plugins/hermes/headroom_retrieve/plugin.yaml +0 -6
- package/plugins/openclaw/hook-shim/HOOK.md +0 -21
- package/plugins/openclaw/hook-shim/handler.js +0 -3
- package/plugins/openclaw/openclaw.plugin.json +0 -98
- package/plugins/openclaw/package-lock.json +0 -2692
- package/plugins/openclaw/package.json +0 -54
- package/plugins/openclaw/prepare-dist.mjs +0 -56
- package/plugins/openclaw/src/convert.ts +0 -418
- package/plugins/openclaw/src/engine.ts +0 -284
- package/plugins/openclaw/src/gateway-config.ts +0 -143
- package/plugins/openclaw/src/index.ts +0 -11
- package/plugins/openclaw/src/plugin/index.ts +0 -98
- package/plugins/openclaw/src/proxy-manager.ts +0 -477
- package/plugins/openclaw/src/tools/headroom-retrieve.ts +0 -76
- package/plugins/openclaw/test/convert.test.ts +0 -96
- package/plugins/openclaw/test/engine-normalization.test.ts +0 -21
- package/plugins/openclaw/test/engine.test.ts +0 -101
- package/plugins/openclaw/test/gateway-config.test.ts +0 -278
- package/plugins/openclaw/test/plugin-runtime-routing.test.ts +0 -141
- package/plugins/openclaw/test/proxy-manager.test.ts +0 -343
- package/plugins/openclaw/tsup.config.ts +0 -9
- package/pyproject.toml +0 -438
- package/rust-toolchain.toml +0 -16
- package/sdk/typescript/examples/basic-compress.ts +0 -64
- package/sdk/typescript/examples/ccr-retrieve.ts +0 -80
- package/sdk/typescript/examples/hooks-custom-compression.ts +0 -117
- package/sdk/typescript/examples/middleware-composition.ts +0 -59
- package/sdk/typescript/examples/multi-provider.ts +0 -53
- package/sdk/typescript/examples/openai-anthropic-adapters.ts +0 -73
- package/sdk/typescript/examples/shared-context-multi-agent.ts +0 -74
- package/sdk/typescript/examples/simulation-dry-run.ts +0 -80
- package/sdk/typescript/examples/streaming-chat.ts +0 -71
- package/sdk/typescript/examples/structured-output.ts +0 -99
- package/sdk/typescript/examples/tool-calling-agent.ts +0 -86
- package/sdk/typescript/examples/with-headroom-vercel.ts +0 -57
- package/sdk/typescript/package-lock.json +0 -3437
- package/sdk/typescript/package.json +0 -108
- package/sdk/typescript/src/adapters/anthropic.ts +0 -218
- package/sdk/typescript/src/adapters/gemini.ts +0 -83
- package/sdk/typescript/src/adapters/openai.ts +0 -77
- package/sdk/typescript/src/adapters/vercel-ai.ts +0 -131
- package/sdk/typescript/src/client.ts +0 -632
- package/sdk/typescript/src/compress.ts +0 -87
- package/sdk/typescript/src/errors.ts +0 -114
- package/sdk/typescript/src/hooks.ts +0 -113
- package/sdk/typescript/src/index.ts +0 -140
- package/sdk/typescript/src/paths.ts +0 -272
- package/sdk/typescript/src/shared-context.ts +0 -188
- package/sdk/typescript/src/simulate.ts +0 -52
- package/sdk/typescript/src/types/config.ts +0 -183
- package/sdk/typescript/src/types/models.ts +0 -314
- package/sdk/typescript/src/types.ts +0 -139
- package/sdk/typescript/src/utils/case.ts +0 -34
- package/sdk/typescript/src/utils/format.ts +0 -480
- package/sdk/typescript/src/utils/stream.ts +0 -50
- package/sdk/typescript/test/adapters/anthropic.test.ts +0 -217
- package/sdk/typescript/test/adapters/gemini.test.ts +0 -131
- package/sdk/typescript/test/adapters/openai.test.ts +0 -174
- package/sdk/typescript/test/adapters/vercel-ai.test.ts +0 -306
- package/sdk/typescript/test/client-expanded.test.ts +0 -333
- package/sdk/typescript/test/client.test.ts +0 -266
- package/sdk/typescript/test/compress.test.ts +0 -118
- package/sdk/typescript/test/config.test.ts +0 -275
- package/sdk/typescript/test/errors.test.ts +0 -169
- package/sdk/typescript/test/format-integration.test.ts +0 -252
- package/sdk/typescript/test/hooks.test.ts +0 -265
- package/sdk/typescript/test/integration.test.ts +0 -249
- package/sdk/typescript/test/mdx-examples.test.ts +0 -253
- package/sdk/typescript/test/models.test.ts +0 -318
- package/sdk/typescript/test/parity.test.ts +0 -337
- package/sdk/typescript/test/paths.test.ts +0 -447
- package/sdk/typescript/test/shared-context.test.ts +0 -245
- package/sdk/typescript/test/simulate.test.ts +0 -84
- package/sdk/typescript/test/types.test.ts +0 -244
- package/sdk/typescript/test/utils/case.test.ts +0 -129
- package/sdk/typescript/test/utils/detect-format.test.ts +0 -133
- package/sdk/typescript/test/utils/format.test.ts +0 -434
- package/sdk/typescript/test/vercel-ai-e2e.test.ts +0 -179
- package/sdk/typescript/tsup.config.ts +0 -17
- package/uv.lock +0 -6951
- package/xithead.egg-info/PKG-INFO +0 -22
- package/xithead.egg-info/SOURCES.txt +0 -16
- package/xithead.egg-info/dependency_links.txt +0 -1
- package/xithead.egg-info/entry_points.txt +0 -2
- package/xithead.egg-info/requires.txt +0 -10
- package/xithead.egg-info/top_level.txt +0 -2
- package/xithead.ps1 +0 -136
- package/xithead.sh +0 -129
- package/xithead_dist/pyproject.toml +0 -39
- package/xithead_dist/xithead.egg-info/PKG-INFO +0 -22
- package/xithead_dist/xithead.egg-info/SOURCES.txt +0 -16
- package/xithead_dist/xithead.egg-info/dependency_links.txt +0 -1
- package/xithead_dist/xithead.egg-info/entry_points.txt +0 -3
- package/xithead_dist/xithead.egg-info/requires.txt +0 -10
- package/xithead_dist/xithead.egg-info/top_level.txt +0 -2
|
@@ -1,153 +0,0 @@
|
|
|
1
|
-
# Testing: GitHub Copilot subscription mode (`headroom wrap copilot --subscription`)
|
|
2
|
-
|
|
3
|
-
This is an **experimental** feature and we need help verifying it on **Linux and
|
|
4
|
-
Windows**. It already works on macOS; the cross-platform gap is small and
|
|
5
|
-
specific (see [Status](#status)). If you have a GitHub Copilot subscription and
|
|
6
|
-
10 minutes, please run one of the flows below and
|
|
7
|
-
[file a report](https://github.com/Xtream-ITSolutions/xithead/issues/new?template=copilot-subscription-test-report.md).
|
|
8
|
-
|
|
9
|
-
> ⚠️ This is experimental, and it reads your Copilot login token + routes your
|
|
10
|
-
> Copilot CLI traffic through a local Xtream Head proxy. Only run it if you're
|
|
11
|
-
> comfortable with that. The branch is open for inspection.
|
|
12
|
-
|
|
13
|
-
## What it does (and what "subscription" means here)
|
|
14
|
-
|
|
15
|
-
Normally `headroom wrap copilot` is **BYOK** — you bring an Anthropic/OpenAI API
|
|
16
|
-
key and pay that vendor. `--subscription` is different: it lets you use the
|
|
17
|
-
**Copilot seat you already pay GitHub for**, with **no separate API key**, while
|
|
18
|
-
still routing through Headroom so your context gets compressed.
|
|
19
|
-
|
|
20
|
-
Mechanically: the Copilot CLI's only interposition hook is its provider-override
|
|
21
|
-
(the "BYOK transport"), so Headroom uses that knob but supplies **your
|
|
22
|
-
subscription token** and points back at **GitHub's own Copilot API**. So the CLI
|
|
23
|
-
may print "BYOK" and require an explicit `--model`, but you are **not** paying a
|
|
24
|
-
third party — it's your subscription, just compressed. (Proof it's working: the
|
|
25
|
-
proxy forwards to GitHub's Copilot API — `https://api.githubcopilot.com` by
|
|
26
|
-
default — with your token.)
|
|
27
|
-
|
|
28
|
-
## API host & Enterprise / data-residency
|
|
29
|
-
|
|
30
|
-
Headroom routes wrapped Copilot traffic to GitHub's **generic public host**,
|
|
31
|
-
`https://api.githubcopilot.com`, for both `--subscription` and the implicit
|
|
32
|
-
OAuth path. That host serves the full model set (including newer models on the
|
|
33
|
-
responses API) and matches the routing that worked before 0.23.
|
|
34
|
-
|
|
35
|
-
Headroom deliberately does **not** auto-select a per-account host from
|
|
36
|
-
`/copilot_internal/user`. That endpoint advertises a segmented host (e.g.
|
|
37
|
-
`api.individual.githubcopilot.com`) that does **not** serve newer models on the
|
|
38
|
-
responses API and is not the host the official Copilot client routes with — using
|
|
39
|
-
it regressed `headroom wrap copilot` after 0.22.4
|
|
40
|
-
([#610](https://github.com/Xtream-ITSolutions/xithead/issues/610)).
|
|
41
|
-
|
|
42
|
-
**Enterprise / data-residency:** if your organization is provisioned on a
|
|
43
|
-
dedicated Copilot API host (GitHub Enterprise Cloud with data residency, or an
|
|
44
|
-
egress proxy), pin it explicitly — the override flows through both
|
|
45
|
-
`--subscription` and OAuth, and onward through the proxy to the upstream request:
|
|
46
|
-
|
|
47
|
-
```bash
|
|
48
|
-
export GITHUB_COPILOT_API_URL=https://api.<your-host>.githubcopilot.com
|
|
49
|
-
headroom wrap copilot --subscription -- --model gpt-5.4
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
If you operate such an environment and would like Headroom to **auto-detect** the
|
|
53
|
-
correct host instead of pinning it, please [open an issue](https://github.com/Xtream-ITSolutions/xithead/issues/new) —
|
|
54
|
-
the intended path is to resolve it from GitHub's token-exchange endpoint (the
|
|
55
|
-
source the official Copilot client uses), and we'd want to validate it against a
|
|
56
|
-
real enterprise tenant.
|
|
57
|
-
|
|
58
|
-
## Status
|
|
59
|
-
|
|
60
|
-
| Platform | Mechanism (compress + forward) | Token **auto-discovery** from the OS secret store |
|
|
61
|
-
|----------|:---:|:---:|
|
|
62
|
-
| macOS (Keychain) | ✅ verified | ✅ verified (`copilot-cli`) |
|
|
63
|
-
| Linux (`secret-tool`/libsecret) | ✅ expected | ❓ **needs testing** |
|
|
64
|
-
| Windows (Credential Manager) | ✅ expected | ❓ **needs testing** |
|
|
65
|
-
| Any OS via `GITHUB_COPILOT_TOKEN` env var | ✅ verified by tests | n/a (bypasses discovery) |
|
|
66
|
-
|
|
67
|
-
The two things we want to learn:
|
|
68
|
-
1. **Does it work end to end on your OS?**
|
|
69
|
-
2. **Does it find your Copilot token automatically**, or do you have to set
|
|
70
|
-
`GITHUB_COPILOT_TOKEN`? If it can't find it, we need the **storage schema**
|
|
71
|
-
(see each flow) so we can fix auto-discovery.
|
|
72
|
-
|
|
73
|
-
## Prerequisites (all platforms)
|
|
74
|
-
|
|
75
|
-
1. A **GitHub Copilot subscription**.
|
|
76
|
-
2. The **GitHub Copilot CLI**: `npm install -g @github/copilot`
|
|
77
|
-
3. **Log in once**: run `copilot`, complete the device-code login in your
|
|
78
|
-
browser, then type `/exit`.
|
|
79
|
-
|
|
80
|
-
---
|
|
81
|
-
|
|
82
|
-
## Linux — the flow we most need (tests auto-discovery)
|
|
83
|
-
|
|
84
|
-
Auto-discovery only works with a **host-native** install (a container can't read
|
|
85
|
-
your host secret store). Linux has prebuilt wheels, so:
|
|
86
|
-
|
|
87
|
-
```bash
|
|
88
|
-
pipx install --pip-args='--pre' xtream-head # or: pip install --pre xtream-head
|
|
89
|
-
# (no separate API key needed — that's the point)
|
|
90
|
-
headroom wrap copilot --subscription -- --model gpt-4o -p "Reply with exactly: HEADROOM_OK"
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
- **If it prints `HEADROOM_OK`** → auto-discovery works on your Linux. 🎉 Report success.
|
|
94
|
-
- **If it errors with "no reusable bearer token"** → discovery missed your token. Please grab the **schema** so we can fix it (redact the secret), then confirm the mechanism works via the env var:
|
|
95
|
-
```bash
|
|
96
|
-
secret-tool search --all 2>/dev/null | sed -E 's/^secret = .*/secret = <redacted>/'
|
|
97
|
-
# then retry, supplying the token explicitly:
|
|
98
|
-
GITHUB_COPILOT_TOKEN='<your-token>' headroom wrap copilot --subscription -- --model gpt-4o -p "Reply with: HEADROOM_OK"
|
|
99
|
-
```
|
|
100
|
-
Report the `attribute.*` lines from `secret-tool` and whether the env-var retry worked.
|
|
101
|
-
|
|
102
|
-
---
|
|
103
|
-
|
|
104
|
-
## Windows
|
|
105
|
-
|
|
106
|
-
There is **no native Windows wheel yet**, so pick one:
|
|
107
|
-
|
|
108
|
-
**A. Mechanism test (easiest — Docker Desktop or WSL2):**
|
|
109
|
-
```powershell
|
|
110
|
-
$env:HEADROOM_DOCKER_IMAGE = "ghcr.io/chopratejas/headroom:<branch-tag>" # ask the maintainer for the tag
|
|
111
|
-
# run the Docker-native installer (scripts/install.ps1), then:
|
|
112
|
-
$env:GITHUB_COPILOT_TOKEN = "<your-token>"
|
|
113
|
-
headroom wrap copilot --subscription -- --model gpt-4o -p "Reply with: HEADROOM_OK"
|
|
114
|
-
```
|
|
115
|
-
Report whether it prints `HEADROOM_OK`.
|
|
116
|
-
|
|
117
|
-
**B. Native auto-discovery schema (even without a working install):** after
|
|
118
|
-
`copilot` login, tell us where Windows stored the token:
|
|
119
|
-
```cmd
|
|
120
|
-
cmd /c "cmdkey /list"
|
|
121
|
-
```
|
|
122
|
-
Report the `Target:` line that looks Copilot-related (it shows the target name,
|
|
123
|
-
not the secret). That single fact lets us make native Windows discovery work.
|
|
124
|
-
|
|
125
|
-
> Native Windows auto-discovery becomes fully testable once we add a Windows
|
|
126
|
-
> wheel to the build matrix — tracked separately.
|
|
127
|
-
|
|
128
|
-
---
|
|
129
|
-
|
|
130
|
-
## macOS (already proven — a second data point still helps)
|
|
131
|
-
|
|
132
|
-
```bash
|
|
133
|
-
pipx install --pip-args='--pre' xtream-head
|
|
134
|
-
headroom wrap copilot --subscription -- --model gpt-4o -p "Reply with exactly: HEADROOM_OK"
|
|
135
|
-
```
|
|
136
|
-
Schema, for reference: Keychain generic password, service `copilot-cli`
|
|
137
|
-
(`security find-generic-password -s copilot-cli -w`).
|
|
138
|
-
|
|
139
|
-
---
|
|
140
|
-
|
|
141
|
-
## What to report
|
|
142
|
-
|
|
143
|
-
Please open a
|
|
144
|
-
[Copilot subscription test report](https://github.com/Xtream-ITSolutions/xithead/issues/new?template=copilot-subscription-test-report.md)
|
|
145
|
-
with:
|
|
146
|
-
|
|
147
|
-
- **OS + version** and **how you installed** (pipx/pip wheel, Docker, source).
|
|
148
|
-
- Was plain `copilot` logged in?
|
|
149
|
-
- Did `wrap copilot --subscription` print **`HEADROOM_OK`**? Paste any error.
|
|
150
|
-
- Did it work **without** setting `GITHUB_COPILOT_TOKEN` (auto-discovery), or
|
|
151
|
-
only **with** it?
|
|
152
|
-
- The **storage schema** if discovery failed (`secret-tool search --all` /
|
|
153
|
-
`cmdkey /list`), with the secret redacted.
|
package/codecov.yml
DELETED
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
codecov:
|
|
2
|
-
require_ci_to_pass: true
|
|
3
|
-
|
|
4
|
-
coverage:
|
|
5
|
-
status:
|
|
6
|
-
# Gate on the comprehensive unit suite (`python` flag from ci.yml's 4 test
|
|
7
|
-
# shards), NOT the narrow native-e2e smoke flags (install-native /
|
|
8
|
-
# wrap-native). Those e2e jobs upload first and barely exercise new code,
|
|
9
|
-
# so an unscoped status computes patch at ~6% off the e2e flags alone and
|
|
10
|
-
# flaps to FAILURE before the unit shards report. Scoping to `python` makes
|
|
11
|
-
# the status reflect real coverage of the diff.
|
|
12
|
-
project:
|
|
13
|
-
default:
|
|
14
|
-
target: auto
|
|
15
|
-
flags:
|
|
16
|
-
- python
|
|
17
|
-
patch:
|
|
18
|
-
default:
|
|
19
|
-
target: auto
|
|
20
|
-
flags:
|
|
21
|
-
- python
|
|
22
|
-
|
|
23
|
-
flags:
|
|
24
|
-
python:
|
|
25
|
-
carryforward: false
|
|
26
|
-
|
|
27
|
-
ignore:
|
|
28
|
-
- "tests/**"
|
|
29
|
-
- "scripts/tests/**"
|
|
30
|
-
- ".github/**"
|
|
31
|
-
- ".claude-plugin/**"
|
|
32
|
-
- "headroom/dashboard/templates/**"
|
|
33
|
-
- "plugins/headroom-agent-hooks/.claude-plugin/**"
|
|
34
|
-
- "plugins/headroom-agent-hooks/.github/**"
|
|
@@ -1,165 +0,0 @@
|
|
|
1
|
-
[package]
|
|
2
|
-
name = "headroom-core"
|
|
3
|
-
version = "0.1.0"
|
|
4
|
-
edition.workspace = true
|
|
5
|
-
rust-version.workspace = true
|
|
6
|
-
license.workspace = true
|
|
7
|
-
repository.workspace = true
|
|
8
|
-
description = "Core Headroom types and compression transform traits (Rust)."
|
|
9
|
-
|
|
10
|
-
[dependencies]
|
|
11
|
-
serde = { workspace = true }
|
|
12
|
-
serde_json = { workspace = true }
|
|
13
|
-
bytes = { workspace = true }
|
|
14
|
-
thiserror = { workspace = true }
|
|
15
|
-
tracing = { workspace = true }
|
|
16
|
-
tiktoken-rs = "0.11"
|
|
17
|
-
# `tokenizers` is the HuggingFace pure-Rust tokenizer crate. Default features
|
|
18
|
-
# pull in `onig` for the BPE pre-tokenizer regex; that vendors oniguruma so it
|
|
19
|
-
# builds without a system dep on macOS/Linux.
|
|
20
|
-
tokenizers = "0.22"
|
|
21
|
-
# `hf-hub` is the HuggingFace Hub client. We use the blocking `ureq` transport
|
|
22
|
-
# with `rustls` (no system OpenSSL dep — keeps the binary static-linkable for
|
|
23
|
-
# AWS deploys). `from_pretrained` is called once at startup, so blocking is
|
|
24
|
-
# fine; if a tokio caller needs it later we can wrap in `spawn_blocking`.
|
|
25
|
-
hf-hub = { version = "0.4", default-features = false, features = ["ureq", "rustls-tls"] }
|
|
26
|
-
# `md5` for the CCR cache_key. Python's compression_store hashes the original
|
|
27
|
-
# diff with MD5 truncated to 24 hex chars; we must match byte-for-byte.
|
|
28
|
-
md-5 = "0.10"
|
|
29
|
-
# `sha2` for `_hash_field_name` in smart_crusher (SHA256 truncated to 16
|
|
30
|
-
# hex chars). Python uses `hashlib.sha256` so we need byte-exact parity.
|
|
31
|
-
sha2 = "0.10"
|
|
32
|
-
# `dashmap` for the CCR storage backend. Concurrent HashMap with sharded
|
|
33
|
-
# locking — distinct keys hashed to different shards never contend, so
|
|
34
|
-
# multi-worker proxy load doesn't queue on a single Mutex. Lock-free
|
|
35
|
-
# reads inside each shard via RwLock semantics.
|
|
36
|
-
dashmap = "6"
|
|
37
|
-
# `regex` is already a transitive dep of tokenizers; depend on it directly so
|
|
38
|
-
# our hunk-header parser and priority-pattern matcher have a stable surface.
|
|
39
|
-
regex = "1"
|
|
40
|
-
# `flate2` for `_validate_with_zlib` in `adaptive_sizer`. Python's adaptive
|
|
41
|
-
# sizing pipeline uses `zlib.compress(..., level=1)` to validate the chosen
|
|
42
|
-
# K against compression-ratio diversity. We use the default `miniz_oxide`
|
|
43
|
-
# backend (pure Rust) which produces DEFLATE output of similar length to
|
|
44
|
-
# CPython's libz at level=1 for typical inputs. The check only triggers on
|
|
45
|
-
# >15% ratio divergence so small per-byte differences don't change the
|
|
46
|
-
# outcome — but if a parity fixture flakes here, swap to
|
|
47
|
-
# `features = ["zlib"]` to link against system libz for byte-equal output.
|
|
48
|
-
flate2 = "1"
|
|
49
|
-
# `fastembed` is the Rust port of the Python fastembed library. Used by
|
|
50
|
-
# `relevance::EmbeddingScorer` for sentence embeddings in semantic relevance
|
|
51
|
-
# scoring. Default features pull in `ort` (ONNX Runtime) with auto-download
|
|
52
|
-
# of the runtime binary; the model file (BAAI/bge-small-en-v1.5, ~30 MB
|
|
53
|
-
# int8-quantized ONNX) auto-downloads from HuggingFace Hub on first use.
|
|
54
|
-
# Same library + same model = byte-equal embeddings between Python and Rust
|
|
55
|
-
# (both call into ONNX Runtime over the identical ONNX file).
|
|
56
|
-
#
|
|
57
|
-
# `default-features = false` + explicit rustls features eliminates the
|
|
58
|
-
# transitive `native-tls` → `openssl-sys` dependency that fastembed's
|
|
59
|
-
# default features pull in (via `hf-hub-native-tls` + `ort-download-
|
|
60
|
-
# binaries-native-tls`). Without this, every wheel-build surface
|
|
61
|
-
# (release matrix, e2e/wrap, e2e/init, devcontainer, ci.yml) needs
|
|
62
|
-
# system OpenSSL + perl modules for openssl-src vendored compile. Using
|
|
63
|
-
# rustls everywhere removes the entire OpenSSL build-deps surface.
|
|
64
|
-
# `magika` is Google's ONNX-backed content classifier (Tier 1 of the
|
|
65
|
-
# Stage-3d ContentRouter detection arch). Bundled standard-model is
|
|
66
|
-
# loaded once per process via `OnceLock` and shared across calls. The
|
|
67
|
-
# crate depends on `ort`, which is already in our dep tree via
|
|
68
|
-
# `fastembed`, so adding it doesn't pull a new ML runtime — both
|
|
69
|
-
# crates share the ONNX Runtime singleton.
|
|
70
|
-
magika = "1"
|
|
71
|
-
# `unidiff` is the Stage-3d Tier-2 diff detector. We use the parser
|
|
72
|
-
# itself as the "is this a diff?" oracle — anything that successfully
|
|
73
|
-
# parses to ≥1 PatchedFile is a diff. The deterministic parser
|
|
74
|
-
# catches diffs Magika may miss (naked hunks without `diff --git`
|
|
75
|
-
# headers, prose-prefixed diffs, truncated outputs). Default features
|
|
76
|
-
# bring `encoding_rs` for non-UTF8 sniffing — we keep them on for
|
|
77
|
-
# compatibility with arbitrary tool outputs.
|
|
78
|
-
unidiff = "0.4"
|
|
79
|
-
# `aho-corasick` powers the Tier-3 KeywordDetector in `signals/`.
|
|
80
|
-
# A single deterministic-finite-automaton scan finds every keyword
|
|
81
|
-
# in a line in O(n + m) — orders of magnitude faster than running N
|
|
82
|
-
# regex .search() calls and harder to misuse. Word-boundary checks
|
|
83
|
-
# happen as a post-filter on the byte offsets the automaton returns.
|
|
84
|
-
# Default features (std, perf-literal) keep the build small.
|
|
85
|
-
aho-corasick = "1"
|
|
86
|
-
# `rayon` powers the pipeline orchestrator's parallel reformat-vs-bloat
|
|
87
|
-
# evaluation: while a worker thread runs the structural reformat passes,
|
|
88
|
-
# another set of threads run the per-offload bloat estimators in parallel.
|
|
89
|
-
# Reformat completion + all bloat estimates need to be ready before the
|
|
90
|
-
# orchestrator can decide which offloads to actually execute, so two-phase
|
|
91
|
-
# join semantics (`rayon::join` + `par_iter`) are exactly what we need.
|
|
92
|
-
rayon = "1"
|
|
93
|
-
# `toml` reads the default pipeline configuration shipped at
|
|
94
|
-
# `config/pipeline.toml`. The defaults embed via `include_str!` so a
|
|
95
|
-
# stock binary needs no external file; production deployments override
|
|
96
|
-
# by loading their own TOML at startup.
|
|
97
|
-
toml = "0.8"
|
|
98
|
-
# `blake3` powers `ccr::compute_key`. BLAKE3 is faster than SHA-256 on
|
|
99
|
-
# every hot path the proxy hits (large diff/log/tool_result payloads)
|
|
100
|
-
# and produces collision-resistant 24-char prefixes for the CCR
|
|
101
|
-
# `<<ccr:HASH>>` marker. Pinning the algorithm + truncation length here
|
|
102
|
-
# keeps Rust and Python in lockstep — Python parses the same 24-char
|
|
103
|
-
# hex via `headroom/ccr/tool_injection.py` regex. Pure-Rust by default,
|
|
104
|
-
# no system dep, no SIMD-feature-gated flag (the crate auto-detects).
|
|
105
|
-
blake3 = "1"
|
|
106
|
-
# `rusqlite` for the SQLite-backed CCR store (the production default).
|
|
107
|
-
# `bundled` builds SQLite from source so deploys do not need a system
|
|
108
|
-
# libsqlite3 — matters for Lambda / container builds where the host
|
|
109
|
-
# image may lag behind. Sub-1 MB binary cost. WAL is enabled at
|
|
110
|
-
# connection-open time (see `ccr/backends/sqlite.rs`); no extra feature
|
|
111
|
-
# flags required.
|
|
112
|
-
rusqlite = { version = "0.32", features = ["bundled"] }
|
|
113
|
-
# `redis` for the optional multi-worker CCR backend. Cfg-gated behind
|
|
114
|
-
# the `redis` feature so deploys that don't need it pay no compile
|
|
115
|
-
# cost. Default features include the sync `Connection` API used in
|
|
116
|
-
# `ccr/backends/redis.rs`; `tokio-comp` would pull `tokio` into the
|
|
117
|
-
# core crate, which we do not want.
|
|
118
|
-
redis = { version = "0.27", optional = true, default-features = false }
|
|
119
|
-
# `http` powers the auth-mode classifier (Phase F PR-F1). The proxy
|
|
120
|
-
# crate already depends on this — pulling it into core lets the
|
|
121
|
-
# classifier live with the other Phase B/F policy primitives without
|
|
122
|
-
# cycling through the proxy crate. Tiny crate (no I/O, just types).
|
|
123
|
-
http = "1"
|
|
124
|
-
|
|
125
|
-
[target.'cfg(not(windows))'.dependencies]
|
|
126
|
-
fastembed = { version = "5", default-features = false, features = [
|
|
127
|
-
"hf-hub-rustls-tls",
|
|
128
|
-
"ort-download-binaries-rustls-tls",
|
|
129
|
-
"image-models",
|
|
130
|
-
] }
|
|
131
|
-
|
|
132
|
-
[target.'cfg(windows)'.dependencies]
|
|
133
|
-
# `ort-download-binaries-*` emits DirectML link libs on Windows (`DXCORE`,
|
|
134
|
-
# `DXGI`, `D3D12`, `DirectML`). Users installing `xtream-head[all]` from
|
|
135
|
-
# sdist often do not have those SDK libs, so load ORT dynamically instead.
|
|
136
|
-
fastembed = { version = "5", default-features = false, features = [
|
|
137
|
-
"hf-hub-rustls-tls",
|
|
138
|
-
"ort-load-dynamic",
|
|
139
|
-
"image-models",
|
|
140
|
-
] }
|
|
141
|
-
|
|
142
|
-
[features]
|
|
143
|
-
default = []
|
|
144
|
-
# Compile in the Redis CCR backend. Enable for multi-worker deployments
|
|
145
|
-
# that want a shared CCR store with no sticky-session at the LB. The
|
|
146
|
-
# SQLite backend (always compiled) is the production default for
|
|
147
|
-
# single-worker / single-instance setups.
|
|
148
|
-
redis = ["dep:redis"]
|
|
149
|
-
|
|
150
|
-
[dev-dependencies]
|
|
151
|
-
proptest = "1"
|
|
152
|
-
criterion = { version = "0.5", features = ["html_reports"] }
|
|
153
|
-
tempfile = "3"
|
|
154
|
-
|
|
155
|
-
[[bench]]
|
|
156
|
-
name = "tokenizer"
|
|
157
|
-
harness = false
|
|
158
|
-
|
|
159
|
-
[[bench]]
|
|
160
|
-
name = "ccr_store"
|
|
161
|
-
harness = false
|
|
162
|
-
|
|
163
|
-
[[bench]]
|
|
164
|
-
name = "auth_mode"
|
|
165
|
-
harness = false
|
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
//! Criterion benchmark for the auth-mode classifier (Phase F PR-F1).
|
|
2
|
-
//!
|
|
3
|
-
//! Acceptance criterion: <10us per call. Realistic header sets from
|
|
4
|
-
//! the three classes the proxy actually sees in production:
|
|
5
|
-
//!
|
|
6
|
-
//! - PAYG: `Authorization: Bearer sk-ant-api03-...`
|
|
7
|
-
//! - OAuth: `Authorization: Bearer <jwt>` (Codex-style)
|
|
8
|
-
//! - Subscription: `User-Agent: claude-code/1.5.0 ...` + `Bearer
|
|
9
|
-
//! sk-ant-oat-...`
|
|
10
|
-
//!
|
|
11
|
-
//! The bench measures one classifier call per iteration. The
|
|
12
|
-
//! `HeaderMap` is constructed once outside the timing loop.
|
|
13
|
-
|
|
14
|
-
use criterion::{black_box, criterion_group, criterion_main, Criterion};
|
|
15
|
-
use headroom_core::auth_mode::classify;
|
|
16
|
-
use http::{HeaderMap, HeaderValue};
|
|
17
|
-
|
|
18
|
-
fn build_headers(pairs: &[(&str, &str)]) -> HeaderMap {
|
|
19
|
-
let mut h = HeaderMap::new();
|
|
20
|
-
for (name, value) in pairs {
|
|
21
|
-
h.insert(
|
|
22
|
-
http::header::HeaderName::from_bytes(name.as_bytes()).unwrap(),
|
|
23
|
-
HeaderValue::from_str(value).unwrap(),
|
|
24
|
-
);
|
|
25
|
-
}
|
|
26
|
-
h
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
fn bench_classify(c: &mut Criterion) {
|
|
30
|
-
let mut group = c.benchmark_group("auth_mode/classify");
|
|
31
|
-
|
|
32
|
-
// Empty headers — the simplest path; all branches fall through.
|
|
33
|
-
let empty = HeaderMap::new();
|
|
34
|
-
group.bench_function("empty", |b| b.iter(|| classify(black_box(&empty))));
|
|
35
|
-
|
|
36
|
-
// PAYG — Authorization is Bearer, prefix matches early.
|
|
37
|
-
let payg = build_headers(&[(
|
|
38
|
-
"authorization",
|
|
39
|
-
"Bearer sk-ant-api03-abcdefghijklmnopqrstuvwxyz0123456789",
|
|
40
|
-
)]);
|
|
41
|
-
group.bench_function("payg_anthropic_api_key", |b| {
|
|
42
|
-
b.iter(|| classify(black_box(&payg)))
|
|
43
|
-
});
|
|
44
|
-
|
|
45
|
-
// OAuth — JWT, three segments, last branch in the bearer match.
|
|
46
|
-
let oauth = build_headers(&[(
|
|
47
|
-
"authorization",
|
|
48
|
-
"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4iLCJpYXQiOjE1MTYyMzkwMjJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
|
|
49
|
-
)]);
|
|
50
|
-
group.bench_function("oauth_jwt", |b| b.iter(|| classify(black_box(&oauth))));
|
|
51
|
-
|
|
52
|
-
// Subscription — UA must be lowercased; the most expensive path.
|
|
53
|
-
let subscription = build_headers(&[
|
|
54
|
-
(
|
|
55
|
-
"user-agent",
|
|
56
|
-
"claude-code/1.5.0 (linux; x86_64) anthropic/0.42.0",
|
|
57
|
-
),
|
|
58
|
-
(
|
|
59
|
-
"authorization",
|
|
60
|
-
"Bearer sk-ant-oat-01-abcdefghijklmnopqrstuvwxyz",
|
|
61
|
-
),
|
|
62
|
-
("content-type", "application/json"),
|
|
63
|
-
("accept", "application/json"),
|
|
64
|
-
("host", "api.anthropic.com"),
|
|
65
|
-
]);
|
|
66
|
-
group.bench_function("subscription_claude_code", |b| {
|
|
67
|
-
b.iter(|| classify(black_box(&subscription)))
|
|
68
|
-
});
|
|
69
|
-
|
|
70
|
-
group.finish();
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
criterion_group!(benches, bench_classify);
|
|
74
|
-
criterion_main!(benches);
|
|
@@ -1,224 +0,0 @@
|
|
|
1
|
-
//! CCR store throughput benchmark — single-threaded and multi-threaded.
|
|
2
|
-
//!
|
|
3
|
-
//! Pins the win from PR9: replacing the single-`Mutex<HashMap>` design
|
|
4
|
-
//! with a `DashMap`-backed sharded store. The single-threaded numbers
|
|
5
|
-
//! should be roughly comparable (DashMap has a small per-op shard-hash
|
|
6
|
-
//! overhead vs a raw Mutex), but the multi-threaded numbers should
|
|
7
|
-
//! diverge sharply — distinct keys hit distinct shards and never
|
|
8
|
-
//! contend.
|
|
9
|
-
//!
|
|
10
|
-
//! Run with:
|
|
11
|
-
//! cargo bench -p headroom-core --bench ccr_store
|
|
12
|
-
//!
|
|
13
|
-
//! The critical numbers to watch are the `mt/N=8` rows: with the
|
|
14
|
-
//! Mutex design, all 8 threads serialize on one lock, so throughput
|
|
15
|
-
//! is ~1× the single-threaded figure. With DashMap, throughput should
|
|
16
|
-
//! scale near-linearly with cores.
|
|
17
|
-
|
|
18
|
-
use std::collections::{HashMap, VecDeque};
|
|
19
|
-
use std::sync::{Arc, Mutex};
|
|
20
|
-
use std::thread;
|
|
21
|
-
use std::time::{Duration, Instant};
|
|
22
|
-
|
|
23
|
-
use criterion::{black_box, criterion_group, criterion_main, Criterion, Throughput};
|
|
24
|
-
use headroom_core::ccr::{CcrStore, InMemoryCcrStore};
|
|
25
|
-
|
|
26
|
-
// ─── Baseline: the old single-Mutex<HashMap> design ────────────────
|
|
27
|
-
//
|
|
28
|
-
// Inlined here so the bench is self-contained and shows the
|
|
29
|
-
// before/after gap directly. Same trait, same semantics; the only
|
|
30
|
-
// difference is "all ops serialize on one Mutex" vs "DashMap-sharded".
|
|
31
|
-
|
|
32
|
-
struct LegacyMutexStore {
|
|
33
|
-
inner: Mutex<LegacyInner>,
|
|
34
|
-
ttl: Duration,
|
|
35
|
-
capacity: usize,
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
struct LegacyInner {
|
|
39
|
-
map: HashMap<String, LegacyEntry>,
|
|
40
|
-
order: VecDeque<String>,
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
struct LegacyEntry {
|
|
44
|
-
payload: String,
|
|
45
|
-
inserted: Instant,
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
impl LegacyMutexStore {
|
|
49
|
-
fn new(capacity: usize, ttl: Duration) -> Self {
|
|
50
|
-
Self {
|
|
51
|
-
inner: Mutex::new(LegacyInner {
|
|
52
|
-
map: HashMap::new(),
|
|
53
|
-
order: VecDeque::new(),
|
|
54
|
-
}),
|
|
55
|
-
ttl,
|
|
56
|
-
capacity,
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
impl CcrStore for LegacyMutexStore {
|
|
62
|
-
fn put(&self, hash: &str, payload: &str) {
|
|
63
|
-
let mut g = self.inner.lock().unwrap();
|
|
64
|
-
if g.map.contains_key(hash) {
|
|
65
|
-
g.map.insert(
|
|
66
|
-
hash.to_string(),
|
|
67
|
-
LegacyEntry {
|
|
68
|
-
payload: payload.to_string(),
|
|
69
|
-
inserted: Instant::now(),
|
|
70
|
-
},
|
|
71
|
-
);
|
|
72
|
-
return;
|
|
73
|
-
}
|
|
74
|
-
while g.map.len() >= self.capacity {
|
|
75
|
-
let Some(oldest) = g.order.pop_front() else {
|
|
76
|
-
break;
|
|
77
|
-
};
|
|
78
|
-
g.map.remove(&oldest);
|
|
79
|
-
}
|
|
80
|
-
g.map.insert(
|
|
81
|
-
hash.to_string(),
|
|
82
|
-
LegacyEntry {
|
|
83
|
-
payload: payload.to_string(),
|
|
84
|
-
inserted: Instant::now(),
|
|
85
|
-
},
|
|
86
|
-
);
|
|
87
|
-
g.order.push_back(hash.to_string());
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
fn get(&self, hash: &str) -> Option<String> {
|
|
91
|
-
let mut g = self.inner.lock().unwrap();
|
|
92
|
-
let expired = match g.map.get(hash) {
|
|
93
|
-
Some(e) => e.inserted.elapsed() > self.ttl,
|
|
94
|
-
None => return None,
|
|
95
|
-
};
|
|
96
|
-
if expired {
|
|
97
|
-
g.map.remove(hash);
|
|
98
|
-
return None;
|
|
99
|
-
}
|
|
100
|
-
g.map.get(hash).map(|e| e.payload.clone())
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
fn len(&self) -> usize {
|
|
104
|
-
self.inner.lock().unwrap().map.len()
|
|
105
|
-
}
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
fn bench_put_single_threaded(c: &mut Criterion) {
|
|
109
|
-
let store = InMemoryCcrStore::new();
|
|
110
|
-
let payload = "x".repeat(512); // typical CCR payload size
|
|
111
|
-
|
|
112
|
-
let mut group = c.benchmark_group("ccr_store/put_st");
|
|
113
|
-
group.throughput(Throughput::Elements(1));
|
|
114
|
-
group.bench_function("new_keys", |b| {
|
|
115
|
-
let mut i = 0u64;
|
|
116
|
-
b.iter(|| {
|
|
117
|
-
let key = format!("k{i:012x}");
|
|
118
|
-
store.put(black_box(&key), black_box(&payload));
|
|
119
|
-
i += 1;
|
|
120
|
-
});
|
|
121
|
-
});
|
|
122
|
-
group.bench_function("same_key_overwrite", |b| {
|
|
123
|
-
b.iter(|| {
|
|
124
|
-
store.put(black_box("hot_key"), black_box(&payload));
|
|
125
|
-
});
|
|
126
|
-
});
|
|
127
|
-
group.finish();
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
fn bench_get_single_threaded(c: &mut Criterion) {
|
|
131
|
-
let store = InMemoryCcrStore::new();
|
|
132
|
-
let payload = "y".repeat(512);
|
|
133
|
-
for i in 0..1000u32 {
|
|
134
|
-
let key = format!("k{i:08x}");
|
|
135
|
-
store.put(&key, &payload);
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
let mut group = c.benchmark_group("ccr_store/get_st");
|
|
139
|
-
group.throughput(Throughput::Elements(1));
|
|
140
|
-
group.bench_function("hit", |b| {
|
|
141
|
-
let mut i = 0u32;
|
|
142
|
-
b.iter(|| {
|
|
143
|
-
let key = format!("k{:08x}", i % 1000);
|
|
144
|
-
let _ = black_box(store.get(black_box(&key)));
|
|
145
|
-
i = i.wrapping_add(1);
|
|
146
|
-
});
|
|
147
|
-
});
|
|
148
|
-
group.bench_function("miss", |b| {
|
|
149
|
-
let mut i = 0u32;
|
|
150
|
-
b.iter(|| {
|
|
151
|
-
let key = format!("absent_{i}");
|
|
152
|
-
let _ = black_box(store.get(black_box(&key)));
|
|
153
|
-
i = i.wrapping_add(1);
|
|
154
|
-
});
|
|
155
|
-
});
|
|
156
|
-
group.finish();
|
|
157
|
-
}
|
|
158
|
-
|
|
159
|
-
fn run_mt_workload(store: Arc<dyn CcrStore>, threads: usize, n: u64) -> Duration {
|
|
160
|
-
const ITERS_PER_THREAD: usize = 200;
|
|
161
|
-
let payload = Arc::new("z".repeat(256));
|
|
162
|
-
for i in 0..256u32 {
|
|
163
|
-
store.put(&format!("warm_{i:08x}"), &payload);
|
|
164
|
-
}
|
|
165
|
-
let start = Instant::now();
|
|
166
|
-
for _ in 0..n {
|
|
167
|
-
thread::scope(|scope| {
|
|
168
|
-
for tid in 0..threads {
|
|
169
|
-
let s = store.clone();
|
|
170
|
-
let p = payload.clone();
|
|
171
|
-
scope.spawn(move || {
|
|
172
|
-
for i in 0..ITERS_PER_THREAD {
|
|
173
|
-
if i & 1 == 0 {
|
|
174
|
-
let k = format!("t{tid}_k{i:08x}");
|
|
175
|
-
s.put(&k, &p);
|
|
176
|
-
} else {
|
|
177
|
-
let k = format!("warm_{:08x}", i % 256);
|
|
178
|
-
let _ = s.get(&k);
|
|
179
|
-
}
|
|
180
|
-
}
|
|
181
|
-
});
|
|
182
|
-
}
|
|
183
|
-
});
|
|
184
|
-
}
|
|
185
|
-
start.elapsed()
|
|
186
|
-
}
|
|
187
|
-
|
|
188
|
-
/// Multi-threaded mixed put/get — direct A/B between the legacy
|
|
189
|
-
/// `Mutex<HashMap>` design and the new DashMap-backed store. The
|
|
190
|
-
/// legacy version serializes every op on one lock; the new version
|
|
191
|
-
/// shards across keys so distinct hashes never contend.
|
|
192
|
-
fn bench_mixed_multi_threaded(c: &mut Criterion) {
|
|
193
|
-
let mut group = c.benchmark_group("ccr_store/mt_mixed");
|
|
194
|
-
group.throughput(Throughput::Elements(1));
|
|
195
|
-
|
|
196
|
-
for &threads in &[1usize, 2, 4, 8] {
|
|
197
|
-
// DashMap-backed (current design).
|
|
198
|
-
let label = format!("dashmap/threads={threads}");
|
|
199
|
-
group.bench_function(&label, |b| {
|
|
200
|
-
b.iter_custom(|n| {
|
|
201
|
-
let store: Arc<dyn CcrStore> = Arc::new(InMemoryCcrStore::new());
|
|
202
|
-
run_mt_workload(store, threads, n)
|
|
203
|
-
});
|
|
204
|
-
});
|
|
205
|
-
// Legacy Mutex<HashMap> (the design PR9 replaces).
|
|
206
|
-
let label = format!("legacy_mutex/threads={threads}");
|
|
207
|
-
group.bench_function(&label, |b| {
|
|
208
|
-
b.iter_custom(|n| {
|
|
209
|
-
let store: Arc<dyn CcrStore> =
|
|
210
|
-
Arc::new(LegacyMutexStore::new(1000, Duration::from_secs(300)));
|
|
211
|
-
run_mt_workload(store, threads, n)
|
|
212
|
-
});
|
|
213
|
-
});
|
|
214
|
-
}
|
|
215
|
-
group.finish();
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
criterion_group!(
|
|
219
|
-
benches,
|
|
220
|
-
bench_put_single_threaded,
|
|
221
|
-
bench_get_single_threaded,
|
|
222
|
-
bench_mixed_multi_threaded,
|
|
223
|
-
);
|
|
224
|
-
criterion_main!(benches);
|