Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ __pycache__/
*.egg-info/
dist/
build/
.worktrees/

# Sensitive
.env
Expand Down
318 changes: 318 additions & 0 deletions AUDIT.md

Large diffs are not rendered by default.

105 changes: 105 additions & 0 deletions ROADMAP.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Working Order — `recost` Python SDK

Plan for working through the 13 GitHub issues from [`AUDIT.md`](./AUDIT.md). Issues are grouped into **waves**; each wave is a set that can be worked in parallel without conflict, and waves are sequential.

Mapping to filed issues: <https://github.com/recost-dev/middleware-python/issues>

---

## At-a-glance

| Wave | Issues | Parallel? | Reason for order |
|---|---|---|---|
| 1 — Foundation | #1, #5 | Yes (different files) | Both zero-risk for blocking other work. |
| 2 — Threading primitive | #4 | — | Adds module-level `RLock` that Wave 3 / 4 depend on. |
| 3 — Lifecycle | #6 then #7 | Sequential (both touch `_transport.py`) | #6 fixes dispose semantics first; #7 builds on clean dispose. |
| 4 — Fork-safety + body sizing | #3, #8 | Yes (different files) | #3 builds on Wave 3's clean dispose; #8 is `_interceptor.py`-only. |
| 5 — P2 cleanup + types + tests | #10, #11, #12, #13, #2, #9 | Mostly yes | Small surface; fold tests into each fix; mypy sweep cleans up residual. |

---

## Detailed sequencing

### Wave 1 — Foundation

Two independent tracks, fully parallel.

- **#1 — [Aggregator thread-safety](https://github.com/recost-dev/middleware-python/issues/1)** (P0)
Files: `recost/_aggregator.py`, `tests/test_aggregator.py`
Wrap `ingest` / `flush` / `would_overflow` in `threading.RLock`. Add a regression test that races N threads ingesting against a flush. No dependencies on other issues.

- **#5 — [Naming + docs reconciliation](https://github.com/recost-dev/middleware-python/issues/5)** (P1)
Files: `recost/frameworks/flask.py`, `recost/__init__.py`, `README.md`, `CLAUDE.md`, `tests/test_provider_registry.py`
Flask class rename (`ReCost` → `RecostExtension`, alias for one release), strip `EcoAPI*` from CLAUDE.md, fix the provider-count claims (21 → 34), document `flush_interval_ms`/`max_buckets`/`shutdown_flush_timeout_ms`, mark `flush_interval` deprecated. No business-logic risk.

**Why this order:** both are zero-risk for blocking other work. Naming should land before any test or doc changes elsewhere so subsequent commits don't reference the old names.

---

### Wave 2 — Threading primitive

- **#4 — [Module-level state races](https://github.com/recost-dev/middleware-python/issues/4)** (P1)
Files: `recost/_init.py`, `recost/_interceptor.py`, `tests/test_init.py`
Introduces a module-level `threading.RLock` around `init()` / `dispose()` / `install()` / `uninstall()`. **Must land before Wave 3** because #6 and #3 will both rely on the same lock for their atomicity guarantees.

---

### Wave 3 — Process lifecycle

Both edits live in `_transport.py`, so do them sequentially to avoid merge conflicts:

1. **#6 — [Process lifecycle: atexit + dispose-during-connect FD leak](https://github.com/recost-dev/middleware-python/issues/6)** (P1)
Files: `recost/_init.py`, `recost/_transport.py`, `tests/test_init.py`
Fixes the dispose path so the loop properly stops and the thread joins. Adds an `atexit` handler that runs a final flush. Provides the clean-dispose mechanic that #3 reuses.

2. **#7 — [Local-mode WebSocket hardening](https://github.com/recost-dev/middleware-python/issues/7)** (P1)
Files: `recost/_transport.py`, `tests/test_transport.py`, plus a coordinated change in the extension repo
Cap the queue (drop-oldest), give up after N failed reconnects (with a one-shot `on_error`), add lightweight `hello`/`ack` handshake. Doing this second means rebasing on top of cleaner dispose semantics.

---

### Wave 4 — Fork-safety + body sizing

Parallel — different files:

- **#3 — [No fork-safety](https://github.com/recost-dev/middleware-python/issues/3)** (P0)
Files: `recost/_init.py`, `recost/_transport.py`, `README.md`, `tests/test_init.py`
Register `os.register_at_fork(after_in_child=_reinit_after_fork)` that re-creates the timer thread and transport thread in the child. Builds on Wave 3's clean dispose because the child needs to fully discard the parent's transport state.

- **#8 — [Body-size measurement](https://github.com/recost-dev/middleware-python/issues/8)** (P1)
Files: `recost/_interceptor.py`, `README.md`, `tests/test_interceptor.py`
aiohttp `json=`/`FormData`, httpx streaming-body materialization, response Content-Length-only caveat. Independent of all lifecycle work.

---

### Wave 5 — P2 cleanup + types + tests

Most can be done in parallel; finish in any order.

- **#10 — [Flush loop hygiene](https://github.com/recost-dev/middleware-python/issues/10)** (P2) — `recost/_init.py`
- **#11 — [urllib3 wrapper maintenance](https://github.com/recost-dev/middleware-python/issues/11)** (P2) — `recost/_interceptor.py`
- **#12 — [exclude_patterns](https://github.com/recost-dev/middleware-python/issues/12)** (P2) — `recost/_init.py`, `README.md`
- **#13 — [Code hygiene](https://github.com/recost-dev/middleware-python/issues/13)** (P2) — `recost/_transport.py`, `recost/_interceptor.py`
- **#2 — [35 mypy strict errors](https://github.com/recost-dev/middleware-python/issues/2)** (P0) — touched files were largely fixed during earlier waves; this is the residual sweep. Add `mypy --strict` to CI as part of this PR so the strict-clean claim becomes verifiable.
- **#9 — [Test gaps](https://github.com/recost-dev/middleware-python/issues/9)** (P1) — fold tests into each PR above. Outstanding items by end of Wave 4: aiohttp interceptor branch coverage (Wave 4 dependency), privacy test, self-instrumentation test, 5xx retry test.

---

## Cross-cutting rules

- **One issue per PR.** Each PR closes one numbered issue. Avoid bundling unrelated fixes.
- **Tests with every fix.** Don't merge a bugfix without a test that fails before the fix and passes after.
- **mypy `--strict` must pass on touched files before merge.** This is how #2 closes — incrementally per file. By Wave 5 only residual errors should remain.
- **Update `CHANGELOG.md` with each PR** (or create one if absent).

---

## What to start with right now

Pick one of:

1. **#5** — low-risk warm-up that unblocks naming.
2. **#1** — go straight to a P0 with a focused fix.
3. **#4** — set up the threading primitive that 3 / 6 / 7 depend on (longer chain).

**Recommendation:** open two branches and do **#5 + #1 in parallel as Wave 1**, then start **#4**.
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ __pycache__/
*.egg-info/
dist/
build/
.worktrees/

# Sensitive
.env
Expand Down
318 changes: 318 additions & 0 deletions AUDIT.md

Large diffs are not rendered by default.

105 changes: 105 additions & 0 deletions ROADMAP.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Working Order — `recost` Python SDK

Plan for working through the 13 GitHub issues from [`AUDIT.md`](./AUDIT.md). Issues are grouped into **waves**; each wave is a set that can be worked in parallel without conflict, and waves are sequential.

Mapping to filed issues: <https://github.com/recost-dev/middleware-python/issues>

---

## At-a-glance

| Wave | Issues | Parallel? | Reason for order |
|---|---|---|---|
| 1 — Foundation | #1, #5 | Yes (different files) | Both zero-risk for blocking other work. |
| 2 — Threading primitive | #4 | — | Adds module-level `RLock` that Wave 3 / 4 depend on. |
| 3 — Lifecycle | #6 then #7 | Sequential (both touch `_transport.py`) | #6 fixes dispose semantics first; #7 builds on clean dispose. |
| 4 — Fork-safety + body sizing | #3, #8 | Yes (different files) | #3 builds on Wave 3's clean dispose; #8 is `_interceptor.py`-only. |
| 5 — P2 cleanup + types + tests | #10, #11, #12, #13, #2, #9 | Mostly yes | Small surface; fold tests into each fix; mypy sweep cleans up residual. |

---

## Detailed sequencing

### Wave 1 — Foundation

Two independent tracks, fully parallel.

- **#1 — [Aggregator thread-safety](https://github.com/recost-dev/middleware-python/issues/1)** (P0)
Files: `recost/_aggregator.py`, `tests/test_aggregator.py`
Wrap `ingest` / `flush` / `would_overflow` in `threading.RLock`. Add a regression test that races N threads ingesting against a flush. No dependencies on other issues.

- **#5 — [Naming + docs reconciliation](https://github.com/recost-dev/middleware-python/issues/5)** (P1)
Files: `recost/frameworks/flask.py`, `recost/__init__.py`, `README.md`, `CLAUDE.md`, `tests/test_provider_registry.py`
Flask class rename (`ReCost` → `RecostExtension`, alias for one release), strip `EcoAPI*` from CLAUDE.md, fix the provider-count claims (21 → 34), document `flush_interval_ms`/`max_buckets`/`shutdown_flush_timeout_ms`, mark `flush_interval` deprecated. No business-logic risk.

**Why this order:** both are zero-risk for blocking other work. Naming should land before any test or doc changes elsewhere so subsequent commits don't reference the old names.

---

### Wave 2 — Threading primitive

- **#4 — [Module-level state races](https://github.com/recost-dev/middleware-python/issues/4)** (P1)
Files: `recost/_init.py`, `recost/_interceptor.py`, `tests/test_init.py`
Introduces a module-level `threading.RLock` around `init()` / `dispose()` / `install()` / `uninstall()`. **Must land before Wave 3** because #6 and #3 will both rely on the same lock for their atomicity guarantees.

---

### Wave 3 — Process lifecycle

Both edits live in `_transport.py`, so do them sequentially to avoid merge conflicts:

1. **#6 — [Process lifecycle: atexit + dispose-during-connect FD leak](https://github.com/recost-dev/middleware-python/issues/6)** (P1)
Files: `recost/_init.py`, `recost/_transport.py`, `tests/test_init.py`
Fixes the dispose path so the loop properly stops and the thread joins. Adds an `atexit` handler that runs a final flush. Provides the clean-dispose mechanic that #3 reuses.

2. **#7 — [Local-mode WebSocket hardening](https://github.com/recost-dev/middleware-python/issues/7)** (P1)
Files: `recost/_transport.py`, `tests/test_transport.py`, plus a coordinated change in the extension repo
Cap the queue (drop-oldest), give up after N failed reconnects (with a one-shot `on_error`), add lightweight `hello`/`ack` handshake. Doing this second means rebasing on top of cleaner dispose semantics.

---

### Wave 4 — Fork-safety + body sizing

Parallel — different files:

- **#3 — [No fork-safety](https://github.com/recost-dev/middleware-python/issues/3)** (P0)
Files: `recost/_init.py`, `recost/_transport.py`, `README.md`, `tests/test_init.py`
Register `os.register_at_fork(after_in_child=_reinit_after_fork)` that re-creates the timer thread and transport thread in the child. Builds on Wave 3's clean dispose because the child needs to fully discard the parent's transport state.

- **#8 — [Body-size measurement](https://github.com/recost-dev/middleware-python/issues/8)** (P1)
Files: `recost/_interceptor.py`, `README.md`, `tests/test_interceptor.py`
aiohttp `json=`/`FormData`, httpx streaming-body materialization, response Content-Length-only caveat. Independent of all lifecycle work.

---

### Wave 5 — P2 cleanup + types + tests

Most can be done in parallel; finish in any order.

- **#10 — [Flush loop hygiene](https://github.com/recost-dev/middleware-python/issues/10)** (P2) — `recost/_init.py`
- **#11 — [urllib3 wrapper maintenance](https://github.com/recost-dev/middleware-python/issues/11)** (P2) — `recost/_interceptor.py`
- **#12 — [exclude_patterns](https://github.com/recost-dev/middleware-python/issues/12)** (P2) — `recost/_init.py`, `README.md`
- **#13 — [Code hygiene](https://github.com/recost-dev/middleware-python/issues/13)** (P2) — `recost/_transport.py`, `recost/_interceptor.py`
- **#2 — [35 mypy strict errors](https://github.com/recost-dev/middleware-python/issues/2)** (P0) — touched files were largely fixed during earlier waves; this is the residual sweep. Add `mypy --strict` to CI as part of this PR so the strict-clean claim becomes verifiable.
- **#9 — [Test gaps](https://github.com/recost-dev/middleware-python/issues/9)** (P1) — fold tests into each PR above. Outstanding items by end of Wave 4: aiohttp interceptor branch coverage (Wave 4 dependency), privacy test, self-instrumentation test, 5xx retry test.

---

## Cross-cutting rules

- **One issue per PR.** Each PR closes one numbered issue. Avoid bundling unrelated fixes.
- **Tests with every fix.** Don't merge a bugfix without a test that fails before the fix and passes after.
- **mypy `--strict` must pass on touched files before merge.** This is how #2 closes — incrementally per file. By Wave 5 only residual errors should remain.
- **Update `CHANGELOG.md` with each PR** (or create one if absent).

---

## What to start with right now

Pick one of:

1. **#5** — low-risk warm-up that unblocks naming.
2. **#1** — go straight to a P0 with a focused fix.
3. **#4** — set up the threading primitive that 3 / 6 / 7 depend on (longer chain).

**Recommendation:** open two branches and do **#5 + #1 in parallel as Wave 1**, then start **#4**.
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ __pycache__/
*.egg-info/
dist/
build/
.worktrees/

# Sensitive
.env
Expand Down
318 changes: 318 additions & 0 deletions AUDIT.md

Large diffs are not rendered by default.

105 changes: 105 additions & 0 deletions ROADMAP.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Working Order — `recost` Python SDK

Plan for working through the 13 GitHub issues from [`AUDIT.md`](./AUDIT.md). Issues are grouped into **waves**; each wave is a set that can be worked in parallel without conflict, and waves are sequential.

Mapping to filed issues: <https://github.com/recost-dev/middleware-python/issues>

---

## At-a-glance

| Wave | Issues | Parallel? | Reason for order |
|---|---|---|---|
| 1 — Foundation | #1, #5 | Yes (different files) | Both zero-risk for blocking other work. |
| 2 — Threading primitive | #4 | — | Adds module-level `RLock` that Wave 3 / 4 depend on. |
| 3 — Lifecycle | #6 then #7 | Sequential (both touch `_transport.py`) | #6 fixes dispose semantics first; #7 builds on clean dispose. |
| 4 — Fork-safety + body sizing | #3, #8 | Yes (different files) | #3 builds on Wave 3's clean dispose; #8 is `_interceptor.py`-only. |
| 5 — P2 cleanup + types + tests | #10, #11, #12, #13, #2, #9 | Mostly yes | Small surface; fold tests into each fix; mypy sweep cleans up residual. |

---

## Detailed sequencing

### Wave 1 — Foundation

Two independent tracks, fully parallel.

- **#1 — [Aggregator thread-safety](https://github.com/recost-dev/middleware-python/issues/1)** (P0)
Files: `recost/_aggregator.py`, `tests/test_aggregator.py`
Wrap `ingest` / `flush` / `would_overflow` in `threading.RLock`. Add a regression test that races N threads ingesting against a flush. No dependencies on other issues.

- **#5 — [Naming + docs reconciliation](https://github.com/recost-dev/middleware-python/issues/5)** (P1)
Files: `recost/frameworks/flask.py`, `recost/__init__.py`, `README.md`, `CLAUDE.md`, `tests/test_provider_registry.py`
Flask class rename (`ReCost` → `RecostExtension`, alias for one release), strip `EcoAPI*` from CLAUDE.md, fix the provider-count claims (21 → 34), document `flush_interval_ms`/`max_buckets`/`shutdown_flush_timeout_ms`, mark `flush_interval` deprecated. No business-logic risk.

**Why this order:** both are zero-risk for blocking other work. Naming should land before any test or doc changes elsewhere so subsequent commits don't reference the old names.

---

### Wave 2 — Threading primitive

- **#4 — [Module-level state races](https://github.com/recost-dev/middleware-python/issues/4)** (P1)
Files: `recost/_init.py`, `recost/_interceptor.py`, `tests/test_init.py`
Introduces a module-level `threading.RLock` around `init()` / `dispose()` / `install()` / `uninstall()`. **Must land before Wave 3** because #6 and #3 will both rely on the same lock for their atomicity guarantees.

---

### Wave 3 — Process lifecycle

Both edits live in `_transport.py`, so do them sequentially to avoid merge conflicts:

1. **#6 — [Process lifecycle: atexit + dispose-during-connect FD leak](https://github.com/recost-dev/middleware-python/issues/6)** (P1)
Files: `recost/_init.py`, `recost/_transport.py`, `tests/test_init.py`
Fixes the dispose path so the loop properly stops and the thread joins. Adds an `atexit` handler that runs a final flush. Provides the clean-dispose mechanic that #3 reuses.

2. **#7 — [Local-mode WebSocket hardening](https://github.com/recost-dev/middleware-python/issues/7)** (P1)
Files: `recost/_transport.py`, `tests/test_transport.py`, plus a coordinated change in the extension repo
Cap the queue (drop-oldest), give up after N failed reconnects (with a one-shot `on_error`), add lightweight `hello`/`ack` handshake. Doing this second means rebasing on top of cleaner dispose semantics.

---

### Wave 4 — Fork-safety + body sizing

Parallel — different files:

- **#3 — [No fork-safety](https://github.com/recost-dev/middleware-python/issues/3)** (P0)
Files: `recost/_init.py`, `recost/_transport.py`, `README.md`, `tests/test_init.py`
Register `os.register_at_fork(after_in_child=_reinit_after_fork)` that re-creates the timer thread and transport thread in the child. Builds on Wave 3's clean dispose because the child needs to fully discard the parent's transport state.

- **#8 — [Body-size measurement](https://github.com/recost-dev/middleware-python/issues/8)** (P1)
Files: `recost/_interceptor.py`, `README.md`, `tests/test_interceptor.py`
aiohttp `json=`/`FormData`, httpx streaming-body materialization, response Content-Length-only caveat. Independent of all lifecycle work.

---

### Wave 5 — P2 cleanup + types + tests

Most can be done in parallel; finish in any order.

- **#10 — [Flush loop hygiene](https://github.com/recost-dev/middleware-python/issues/10)** (P2) — `recost/_init.py`
- **#11 — [urllib3 wrapper maintenance](https://github.com/recost-dev/middleware-python/issues/11)** (P2) — `recost/_interceptor.py`
- **#12 — [exclude_patterns](https://github.com/recost-dev/middleware-python/issues/12)** (P2) — `recost/_init.py`, `README.md`
- **#13 — [Code hygiene](https://github.com/recost-dev/middleware-python/issues/13)** (P2) — `recost/_transport.py`, `recost/_interceptor.py`
- **#2 — [35 mypy strict errors](https://github.com/recost-dev/middleware-python/issues/2)** (P0) — touched files were largely fixed during earlier waves; this is the residual sweep. Add `mypy --strict` to CI as part of this PR so the strict-clean claim becomes verifiable.
- **#9 — [Test gaps](https://github.com/recost-dev/middleware-python/issues/9)** (P1) — fold tests into each PR above. Outstanding items by end of Wave 4: aiohttp interceptor branch coverage (Wave 4 dependency), privacy test, self-instrumentation test, 5xx retry test.

---

## Cross-cutting rules

- **One issue per PR.** Each PR closes one numbered issue. Avoid bundling unrelated fixes.
- **Tests with every fix.** Don't merge a bugfix without a test that fails before the fix and passes after.
- **mypy `--strict` must pass on touched files before merge.** This is how #2 closes — incrementally per file. By Wave 5 only residual errors should remain.
- **Update `CHANGELOG.md` with each PR** (or create one if absent).

---

## What to start with right now

Pick one of:

1. **#5** — low-risk warm-up that unblocks naming.
2. **#1** — go straight to a P0 with a focused fix.
3. **#4** — set up the threading primitive that 3 / 6 / 7 depend on (longer chain).

**Recommendation:** open two branches and do **#5 + #1 in parallel as Wave 1**, then start **#4**.
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ __pycache__/
*.egg-info/
dist/
build/
.worktrees/

# Sensitive
.env
Expand Down
318 changes: 318 additions & 0 deletions AUDIT.md

Large diffs are not rendered by default.

105 changes: 105 additions & 0 deletions ROADMAP.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Working Order — `recost` Python SDK

Plan for working through the 13 GitHub issues from [`AUDIT.md`](./AUDIT.md). Issues are grouped into **waves**; each wave is a set that can be worked in parallel without conflict, and waves are sequential.

Mapping to filed issues: <https://github.com/recost-dev/middleware-python/issues>

---

## At-a-glance

| Wave | Issues | Parallel? | Reason for order |
|---|---|---|---|
| 1 — Foundation | #1, #5 | Yes (different files) | Both zero-risk for blocking other work. |
| 2 — Threading primitive | #4 | — | Adds module-level `RLock` that Wave 3 / 4 depend on. |
| 3 — Lifecycle | #6 then #7 | Sequential (both touch `_transport.py`) | #6 fixes dispose semantics first; #7 builds on clean dispose. |
| 4 — Fork-safety + body sizing | #3, #8 | Yes (different files) | #3 builds on Wave 3's clean dispose; #8 is `_interceptor.py`-only. |
| 5 — P2 cleanup + types + tests | #10, #11, #12, #13, #2, #9 | Mostly yes | Small surface; fold tests into each fix; mypy sweep cleans up residual. |

---

## Detailed sequencing

### Wave 1 — Foundation

Two independent tracks, fully parallel.

- **#1 — [Aggregator thread-safety](https://github.com/recost-dev/middleware-python/issues/1)** (P0)
Files: `recost/_aggregator.py`, `tests/test_aggregator.py`
Wrap `ingest` / `flush` / `would_overflow` in `threading.RLock`. Add a regression test that races N threads ingesting against a flush. No dependencies on other issues.

- **#5 — [Naming + docs reconciliation](https://github.com/recost-dev/middleware-python/issues/5)** (P1)
Files: `recost/frameworks/flask.py`, `recost/__init__.py`, `README.md`, `CLAUDE.md`, `tests/test_provider_registry.py`
Flask class rename (`ReCost` → `RecostExtension`, alias for one release), strip `EcoAPI*` from CLAUDE.md, fix the provider-count claims (21 → 34), document `flush_interval_ms`/`max_buckets`/`shutdown_flush_timeout_ms`, mark `flush_interval` deprecated. No business-logic risk.

**Why this order:** both are zero-risk for blocking other work. Naming should land before any test or doc changes elsewhere so subsequent commits don't reference the old names.

---

### Wave 2 — Threading primitive

- **#4 — [Module-level state races](https://github.com/recost-dev/middleware-python/issues/4)** (P1)
Files: `recost/_init.py`, `recost/_interceptor.py`, `tests/test_init.py`
Introduces a module-level `threading.RLock` around `init()` / `dispose()` / `install()` / `uninstall()`. **Must land before Wave 3** because #6 and #3 will both rely on the same lock for their atomicity guarantees.

---

### Wave 3 — Process lifecycle

Both edits live in `_transport.py`, so do them sequentially to avoid merge conflicts:

1. **#6 — [Process lifecycle: atexit + dispose-during-connect FD leak](https://github.com/recost-dev/middleware-python/issues/6)** (P1)
Files: `recost/_init.py`, `recost/_transport.py`, `tests/test_init.py`
Fixes the dispose path so the loop properly stops and the thread joins. Adds an `atexit` handler that runs a final flush. Provides the clean-dispose mechanic that #3 reuses.

2. **#7 — [Local-mode WebSocket hardening](https://github.com/recost-dev/middleware-python/issues/7)** (P1)
Files: `recost/_transport.py`, `tests/test_transport.py`, plus a coordinated change in the extension repo
Cap the queue (drop-oldest), give up after N failed reconnects (with a one-shot `on_error`), add lightweight `hello`/`ack` handshake. Doing this second means rebasing on top of cleaner dispose semantics.

---

### Wave 4 — Fork-safety + body sizing

Parallel — different files:

- **#3 — [No fork-safety](https://github.com/recost-dev/middleware-python/issues/3)** (P0)
Files: `recost/_init.py`, `recost/_transport.py`, `README.md`, `tests/test_init.py`
Register `os.register_at_fork(after_in_child=_reinit_after_fork)` that re-creates the timer thread and transport thread in the child. Builds on Wave 3's clean dispose because the child needs to fully discard the parent's transport state.

- **#8 — [Body-size measurement](https://github.com/recost-dev/middleware-python/issues/8)** (P1)
Files: `recost/_interceptor.py`, `README.md`, `tests/test_interceptor.py`
aiohttp `json=`/`FormData`, httpx streaming-body materialization, response Content-Length-only caveat. Independent of all lifecycle work.

---

### Wave 5 — P2 cleanup + types + tests

Most can be done in parallel; finish in any order.

- **#10 — [Flush loop hygiene](https://github.com/recost-dev/middleware-python/issues/10)** (P2) — `recost/_init.py`
- **#11 — [urllib3 wrapper maintenance](https://github.com/recost-dev/middleware-python/issues/11)** (P2) — `recost/_interceptor.py`
- **#12 — [exclude_patterns](https://github.com/recost-dev/middleware-python/issues/12)** (P2) — `recost/_init.py`, `README.md`
- **#13 — [Code hygiene](https://github.com/recost-dev/middleware-python/issues/13)** (P2) — `recost/_transport.py`, `recost/_interceptor.py`
- **#2 — [35 mypy strict errors](https://github.com/recost-dev/middleware-python/issues/2)** (P0) — touched files were largely fixed during earlier waves; this is the residual sweep. Add `mypy --strict` to CI as part of this PR so the strict-clean claim becomes verifiable.
- **#9 — [Test gaps](https://github.com/recost-dev/middleware-python/issues/9)** (P1) — fold tests into each PR above. Outstanding items by end of Wave 4: aiohttp interceptor branch coverage (Wave 4 dependency), privacy test, self-instrumentation test, 5xx retry test.

---

## Cross-cutting rules

- **One issue per PR.** Each PR closes one numbered issue. Avoid bundling unrelated fixes.
- **Tests with every fix.** Don't merge a bugfix without a test that fails before the fix and passes after.
- **mypy `--strict` must pass on touched files before merge.** This is how #2 closes — incrementally per file. By Wave 5 only residual errors should remain.
- **Update `CHANGELOG.md` with each PR** (or create one if absent).

---

## What to start with right now

Pick one of:

1. **#5** — low-risk warm-up that unblocks naming.
2. **#1** — go straight to a P0 with a focused fix.
3. **#4** — set up the threading primitive that 3 / 6 / 7 depend on (longer chain).

**Recommendation:** open two branches and do **#5 + #1 in parallel as Wave 1**, then start **#4**.
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ __pycache__/
*.egg-info/
dist/
build/
.worktrees/

# Sensitive
.env
Expand Down
318 changes: 318 additions & 0 deletions AUDIT.md

Large diffs are not rendered by default.

105 changes: 105 additions & 0 deletions ROADMAP.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Working Order — `recost` Python SDK

Plan for working through the 13 GitHub issues from [`AUDIT.md`](./AUDIT.md). Issues are grouped into **waves**; each wave is a set that can be worked in parallel without conflict, and waves are sequential.

Mapping to filed issues: <https://github.com/recost-dev/middleware-python/issues>

---

## At-a-glance

| Wave | Issues | Parallel? | Reason for order |
|---|---|---|---|
| 1 — Foundation | #1, #5 | Yes (different files) | Both zero-risk for blocking other work. |
| 2 — Threading primitive | #4 | — | Adds module-level `RLock` that Wave 3 / 4 depend on. |
| 3 — Lifecycle | #6 then #7 | Sequential (both touch `_transport.py`) | #6 fixes dispose semantics first; #7 builds on clean dispose. |
| 4 — Fork-safety + body sizing | #3, #8 | Yes (different files) | #3 builds on Wave 3's clean dispose; #8 is `_interceptor.py`-only. |
| 5 — P2 cleanup + types + tests | #10, #11, #12, #13, #2, #9 | Mostly yes | Small surface; fold tests into each fix; mypy sweep cleans up residual. |

---

## Detailed sequencing

### Wave 1 — Foundation

Two independent tracks, fully parallel.

- **#1 — [Aggregator thread-safety](https://github.com/recost-dev/middleware-python/issues/1)** (P0)
Files: `recost/_aggregator.py`, `tests/test_aggregator.py`
Wrap `ingest` / `flush` / `would_overflow` in `threading.RLock`. Add a regression test that races N threads ingesting against a flush. No dependencies on other issues.

- **#5 — [Naming + docs reconciliation](https://github.com/recost-dev/middleware-python/issues/5)** (P1)
Files: `recost/frameworks/flask.py`, `recost/__init__.py`, `README.md`, `CLAUDE.md`, `tests/test_provider_registry.py`
Flask class rename (`ReCost` → `RecostExtension`, alias for one release), strip `EcoAPI*` from CLAUDE.md, fix the provider-count claims (21 → 34), document `flush_interval_ms`/`max_buckets`/`shutdown_flush_timeout_ms`, mark `flush_interval` deprecated. No business-logic risk.

**Why this order:** both are zero-risk for blocking other work. Naming should land before any test or doc changes elsewhere so subsequent commits don't reference the old names.

---

### Wave 2 — Threading primitive

- **#4 — [Module-level state races](https://github.com/recost-dev/middleware-python/issues/4)** (P1)
Files: `recost/_init.py`, `recost/_interceptor.py`, `tests/test_init.py`
Introduces a module-level `threading.RLock` around `init()` / `dispose()` / `install()` / `uninstall()`. **Must land before Wave 3** because #6 and #3 will both rely on the same lock for their atomicity guarantees.

---

### Wave 3 — Process lifecycle

Both edits live in `_transport.py`, so do them sequentially to avoid merge conflicts:

1. **#6 — [Process lifecycle: atexit + dispose-during-connect FD leak](https://github.com/recost-dev/middleware-python/issues/6)** (P1)
Files: `recost/_init.py`, `recost/_transport.py`, `tests/test_init.py`
Fixes the dispose path so the loop properly stops and the thread joins. Adds an `atexit` handler that runs a final flush. Provides the clean-dispose mechanic that #3 reuses.

2. **#7 — [Local-mode WebSocket hardening](https://github.com/recost-dev/middleware-python/issues/7)** (P1)
Files: `recost/_transport.py`, `tests/test_transport.py`, plus a coordinated change in the extension repo
Cap the queue (drop-oldest), give up after N failed reconnects (with a one-shot `on_error`), add lightweight `hello`/`ack` handshake. Doing this second means rebasing on top of cleaner dispose semantics.

---

### Wave 4 — Fork-safety + body sizing

Parallel — different files:

- **#3 — [No fork-safety](https://github.com/recost-dev/middleware-python/issues/3)** (P0)
Files: `recost/_init.py`, `recost/_transport.py`, `README.md`, `tests/test_init.py`
Register `os.register_at_fork(after_in_child=_reinit_after_fork)` that re-creates the timer thread and transport thread in the child. Builds on Wave 3's clean dispose because the child needs to fully discard the parent's transport state.

- **#8 — [Body-size measurement](https://github.com/recost-dev/middleware-python/issues/8)** (P1)
Files: `recost/_interceptor.py`, `README.md`, `tests/test_interceptor.py`
aiohttp `json=`/`FormData`, httpx streaming-body materialization, response Content-Length-only caveat. Independent of all lifecycle work.

---

### Wave 5 — P2 cleanup + types + tests

Most can be done in parallel; finish in any order.

- **#10 — [Flush loop hygiene](https://github.com/recost-dev/middleware-python/issues/10)** (P2) — `recost/_init.py`
- **#11 — [urllib3 wrapper maintenance](https://github.com/recost-dev/middleware-python/issues/11)** (P2) — `recost/_interceptor.py`
- **#12 — [exclude_patterns](https://github.com/recost-dev/middleware-python/issues/12)** (P2) — `recost/_init.py`, `README.md`
- **#13 — [Code hygiene](https://github.com/recost-dev/middleware-python/issues/13)** (P2) — `recost/_transport.py`, `recost/_interceptor.py`
- **#2 — [35 mypy strict errors](https://github.com/recost-dev/middleware-python/issues/2)** (P0) — touched files were largely fixed during earlier waves; this is the residual sweep. Add `mypy --strict` to CI as part of this PR so the strict-clean claim becomes verifiable.
- **#9 — [Test gaps](https://github.com/recost-dev/middleware-python/issues/9)** (P1) — fold tests into each PR above. Outstanding items by end of Wave 4: aiohttp interceptor branch coverage (Wave 4 dependency), privacy test, self-instrumentation test, 5xx retry test.

---

## Cross-cutting rules

- **One issue per PR.** Each PR closes one numbered issue. Avoid bundling unrelated fixes.
- **Tests with every fix.** Don't merge a bugfix without a test that fails before the fix and passes after.
- **mypy `--strict` must pass on touched files before merge.** This is how #2 closes — incrementally per file. By Wave 5 only residual errors should remain.
- **Update `CHANGELOG.md` with each PR** (or create one if absent).

---

## What to start with right now

Pick one of:

1. **#5** — low-risk warm-up that unblocks naming.
2. **#1** — go straight to a P0 with a focused fix.
3. **#4** — set up the threading primitive that 3 / 6 / 7 depend on (longer chain).

**Recommendation:** open two branches and do **#5 + #1 in parallel as Wave 1**, then start **#4**.
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ __pycache__/
*.egg-info/
dist/
build/
.worktrees/

# Sensitive
.env
Expand Down
318 changes: 318 additions & 0 deletions AUDIT.md

Large diffs are not rendered by default.

105 changes: 105 additions & 0 deletions ROADMAP.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Working Order — `recost` Python SDK

Plan for working through the 13 GitHub issues from [`AUDIT.md`](./AUDIT.md). Issues are grouped into **waves**; each wave is a set that can be worked in parallel without conflict, and waves are sequential.

Mapping to filed issues: <https://github.com/recost-dev/middleware-python/issues>

---

## At-a-glance

| Wave | Issues | Parallel? | Reason for order |
|---|---|---|---|
| 1 — Foundation | #1, #5 | Yes (different files) | Both zero-risk for blocking other work. |
| 2 — Threading primitive | #4 | — | Adds module-level `RLock` that Wave 3 / 4 depend on. |
| 3 — Lifecycle | #6 then #7 | Sequential (both touch `_transport.py`) | #6 fixes dispose semantics first; #7 builds on clean dispose. |
| 4 — Fork-safety + body sizing | #3, #8 | Yes (different files) | #3 builds on Wave 3's clean dispose; #8 is `_interceptor.py`-only. |
| 5 — P2 cleanup + types + tests | #10, #11, #12, #13, #2, #9 | Mostly yes | Small surface; fold tests into each fix; mypy sweep cleans up residual. |

---

## Detailed sequencing

### Wave 1 — Foundation

Two independent tracks, fully parallel.

- **#1 — [Aggregator thread-safety](https://github.com/recost-dev/middleware-python/issues/1)** (P0)
Files: `recost/_aggregator.py`, `tests/test_aggregator.py`
Wrap `ingest` / `flush` / `would_overflow` in `threading.RLock`. Add a regression test that races N threads ingesting against a flush. No dependencies on other issues.

- **#5 — [Naming + docs reconciliation](https://github.com/recost-dev/middleware-python/issues/5)** (P1)
Files: `recost/frameworks/flask.py`, `recost/__init__.py`, `README.md`, `CLAUDE.md`, `tests/test_provider_registry.py`
Flask class rename (`ReCost` → `RecostExtension`, alias for one release), strip `EcoAPI*` from CLAUDE.md, fix the provider-count claims (21 → 34), document `flush_interval_ms`/`max_buckets`/`shutdown_flush_timeout_ms`, mark `flush_interval` deprecated. No business-logic risk.

**Why this order:** both are zero-risk for blocking other work. Naming should land before any test or doc changes elsewhere so subsequent commits don't reference the old names.

---

### Wave 2 — Threading primitive

- **#4 — [Module-level state races](https://github.com/recost-dev/middleware-python/issues/4)** (P1)
Files: `recost/_init.py`, `recost/_interceptor.py`, `tests/test_init.py`
Introduces a module-level `threading.RLock` around `init()` / `dispose()` / `install()` / `uninstall()`. **Must land before Wave 3** because #6 and #3 will both rely on the same lock for their atomicity guarantees.

---

### Wave 3 — Process lifecycle

Both edits live in `_transport.py`, so do them sequentially to avoid merge conflicts:

1. **#6 — [Process lifecycle: atexit + dispose-during-connect FD leak](https://github.com/recost-dev/middleware-python/issues/6)** (P1)
Files: `recost/_init.py`, `recost/_transport.py`, `tests/test_init.py`
Fixes the dispose path so the loop properly stops and the thread joins. Adds an `atexit` handler that runs a final flush. Provides the clean-dispose mechanic that #3 reuses.

2. **#7 — [Local-mode WebSocket hardening](https://github.com/recost-dev/middleware-python/issues/7)** (P1)
Files: `recost/_transport.py`, `tests/test_transport.py`, plus a coordinated change in the extension repo
Cap the queue (drop-oldest), give up after N failed reconnects (with a one-shot `on_error`), add lightweight `hello`/`ack` handshake. Doing this second means rebasing on top of cleaner dispose semantics.

---

### Wave 4 — Fork-safety + body sizing

Parallel — different files:

- **#3 — [No fork-safety](https://github.com/recost-dev/middleware-python/issues/3)** (P0)
Files: `recost/_init.py`, `recost/_transport.py`, `README.md`, `tests/test_init.py`
Register `os.register_at_fork(after_in_child=_reinit_after_fork)` that re-creates the timer thread and transport thread in the child. Builds on Wave 3's clean dispose because the child needs to fully discard the parent's transport state.

- **#8 — [Body-size measurement](https://github.com/recost-dev/middleware-python/issues/8)** (P1)
Files: `recost/_interceptor.py`, `README.md`, `tests/test_interceptor.py`
aiohttp `json=`/`FormData`, httpx streaming-body materialization, response Content-Length-only caveat. Independent of all lifecycle work.

---

### Wave 5 — P2 cleanup + types + tests

Most can be done in parallel; finish in any order.

- **#10 — [Flush loop hygiene](https://github.com/recost-dev/middleware-python/issues/10)** (P2) — `recost/_init.py`
- **#11 — [urllib3 wrapper maintenance](https://github.com/recost-dev/middleware-python/issues/11)** (P2) — `recost/_interceptor.py`
- **#12 — [exclude_patterns](https://github.com/recost-dev/middleware-python/issues/12)** (P2) — `recost/_init.py`, `README.md`
- **#13 — [Code hygiene](https://github.com/recost-dev/middleware-python/issues/13)** (P2) — `recost/_transport.py`, `recost/_interceptor.py`
- **#2 — [35 mypy strict errors](https://github.com/recost-dev/middleware-python/issues/2)** (P0) — touched files were largely fixed during earlier waves; this is the residual sweep. Add `mypy --strict` to CI as part of this PR so the strict-clean claim becomes verifiable.
- **#9 — [Test gaps](https://github.com/recost-dev/middleware-python/issues/9)** (P1) — fold tests into each PR above. Outstanding items by end of Wave 4: aiohttp interceptor branch coverage (Wave 4 dependency), privacy test, self-instrumentation test, 5xx retry test.

---

## Cross-cutting rules

- **One issue per PR.** Each PR closes one numbered issue. Avoid bundling unrelated fixes.
- **Tests with every fix.** Don't merge a bugfix without a test that fails before the fix and passes after.
- **mypy `--strict` must pass on touched files before merge.** This is how #2 closes — incrementally per file. By Wave 5 only residual errors should remain.
- **Update `CHANGELOG.md` with each PR** (or create one if absent).

---

## What to start with right now

Pick one of:

1. **#5** — low-risk warm-up that unblocks naming.
2. **#1** — go straight to a P0 with a focused fix.
3. **#4** — set up the threading primitive that 3 / 6 / 7 depend on (longer chain).

**Recommendation:** open two branches and do **#5 + #1 in parallel as Wave 1**, then start **#4**.
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ __pycache__/
*.egg-info/
dist/
build/
.worktrees/

# Sensitive
.env
Expand Down
318 changes: 318 additions & 0 deletions AUDIT.md

Large diffs are not rendered by default.

105 changes: 105 additions & 0 deletions ROADMAP.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Working Order — `recost` Python SDK

Plan for working through the 13 GitHub issues from [`AUDIT.md`](./AUDIT.md). Issues are grouped into **waves**; each wave is a set that can be worked in parallel without conflict, and waves are sequential.

Mapping to filed issues: <https://github.com/recost-dev/middleware-python/issues>

---

## At-a-glance

| Wave | Issues | Parallel? | Reason for order |
|---|---|---|---|
| 1 — Foundation | #1, #5 | Yes (different files) | Both zero-risk for blocking other work. |
| 2 — Threading primitive | #4 | — | Adds module-level `RLock` that Wave 3 / 4 depend on. |
| 3 — Lifecycle | #6 then #7 | Sequential (both touch `_transport.py`) | #6 fixes dispose semantics first; #7 builds on clean dispose. |
| 4 — Fork-safety + body sizing | #3, #8 | Yes (different files) | #3 builds on Wave 3's clean dispose; #8 is `_interceptor.py`-only. |
| 5 — P2 cleanup + types + tests | #10, #11, #12, #13, #2, #9 | Mostly yes | Small surface; fold tests into each fix; mypy sweep cleans up residual. |

---

## Detailed sequencing

### Wave 1 — Foundation

Two independent tracks, fully parallel.

- **#1 — [Aggregator thread-safety](https://github.com/recost-dev/middleware-python/issues/1)** (P0)
Files: `recost/_aggregator.py`, `tests/test_aggregator.py`
Wrap `ingest` / `flush` / `would_overflow` in `threading.RLock`. Add a regression test that races N threads ingesting against a flush. No dependencies on other issues.

- **#5 — [Naming + docs reconciliation](https://github.com/recost-dev/middleware-python/issues/5)** (P1)
Files: `recost/frameworks/flask.py`, `recost/__init__.py`, `README.md`, `CLAUDE.md`, `tests/test_provider_registry.py`
Flask class rename (`ReCost` → `RecostExtension`, alias for one release), strip `EcoAPI*` from CLAUDE.md, fix the provider-count claims (21 → 34), document `flush_interval_ms`/`max_buckets`/`shutdown_flush_timeout_ms`, mark `flush_interval` deprecated. No business-logic risk.

**Why this order:** both are zero-risk for blocking other work. Naming should land before any test or doc changes elsewhere so subsequent commits don't reference the old names.

---

### Wave 2 — Threading primitive

- **#4 — [Module-level state races](https://github.com/recost-dev/middleware-python/issues/4)** (P1)
Files: `recost/_init.py`, `recost/_interceptor.py`, `tests/test_init.py`
Introduces a module-level `threading.RLock` around `init()` / `dispose()` / `install()` / `uninstall()`. **Must land before Wave 3** because #6 and #3 will both rely on the same lock for their atomicity guarantees.

---

### Wave 3 — Process lifecycle

Both edits live in `_transport.py`, so do them sequentially to avoid merge conflicts:

1. **#6 — [Process lifecycle: atexit + dispose-during-connect FD leak](https://github.com/recost-dev/middleware-python/issues/6)** (P1)
Files: `recost/_init.py`, `recost/_transport.py`, `tests/test_init.py`
Fixes the dispose path so the loop properly stops and the thread joins. Adds an `atexit` handler that runs a final flush. Provides the clean-dispose mechanic that #3 reuses.

2. **#7 — [Local-mode WebSocket hardening](https://github.com/recost-dev/middleware-python/issues/7)** (P1)
Files: `recost/_transport.py`, `tests/test_transport.py`, plus a coordinated change in the extension repo
Cap the queue (drop-oldest), give up after N failed reconnects (with a one-shot `on_error`), add lightweight `hello`/`ack` handshake. Doing this second means rebasing on top of cleaner dispose semantics.

---

### Wave 4 — Fork-safety + body sizing

Parallel — different files:

- **#3 — [No fork-safety](https://github.com/recost-dev/middleware-python/issues/3)** (P0)
Files: `recost/_init.py`, `recost/_transport.py`, `README.md`, `tests/test_init.py`
Register `os.register_at_fork(after_in_child=_reinit_after_fork)` that re-creates the timer thread and transport thread in the child. Builds on Wave 3's clean dispose because the child needs to fully discard the parent's transport state.

- **#8 — [Body-size measurement](https://github.com/recost-dev/middleware-python/issues/8)** (P1)
Files: `recost/_interceptor.py`, `README.md`, `tests/test_interceptor.py`
aiohttp `json=`/`FormData`, httpx streaming-body materialization, response Content-Length-only caveat. Independent of all lifecycle work.

---

### Wave 5 — P2 cleanup + types + tests

Most can be done in parallel; finish in any order.

- **#10 — [Flush loop hygiene](https://github.com/recost-dev/middleware-python/issues/10)** (P2) — `recost/_init.py`
- **#11 — [urllib3 wrapper maintenance](https://github.com/recost-dev/middleware-python/issues/11)** (P2) — `recost/_interceptor.py`
- **#12 — [exclude_patterns](https://github.com/recost-dev/middleware-python/issues/12)** (P2) — `recost/_init.py`, `README.md`
- **#13 — [Code hygiene](https://github.com/recost-dev/middleware-python/issues/13)** (P2) — `recost/_transport.py`, `recost/_interceptor.py`
- **#2 — [35 mypy strict errors](https://github.com/recost-dev/middleware-python/issues/2)** (P0) — touched files were largely fixed during earlier waves; this is the residual sweep. Add `mypy --strict` to CI as part of this PR so the strict-clean claim becomes verifiable.
- **#9 — [Test gaps](https://github.com/recost-dev/middleware-python/issues/9)** (P1) — fold tests into each PR above. Outstanding items by end of Wave 4: aiohttp interceptor branch coverage (Wave 4 dependency), privacy test, self-instrumentation test, 5xx retry test.

---

## Cross-cutting rules

- **One issue per PR.** Each PR closes one numbered issue. Avoid bundling unrelated fixes.
- **Tests with every fix.** Don't merge a bugfix without a test that fails before the fix and passes after.
- **mypy `--strict` must pass on touched files before merge.** This is how #2 closes — incrementally per file. By Wave 5 only residual errors should remain.
- **Update `CHANGELOG.md` with each PR** (or create one if absent).

---

## What to start with right now

Pick one of:

1. **#5** — low-risk warm-up that unblocks naming.
2. **#1** — go straight to a P0 with a focused fix.
3. **#4** — set up the threading primitive that 3 / 6 / 7 depend on (longer chain).

**Recommendation:** open two branches and do **#5 + #1 in parallel as Wave 1**, then start **#4**.
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ __pycache__/
*.egg-info/
dist/
build/
.worktrees/

# Sensitive
.env
Expand Down
318 changes: 318 additions & 0 deletions AUDIT.md

Large diffs are not rendered by default.

105 changes: 105 additions & 0 deletions ROADMAP.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Working Order — `recost` Python SDK

Plan for working through the 13 GitHub issues from [`AUDIT.md`](./AUDIT.md). Issues are grouped into **waves**; each wave is a set that can be worked in parallel without conflict, and waves are sequential.

Mapping to filed issues: <https://github.com/recost-dev/middleware-python/issues>

---

## At-a-glance

| Wave | Issues | Parallel? | Reason for order |
|---|---|---|---|
| 1 — Foundation | #1, #5 | Yes (different files) | Both zero-risk for blocking other work. |
| 2 — Threading primitive | #4 | — | Adds module-level `RLock` that Wave 3 / 4 depend on. |
| 3 — Lifecycle | #6 then #7 | Sequential (both touch `_transport.py`) | #6 fixes dispose semantics first; #7 builds on clean dispose. |
| 4 — Fork-safety + body sizing | #3, #8 | Yes (different files) | #3 builds on Wave 3's clean dispose; #8 is `_interceptor.py`-only. |
| 5 — P2 cleanup + types + tests | #10, #11, #12, #13, #2, #9 | Mostly yes | Small surface; fold tests into each fix; mypy sweep cleans up residual. |

---

## Detailed sequencing

### Wave 1 — Foundation

Two independent tracks, fully parallel.

- **#1 — [Aggregator thread-safety](https://github.com/recost-dev/middleware-python/issues/1)** (P0)
Files: `recost/_aggregator.py`, `tests/test_aggregator.py`
Wrap `ingest` / `flush` / `would_overflow` in `threading.RLock`. Add a regression test that races N threads ingesting against a flush. No dependencies on other issues.

- **#5 — [Naming + docs reconciliation](https://github.com/recost-dev/middleware-python/issues/5)** (P1)
Files: `recost/frameworks/flask.py`, `recost/__init__.py`, `README.md`, `CLAUDE.md`, `tests/test_provider_registry.py`
Flask class rename (`ReCost` → `RecostExtension`, alias for one release), strip `EcoAPI*` from CLAUDE.md, fix the provider-count claims (21 → 34), document `flush_interval_ms`/`max_buckets`/`shutdown_flush_timeout_ms`, mark `flush_interval` deprecated. No business-logic risk.

**Why this order:** both are zero-risk for blocking other work. Naming should land before any test or doc changes elsewhere so subsequent commits don't reference the old names.

---

### Wave 2 — Threading primitive

- **#4 — [Module-level state races](https://github.com/recost-dev/middleware-python/issues/4)** (P1)
Files: `recost/_init.py`, `recost/_interceptor.py`, `tests/test_init.py`
Introduces a module-level `threading.RLock` around `init()` / `dispose()` / `install()` / `uninstall()`. **Must land before Wave 3** because #6 and #3 will both rely on the same lock for their atomicity guarantees.

---

### Wave 3 — Process lifecycle

Both edits live in `_transport.py`, so do them sequentially to avoid merge conflicts:

1. **#6 — [Process lifecycle: atexit + dispose-during-connect FD leak](https://github.com/recost-dev/middleware-python/issues/6)** (P1)
Files: `recost/_init.py`, `recost/_transport.py`, `tests/test_init.py`
Fixes the dispose path so the loop properly stops and the thread joins. Adds an `atexit` handler that runs a final flush. Provides the clean-dispose mechanic that #3 reuses.

2. **#7 — [Local-mode WebSocket hardening](https://github.com/recost-dev/middleware-python/issues/7)** (P1)
Files: `recost/_transport.py`, `tests/test_transport.py`, plus a coordinated change in the extension repo
Cap the queue (drop-oldest), give up after N failed reconnects (with a one-shot `on_error`), add lightweight `hello`/`ack` handshake. Doing this second means rebasing on top of cleaner dispose semantics.

---

### Wave 4 — Fork-safety + body sizing

Parallel — different files:

- **#3 — [No fork-safety](https://github.com/recost-dev/middleware-python/issues/3)** (P0)
Files: `recost/_init.py`, `recost/_transport.py`, `README.md`, `tests/test_init.py`
Register `os.register_at_fork(after_in_child=_reinit_after_fork)` that re-creates the timer thread and transport thread in the child. Builds on Wave 3's clean dispose because the child needs to fully discard the parent's transport state.

- **#8 — [Body-size measurement](https://github.com/recost-dev/middleware-python/issues/8)** (P1)
Files: `recost/_interceptor.py`, `README.md`, `tests/test_interceptor.py`
aiohttp `json=`/`FormData`, httpx streaming-body materialization, response Content-Length-only caveat. Independent of all lifecycle work.

---

### Wave 5 — P2 cleanup + types + tests

Most can be done in parallel; finish in any order.

- **#10 — [Flush loop hygiene](https://github.com/recost-dev/middleware-python/issues/10)** (P2) — `recost/_init.py`
- **#11 — [urllib3 wrapper maintenance](https://github.com/recost-dev/middleware-python/issues/11)** (P2) — `recost/_interceptor.py`
- **#12 — [exclude_patterns](https://github.com/recost-dev/middleware-python/issues/12)** (P2) — `recost/_init.py`, `README.md`
- **#13 — [Code hygiene](https://github.com/recost-dev/middleware-python/issues/13)** (P2) — `recost/_transport.py`, `recost/_interceptor.py`
- **#2 — [35 mypy strict errors](https://github.com/recost-dev/middleware-python/issues/2)** (P0) — touched files were largely fixed during earlier waves; this is the residual sweep. Add `mypy --strict` to CI as part of this PR so the strict-clean claim becomes verifiable.
- **#9 — [Test gaps](https://github.com/recost-dev/middleware-python/issues/9)** (P1) — fold tests into each PR above. Outstanding items by end of Wave 4: aiohttp interceptor branch coverage (Wave 4 dependency), privacy test, self-instrumentation test, 5xx retry test.

---

## Cross-cutting rules

- **One issue per PR.** Each PR closes one numbered issue. Avoid bundling unrelated fixes.
- **Tests with every fix.** Don't merge a bugfix without a test that fails before the fix and passes after.
- **mypy `--strict` must pass on touched files before merge.** This is how #2 closes — incrementally per file. By Wave 5 only residual errors should remain.
- **Update `CHANGELOG.md` with each PR** (or create one if absent).

---

## What to start with right now

Pick one of:

1. **#5** — low-risk warm-up that unblocks naming.
2. **#1** — go straight to a P0 with a focused fix.
3. **#4** — set up the threading primitive that 3 / 6 / 7 depend on (longer chain).

**Recommendation:** open two branches and do **#5 + #1 in parallel as Wave 1**, then start **#4**.
Loading