Compare commits
No files matched your search
@@ -1,33 +0,0 @@
|
||||
# Repo Memory
|
||||
|
||||
Curated, reviewed knowledge for coding agents working in this repository.
|
||||
Memory is an accelerator, not a second source of truth.
|
||||
|
||||
## Precedence (highest first)
|
||||
|
||||
1. Source code and tests
|
||||
2. Executable configuration
|
||||
3. Accepted design records / docs
|
||||
4. `AGENTS.md`
|
||||
5. This memory
|
||||
|
||||
If memory conflicts with anything above it, the memory is stale — propose a fix.
|
||||
|
||||
## Topics
|
||||
|
||||
- `memory/architecture.md` — durable architectural decisions and constraints
|
||||
- `memory/conventions.md` — validated conventions not obvious from the code
|
||||
- `memory/lessons.md` — hard-won lessons and recurring landmines
|
||||
- `memory/decisions.jsonl` — structured decision records (one JSON object per line)
|
||||
|
||||
## Write policy
|
||||
|
||||
Agents MAY read everything here and MAY add candidates under `proposals/`
|
||||
(one file per proposal, named `YYYY-MM-DD-<slug>.md`, with evidence links).
|
||||
Agents MUST NOT edit `memory/` directly; trusted memory changes only through
|
||||
reviewed commits that promote a proposal.
|
||||
|
||||
## Prohibited content
|
||||
|
||||
Credentials or secrets, personal data, raw transcripts or tool logs, session
|
||||
TODOs, high-frequency agent state, unverified external claims.
|
||||
@@ -1,17 +0,0 @@
|
||||
# Architecture
|
||||
|
||||
Durable architectural decisions and constraints for bitvid.
|
||||
|
||||
## AGENTS.md is a thin constitution; long-form standards live in docs/
|
||||
|
||||
On 2026-08-12 AGENTS.md was split into a thin agent constitution plus
|
||||
reference docs under `docs/testing/` and `docs/lessons/`, because the file had
|
||||
outgrown the 32 KiB harness context budget. AGENTS.md keeps only the invariant
|
||||
and a pointer per topic; new long-form material belongs in `docs/`, not in
|
||||
AGENTS.md.
|
||||
|
||||
Authoritative source:
|
||||
- docs/testing/test-integrity.md
|
||||
- docs/testing/agent-playwright-harness.md
|
||||
- docs/lessons/
|
||||
- git commit 911afb1c ("Split AGENTS.md reference sections into docs/; keep thin agent constitution")
|
||||
@@ -1,5 +0,0 @@
|
||||
# Conventions
|
||||
|
||||
Validated conventions not obvious from the code.
|
||||
|
||||
No entries yet.
|
||||
@@ -1 +0,0 @@
|
||||
{"kind":"decision","subject":"docs/agents-md-split","summary":"AGENTS.md was split on 2026-08-12 into a thin agent constitution plus reference docs under docs/testing/ and docs/lessons/ to stay within the 32 KiB harness context budget; AGENTS.md keeps only invariants and pointers, and new long-form material belongs in docs/.","status":"active","evidence":[{"type":"repository","ref":"docs/testing/test-integrity.md"},{"type":"repository","ref":"docs/testing/agent-playwright-harness.md"},{"type":"repository","ref":"docs/lessons/"},{"type":"git","ref":"911afb1c"}],"created":"2026-08-12","supersedes":[]}
|
||||
@@ -1,24 +0,0 @@
|
||||
# Lessons
|
||||
|
||||
Hard-won lessons and recurring landmines.
|
||||
|
||||
## Cloudflare/S3 upload-path gotchas
|
||||
|
||||
`js/services/r2Service.js` and `js/services/s3UploadService.js` are near-identical
|
||||
copies that must be changed in lockstep, and storage keys must stay
|
||||
content-addressed (`computeStorageContentHash`) or URL-first uploads silently
|
||||
overwrite objects. Full audited writeup in the doc below.
|
||||
|
||||
Authoritative source:
|
||||
- docs/lessons/cloudflare-s3-upload-gotchas.md
|
||||
|
||||
## NIP-07 signer reliability
|
||||
|
||||
"DMs / lists / watch-history won't load after login" is almost always an
|
||||
unresponsive NIP-07 signer extension, not bitvid — diagnose with a raw
|
||||
`window.nostr` probe first, and never regress the five resilience invariants
|
||||
(capped relay fan-out, NIP-07 circuit breaker, re-thrown transient decrypt
|
||||
errors, generous decrypt budgets, lazy modal population).
|
||||
|
||||
Authoritative source:
|
||||
- docs/lessons/nip07-signer-reliability.md
|
||||
@@ -1,8 +0,0 @@
|
||||
# Agent plans
|
||||
|
||||
Durable, multi-session execution plans only — the canonical backlog stays in
|
||||
the repo's TODO file or GitHub Issues, and session-local checklists are never
|
||||
committed. One plan per task, named `<ticket-or-slug>.md`, in `active/`;
|
||||
move finished plans to `archive/`. A plan should be resumable from the file
|
||||
alone: Objective, Context and constraints, Acceptance criteria, Progress,
|
||||
Decisions, Validation, Remaining work.
|
||||
@@ -1,7 +0,0 @@
|
||||
# Memory proposals
|
||||
|
||||
Agents: drop candidate memories here, one file per proposal, named
|
||||
`YYYY-MM-DD-<slug>.md`. State the claim, the evidence (file paths, commits,
|
||||
test results), and why it is durable. A human reviews and either promotes it
|
||||
into `../memory/` in a reviewed commit or deletes it. Nothing in this
|
||||
directory is trusted context.
|
||||
@@ -1,29 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"title": "Repo Memory Decision Record",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["kind", "subject", "summary", "status", "evidence", "created"],
|
||||
"properties": {
|
||||
"kind": {"enum": ["decision", "constraint", "lesson", "observation", "workaround"]},
|
||||
"subject": {"type": "string", "minLength": 1},
|
||||
"summary": {"type": "string", "minLength": 1, "maxLength": 4096},
|
||||
"status": {"enum": ["proposed", "active", "superseded", "expired"]},
|
||||
"evidence": {
|
||||
"type": "array",
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["type", "ref"],
|
||||
"properties": {
|
||||
"type": {"enum": ["repository", "git", "issue", "test", "external"]},
|
||||
"ref": {"type": "string", "minLength": 1}
|
||||
}
|
||||
}
|
||||
},
|
||||
"created": {"type": "string"},
|
||||
"expires": {"type": ["string", "null"]},
|
||||
"supersedes": {"type": "array", "items": {"type": "string"}}
|
||||
}
|
||||
}
|
||||
@@ -1,12 +0,0 @@
|
||||
---
|
||||
name: agent-fleet
|
||||
description: Use fleet-mcp tools for backlog, mailbox, landing queue, and area ownership. Do not use it to start sessions or push main.
|
||||
---
|
||||
|
||||
Follow the fleet rules in `AGENTS.md`. Call the `agent-fleet` MCP tools for backlog, mailbox, landing-queue, area questions, and commits. Editing those files directly is also fine. Sandboxed Codex cannot write Git's index: use the `commit` tool (or `fleet commit -m "..." --area <id> -- <paths>`), not `git commit`. `submit: true` queues the landing and starts a drain. Go back to work. At your next natural checkpoint, `land_status` (or `fleet landq status <id>`) can report that submission. Waiting is optional. Do not infer the lander or the land result from silence. Other providers may use either commit path.
|
||||
|
||||
If you installed this fleet, you stay on as the interpreter. Read `docs/agents/prompts/interpreter.md`. Run `fleet up` yourself. Talk to the session manager with `tell` and read replies with `hear`. Do not scrape the tmux pane, and do not send the user to a terminal. A routine yes you relay counts. Money, pushes, deploys, deletes, secrets, outgoing messages, and a bigger structural or directional change go to the user. Uncommitted setup files use `setup_commit`, not `git commit`. Workers do not start the fleet. `fleet crontab` stays unused unless the user asks.
|
||||
|
||||
You may use this harness's own subagents for parallel research, investigation, test runs, or review. You coordinate edits in a worktree so subagents do not edit the same files at the same time. Landing still goes through your `commit` and the queue.
|
||||
|
||||
To update the kit: `git pull` in `~/agent-fleet-kit`, reinstall, run `fleet update`, and restart agents after handoff if it says so. Do not re-run init to upgrade.
|
||||
@@ -4,10 +4,7 @@
|
||||
"features": {
|
||||
"ghcr.io/devcontainers/features/github-cli:1": {}
|
||||
},
|
||||
"forwardPorts": [
|
||||
3000
|
||||
],
|
||||
"postCreateCommand": "npm ci && npm run build && npx playwright install --with-deps",
|
||||
"postCreateCommand": "npm ci && npm run build && npx playwright install",
|
||||
"customizations": {
|
||||
"vscode": {
|
||||
"extensions": [
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
# Agent instruction and memory surfaces require maintainer review
|
||||
/AGENTS.md @PR0M3TH3AN
|
||||
/CLAUDE.md @PR0M3TH3AN
|
||||
/.agents/ @PR0M3TH3AN
|
||||
/SECURITY.md @PR0M3TH3AN
|
||||
/.github/workflows/agent-governance.yml @PR0M3TH3AN
|
||||
@@ -1,65 +0,0 @@
|
||||
name: Agent governance
|
||||
|
||||
on:
|
||||
push:
|
||||
paths:
|
||||
- "AGENTS.md"
|
||||
- "CLAUDE.md"
|
||||
- ".agents/**"
|
||||
pull_request:
|
||||
paths:
|
||||
- "AGENTS.md"
|
||||
- "CLAUDE.md"
|
||||
- ".agents/**"
|
||||
|
||||
jobs:
|
||||
lint-agent-artifacts:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Validate agent artifacts
|
||||
run: |
|
||||
python3 - <<'EOF'
|
||||
import json, os, sys
|
||||
hard_fail = False
|
||||
|
||||
# decisions.jsonl: every line must be valid JSON with required keys
|
||||
path = ".agents/memory/decisions.jsonl"
|
||||
if os.path.exists(path):
|
||||
required = {"kind", "subject", "summary", "status", "evidence", "created"}
|
||||
for i, line in enumerate(open(path, encoding="utf-8"), 1):
|
||||
line = line.strip()
|
||||
if not line:
|
||||
continue
|
||||
try:
|
||||
rec = json.loads(line)
|
||||
except json.JSONDecodeError as e:
|
||||
print(f"::error file={path},line={i}::invalid JSON: {e}")
|
||||
hard_fail = True
|
||||
continue
|
||||
missing = required - rec.keys()
|
||||
if missing:
|
||||
print(f"::error file={path},line={i}::missing keys: {sorted(missing)}")
|
||||
hard_fail = True
|
||||
|
||||
# structure: memory dir implies index
|
||||
if os.path.isdir(".agents") and not os.path.exists(".agents/MEMORY.md"):
|
||||
print("::error::.agents/ exists but .agents/MEMORY.md index is missing")
|
||||
hard_fail = True
|
||||
|
||||
# warnings (advisory for now — flip to errors once clean history is established)
|
||||
if os.path.exists("AGENTS.md"):
|
||||
size = os.path.getsize("AGENTS.md")
|
||||
if size > 32768:
|
||||
print(f"::warning file=AGENTS.md::{size} bytes exceeds the 32 KiB context budget")
|
||||
if os.path.exists("CLAUDE.md"):
|
||||
lines = sum(1 for _ in open("CLAUDE.md", encoding="utf-8"))
|
||||
if lines > 40:
|
||||
print(f"::warning file=CLAUDE.md::{lines} lines — expected a thin wrapper over AGENTS.md")
|
||||
for f in ("architecture.md", "conventions.md", "lessons.md"):
|
||||
p = f".agents/memory/{f}"
|
||||
if os.path.exists(p) and os.path.getsize(p) > 25 * 1024:
|
||||
print(f"::warning file={p}::exceeds 25 KB — curate or split")
|
||||
|
||||
sys.exit(1 if hard_fail else 0)
|
||||
EOF
|
||||
@@ -17,23 +17,21 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.ref }}
|
||||
repository: ${{ github.event.pull_request.head.repo.full_name }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v5
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22
|
||||
node-version: 20
|
||||
cache: 'npm'
|
||||
|
||||
- name: Add upstream remote
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
git remote add upstream https://x-access-token:${GITHUB_TOKEN}@github.com/PR0M3TH3AN/bitvid.git || true
|
||||
git remote add upstream https://github.com/PR0M3TH3AN/bitvid.git || true
|
||||
git fetch upstream
|
||||
|
||||
- name: Verify upstream branch and diff
|
||||
|
||||
@@ -4,7 +4,6 @@ on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- unstable
|
||||
pull_request:
|
||||
|
||||
concurrency:
|
||||
@@ -17,16 +16,14 @@ jobs:
|
||||
timeout-minutes: 45
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [22]
|
||||
node-version: [20]
|
||||
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
with:
|
||||
fetch-depth: 0
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v5
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
@@ -52,9 +49,7 @@ jobs:
|
||||
run: npm ci
|
||||
|
||||
- name: Install ripgrep
|
||||
run: |
|
||||
sudo rm -f /etc/apt/sources.list.d/microsoft-prod.list
|
||||
sudo apt-get update && sudo apt-get install -y ripgrep
|
||||
run: sudo apt-get update && sudo apt-get install -y ripgrep
|
||||
|
||||
- name: Run lint suite
|
||||
run: npm run lint
|
||||
@@ -62,78 +57,6 @@ jobs:
|
||||
- name: Build assets
|
||||
run: npm run build
|
||||
|
||||
- name: Verify deploy artifact markup and hashed references
|
||||
run: npm run verify:dist:deploy-artifact
|
||||
|
||||
- name: Smoke check hashed dist asset references
|
||||
run: npm run smoke:dist-assets
|
||||
|
||||
- name: Install Playwright browsers
|
||||
run: npx playwright install --with-deps chromium
|
||||
|
||||
- name: Run cache-upgrade smoke test
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/unstable'
|
||||
run: npm run test:e2e:cache-upgrade
|
||||
|
||||
- name: Generate dist hash state
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/unstable'
|
||||
run: |
|
||||
mkdir -p artifacts
|
||||
node scripts/hash-dist.mjs --dist dist --output artifacts/dist-hashes-current.json
|
||||
|
||||
- name: Upload dist hash artifact
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/unstable'
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: dist-hashes-current
|
||||
path: artifacts/dist-hashes-current.json
|
||||
if-no-files-found: error
|
||||
|
||||
|
||||
# Visual regression runs as its own job so an environment-sensitive pixel diff
|
||||
# (CI Chromium/font rendering can differ from the committed baseline) reports a
|
||||
# failure WITHOUT blocking the build job — and therefore without blocking the
|
||||
# deploy-cache-state CDN purge below. Real build/lint failures still gate the
|
||||
# deploy via the build job.
|
||||
visual-regression:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [22]
|
||||
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v5
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
- name: Cache npm directory
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.npm
|
||||
key: ${{ runner.os }}-node-${{ matrix.node-version }}-npm-${{ hashFiles('package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node-${{ matrix.node-version }}-npm-
|
||||
|
||||
- name: Cache node_modules
|
||||
id: node-modules-cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: node_modules
|
||||
key: ${{ runner.os }}-node-${{ matrix.node-version }}-modules-${{ hashFiles('package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node-${{ matrix.node-version }}-modules-
|
||||
|
||||
- name: Install dependencies
|
||||
if: steps.node-modules-cache.outputs.cache-hit != 'true'
|
||||
run: npm ci
|
||||
|
||||
- name: Install Playwright browsers
|
||||
run: npx playwright install --with-deps chromium
|
||||
|
||||
@@ -144,7 +67,7 @@ jobs:
|
||||
|
||||
- name: Upload Playwright artifacts
|
||||
if: steps.visual.outcome == 'failure'
|
||||
uses: actions/upload-artifact@v7
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: playwright-visual-diffs
|
||||
path: |
|
||||
@@ -156,181 +79,21 @@ jobs:
|
||||
if: steps.visual.outcome == 'failure'
|
||||
run: exit 1
|
||||
|
||||
|
||||
deploy-cache-state:
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/unstable'
|
||||
needs: build
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 20
|
||||
concurrency:
|
||||
group: deploy-cache-state-unstable
|
||||
cancel-in-progress: false
|
||||
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Download dist hash artifact
|
||||
uses: actions/download-artifact@v8
|
||||
with:
|
||||
name: dist-hashes-current
|
||||
path: artifacts
|
||||
|
||||
- name: Fetch prior dist hash state and metadata
|
||||
env:
|
||||
DIST_HASH_STATE_URL: ${{ secrets.DIST_HASH_STATE_URL }}
|
||||
run: |
|
||||
mkdir -p artifacts
|
||||
|
||||
if [ -n "$DIST_HASH_STATE_URL" ]; then
|
||||
curl --fail --silent --show-error --dump-header artifacts/dist-hashes-previous.headers "$DIST_HASH_STATE_URL" -o artifacts/dist-hashes-previous.json
|
||||
DIST_HASH_STATE_ETAG=$(awk 'tolower($1)=="etag:" {print $2}' artifacts/dist-hashes-previous.headers | tr -d '\r' | tail -n 1)
|
||||
DIST_HASH_STATE_VERSION=$(awk 'tolower($1)=="x-dist-hash-version:" {print $2}' artifacts/dist-hashes-previous.headers | tr -d '\r' | tail -n 1)
|
||||
DIST_HASH_STATE_LAST_MODIFIED=$(awk 'BEGIN{IGNORECASE=1} /^Last-Modified:/ {sub(/^Last-Modified:[[:space:]]*/, ""); sub(/\r$/, ""); print; exit}' artifacts/dist-hashes-previous.headers)
|
||||
echo "Loaded prior dist hash state from authoritative store."
|
||||
else
|
||||
echo '{"combined":"","files":[]}' > artifacts/dist-hashes-previous.json
|
||||
DIST_HASH_STATE_ETAG=''
|
||||
DIST_HASH_STATE_VERSION=''
|
||||
DIST_HASH_STATE_LAST_MODIFIED=''
|
||||
echo "No DIST_HASH_STATE_URL configured; using empty baseline."
|
||||
fi
|
||||
|
||||
{
|
||||
echo "DIST_HASH_STATE_ETAG=$DIST_HASH_STATE_ETAG"
|
||||
echo "DIST_HASH_STATE_VERSION=$DIST_HASH_STATE_VERSION"
|
||||
echo "DIST_HASH_STATE_LAST_MODIFIED=$DIST_HASH_STATE_LAST_MODIFIED"
|
||||
} >> "$GITHUB_ENV"
|
||||
|
||||
echo "State metadata snapshot: etag='${DIST_HASH_STATE_ETAG:-<none>}', version='${DIST_HASH_STATE_VERSION:-<none>}', last-modified='${DIST_HASH_STATE_LAST_MODIFIED:-<none>}'"
|
||||
|
||||
- name: Diff dist hash states
|
||||
run: |
|
||||
node scripts/diff-dist-hashes.mjs \
|
||||
--current artifacts/dist-hashes-current.json \
|
||||
--previous artifacts/dist-hashes-previous.json > artifacts/dist-hashes-changed.txt
|
||||
echo "Changed dist paths (initial baseline):"
|
||||
cat artifacts/dist-hashes-changed.txt || true
|
||||
|
||||
- name: Plan cache purge scope
|
||||
run: |
|
||||
node scripts/plan-cache-purge.mjs \
|
||||
--changed-file artifacts/dist-hashes-changed.txt \
|
||||
--output-file artifacts/dist-purge-targets.txt > artifacts/dist-purge-plan.json
|
||||
echo "Initial purge plan:"
|
||||
cat artifacts/dist-purge-plan.json
|
||||
|
||||
- name: Record authoritative dist hash state with CAS and resolve races
|
||||
env:
|
||||
DIST_HASH_STATE_URL: ${{ secrets.DIST_HASH_STATE_URL }}
|
||||
DIST_HASH_STATE_UPLOAD_URL: ${{ secrets.DIST_HASH_STATE_UPLOAD_URL }}
|
||||
run: |
|
||||
if [ -z "$DIST_HASH_STATE_UPLOAD_URL" ]; then
|
||||
echo "No DIST_HASH_STATE_UPLOAD_URL configured; skipping authoritative hash-state update."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
set +e
|
||||
node scripts/store-dist-hash-state.mjs \
|
||||
--input artifacts/dist-hashes-current.json \
|
||||
--upload-url "$DIST_HASH_STATE_UPLOAD_URL" \
|
||||
--if-match "$DIST_HASH_STATE_ETAG" \
|
||||
--if-version "$DIST_HASH_STATE_VERSION" \
|
||||
--if-unmodified-since "$DIST_HASH_STATE_LAST_MODIFIED"
|
||||
STORE_EXIT=$?
|
||||
set -e
|
||||
|
||||
if [ "$STORE_EXIT" -eq 0 ]; then
|
||||
echo "CAS write succeeded on first attempt; retaining initial purge plan."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if [ "$STORE_EXIT" -ne 3 ]; then
|
||||
echo "Hash-state upload failed with exit code $STORE_EXIT"
|
||||
exit "$STORE_EXIT"
|
||||
fi
|
||||
|
||||
echo "CAS conflict detected. Re-fetching state and recomputing purge targets before any CDN purge."
|
||||
|
||||
if [ -z "$DIST_HASH_STATE_URL" ]; then
|
||||
echo "DIST_HASH_STATE_URL is required for race resolution after CAS conflict."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
curl --fail --silent --show-error --dump-header artifacts/dist-hashes-previous.headers "$DIST_HASH_STATE_URL" -o artifacts/dist-hashes-previous.json
|
||||
DIST_HASH_STATE_ETAG=$(awk 'tolower($1)=="etag:" {print $2}' artifacts/dist-hashes-previous.headers | tr -d '\r' | tail -n 1)
|
||||
DIST_HASH_STATE_VERSION=$(awk 'tolower($1)=="x-dist-hash-version:" {print $2}' artifacts/dist-hashes-previous.headers | tr -d '\r' | tail -n 1)
|
||||
DIST_HASH_STATE_LAST_MODIFIED=$(awk 'BEGIN{IGNORECASE=1} /^Last-Modified:/ {sub(/^Last-Modified:[[:space:]]*/, ""); sub(/\r$/, ""); print; exit}' artifacts/dist-hashes-previous.headers)
|
||||
|
||||
echo "Race-resolution metadata: etag='${DIST_HASH_STATE_ETAG:-<none>}', version='${DIST_HASH_STATE_VERSION:-<none>}', last-modified='${DIST_HASH_STATE_LAST_MODIFIED:-<none>}'"
|
||||
|
||||
node scripts/diff-dist-hashes.mjs \
|
||||
--current artifacts/dist-hashes-current.json \
|
||||
--previous artifacts/dist-hashes-previous.json > artifacts/dist-hashes-changed.txt
|
||||
echo "Changed dist paths (race-resolved baseline):"
|
||||
cat artifacts/dist-hashes-changed.txt || true
|
||||
|
||||
node scripts/plan-cache-purge.mjs \
|
||||
--changed-file artifacts/dist-hashes-changed.txt \
|
||||
--output-file artifacts/dist-purge-targets.txt > artifacts/dist-purge-plan.json
|
||||
echo "Race-resolved purge plan:"
|
||||
cat artifacts/dist-purge-plan.json
|
||||
|
||||
node scripts/store-dist-hash-state.mjs \
|
||||
--input artifacts/dist-hashes-current.json \
|
||||
--upload-url "$DIST_HASH_STATE_UPLOAD_URL" \
|
||||
--if-match "$DIST_HASH_STATE_ETAG" \
|
||||
--if-version "$DIST_HASH_STATE_VERSION" \
|
||||
--if-unmodified-since "$DIST_HASH_STATE_LAST_MODIFIED"
|
||||
|
||||
echo "CAS write succeeded after race resolution; proceeding with recomputed purge targets."
|
||||
|
||||
- name: Purge changed Cloudflare URLs
|
||||
env:
|
||||
CLOUDFLARE_ZONE_ID: ${{ secrets.CLOUDFLARE_ZONE_ID }}
|
||||
CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
||||
CLOUDFLARE_PURGE_BASE_URL: ${{ secrets.CLOUDFLARE_PURGE_BASE_URL }}
|
||||
run: |
|
||||
if [ ! -s artifacts/dist-purge-targets.txt ]; then
|
||||
echo "No purge targets detected. Skipping purge."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if [ -z "$CLOUDFLARE_ZONE_ID" ] || [ -z "$CLOUDFLARE_API_TOKEN" ] || [ -z "$CLOUDFLARE_PURGE_BASE_URL" ]; then
|
||||
echo "Cloudflare secrets not configured; skipping targeted purge."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
node scripts/purge-cloudflare-changed.mjs \
|
||||
--changed-file artifacts/dist-purge-targets.txt \
|
||||
--base-url "$CLOUDFLARE_PURGE_BASE_URL"
|
||||
|
||||
- name: Verify deployed index.html version markup
|
||||
env:
|
||||
CLOUDFLARE_PURGE_BASE_URL: ${{ secrets.CLOUDFLARE_PURGE_BASE_URL }}
|
||||
run: |
|
||||
if [ -z "$CLOUDFLARE_PURGE_BASE_URL" ]; then
|
||||
echo "CLOUDFLARE_PURGE_BASE_URL is not configured; skipping deployed index.html verification."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
DEPLOY_INDEX_URL="${CLOUDFLARE_PURGE_BASE_URL%/}/index.html" npm run verify:deployed:index-html
|
||||
|
||||
unit-tests:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
node-version: [22]
|
||||
node-version: [20]
|
||||
shard: [1, 2, 3]
|
||||
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v5
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
@@ -365,14 +128,14 @@ jobs:
|
||||
timeout-minutes: 20
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [22]
|
||||
node-version: [20]
|
||||
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v5
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
@@ -400,67 +163,19 @@ jobs:
|
||||
- name: Run DM unit tests
|
||||
run: npm run test:dm:unit
|
||||
|
||||
e2e-tests:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 35
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
node-version: [22]
|
||||
project: [e2e, e2e-firefox]
|
||||
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Set up Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v5
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
- name: Cache npm directory
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.npm
|
||||
key: ${{ runner.os }}-node-${{ matrix.node-version }}-npm-${{ hashFiles('package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node-${{ matrix.node-version }}-npm-
|
||||
|
||||
- name: Cache node_modules
|
||||
id: node-modules-cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: node_modules
|
||||
key: ${{ runner.os }}-node-${{ matrix.node-version }}-modules-${{ hashFiles('package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node-${{ matrix.node-version }}-modules-
|
||||
|
||||
- name: Install dependencies
|
||||
if: steps.node-modules-cache.outputs.cache-hit != 'true'
|
||||
run: npm ci
|
||||
|
||||
- name: Build app
|
||||
run: npm run build
|
||||
|
||||
- name: Install Playwright browsers
|
||||
run: npx playwright install --with-deps chromium firefox
|
||||
|
||||
- name: Run deterministic E2E suite (${{ matrix.project }})
|
||||
run: npx playwright test tests/e2e --project=${{ matrix.project }}
|
||||
|
||||
dm-integration-tests:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [22]
|
||||
node-version: [20]
|
||||
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v5
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
@@ -493,14 +208,14 @@ jobs:
|
||||
timeout-minutes: 45
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [22]
|
||||
node-version: [20]
|
||||
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v5
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
@@ -526,7 +241,7 @@ jobs:
|
||||
run: npm ci
|
||||
|
||||
- name: Install Playwright browsers
|
||||
run: npx playwright install --with-deps chromium firefox
|
||||
run: npx playwright install --with-deps chromium
|
||||
|
||||
- name: Run headless E2E tests
|
||||
run: npm run test:e2e
|
||||
@@ -1,6 +1,8 @@
|
||||
name: Daily Design System Audit
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 9 * * *' # Run daily at 09:00 UTC
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
@@ -14,14 +16,14 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout unstable branch
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: unstable
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v5
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '22'
|
||||
node-version: '20'
|
||||
cache: 'npm'
|
||||
|
||||
- name: Verify gh CLI availability
|
||||
|
||||
@@ -1,97 +0,0 @@
|
||||
# Build a fresh, downloadable site archive on every push (any branch), so a
|
||||
# ready-to-upload copy of the compiled app is always available for a MANUAL nsite
|
||||
# publish (NIP-5A). This does NOT publish to nsite or touch any Nostr signing key —
|
||||
# it just builds `dist/`.
|
||||
# - every branch: upload it as a 30-day workflow artifact.
|
||||
# - main only: also cut an immutable GitHub Release with the .zip attached,
|
||||
# giving a stable download URL:
|
||||
# https://github.com/PR0M3TH3AN/bitvid/releases/latest/download/bitvid-site.zip
|
||||
# The Release contains only the public compiled app (same as Vercel serves) — no
|
||||
# secret. See docs/nsite-mirror-plan.md.
|
||||
name: Build site archive
|
||||
|
||||
on:
|
||||
push:
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
# One archive build in flight per branch; a newer push supersedes an older one.
|
||||
concurrency:
|
||||
group: nsite-archive-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
archive:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
|
||||
- uses: actions/setup-node@v5
|
||||
with:
|
||||
node-version: 22
|
||||
cache: npm
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Build static site
|
||||
run: npm run build
|
||||
|
||||
- name: Short SHA
|
||||
id: vars
|
||||
run: echo "sha=${GITHUB_SHA::7}" >> "$GITHUB_OUTPUT"
|
||||
|
||||
# `path: dist` stores the site files at the artifact root (index.html at top),
|
||||
# so the downloaded .zip extracts straight to the nsite site directory.
|
||||
- name: Upload site archive
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: bitvid-site-${{ github.ref_name }}-${{ steps.vars.outputs.sha }}
|
||||
path: dist
|
||||
if-no-files-found: error
|
||||
retention-days: 30
|
||||
|
||||
# Production only: publish an immutable GitHub Release with the .zip attached, so
|
||||
# the latest prod archive is always at a stable URL:
|
||||
# https://github.com/PR0M3TH3AN/bitvid/releases/latest/download/bitvid-site.zip
|
||||
# This is purely a download convenience + per-release snapshot — it does NOT
|
||||
# publish to nsite and holds no Nostr signing key (that step stays manual).
|
||||
release:
|
||||
if: github.ref == 'refs/heads/main'
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
|
||||
- uses: actions/setup-node@v5
|
||||
with:
|
||||
node-version: 22
|
||||
cache: npm
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
# `npm run archive` builds dist/ and writes bitvid-site.zip (index.html at root).
|
||||
- name: Build site archive
|
||||
run: npm run archive
|
||||
|
||||
- name: Publish site release
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
run: |
|
||||
tag="site-$(date -u +%Y%m%d)-${GITHUB_SHA::7}"
|
||||
notes="Compiled bitvid static app (\`dist/\`) at ${GITHUB_SHA}.
|
||||
Stable latest link: https://github.com/${GITHUB_REPOSITORY}/releases/latest/download/bitvid-site.zip"
|
||||
# Re-runs of the same commit reuse the tag: refresh the asset instead of failing.
|
||||
if gh release view "$tag" >/dev/null 2>&1; then
|
||||
gh release upload "$tag" bitvid-site.zip --clobber
|
||||
gh release edit "$tag" --latest
|
||||
else
|
||||
gh release create "$tag" bitvid-site.zip \
|
||||
--title "Site archive $tag" \
|
||||
--notes "$notes" \
|
||||
--latest
|
||||
fi
|
||||
@@ -1,95 +0,0 @@
|
||||
# Regenerate the visual-regression baselines IN the environment that compares
|
||||
# them.
|
||||
#
|
||||
# The baselines in tests/visual/baselines.json are pixel-compared on
|
||||
# ubuntu-latest CI, but they were historically captured on a developer machine.
|
||||
# Chromium builds and font fallbacks differ between the two ("Inter"/"Fira
|
||||
# Code" are not shipped or installed anywhere, so every environment renders its
|
||||
# own system fallback), so the kitchen-sink diff drifted past MAX_DIFF_RATIO on
|
||||
# CI while passing locally — ci.yml even documents the mismatch as the reason
|
||||
# visual-regression must not block deploys. Capturing the baselines on the same
|
||||
# runner image, browser install and font stack as the comparison removes the
|
||||
# environment variable from the equation entirely.
|
||||
#
|
||||
# Two explicit triggers, both requiring deliberate human intent — regenerating
|
||||
# baselines must never be a side effect of ordinary work:
|
||||
#
|
||||
# 1. workflow_dispatch — only usable once this file reaches the default
|
||||
# branch (GitHub does not index dispatchable workflows on other branches).
|
||||
# 2. A push whose head commit message contains [update-visual-baselines] —
|
||||
# works from unstable today, before any promotion. The workflow's own
|
||||
# commit omits the token, so it cannot retrigger itself.
|
||||
name: Update visual baselines
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches: [unstable]
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
update-baselines:
|
||||
if: >-
|
||||
github.event_name == 'workflow_dispatch' ||
|
||||
contains(github.event.head_commit.message, '[update-visual-baselines]')
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Node.js 22
|
||||
uses: actions/setup-node@v5
|
||||
with:
|
||||
node-version: 22
|
||||
|
||||
# Mirror the visual-regression job's caches so the regenerated baselines
|
||||
# come from the same dependency tree the comparison job will use.
|
||||
- name: Cache npm directory
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.npm
|
||||
key: ${{ runner.os }}-node-22-npm-${{ hashFiles('package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node-22-npm-
|
||||
|
||||
- name: Cache node_modules
|
||||
id: node-modules-cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: node_modules
|
||||
key: ${{ runner.os }}-node-22-modules-${{ hashFiles('package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node-22-modules-
|
||||
|
||||
- name: Install dependencies
|
||||
if: steps.node-modules-cache.outputs.cache-hit != 'true'
|
||||
run: npm ci
|
||||
|
||||
- name: Install Playwright browsers
|
||||
run: npx playwright install --with-deps chromium
|
||||
|
||||
- name: Regenerate baselines
|
||||
run: npm run test:visual:update
|
||||
|
||||
- name: Verify the fresh baselines pass in this environment
|
||||
run: npx playwright test --project=visual
|
||||
|
||||
- name: Commit updated baselines
|
||||
run: |
|
||||
if git diff --quiet -- tests/visual/baselines.json; then
|
||||
echo "Baselines unchanged; nothing to commit."
|
||||
exit 0
|
||||
fi
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
||||
git add tests/visual/baselines.json
|
||||
git commit \
|
||||
-m "test(visual): regenerate baselines on ubuntu-latest" \
|
||||
-m "Captured by the update-visual-baselines workflow so the baseline environment matches the visual-regression job that compares against them."
|
||||
git push
|
||||
@@ -6,31 +6,7 @@ playwright-report/
|
||||
test-results/
|
||||
tests/visual/__snapshots__/
|
||||
artifacts/
|
||||
!artifacts/load-report-*.json
|
||||
css/tailwind.generated.css
|
||||
ai/reports/
|
||||
*.log
|
||||
coverage/
|
||||
dist/
|
||||
TEST_LOG.mdtest_logs/nip-hits.txt
|
||||
!artifacts/audit/
|
||||
!artifacts/audit/*.md
|
||||
!artifacts/audit/*.json
|
||||
|
||||
# Vercel CLI local link/state
|
||||
.vercel
|
||||
|
||||
# Local site archive for manual nsite upload (npm run archive)
|
||||
bitvid-site.zip
|
||||
.env*
|
||||
|
||||
# Agent runtime state (local only)
|
||||
memory-update.md
|
||||
memory-update.json
|
||||
|
||||
# Agent-local memory state (never committed)
|
||||
.agents/private/
|
||||
.agents/state/
|
||||
fleet/inbox/
|
||||
.task
|
||||
.fleet/
|
||||
@@ -1,23 +0,0 @@
|
||||
# After Benchmark for Moderation Stage Batching
|
||||
|
||||
## Command
|
||||
`node benchmarks/moderation_batch_bench.js`
|
||||
|
||||
## Environment
|
||||
- Node.js v22.22.0
|
||||
- 5000 items
|
||||
- 500 authors
|
||||
- 100 muters per author
|
||||
- Forced prune check (lastPrunedAt = 0)
|
||||
|
||||
## Results
|
||||
- Run 1: 184.34ms
|
||||
- Run 2: 277.68ms
|
||||
- Run 3: 188.89ms
|
||||
- Run 4: 256.48ms
|
||||
- **Average: ~227ms**
|
||||
|
||||
## Comparison
|
||||
- Baseline: ~454ms
|
||||
- After: ~227ms
|
||||
- **Improvement: ~50% faster**
|
||||
@@ -4,7 +4,7 @@ This guide tells AI agents how to keep bitvid aligned with the current product d
|
||||
|
||||
**Important:** Before starting any development or debugging, please review `KNOWN_ISSUES.md`. This file documents pre-existing test failures, environmental quirks, and architectural limitations that you should be aware of to avoid unnecessary investigation.
|
||||
|
||||
For any nostr related work, please review the nip documentation located in /docs/nips before beginning work.
|
||||
For any nostr related work, please review the nip documentation located in /docs/nips before begining work.
|
||||
|
||||
**Comment publishing guardrail:** Session actors are limited to passive telemetry (e.g., view counters). Always require the logged-in Nostr signer when sending video comments through [`js/nostr/commentEvents.js`](js/nostr/commentEvents.js). See the reminder in [`docs/nostr-event-schemas.md`](docs/nostr-event-schemas.md#event-catalogue) for context.
|
||||
|
||||
@@ -14,7 +14,7 @@ For any nostr related work, please review the nip documentation located in /docs
|
||||
|
||||
* **Main** is the production track. Anything merged here must preserve today’s UX and magnet safety guarantees. Rollbacks should be painless: keep commits atomic, avoid destructive migrations, and leave feature flags in a known-good default (`false` unless product explicitly flips them).
|
||||
* **Unstable** is our experimentation lane. Gate risky behavior behind feature flags defined in `js/constants.js` and document the toggle/rollback plan in PR descriptions.
|
||||
* **Emergency response:** If a change regresses playback or breaks magnet parsing, revert immediately, call this out in the PR, and annotate the AGENTS.md changelog with remediation tips. **Note:** These regressions usually surface in dev logs and tests around playback/magnet helpers—reference them when triaging so future agents don’t repeat the mistake.
|
||||
* **Emergency response:** If a change regresses URL-first playback or breaks magnet parsing, revert immediately, call this out in the PR, and annotate the AGENTS.md changelog with remediation tips. **Note:** These regressions usually surface in dev logs and tests around playback/magnet helpers—reference them when triaging so future agents don’t repeat the mistake.
|
||||
|
||||
### Browser logging policy
|
||||
|
||||
@@ -23,11 +23,12 @@ For any nostr related work, please review the nip documentation located in /docs
|
||||
* Before promoting a build, flip `IS_DEV_MODE` in `config/instance-config.js` to match the target environment so `window.__BITVID_DEV_MODE__` and the logger channels behave correctly.
|
||||
* Review and follow [`docs/logging.md`](docs/logging.md) whenever you add new logging or touch inline scripts.
|
||||
|
||||
## 2. Mission: Hybrid Playback Strategy
|
||||
## 2. Mission: URL‑First Playback with WebTorrent Fallback
|
||||
|
||||
* **Goal:** Always deliver smooth playback while optimizing for the configured priority (hosted URL or P2P).
|
||||
* **Configuration:** `DEFAULT_PLAYBACK_SOURCE` in `config/instance-config.js` determines whether `url` or `torrent` is attempted first.
|
||||
* **Runtime behavior:** Call `bitvidApp.playVideoWithFallback({ url, magnet })` (implemented in `js/app/playbackCoordinator.js` and bound to the app instance in `js/app.js`). This function attempts the preferred source first and falls back to the alternative if the primary fails or stalls. `js/playbackUtils.js` now provides magnet/session helper utilities rather than the playback entry point itself.
|
||||
* **Goal:** Always deliver smooth playback while keeping hosting costs low.
|
||||
* **Primary transport:** A hosted video URL (MP4/WebM/HLS/DASH) that the `<video>` element can stream directly.
|
||||
* **Fallback transport:** A WebTorrent magnet that includes browser‑safe trackers plus optional HTTP hints.
|
||||
* **Runtime behavior:** Call `bitvidApp.playVideoWithFallback({ url, magnet })` in `js/app.js`. This function orchestrates URL probing and magnet fallback, delegating low-level stream handling to `js/services/playbackService.js`. `js/playbackUtils.js` now provides magnet/session helper utilities rather than the playback entry point itself.
|
||||
* **Content contract:** bitvid posts (Nostr kind `30078`) must include a `title` and at least one of `url` or `magnet`. Prefer to publish both along with optional `thumbnail`, `description`, and `mode` fields. When mirroring to NIP‑94 (`kind 1063`), copy the hosted URL and (optionally) the magnet so other clients can discover the same asset.
|
||||
|
||||
## Styling & Theming Rules (token-first)
|
||||
@@ -58,16 +59,11 @@ For any nostr related work, please review the nip documentation located in /docs
|
||||
|
||||
1. **Required fields:** Validation must ensure a title exists and that either a hosted URL or a magnet (or both) is supplied. Optional `ws` / `xs` inputs should be appended only when a magnet is present.
|
||||
2. **Magnet parsing errors:** When a user pastes encoded magnets, run `safeDecodeMagnet()` before normalizing. Show inline errors if decoding fails and confirm the raw `magnet:?xt=` string survives the round trip.
|
||||
3. **Playback source promise:** After submission, confirm the resulting feed item carries `data-play-url` and `data-play-magnet` attributes so playback utilities can attempt the configured source first.
|
||||
3. **URL-first promise:** After submission, confirm the resulting feed item carries `data-play-url` and `data-play-magnet` attributes so playback utilities can attempt the URL first.
|
||||
4. **Mixed-content warnings:** If the page is served over HTTPS, reject `ws=` or `xs=` hints that begin with `http://` and show guidance to upgrade to HTTPS. Document the copy in README/UX strings so operators can align messaging.
|
||||
5. **Telemetry hooks:** Keep existing analytics/logging untouched unless instructed. If you add new modal states, annotate them clearly in code comments.
|
||||
6. **Modal regressions:** If validation or helper wiring breaks in Main, disable new feature flags and ship a revert PR immediately. Note the rollback steps in AGENTS.md for posterity.
|
||||
|
||||
### 4a. Cloudflare/S3 upload-path gotchas (audited 2026-06-16)
|
||||
|
||||
**Invariants:** `js/services/r2Service.js` and `js/services/s3UploadService.js` are near-identical copies — any fix to one must be mirrored in the other; storage keys must stay content-addressed (reuse `computeStorageContentHash` in `js/r2.js` for any new upload path); `R2Service.deleteVideoStorage()` stays best-effort, never throws, and only touches URLs under the owner's bucket base.
|
||||
Full writeup: [`docs/lessons/cloudflare-s3-upload-gotchas.md`](docs/lessons/cloudflare-s3-upload-gotchas.md).
|
||||
|
||||
---
|
||||
|
||||
## 5. Manual QA Checklist
|
||||
@@ -78,10 +74,10 @@ Run this script before shipping notable UI changes, especially around upload/pla
|
||||
|
||||
* Launch the site, open the Upload modal, and confirm required-field validation (title + one of URL/magnet).
|
||||
* Submit with URL only, magnet only, and both; ensure success states are clear.
|
||||
2. **Hybrid playback**
|
||||
2. **URL-first playback**
|
||||
|
||||
* Publish a post with both URL and magnet. Load the card and verify the player fetches the configured preferred source first (check network tab or logs).
|
||||
* Temporarily block the primary source (e.g., devtools throttling or offline). Confirm playback seamlessly falls back to the secondary source.
|
||||
* Publish a post with both URL and magnet. Load the card and verify the player fetches the hosted URL first (check network tab or logs).
|
||||
* Temporarily block the URL (e.g., devtools throttling or offline). Confirm playback seamlessly falls back to the magnet.
|
||||
3. **Magnet hygiene**
|
||||
|
||||
* Paste an encoded magnet; ensure `safeDecodeMagnet()` returns the raw value and the final string still includes the original `xt` hash.
|
||||
@@ -194,273 +190,13 @@ When moving a feature to a controller, follow these steps:
|
||||
|
||||
---
|
||||
|
||||
## 11. Telemetry & Error Aggregation
|
||||
|
||||
* **Tooling:** Use `npm run telemetry:aggregate` (which runs `scripts/agent/telemetry-aggregator.mjs`) to collect, sanitize, and aggregate errors from CI/test runs, smoke tests, and agent logs.
|
||||
* **Privacy Policy:** The tool automatically strips PII (IPs, emails, hex keys, bech32 keys) from logs. **Do not** manually inspect raw logs containing PII unless necessary for debugging in a secure environment; rely on the sanitized reports in `ai/reports/`.
|
||||
* **Opt-in:** Telemetry generation is opt-in. You must set the environment variable `ENABLE_TELEMETRY=true` when running the aggregator.
|
||||
* **Reports:** Aggregated reports are generated in `ai/reports/telemetry-YYYYMMDD.md` and `artifacts/error-aggregates.json`. These files provide prioritized issues for triage.
|
||||
|
||||
---
|
||||
|
||||
## 12. Multi-Agent Coordination
|
||||
|
||||
This project uses multiple AI agents (Claude Code, OpenAI Codex, Google Jules) working in parallel. Without coordination, agents will create conflicting PRs, duplicate work, and cause painful merge conflicts. Follow these rules to keep things clean.
|
||||
|
||||
### Before Starting Work
|
||||
|
||||
1. **Check open PRs.** Run the following command to list all open PRs:
|
||||
```
|
||||
curl -s "https://api.github.com/repos/PR0M3TH3AN/bitvid/pulls?state=open&per_page=100" | jq '{count: length, titles: [.[].title]}'
|
||||
```
|
||||
If another agent already has a PR touching the same files or subsystem, do not create a competing PR. Instead, note the conflict and ask the maintainer how to proceed.
|
||||
2. **Check this section for in-flight work.** The maintainer may list active work areas below. Respect these reservations.
|
||||
3. **Read KNOWN_ISSUES.md.** Do not open PRs to fix issues already documented there unless explicitly asked.
|
||||
|
||||
### Subsystem Boundaries
|
||||
|
||||
To minimize merge conflicts, treat these as independent work zones. An agent should avoid touching files outside its assigned zone in a single PR:
|
||||
|
||||
| Zone | Key Files | Description |
|
||||
|------|-----------|-------------|
|
||||
| **Nostr Core** | `js/nostr/client.js`, `js/nostr/adapters/`, `js/nostrClientFacade.js` | Protocol client, signers, relay management |
|
||||
| **Event Schemas** | `js/nostrEventSchemas.js`, `docs/nostr-event-schemas.md` | Event definitions and documentation |
|
||||
| **Playback** | `js/services/playbackService.js`, `js/playbackUtils.js`, `js/magnetUtils.js` | Video streaming, magnet handling |
|
||||
| **UI Controllers** | `js/ui/` | Modal controllers, notification, components |
|
||||
| **State** | `js/state/` | Profile cache, application state |
|
||||
| **DMs** | `js/ui/dm/`, `js/nostr/dm/` | Direct messaging subsystem |
|
||||
| **Moderation** | `js/moderation/`, `docs/moderation/` | Content moderation, reports, admin lists |
|
||||
| **Build & CI** | `.github/workflows/`, `scripts/`, `tailwind.config.cjs` | CI pipeline, lint scripts, build tooling |
|
||||
| **Styling** | `css/tokens.css`, `css/tailwind.source.css` | Design tokens and Tailwind source |
|
||||
| **App Orchestrator** | `js/app.js`, `js/app/` | Main app wiring (high conflict risk — only one PR at a time) |
|
||||
|
||||
**`js/app.js` is the highest-risk file.** It wires everything together. Never have two agent PRs modifying it simultaneously.
|
||||
|
||||
### PR Discipline
|
||||
|
||||
- **One subsystem per PR.** A PR that touches Nostr Core and UI Controllers is two PRs. Split them.
|
||||
- **Small and mergeable.** Target PRs that can be reviewed in one sitting. If a refactor spans 10+ files, break it into sequential PRs.
|
||||
- **Merge before branching.** Before starting new work on a subsystem, ensure all open PRs for that subsystem are merged or closed.
|
||||
- **Rebase, don't stack.** Long-lived branches diverge fast with multiple agents. Rebase onto `unstable` frequently.
|
||||
|
||||
### Signaling Work to Other Agents
|
||||
|
||||
When you create a PR or start work, leave a clear signal:
|
||||
- **PR title prefix**: Use a descriptive prefix like `[nostr-core]`, `[playback]`, `[ui]`, `[ci]` so the scope is visible at a glance.
|
||||
- **PR description**: Include a "Files Modified" section listing the key files touched, so other agents can quickly detect conflicts.
|
||||
|
||||
### Task Coordination
|
||||
|
||||
> The previous TORCH relay-locking protocol (and its `torch/` tooling) has been
|
||||
> removed. Coordinate via GitHub instead: before starting, check open PRs
|
||||
> (`gh pr list` or the GitHub API) for overlap on the same subsystem, and use a
|
||||
> descriptive PR title prefix so scope is visible. Don't run two agents on the
|
||||
> same subsystem simultaneously, and keep `js/app.js` single-writer (see the
|
||||
> Multi-Agent Coordination rules above).
|
||||
|
||||
### Currently In-Flight Work
|
||||
|
||||
<!-- Maintainer: update this list when assigning work to agents. Agents: check this before starting. -->
|
||||
|
||||
_No reservations currently active._
|
||||
|
||||
---
|
||||
|
||||
## 13. Code Health Rules (CI-Enforced)
|
||||
|
||||
Three automated lint checks protect the codebase from common growth problems. These run in CI via `npm run lint` and will block your PR if violated.
|
||||
|
||||
### File Size Limits
|
||||
|
||||
**Script:** `npm run lint:file-size` (`scripts/check-file-size.mjs`)
|
||||
|
||||
- New `.js` files under `js/` must stay **under 1,000 lines**.
|
||||
- Existing oversized files are grandfathered with a recorded line count. They must **not grow** beyond their recorded count + 50 lines.
|
||||
- If your change would push a grandfathered file over its limit, **extract logic into a new module first**, then make your change.
|
||||
|
||||
**Decomposition strategy for agents:**
|
||||
1. Identify a cohesive block of logic (e.g., a group of related methods, a subsection of a controller).
|
||||
2. Extract it into a new file in the same directory.
|
||||
3. Export the extracted functions/class.
|
||||
4. Import and re-wire from the original file.
|
||||
5. Run `npm run lint:file-size` to confirm the original file shrank.
|
||||
6. Update the grandfathered count if needed (the maintainer will handle this when merging).
|
||||
|
||||
### innerHTML Baseline
|
||||
|
||||
**Script:** `npm run lint:innerhtml` (`scripts/check-innerhtml.mjs`)
|
||||
|
||||
- Every file has a **baseline** innerHTML assignment count. Adding new `innerHTML` usage beyond the baseline fails the lint.
|
||||
- For new UI code, use **safe DOM APIs** instead:
|
||||
```javascript
|
||||
// PREFERRED: auto-escaped, no XSS risk
|
||||
element.textContent = userProvidedString;
|
||||
const el = document.createElement("div");
|
||||
el.className = "card";
|
||||
parent.appendChild(el);
|
||||
|
||||
// ACCEPTABLE: innerHTML with escapeHtml for all user data
|
||||
import { escapeHtml } from "../utils/domUtils.js";
|
||||
container.innerHTML = `<span>${escapeHtml(title)}</span>`;
|
||||
|
||||
// BLOCKED: innerHTML with unescaped user data
|
||||
container.innerHTML = `<span>${title}</span>`; // XSS vulnerability
|
||||
```
|
||||
- If you must add innerHTML (e.g., loading a view template), update the baseline: `node scripts/check-innerhtml.mjs --update` and include the updated BASELINE in your PR.
|
||||
|
||||
### Constants — No Duplication
|
||||
|
||||
- Relay timing constants live in **`js/nostr/relayConstants.js`** — always import from there.
|
||||
- Before defining a new numeric constant, search for existing ones with the same value. If a match exists, import it.
|
||||
- Feature flags live in **`js/constants.js`**.
|
||||
- Cache policies live in **`js/nostr/cachePolicies.js`**.
|
||||
- Do not define the same constant in two files. If two modules need the same value, create a shared module and import from it.
|
||||
|
||||
---
|
||||
|
||||
## 14. Playwright Agent Testing Infrastructure
|
||||
|
||||
bitvid ships a test harness (`window.__bitvidTest__`, enabled via `?__test__=1`), a mock relay (`scripts/agent/simple-relay.mjs`), and a reusable Playwright fixture (`tests/e2e/helpers/bitvidTestFixture.ts`) so agents can programmatically log in, seed relay data, and inspect app state — no browser extensions or real relays required.
|
||||
Full reference (harness API, mock relay, fixtures, `data-testid` selectors): [`docs/testing/agent-playwright-harness.md`](docs/testing/agent-playwright-harness.md).
|
||||
|
||||
---
|
||||
|
||||
## 15. Agent Execution Protocol
|
||||
|
||||
This section defines the meta-workflow that **every AI agent** must follow when executing tasks in this codebase. It ensures safe, incremental changes, a clear decision trail, and continuity across context resets or agent hand-offs.
|
||||
|
||||
### Mindset
|
||||
|
||||
- Implement changes safely. Match existing conventions. Leave a clear trail of decisions.
|
||||
- Correctness > cleverness. Consistent conventions > personal preference. Explicit tradeoffs > "should work."
|
||||
- Prefer minimal, incremental changes over rewrites. Keep the build and tests green.
|
||||
- Do not invent files, APIs, libraries, or behaviors. If unsure, inspect the codebase first.
|
||||
|
||||
### Scoping the Work
|
||||
|
||||
Before writing any code, establish clarity on three things:
|
||||
|
||||
1. **Primary goal** — What is being built or fixed?
|
||||
2. **Success criteria** — How will we know it's done? (e.g., tests pass, feature visible in UI, lint clean)
|
||||
3. **Non-goals** — What is explicitly out of scope? (Prevents scope creep across agent sessions.)
|
||||
|
||||
### External Notes (Persistent State Files)
|
||||
|
||||
Agents lose context across sessions. These files act as persistent memory that any agent (or human) can read to resume work or understand project status. **Update them before any likely context reset.**
|
||||
|
||||
**Storage Rule:** To prevent conflicts, these files are stored in dedicated directories with timestamps.
|
||||
- **Read:** Always look for the **latest** timestamped file in the directory (e.g., `ls context/ | sort | tail -n 1`).
|
||||
- **Write:** Never overwrite an existing file. Create a **new** file with a new timestamp (e.g., `context/CONTEXT_YYYY-MM-DD_HH-MM-SS.md`).
|
||||
|
||||
| Directory | File Pattern | Purpose | When to Update |
|
||||
|-----------|--------------|---------|----------------|
|
||||
| `context/` | `CONTEXT_<timestamp>.md` | Current goal, scope, assumptions, constraints, and "Definition of Done" | At start; when scope changes |
|
||||
| `todo/` | `TODO_<timestamp>.md` | Checkbox task list with "Done" and "Blocked/Questions" sections | After planning; after tasks |
|
||||
| `decisions/` | `DECISIONS_<timestamp>.md` | Key choices made, alternatives considered, and rationale | When making tradeoffs |
|
||||
| `test_logs/` | `TEST_LOG_<timestamp>.md` | Commands run and their results (including failures) | After every lint/test/build run |
|
||||
|
||||
**Rules for external notes:**
|
||||
- These files are working documents. They should reflect the *current* state of work.
|
||||
- When starting a fresh task, clear stale content (by writing a fresh file) and re-scope.
|
||||
- Keep entries concise — bullet points and checklists, not prose.
|
||||
- `decisions/` is especially important: when you make a tradeoff, write it down so the next agent doesn't undo it.
|
||||
|
||||
### Work Loop
|
||||
|
||||
For each task item, repeat this cycle:
|
||||
|
||||
#### A) Locate
|
||||
|
||||
- Identify the relevant code and existing patterns. Find the "right place" to make the change.
|
||||
- Write a short plan (3–7 bullets) before editing. If the task touches multiple subsystem zones (see Section 12), flag this — it may need to be split into separate PRs.
|
||||
|
||||
#### B) Implement
|
||||
|
||||
- Make the smallest change that satisfies the requirement.
|
||||
- Keep edits cohesive. Avoid unrelated refactors in the same commit.
|
||||
- Follow all conventions already documented in this file (logging via `logger`, token-first styling, magnet safety, schema definitions in `nostrEventSchemas.js`, etc.).
|
||||
|
||||
#### C) Verify
|
||||
|
||||
- Run the most relevant lint/test commands (see CLAUDE.md "Available Scripts" for the full list):
|
||||
```bash
|
||||
npm run lint # Required
|
||||
npm run test:unit:shard1 # Fast feedback; run full suite before PR
|
||||
```
|
||||
- If there's no test coverage for your change, add focused tests or document in `decisions/` why tests aren't feasible.
|
||||
- Log all commands and results in a new `test_logs/TEST_LOG_<timestamp>.md` file.
|
||||
|
||||
#### D) Update Notes
|
||||
|
||||
- Check off completed items in the latest `todo/` file (by creating a new one).
|
||||
- Record decisions in a new `decisions/` file.
|
||||
- Log verification results in a new `test_logs/` file.
|
||||
- **Do this before any likely context/memory reset** — if you're about to hit a token limit, finish a long session, or hand off to another agent, update notes first.
|
||||
|
||||
### Context Recovery
|
||||
|
||||
If an agent starts a session and finds existing work-in-progress:
|
||||
|
||||
1. **Immediately read the latest files** in `context/`, `todo/`, `decisions/`, and `test_logs/`.
|
||||
2. Resume from the next unchecked item in the latest `todo/` file.
|
||||
3. Verify the current state by running `git status`, `git log --oneline -10`, and a quick lint/test pass.
|
||||
4. Do not re-do work that the latest `test_logs/` shows already passed — unless the code has changed since.
|
||||
|
||||
### Output Requirements
|
||||
|
||||
When finishing a task or handing off, provide:
|
||||
|
||||
- **Summary** of what changed and why.
|
||||
- **Files changed** (list).
|
||||
- **Verification results** (from the latest `test_logs/` file).
|
||||
- **Follow-ups / risks / remaining TODOs**.
|
||||
- **If blocked:** Ask specific questions and propose 1–2 options.
|
||||
|
||||
### Quality Bar
|
||||
|
||||
| Principle | Meaning |
|
||||
|-----------|---------|
|
||||
| Correctness over cleverness | Simple, working code beats elegant abstractions |
|
||||
| Conventions over preference | Match what's already in the repo, even if you'd do it differently |
|
||||
| Explicit tradeoffs | Write down *why* in `decisions/`, don't leave the next agent guessing |
|
||||
| Logged verification | Every claim of "tests pass" must have a `test_logs/` entry to back it up |
|
||||
| Incremental over sweeping | Small, reviewable changes that keep the build green at every step |
|
||||
|
||||
---
|
||||
|
||||
## 16. Scenario-First Tests & Test Integrity (Dark Factory Standard)
|
||||
|
||||
**Invariant:** validation replaces code review in this repo — never weaken, delete, or rewrite a test merely to make it pass, and never mask flakiness with retries/sleeps/looser assertions. Expectation changes are allowed only via the Spec Correction Protocol with an accompanying Test Integrity Note.
|
||||
Read the full standard before adding or modifying any test: `docs/testing/test-integrity.md`.
|
||||
|
||||
---
|
||||
|
||||
## 17. NIP-07 Signer Reliability & Encrypted-List Loading (hard-won, 2026-06-16)
|
||||
|
||||
**Invariant:** the #1 cause of "DMs / hashtags / watch-history / lists won't load after login" is an unresponsive NIP-07 signer, not bitvid — diagnose with a raw `window.nostr` probe first, and do not regress the five resilience invariants (capped relay fan-out, NIP-07 circuit breaker, re-thrown transient decrypt errors, generous decrypt budgets, lazy modal population).
|
||||
Full writeup: `docs/lessons/nip07-signer-reliability.md`. See also `docs/KNOWN_BUGS.md` #0.
|
||||
|
||||
---
|
||||
|
||||
## Repo memory
|
||||
|
||||
Curated agent memory lives in `.agents/` (index `.agents/MEMORY.md`); read it first. Propose additions in `.agents/proposals/`; `.agents/memory/` changes only via reviewed commits. Code/tests/config outrank memory.
|
||||
|
||||
---
|
||||
|
||||
## Next
|
||||
|
||||
Read `docs/nostr-event-schemas.md` and `js/nostrEventSchemas.js` next; keep new nostr kinds centralized there and the doc up to date.
|
||||
Please read these documents next.
|
||||
|
||||
# Agent fleet
|
||||
* `docs/nostr-event-schemas.md`
|
||||
* `js/nostrEventSchemas.js`
|
||||
|
||||
This repo uses agent-fleet-kit. The `agent-fleet` MCP server (`fleet-mcp`) is a convenience. Editing backlog JSON and mailbox files directly is fine. Do not hand-edit the landing queue while a drain is merging, and do not push main.
|
||||
And if you need to create new nostr kinds please keep the logic centralized there in `nostrEventSchemas.js` and the `nostr-event-schemas.md` up to date.
|
||||
|
||||
- `area_info` for the owner of a path.
|
||||
- `backlog_claim` with an item id marks it in-progress. Pick the item from PROGRAM.md. Without an id the tool does not choose one. Idle is a correct result.
|
||||
- `mailbox_read` at the start of a turn; `mailbox_send` to reach a peer. Mail is always delivered. The prompt says when to act.
|
||||
- `commit` to stage and commit in your area worktree. Codex `workspace-write` keeps `.git` read-only, so do not run `git commit` yourself. Pass `message` and the file paths (or `all: true`), and `cwd` or `area` when this server is not already in the worktree. `submit: true` also queues the tip. A doesNotOwn path warns and still commits. The same operation is `fleet commit -m "..." --area <id> [--submit] -- <paths>`.
|
||||
- `landq_submit` queues the committed tip and starts a drain. A dirty worktree warns; only HEAD is queued. Then go back to work. At your next natural checkpoint, `land_status` (or `fleet landq status <id>`) is a quick lookup, and its wait is optional. Never infer the lander or the land result from silence. States: queued, gating, landed with the main sha, rejected with the reason, or unknown. If no drain is alive, the answer says so and names `fleet lander start`.
|
||||
- A scarce machine is a prompt convention: say so in `.task` and wait if a peer has it. There is no slot lock.
|
||||
|
||||
Sessions, worktrees, and cron are the `fleet` CLI. Submit starts the drain; do not run a second merge by hand.
|
||||
**End of AGENTS.md**
|
||||
@@ -1,26 +0,0 @@
|
||||
# Weekly Audit Report
|
||||
|
||||
**Branch:** `unstable`
|
||||
**Date:** 2024-02-12
|
||||
|
||||
## Metrics
|
||||
|
||||
### 1. File Size Audit
|
||||
- **Grandfathered oversized files:** 44
|
||||
- **Sum of excess lines:** 50,025 (lines exceeding the 1000-line threshold)
|
||||
- **Status:** **PASS** (No new violations beyond grandfathered list)
|
||||
|
||||
### 2. InnerHTML Audit
|
||||
- **Total innerHTML assignments:** 99
|
||||
- **Status:** **PASS** (No new assignments found)
|
||||
|
||||
### 3. Lint Status
|
||||
- **Result:** **PASS**
|
||||
- **Notes:** All checks passed. `lint:assets` and `lint:sw-compat` were skipped due to the environment (missing build artifacts/git history), which is expected.
|
||||
|
||||
## Comparison
|
||||
- **Previous Week:** No previous report was found in the PR comments or issues for comparison.
|
||||
|
||||
## Recommendations
|
||||
- Continue decomposition efforts for the largest grandfathered files (e.g., `js/ui/profileModalController.js`, `js/ui/components/VideoModal.js`).
|
||||
- Maintain strict checks on innerHTML usage to prevent new security risks.
|
||||
@@ -1,18 +0,0 @@
|
||||
# Baseline Benchmark for Moderation Stage Batching
|
||||
|
||||
## Command
|
||||
`node benchmarks/moderation_batch_bench.js`
|
||||
|
||||
## Environment
|
||||
- Node.js v22.22.0
|
||||
- 5000 items
|
||||
- 500 authors
|
||||
- 100 muters per author
|
||||
- Forced prune check (lastPrunedAt = 0)
|
||||
|
||||
## Results
|
||||
- Run 1: 545.80ms
|
||||
- Run 2: 370.08ms
|
||||
- Run 3: 523.04ms
|
||||
- Run 4: 379.80ms
|
||||
- **Average: ~454ms**
|
||||
@@ -8,25 +8,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
|
||||
- New views for Kids, History, Search, Subscriptions, and Docs. (PR #2129, PR #2153 by PR0M3TH3AN)
|
||||
- Comprehensive test suite for Nostr features and UI components. (PR #2153 by PR0M3TH3AN)
|
||||
- Provider-agnostic S3 multipart upload helpers to support large file uploads and bucket management. (PR #1620 by PR0M3TH3AN)
|
||||
|
||||
### Changed
|
||||
|
||||
- Documentation alignment and updates. (PR #2563 by PR0M3TH3AN)
|
||||
- Cleanup of Search Filter Modal comments. (PR #2562 by PR0M3TH3AN)
|
||||
- Performance improvements for documentation scroll spy. (PR #2129 by PR0M3TH3AN)
|
||||
- Optimized Nostr login speed. (PR #2153 by PR0M3TH3AN)
|
||||
- Updated `nostr-tools`, `floating-ui`, and `crypto-helpers` dependencies. (PR #2153 by PR0M3TH3AN)
|
||||
- Major repository update and synchronization (Commit `b429b1c` by thePR0M3TH3AN)
|
||||
- Removed runtime `ASSET_VERSION` query-string cache busting for static assets. Deployment freshness is now driven by build-time hashed filenames and `asset-manifest.json` rewrites.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Reverted webseed regression fix (PR #2002 by thePR0M3TH3AN)
|
||||
|
||||
### Security
|
||||
|
||||
- Fixed magnet parameter injection vulnerability via `xt` parameter decoding. (PR #2345 by PR0M3TH3AN)
|
||||
@@ -1,573 +0,0 @@
|
||||
# CLAUDE.md — AI Assistant Guide for bitvid
|
||||
|
||||
This document provides context and guidance for AI assistants working with the bitvid codebase. It explains the project structure, development workflows, conventions, and key architectural decisions.
|
||||
|
||||
**Canonical guidance:** `AGENTS.md` is the canonical agent guidance for this repo; `CLAUDE.md` holds Claude-oriented codebase orientation that layers on top of it.
|
||||
|
||||
---
|
||||
|
||||
## Project Overview
|
||||
|
||||
**bitvid** is a decentralized video sharing platform built on the Nostr protocol. It operates as a static client — no backend server, no custody of user keys, no server-side signing. All authentication and state management happens client-side or via connected Nostr signers.
|
||||
|
||||
### Key Technologies
|
||||
- **Nostr**: Decentralized identity and event protocol (NIP-07, NIP-33, NIP-44, NIP-46, NIP-51, NIP-71, etc.)
|
||||
- **WebTorrent**: P2P video streaming fallback
|
||||
- **Tailwind CSS**: Utility-first styling with custom design tokens
|
||||
- **Playwright**: E2E and visual regression testing
|
||||
- **Node.js 22+**: Development environment
|
||||
|
||||
### License
|
||||
GPL-3.0-or-later (see `LICENSE`)
|
||||
|
||||
---
|
||||
|
||||
## Codebase Structure
|
||||
|
||||
```
|
||||
bitvid/
|
||||
├── js/ # Main application JavaScript
|
||||
│ ├── app.js # Main orchestrator (bitvidApp)
|
||||
│ ├── nostr/ # Nostr protocol implementation
|
||||
│ │ ├── client.js # Core Nostr client with signer adapters
|
||||
│ │ ├── nip71.js # NIP-71 video note parsing
|
||||
│ │ ├── sessionActor.js # Anonymous session actors for telemetry
|
||||
│ │ └── adapters/ # NIP-07, NIP-46, nsec signer adapters
|
||||
│ ├── services/ # Business logic services
|
||||
│ │ └── playbackService.js # Video playback orchestration
|
||||
│ ├── ui/ # UI components and controllers
|
||||
│ ├── state/ # State management (cache.js)
|
||||
│ ├── utils/ # Utility functions
|
||||
│ ├── constants.js # Feature flags and WSS trackers
|
||||
│ ├── config.js # Re-exports from instance config
|
||||
│ ├── magnetUtils.js # Magnet URI helpers
|
||||
│ ├── nostrEventSchemas.js # Event schema definitions (source of truth)
|
||||
│ └── nostrClientFacade.js # Main Nostr client entry point
|
||||
├── config/
|
||||
│ └── instance-config.js # Deployment configuration
|
||||
├── css/
|
||||
│ ├── tokens.css # Design token definitions
|
||||
│ ├── tailwind.source.css # Tailwind input file
|
||||
│ └── tailwind.generated.css # Generated (gitignored)
|
||||
├── tests/ # Test suites
|
||||
│ ├── unit/ # Unit tests
|
||||
│ ├── e2e/ # End-to-end tests
|
||||
│ ├── visual/ # Visual regression tests
|
||||
│ ├── nostr/ # Nostr-specific tests
|
||||
│ └── moderation/ # Moderation feature tests
|
||||
├── docs/ # Documentation
|
||||
│ ├── nostr-event-schemas.md # Event schema reference
|
||||
│ ├── playback-fallback.md # Playback architecture
|
||||
│ ├── moderation/ # Moderation system docs
|
||||
│ └── nips/ # NIP reference documentation
|
||||
├── views/ # HTML view templates
|
||||
├── components/ # HTML component templates
|
||||
├── content/ # Markdown content (docs, roadmap)
|
||||
├── torrent/ # WebTorrent integration
|
||||
├── scripts/ # Build and utility scripts
|
||||
└── .github/workflows/ # CI/CD configuration
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Essential Files to Know
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `AGENTS.md` | AI agent guide with architectural rules and mission |
|
||||
| `KNOWN_ISSUES.md` | Pre-existing test failures and environmental quirks |
|
||||
| `CONTRIBUTING.md` | Developer setup and contribution guidelines |
|
||||
| `js/app.js` | Main application orchestrator (`bitvidApp`) |
|
||||
| `js/nostr/client.js` | Core Nostr client with signer registry |
|
||||
| `js/nostrEventSchemas.js` | **Source of truth** for all Nostr event schemas |
|
||||
| `js/constants.js` | Feature flags and runtime configuration |
|
||||
| `config/instance-config.js` | Deployment-specific settings |
|
||||
| `js/testHarness.js` | Playwright test harness (`window.__bitvidTest__`) |
|
||||
| `tests/e2e/helpers/bitvidTestFixture.ts` | Reusable Playwright fixture for agent testing |
|
||||
| `scripts/agent/simple-relay.mjs` | Mock Nostr relay with HTTP seeding API |
|
||||
| `docs/nostr-event-schemas.md` | Event schema documentation |
|
||||
| `context/` | Agent working state: current goal, scope, assumptions (see AGENTS.md §15) |
|
||||
| `todo/` | Agent task checklist with done/blocked sections (see AGENTS.md §15) |
|
||||
| `decisions/` | Agent decision log: choices, alternatives, rationale (see AGENTS.md §15) |
|
||||
| `test_logs/` | Agent verification log: commands run and results (see AGENTS.md §15) |
|
||||
|
||||
---
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Initial Setup
|
||||
|
||||
```bash
|
||||
# Clone and install
|
||||
git clone https://github.com/PR0M3TH3AN/bitvid.git
|
||||
cd bitvid
|
||||
npm ci # Use ci for exact lockfile deps
|
||||
|
||||
# Build (generates Tailwind CSS)
|
||||
npm run build
|
||||
|
||||
# Start local server
|
||||
python -m http.server 8000
|
||||
# or
|
||||
npx serve
|
||||
```
|
||||
|
||||
### Before Every PR
|
||||
|
||||
```bash
|
||||
# Required checks
|
||||
npm run format # Format CSS/HTML/MD
|
||||
npm run lint # All lint checks
|
||||
npm run test:unit # Or use shards for faster feedback
|
||||
|
||||
# Recommended for UI changes
|
||||
npm run test:visual
|
||||
```
|
||||
|
||||
### Available Scripts
|
||||
|
||||
| Script | Purpose |
|
||||
|--------|---------|
|
||||
| `npm run build` | Full build (Tailwind + dist + verify) |
|
||||
| `npm run build:css` | Regenerate Tailwind only |
|
||||
| `npm run format` | Format with Prettier |
|
||||
| `npm run lint` | Run all linting checks |
|
||||
| `npm run lint:css` | CSS token validation |
|
||||
| `npm run lint:inline-styles` | Block inline styles |
|
||||
| `npm run lint:tokens` | Design token enforcement |
|
||||
| `npm run lint:file-size` | Enforce file size limits |
|
||||
| `npm run lint:innerhtml` | Enforce innerHTML baseline |
|
||||
| `npm run audit` | Run design system audit |
|
||||
| `npm run build:beacon` | Build torrent beacon assets |
|
||||
| `npm run test:unit` | Full unit test suite |
|
||||
| `npm run test:unit:shard1` | Shard 1/3 (faster local dev) |
|
||||
| `npm run test:unit:shard2` | Shard 2/3 |
|
||||
| `npm run test:unit:shard3` | Shard 3/3 |
|
||||
| `npm run test:smoke` | Run critical path smoke tests |
|
||||
| `npm run test:dm:unit` | Direct message unit tests |
|
||||
| `npm run test:dm:integration` | DM integration tests |
|
||||
| `npm run test:e2e` | Headless E2E tests |
|
||||
| `npm run test:load` | Run load tests |
|
||||
| `npm run test:visual` | Visual regression tests |
|
||||
| `npm run test:visual:update` | Update visual regression baselines |
|
||||
| `npm run telemetry:aggregate` | Aggregate telemetry logs |
|
||||
| `node scripts/agent/validate-events.mjs` | Validate Nostr event schemas |
|
||||
|
||||
---
|
||||
|
||||
## CI/CD Pipeline
|
||||
|
||||
The CI workflow (`.github/workflows/ci.yml`) runs on every push to `main` and all PRs:
|
||||
|
||||
| Job | Timeout | Description |
|
||||
|-----|---------|-------------|
|
||||
| `build` | 45 min | Lint, build, visual regression |
|
||||
| `unit-tests` | 30 min | Sharded unit tests (3 shards) |
|
||||
| `dm-unit-tests` | 20 min | Direct message unit tests |
|
||||
| `dm-integration-tests` | 30 min | DM integration tests |
|
||||
| `e2e-headless` | 45 min | Playwright E2E tests |
|
||||
|
||||
**Concurrency**: `cancel-in-progress: true` — new commits cancel running jobs.
|
||||
|
||||
---
|
||||
|
||||
## Code Conventions
|
||||
|
||||
### Logging
|
||||
|
||||
**Always use the logger utility**, never call `console.*` directly:
|
||||
|
||||
```javascript
|
||||
import { logger } from './utils/logger.js';
|
||||
|
||||
logger.user.error('User-facing error'); // Production visible
|
||||
logger.dev.log('Debug info'); // Dev mode only (IS_DEV_MODE)
|
||||
```
|
||||
|
||||
### Styling Rules
|
||||
|
||||
1. **Token-first**: Use design tokens from `css/tokens.css`, never raw hex colors
|
||||
2. **No inline styles**: `style=` attributes and `element.style` are blocked by lint
|
||||
3. **Semantic tokens**: Use `bg`, `text`, `accent`, `border`, `danger`, etc.
|
||||
4. **Theme scopes**: Toggle themes via `data-theme` attribute, not code
|
||||
|
||||
### Nostr Event Schemas
|
||||
|
||||
All Nostr events must be defined in `js/nostrEventSchemas.js`:
|
||||
|
||||
```javascript
|
||||
import { buildVideoPostEvent, NOTE_TYPES } from './nostrEventSchemas.js';
|
||||
|
||||
const event = buildVideoPostEvent({
|
||||
pubkey: hexPubkey,
|
||||
created_at: Math.floor(Date.now() / 1000),
|
||||
dTagValue: 'video-id',
|
||||
content: {
|
||||
version: 3,
|
||||
title: 'My Video',
|
||||
videoRootId: 'video-id',
|
||||
url: 'https://example.com/video.mp4'
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Magnet Handling
|
||||
|
||||
**Critical rules** — magnets are fragile:
|
||||
|
||||
```javascript
|
||||
import { safeDecodeMagnet, normalizeAndAugmentMagnet } from './magnetUtils.js';
|
||||
|
||||
// Always decode first
|
||||
const raw = safeDecodeMagnet(userInput);
|
||||
|
||||
// Then normalize with hints
|
||||
const enriched = normalizeAndAugmentMagnet(raw, { wsHint, xsHint });
|
||||
|
||||
// NEVER use new URL() on magnets — it corrupts hashes!
|
||||
```
|
||||
|
||||
- WSS trackers only (from `js/constants.js`)
|
||||
- Persist raw magnet strings, decode only at playback
|
||||
- Include HTTPS `ws=`/`xs=` hints when available
|
||||
|
||||
### Architecture Pattern
|
||||
|
||||
**Separation of concerns**:
|
||||
|
||||
- `bitvidApp` (js/app.js) — Orchestrator, manages app-wide state
|
||||
- UI Controllers — Handle specific UI components (e.g., `ProfileModalController`)
|
||||
- Services — Business logic (e.g., `playbackService.js`)
|
||||
- State — Central truth in `js/state/cache.js`
|
||||
|
||||
**Data flow**:
|
||||
1. User action triggers controller event handler
|
||||
2. Controller invokes callback provided by `bitvidApp`
|
||||
3. `bitvidApp` executes logic, updates central state
|
||||
4. `bitvidApp` notifies controller to re-render
|
||||
|
||||
---
|
||||
|
||||
## Feature Flags
|
||||
|
||||
Feature flags in `js/constants.js` gate experimental behavior:
|
||||
|
||||
| Flag | Default | Purpose |
|
||||
|------|---------|---------|
|
||||
| `URL_FIRST_ENABLED` | Depends on config | Try URL before magnet |
|
||||
| `FEATURE_WATCH_HISTORY_V2` | true | Watch history system |
|
||||
| `FEATURE_PUBLISH_NIP71` | false | NIP-71 video publishing |
|
||||
| `FEATURE_SEARCH_FILTERS` | Dev mode only | Advanced search |
|
||||
| `FEATURE_TRUST_SEEDS` | true | Baseline trust seeds |
|
||||
| `FEATURE_TRUSTED_HIDE_CONTROLS` | true | Trusted mute/spam hide controls |
|
||||
| `FEATURE_IMPROVED_COMMENT_FETCHING` | true | Improved comment fetching logic |
|
||||
|
||||
Toggle at runtime:
|
||||
```javascript
|
||||
import { setUrlFirstEnabled } from './constants.js';
|
||||
setUrlFirstEnabled(false); // Disable URL-first playback
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Nostr Integration
|
||||
|
||||
### Key NIPs Used
|
||||
|
||||
| NIP | Purpose |
|
||||
|-----|---------|
|
||||
| NIP-07 | Browser extension signing |
|
||||
| NIP-33 | Parameterized replaceable events (videos) |
|
||||
| NIP-04 | Legacy DM encryption |
|
||||
| NIP-44 | Modern encryption |
|
||||
| NIP-46 | Remote signing |
|
||||
| NIP-51 | Lists (mute, admin) |
|
||||
| NIP-56 | Moderation reports |
|
||||
| NIP-71 | Video events |
|
||||
|
||||
### Signer Adapters
|
||||
|
||||
```javascript
|
||||
import { nostrClient } from './nostrClientFacade.js';
|
||||
import { setActiveSigner } from './nostr/client.js';
|
||||
|
||||
// Register a signer
|
||||
setActiveSigner({
|
||||
pubkey,
|
||||
signEvent: (event) => signer.sign(event),
|
||||
nip04Encrypt: (target, text) => signer.nip04.encrypt(target, text),
|
||||
nip04Decrypt: (actor, cipher) => signer.nip04.decrypt(actor, cipher),
|
||||
// Optional: nip44Encrypt, nip44Decrypt
|
||||
});
|
||||
```
|
||||
|
||||
### NIP-33 Addressing (Important!)
|
||||
|
||||
Video events are addressed by `kind + pubkey + d-tag`:
|
||||
|
||||
```javascript
|
||||
// CORRECT: Use the d-tag for addressing
|
||||
const dTag = event.tags.find(t => t[0] === 'd')?.[1];
|
||||
|
||||
// WRONG: Don't use logical IDs like videoRootId for relay lookups
|
||||
```
|
||||
|
||||
### NIP-07 Signer Reliability (hard-won)
|
||||
|
||||
The #1 cause of "DMs / hashtags / watch-history / lists won't load after login" is an **unresponsive NIP-07 signer**, not bitvid. The extension's MV3 background worker can die and `window.nostr` calls then hang forever — no client change fixes a dead signer. **Diagnose with a raw `window.nostr` probe** (`getPublicKey → nip04.encrypt → nip04.decrypt`) in the console; if that hangs, it's the extension (recommend nos2x/Alby). See `docs/lessons/nip07-signer-reliability.md` (summarized in `AGENTS.md` §17) and `docs/KNOWN_BUGS.md` #0.
|
||||
|
||||
Resilience invariants — **do not regress**:
|
||||
|
||||
1. **Cap relay fan-out** (`js/nostr/toolkit.js` `capReadRelays`, ≤8, user-relays-first + 2 reserved defaults) — an uncapped cold-login REQ storm starves the single-threaded signer.
|
||||
2. **Circuit breaker** on consecutive NIP-07 timeouts (`js/nostr/nip07Permissions.js`) — fast-fail instead of hanging; channel-death counts toward opening; permission prompts bypass.
|
||||
3. **Never swallow a transient decrypt error as `[]`** — re-throw channel-death/timeout so retries run (returning empty = "user has no lists" + no retry).
|
||||
4. **Generous decrypt budget** (~25–30s/call) — a 6s timeout kills slow signers mid-decrypt.
|
||||
5. **Lazy modal population** — don't render every profile panel into a closed modal at login; populate per-pane on open (`selectPane`).
|
||||
|
||||
---
|
||||
|
||||
## Testing & Validation: Scenario-First, Cheat-Resistant (Dark Factory Rules)
|
||||
|
||||
The testing and validation invariant is stated in `AGENTS.md` §16 "Scenario-First Tests & Test Integrity (Dark Factory Standard)", and the full standard lives in [`docs/testing/test-integrity.md`](docs/testing/test-integrity.md). In short: validation replaces human code review here, tests are behavioral scenarios that assert externally observable outcomes at boundaries, and you must **never alter a test merely to make it pass** — expectation changes are allowed only via the Spec Correction Protocol with an accompanying Test Integrity Note. Read `docs/testing/test-integrity.md` in full before adding or modifying any test.
|
||||
|
||||
---
|
||||
|
||||
## Testing Guidelines
|
||||
|
||||
### Before Starting Work
|
||||
|
||||
1. Read `KNOWN_ISSUES.md` for pre-existing failures
|
||||
2. Run relevant test shard to verify baseline
|
||||
|
||||
### Running Tests
|
||||
|
||||
```bash
|
||||
# Fast feedback during development
|
||||
npm run test:unit:shard1
|
||||
|
||||
# Full suite before PR
|
||||
npm run test:unit
|
||||
|
||||
# Visual changes
|
||||
npm run test:visual
|
||||
|
||||
# DM features
|
||||
npm run test:dm:unit && npm run test:dm:integration
|
||||
|
||||
# E2E journeys
|
||||
npm run test:e2e
|
||||
```
|
||||
|
||||
### Test Artifacts
|
||||
|
||||
Failed visual tests store artifacts in `artifacts/test-results/`:
|
||||
- Screenshots
|
||||
- Videos
|
||||
- Traces
|
||||
|
||||
View with: `./scripts/show-artifacts.sh`
|
||||
|
||||
### Agent E2E Testing (Playwright)
|
||||
|
||||
bitvid includes a test harness for programmatic Playwright testing without browser extensions or real relays. See `docs/testing/agent-playwright-harness.md` for the full reference (summarized in `AGENTS.md` §14). Quick start:
|
||||
|
||||
```typescript
|
||||
import { test, expect } from "./helpers/bitvidTestFixture";
|
||||
|
||||
test("my test", async ({ page, gotoApp, loginAs, seedEvent }) => {
|
||||
await seedEvent({ title: "Test Video", url: "https://example.com/v.mp4" });
|
||||
await gotoApp();
|
||||
await loginAs(page);
|
||||
// interact with the app using data-testid selectors
|
||||
await expect(page.locator('[data-testid="upload-button"]')).toBeVisible();
|
||||
});
|
||||
```
|
||||
|
||||
Key capabilities:
|
||||
- **Programmatic login**: `loginAs(page)` uses `window.__bitvidTest__.loginWithNsec()` — no modal interaction needed
|
||||
- **Mock relay**: Each test gets an isolated in-memory relay with HTTP seeding
|
||||
- **Relay override**: `?__test__=1&__testRelays__=ws://localhost:8877` redirects all connections
|
||||
- **State inspection**: `window.__bitvidTest__.getAppState()` returns login status, relays, etc.
|
||||
- **Stable selectors**: All key elements have `data-testid` attributes (see `docs/testing/agent-playwright-harness.md`)
|
||||
|
||||
---
|
||||
|
||||
## Common Tasks
|
||||
|
||||
### Adding a New Nostr Event Type
|
||||
|
||||
1. Define schema in `js/nostrEventSchemas.js`
|
||||
2. Add builder function
|
||||
3. Document in `docs/nostr-event-schemas.md`
|
||||
4. Add tests
|
||||
|
||||
### Creating UI Components
|
||||
|
||||
1. Create controller in `js/ui/`
|
||||
2. Wire callbacks through `bitvidApp`
|
||||
3. Read state via provided getters, never directly
|
||||
4. Use design tokens for styling
|
||||
|
||||
### Modifying Playback Behavior
|
||||
|
||||
1. Check `js/services/playbackService.js` for stream handling
|
||||
2. Update `js/constants.js` feature flags if needed
|
||||
3. Test with both URL and magnet sources
|
||||
4. Document rollback steps in PR
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Build Issues
|
||||
|
||||
```bash
|
||||
# Browserslist warning
|
||||
npx update-browserslist-db@latest
|
||||
|
||||
# Tailwind not regenerating
|
||||
rm css/tailwind.generated.css && npm run build:css
|
||||
```
|
||||
|
||||
### Test Hangs
|
||||
|
||||
- Unit tests may hang after completion — use `Ctrl+C`
|
||||
- Use shards for faster local runs
|
||||
- Set `UNIT_TEST_TIMEOUT_MS=120000` for slow tests
|
||||
|
||||
### Lint Failures
|
||||
|
||||
- **Inline styles**: Move to CSS classes or tokens
|
||||
- **Hex colors**: Use design tokens
|
||||
- **Design tokens**: Use `theme()` or existing utilities
|
||||
|
||||
---
|
||||
|
||||
## Release Channels & Promotion Pipeline
|
||||
|
||||
Code flows through three branches with increasing stability:
|
||||
|
||||
```
|
||||
unstable → beta → main
|
||||
(dev) (soak) (prod)
|
||||
```
|
||||
|
||||
| Branch | Purpose | CI Required | Manual QA |
|
||||
|--------|---------|-------------|-----------|
|
||||
| `unstable` | Active development, AI agent PRs land here | Yes | No |
|
||||
| `beta` | Stabilization soak (hosted for testing) | Yes | Yes — hosted domain |
|
||||
| `main` | Production | Yes | Verified via beta |
|
||||
|
||||
**Promotion rules:**
|
||||
- `unstable → beta`: After a batch of improvements passes CI and local testing
|
||||
- `beta → main`: After weeks of soak time on the beta hosted domain with no regressions
|
||||
- Never push directly to `main` or `beta` — always promote from the previous stage
|
||||
|
||||
### Emergency Response
|
||||
|
||||
If a change breaks playback or magnet handling:
|
||||
1. Revert immediately
|
||||
2. Note rollback in PR
|
||||
3. Document in AGENTS.md
|
||||
|
||||
---
|
||||
|
||||
## Multi-Agent Development Workflow
|
||||
|
||||
This project uses multiple AI coding agents working in parallel:
|
||||
- **Claude Code** — Refactoring, convention enforcement, codebase-wide changes
|
||||
- **OpenAI Codex** — Isolated feature implementation with clear specs
|
||||
- **Google Jules** — Issue triage and straightforward bug fixes
|
||||
|
||||
### Coordination Rules
|
||||
|
||||
All agents **must** follow the subsystem boundaries and PR discipline rules in `AGENTS.md` Section 12. The key principles:
|
||||
|
||||
1. **Check before you start.** Look at open PRs before beginning work by running:
|
||||
```
|
||||
curl -s "https://api.github.com/repos/PR0M3TH3AN/bitvid/pulls?state=open&per_page=100" | jq '{count: length, titles: [.[].title]}'
|
||||
```
|
||||
If another agent has an open PR touching the same files, stop and flag the conflict.
|
||||
2. **One subsystem per PR.** Don't mix unrelated changes. A lint fix and a feature addition are two separate PRs.
|
||||
3. **`js/app.js` is single-writer.** Only one PR at a time should modify the main orchestrator.
|
||||
4. **Merge fast, branch short.** Long-lived branches cause exponential merge pain with multiple agents. Keep PRs small and mergeable in one sitting.
|
||||
|
||||
### For Human Maintainers
|
||||
|
||||
When assigning work to agents:
|
||||
- Update the "Currently In-Flight Work" section in `AGENTS.md` to reserve subsystems
|
||||
- Avoid sending two agents at the same subsystem simultaneously
|
||||
- Review and merge agent PRs promptly to keep the queue short — stale PRs compound conflicts
|
||||
- Use PR title prefixes (`[nostr-core]`, `[ui]`, `[playback]`, etc.) to make scope visible
|
||||
|
||||
---
|
||||
|
||||
## Key Documentation
|
||||
|
||||
| Document | What It Covers |
|
||||
|----------|---------------|
|
||||
| `AGENTS.md` | AI agent rules, mission, architectural decisions |
|
||||
| `CONTRIBUTING.md` | Setup, PR process, DCO |
|
||||
| `KNOWN_ISSUES.md` | Pre-existing test failures |
|
||||
| `docs/nostr-event-schemas.md` | Event definitions |
|
||||
| `docs/playback-fallback.md` | URL-first strategy |
|
||||
| `docs/moderation/README.md` | Moderation system |
|
||||
| `docs/logging.md` | Logger usage |
|
||||
| `context/` / `todo/` / `decisions/` / `test_logs/` | Agent persistent state files (see AGENTS.md §15) |
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference
|
||||
|
||||
### Import Patterns
|
||||
|
||||
```javascript
|
||||
// Nostr client
|
||||
import { nostrClient } from './nostrClientFacade.js';
|
||||
|
||||
// View events (analytics)
|
||||
import { recordVideoView } from './nostrViewEventsFacade.js';
|
||||
|
||||
// Watch history
|
||||
import { updateWatchHistoryListWithDefaultClient } from './nostrWatchHistoryFacade.js';
|
||||
|
||||
// Event building
|
||||
import { buildVideoPostEvent } from './nostrEventSchemas.js';
|
||||
|
||||
// Feature flags
|
||||
import { URL_FIRST_ENABLED, setUrlFirstEnabled } from './constants.js';
|
||||
|
||||
// Logger
|
||||
import { logger } from './utils/logger.js';
|
||||
```
|
||||
|
||||
### Content Schema v3
|
||||
|
||||
```javascript
|
||||
{
|
||||
version: 3,
|
||||
title: string, // Required
|
||||
url?: string, // HTTPS video URL
|
||||
magnet?: string, // WebTorrent magnet
|
||||
thumbnail?: string,
|
||||
description?: string,
|
||||
mode: 'live' | 'dev',
|
||||
isPrivate: boolean,
|
||||
deleted: boolean,
|
||||
videoRootId: string // Stable identifier
|
||||
}
|
||||
```
|
||||
|
||||
Validation: Must have `title` + at least one of `url` or `magnet`.
|
||||
|
||||
---
|
||||
|
||||
## Final Notes
|
||||
|
||||
1. **Read AGENTS.md first** — it contains mission-critical architectural decisions and the Agent Execution Protocol (§15)
|
||||
2. **Check KNOWN_ISSUES.md** — avoid investigating pre-existing failures
|
||||
3. **Use sharded tests** — faster feedback during development
|
||||
4. **Never commit generated CSS** — `css/tailwind.generated.css` is gitignored
|
||||
5. **Token-first styling** — no raw colors, no inline styles
|
||||
6. **Keep magnets raw** — decode only at playback time
|
||||
7. **Document rollback steps** — especially for playback changes
|
||||
@@ -22,34 +22,31 @@ See [https://developercertificate.org/](https://developercertificate.org/) for t
|
||||
|
||||
## (Optional) Contributor License Agreement (CLA)
|
||||
|
||||
If we later introduce **dual-licensing** options (e.g., commercial licenses for enterprises), we may add an _optional_ CLA for contributors who want to grant relicense rights. You will be asked to agree explicitly in any PR that requires it. We will keep community use under GPL-3.0-or-later.
|
||||
If we later introduce **dual-licensing** options (e.g., commercial licenses for enterprises), we may add an *optional* CLA for contributors who want to grant relicense rights. You will be asked to agree explicitly in any PR that requires it. We will keep community use under GPL-3.0-or-later.
|
||||
|
||||
## Code Guidelines
|
||||
|
||||
- Prefer small, focused PRs.
|
||||
- Add tests where reasonable; keep UI accessible.
|
||||
- Follow existing formatting/lint rules.
|
||||
- Update docs and user-facing text when behavior changes.
|
||||
- Do not commit `css/tailwind.generated.css`; it is generated at build time.
|
||||
* Prefer small, focused PRs.
|
||||
* Add tests where reasonable; keep UI accessible.
|
||||
* Follow existing formatting/lint rules.
|
||||
* Update docs and user-facing text when behavior changes.
|
||||
* Do not commit `css/tailwind.generated.css`; it is generated at build time.
|
||||
|
||||
## Agent PR Conventions
|
||||
|
||||
Automated agents contributing to this repository should follow these rules:
|
||||
|
||||
- **Atomic Commits**: Keep changes small, focused, and self-contained.
|
||||
- **Descriptive Titles**: Use clear, semantic titles (e.g., `fix(ui): resolve upload modal overflow`).
|
||||
- **Commit Messages**: Use the convention `type(scope): description (agent)` (e.g., `fix(ai): formatting (agent)` or `docs(ai): update quickstart (agent)`).
|
||||
- **Reference Issues**: Link to relevant issues in the PR description.
|
||||
- **Review AGENTS.md**: Always consult `AGENTS.md` for specific architectural guidelines (like URL-first playback, token-first design system) and constraints before starting work.
|
||||
- **Review KNOWN_ISSUES.md**: Before starting development or debugging, review `KNOWN_ISSUES.md` to avoid investigating pre-existing failures or limitations.
|
||||
- **Dependency Upgrades**: Major or risky dependency upgrades must be documented by creating a Markdown file in the `issues/` directory (e.g., `issues/upgrade-<pkg>.md`) with a plan and risk assessment, rather than opening an immediate PR.
|
||||
- **Efficiency**: Prefer running targeted or sharded tests (e.g., `npm run test:unit:shard1`, `shard2`, or `shard3`) to conserve resources during iteration.
|
||||
- **Review AGENTS.md**: Always consult `AGENTS.md` for specific architectural guidelines and constraints before starting work.
|
||||
- **Efficiency**: Prefer running targeted or sharded tests (e.g., `npm run test:unit:shard1`) to conserve resources during iteration.
|
||||
|
||||
## Submitting a Pull Request
|
||||
|
||||
1. Fork the repository and create a new branch from `main`.
|
||||
2. Make your changes, adding tests if applicable.
|
||||
3. Run `npm run format`, `npm run lint`, and unit tests (e.g. `npm run test:unit` or a shard like `npm run test:unit:shard1`) to ensure quality before pushing.
|
||||
3. Run `npm run format`, `npm run lint`, and unit tests (e.g. `npm run test:unit` or a shard like `npm run test:unit:shard1`) to ensure quality.
|
||||
4. (Optional) Run `npm run test:visual` if you made UI changes.
|
||||
5. (Optional) Run domain-specific tests if relevant (e.g., `npm run test:dm:unit` for Direct Messages).
|
||||
6. Push your branch and open a Pull Request against the `main` branch.
|
||||
@@ -94,96 +91,44 @@ This workflow uses the `force-cancel` endpoint to ensure stalled runs are termin
|
||||
|
||||
To set up the project locally:
|
||||
|
||||
1. **Prerequisites**:
|
||||
- **Node.js**: v22 or higher (enforced by `.npmrc`).
|
||||
- **NPM**: v10 or higher (included with Node 22).
|
||||
|
||||
2. **Install Dependencies**:
|
||||
Use `npm ci` to ensure you get the exact dependencies from `package-lock.json`. If you intend to run smoke, visual, or end-to-end tests, also install Playwright browsers.
|
||||
|
||||
1. **Install Dependencies**:
|
||||
Use `npm ci` to ensure you get the exact dependencies from `package-lock.json`.
|
||||
```bash
|
||||
npm ci
|
||||
npx playwright install
|
||||
```
|
||||
|
||||
3. **Start the Application**:
|
||||
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
|
||||
This command runs a full production build (generating `dist/` and `css/tailwind.generated.css`) and starts a local server.
|
||||
|
||||
**Or, build manually:**
|
||||
|
||||
2. **Build**:
|
||||
```bash
|
||||
npm run build
|
||||
npx serve dist
|
||||
```
|
||||
(This runs `npm run build:css` to generate Tailwind styles.)
|
||||
|
||||
(The build command populates the `dist/` directory, which you can then serve locally.)
|
||||
|
||||
**For CSS-only changes:**
|
||||
If you are only iterating on styles, you can run the faster CSS build:
|
||||
|
||||
```bash
|
||||
npm run build:css
|
||||
```
|
||||
|
||||
4. **Run Tests**:
|
||||
|
||||
3. **Run Tests**:
|
||||
```bash
|
||||
npm run test:unit
|
||||
```
|
||||
*Note: Running the full suite (`npm run test:unit`) is resource-intensive and may time out in some environments. We strongly recommend using sharded runs for local development: `npm run test:unit:shard1`.*
|
||||
|
||||
_Note: Running the full suite (`npm run test:unit`) is resource-intensive, runs sequentially, and may time out in some environments. We strongly recommend using sharded runs for local development to save time: `npm run test:unit:shard1`, `shard2`, or `shard3`._
|
||||
|
||||
You can also run end-to-end, smoke, and visual tests:
|
||||
|
||||
You can also run end-to-end and visual tests:
|
||||
```bash
|
||||
npm run test:e2e
|
||||
npm run test:smoke # Critical path verification
|
||||
npm run test:visual
|
||||
```
|
||||
|
||||
To run load tests (agent-driven):
|
||||
|
||||
```bash
|
||||
npm run test:load
|
||||
```
|
||||
|
||||
To update visual regression baselines:
|
||||
|
||||
```bash
|
||||
npm run test:visual:update
|
||||
```
|
||||
|
||||
For Direct Message features, run:
|
||||
|
||||
```bash
|
||||
npm run test:dm:unit
|
||||
npm run test:dm:integration
|
||||
```
|
||||
|
||||
To aggregate telemetry from test logs:
|
||||
|
||||
```bash
|
||||
npm run telemetry:aggregate
|
||||
```
|
||||
|
||||
5. **Format & Lint**:
|
||||
|
||||
4. **Format & Lint**:
|
||||
```bash
|
||||
npm run format
|
||||
npm run lint
|
||||
```
|
||||
*Note: `npm run format` currently only targets CSS, HTML, and Markdown files.*
|
||||
|
||||
- **Format**: Targets CSS, HTML, Markdown, and config files. (Note: JavaScript files are not currently auto-formatted by this command).
|
||||
- **Lint**: Checks for CSS errors, hex color usage, inline styles, design tokens, Tailwind guards, file size limits, innerHTML usage, asset references, and Service Worker compatibility. (Note: There is no ESLint configuration for JavaScript logic; this step focuses on style and design system guards).
|
||||
- **Note**: `npm run lint` includes an asset verification step (`lint:assets`) which checks the `dist/` directory. For full coverage, run `npm run build` before linting.
|
||||
- **Audit**: `npm run audit` runs a design system audit and generates `REMEDIATION_REPORT.md` with auto-fix suggestions.
|
||||
|
||||
6. **Git Hooks (Optional)**:
|
||||
5. **Git Hooks (Optional)**:
|
||||
We provide a script to set up a git pre-commit hook that runs linting and CSS builds automatically before you commit.
|
||||
```bash
|
||||
./scripts/setup-pre-commit.sh
|
||||
@@ -191,20 +136,9 @@ To set up the project locally:
|
||||
|
||||
For a full guide, see the [Local Setup section in README.md](./README.md#local-setup).
|
||||
|
||||
### Event Schema Validation
|
||||
|
||||
When modifying event schemas or builders, verify your changes against the codebase and test suite:
|
||||
|
||||
```bash
|
||||
node scripts/agent/validate-events.mjs
|
||||
```
|
||||
|
||||
This script checks that all event builders produce valid events according to the definitions in `js/nostrEventSchemas.js`.
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
- **Browserslist Warning**: If you see `Browserslist: caniuse-lite is outdated` during the build, run:
|
||||
|
||||
```bash
|
||||
npx update-browserslist-db@latest
|
||||
```
|
||||
@@ -218,7 +152,6 @@ This script checks that all event builders produce valid events according to the
|
||||
This project includes a `.devcontainer` configuration for VS Code. It provides a pre-configured environment with Node.js 22, the GitHub CLI, and necessary extensions.
|
||||
|
||||
To use it:
|
||||
|
||||
1. Open the project in VS Code.
|
||||
2. When prompted, re-open in Container (or use the command palette: "Dev Containers: Reopen in Container").
|
||||
3. The container will automatically:
|
||||
@@ -231,7 +164,6 @@ To use it:
|
||||
Before starting your work, please review these key documents:
|
||||
|
||||
- **[AGENTS.md](./AGENTS.md)**: Architectural guidelines, mission statement, and troubleshooting tips.
|
||||
- **[Documentation Index](./docs/README.md)**: A complete list of system documentation, including architecture and feed logic.
|
||||
- **[Nostr Event Schemas](./docs/nostr-event-schemas.md)**: The source of truth for all Nostr events published by the application.
|
||||
- **[Playback Fallback](./docs/playback-fallback.md)**: Details on the URL-first playback strategy and WebTorrent fallback mechanism.
|
||||
|
||||
@@ -242,12 +174,3 @@ If you find a vulnerability, please email **[[email protected]](mailto:sec
|
||||
## Trademark
|
||||
|
||||
The **bitvid** name and logos are trademarks (see `TRADEMARKS.md`). Don’t use them in ways that imply official sponsorship or confuse users. “Powered by bitvid” attribution is encouraged.
|
||||
|
||||
## AI-assisted contributions
|
||||
|
||||
AI-assisted changes are subject to the same testing, security, and review
|
||||
requirements as any other change; the contributor remains responsible for
|
||||
understanding what they submit. Do not submit unvalidated generated code,
|
||||
credentials, or agent-generated trusted memory without evidence and review.
|
||||
The canonical backlog and planning rules are in `AGENTS.md`; durable agent
|
||||
plans live under `.agents/plans/`.
|
||||
@@ -1,13 +0,0 @@
|
||||
# Initial Baseline - Performance & Docs (Feb 2026)
|
||||
|
||||
## Performance Bottlenecks
|
||||
- **Unbounded Concurrency (P0):** `js/nostr/commentEvents.js` uses `Promise.all` for relay requests in `publishComment` and `listVideoComments`. This can saturate network connections if a user has many relays (20+), causing UI freeze or timeouts.
|
||||
- **Remediation:** Apply `pMap` with `RELAY_BACKGROUND_CONCURRENCY` (3).
|
||||
- **VideoEventBuffer (P1):** Flushes every 75ms on event ingest regardless of visibility.
|
||||
- **Remediation:** Implemented visibility gating (2026-02-13).
|
||||
- **WatchHistory (P2):** Republish loop has backoff but no visibility check.
|
||||
|
||||
## Documentation Gaps
|
||||
- **CORS Configuration:** `content/docs/guides/upload-content.md` suggests `http://localhost:5500` for CORS, but the default dev port is `3000`.
|
||||
- **Remediation:** Update port to `3000`.
|
||||
- **Upload Limit:** 2GB (documented and code-verified).
|
||||
@@ -1,52 +1,34 @@
|
||||
# Known Issues
|
||||
|
||||
## Test Infrastructure
|
||||
## Tests
|
||||
|
||||
### Missing `jsdom` Dependency
|
||||
- **Status:** Resolved (2026-07-30)
|
||||
- **Detected:** 2026-02-26
|
||||
- **Description:** Unit tests failed with `ERR_MODULE_NOT_FOUND` because `jsdom` was imported but not installed.
|
||||
- **Resolution:** `jsdom` has been a devDependency for some time (28.1.0 installed and in `package.json`); the jsdom-based suites run clean.
|
||||
### Unit Tests
|
||||
- `npm run test:unit` consistently times out in the CI environment due to resource constraints. Targeted testing (`test:dm:unit`, `test:dm:integration`) is recommended.
|
||||
|
||||
## Run Notes (2026-03-04)
|
||||
### Visual Regression Tests (`test:visual`)
|
||||
- **Artifact Retention**: Visual tests are configured to retain screenshots, traces, and videos on failure to assist with debugging. These artifacts can be found in `artifacts/test-results/`.
|
||||
- **Moderation UI (`tests/visual/moderation.spec.ts`)**: The "Show anyway" button and related moderation badges fail to render in the test environment, causing `toBeVisible()` assertions to fail. The logic for creating the button appears correct (`allowOverride` is true), but the button element is not found in the DOM during the test execution. This might be due to a race condition in the test fixture's state initialization or an environment-specific rendering issue.
|
||||
- **Sidebar Layout (`tests/visual/overlay-layers.spec.ts`)**: The `mobile sidebar shares desktop rail behavior` test fails. The expected margin for the app container does not match the computed margin in the test environment (diff of ~45px). Attempts to fix this by adjusting CSS margin calculations were incomplete and reverted to avoid instability.
|
||||
- **Kitchen Sink (`tests/visual/kitchen-sink.spec.ts`)**: Minor pixel mismatch (width 1292 vs expected 1280) in snapshot comparison.
|
||||
|
||||
### Firefox E2E feed hydration flakes under full parallel load
|
||||
- **Status:** Active
|
||||
- **Description:** `test:e2e` can intermittently fail in Firefox with `[testHarness] Timed out waiting for <n> feed items (found 0)` in `waitForFeedItems`, while the same failing specs usually pass in isolated reruns.
|
||||
- **Impact:** Full-suite Firefox E2E runs are flaky even after local polling hardening.
|
||||
- **Observed failures:** `tests/e2e/video-crud-flows.spec.ts`, `tests/e2e/video-edit-delete-execution.spec.ts`, `tests/e2e/view-navigation.spec.ts`.
|
||||
### E2E Tests (`test:e2e`)
|
||||
- **Modals (`tests/e2e/ui-modals.spec.ts`)**:
|
||||
- `application-form` and `profile-modal` fail with 404 errors for requested resources (likely related to how `http-server` serves relative paths or nested components in the test runner).
|
||||
- Several modals (`upload-modal`, `edit-video-modal`, etc.) timeout waiting for close actions or visibility checks. This might be due to the `reducedMotion` application interacting poorly with visibility checks or genuine performance issues in the test runner.
|
||||
- `login-modal` fails to find the `[data-nsec-error]` element (it expects it to be visible but it remains hidden).
|
||||
- **Popover (`tests/e2e/popover.spec.ts`)**: Fails with `ReferenceError: getPanelWithTriggerMetrics is not defined`. This helper function seems to be missing or not imported correctly in the test file.
|
||||
|
||||
### Nostr tools signing/key API expectation in unit tests
|
||||
- **Status:** Addressed
|
||||
- **Description:** `tests/nostr-send-direct-message.test.mjs` must pass `Uint8Array` secret keys to `getPublicKey/finalizeEvent` for current `nostr-tools`.
|
||||
- **Impact:** Passing hex strings causes failures like `expected Uint8Array, got type=string`.
|
||||
## CSS / Design System
|
||||
- The global CSS (`css/tailwind.source.css`) was updated to fix a linter error by using `calc(theme("screens.md") - var(--breakpoint-edge-offset))` instead of raw pixels.
|
||||
|
||||
## Run Notes (2026-06-20, updated 2026-07-30)
|
||||
## Retrospective & Future Improvements
|
||||
|
||||
### `login-flows.spec.ts:149` — upload/profile buttons stay visible after logout
|
||||
- **Status:** Active — NOT merely a parallel-load flake
|
||||
- **Description:** Previously filed as a worker-contention flake that "passes deterministically in isolation." On 2026-07-28 it failed **in isolation** as well (chromium, local and CI `e2e-headless`), while passing in the CI `e2e-tests (e2e)` job — environment-sensitive, not load-sensitive. Direct probes of the same flow (raw `__bitvidTest__.loginWithNsec` → `logout()` against a mock relay) hide the button correctly, so the failure is specific to something in the Playwright fixture path. An attempted fix (running `applyLoggedOutUiState()` before the awaited NWC/profile teardown in `_executeAuthLogout`) did not change the outcome and was reverted rather than shipped unverified.
|
||||
- **Impact:** One e2e failure in `e2e-headless`; logout hides gated UI correctly in manual testing and direct harness probes.
|
||||
- **Next step:** Investigate alongside pre-launch TODO #33 ("logout logs out everyone" / NIP-46 session persistence) — same subsystem.
|
||||
### Challenges
|
||||
- **Generated Artifacts**: The build process modifies `css/tailwind.generated.css`, which creates noise in diffs and potential merge conflicts. It is recommended to ignore this file in version control or enforce a check that it matches the build output without committing it manually in every PR.
|
||||
- **Test Environment Isolation**: Debugging visual test failures (like the Sidebar Layout and Moderation UI) was difficult without access to the live browser UI or artifacts. The reproduction script failed due to environment restrictions on launching browsers.
|
||||
- **Test Flakiness**: E2E tests for modals are prone to timeouts, likely due to animation/transition handling or resource loading delays in the CI environment. Using `applyReducedMotion` consistently helps but doesn't solve all timing issues.
|
||||
|
||||
### `video-upload-publish-lifecycle.spec.ts:49` / `:79` flake under full parallel load
|
||||
- **Status:** Active
|
||||
- **Description:** Under the full `test:e2e` run these intermittently fail on feed-appearance timeouts but pass on retry (CI marks them flaky). Worker resource contention.
|
||||
- **Impact:** Full-suite e2e occasionally needs retries; isolated reruns are green.
|
||||
|
||||
### `webseed-playback.spec.ts:31` fails on Firefox headless (CDN mode)
|
||||
- **Status:** Resolved (2026-07-28, `f48150ed`)
|
||||
- **Description:** The test asserted the **final** `src` equals the CDN URL while simultaneously tolerating "No playable source found" in its status assertion — contradictory, because a failed hosted attempt calls `resetVideoElement()`, which clears `src`. Headless CI cannot decode the archive.org H.264 sample, so the cleared-src path was routine there.
|
||||
- **Resolution:** The test now records every `src` the player attaches via a MutationObserver and asserts the CDN URL was attached — the actual behavior under test. Green in both `e2e` and `e2e-firefox` CI jobs.
|
||||
|
||||
### `uploadModal-reset.test.mjs` ("UploadModal Reset Logic") hangs/cancels
|
||||
- **Status:** Not reproducible (2026-07-30)
|
||||
- **Description:** Intermittent `cancelledByParent` / "Promise resolution is still pending" hang, order/timing dependent.
|
||||
- **Current state:** Passes cleanly (`pass=3 fail=0 cancelled=0`) in isolation and across repeated full-suite sweeps on 2026-07-28–30. Left on file because the original failure was ordering-dependent; if it recurs, capture the full-suite ordering that produced it.
|
||||
|
||||
## Run Notes (2026-07-30)
|
||||
|
||||
### Visual baselines are CI-canonical — local `test:visual` may fail the kitchen-sink diff
|
||||
- **Status:** By design (since `ab120a03`)
|
||||
- **Description:** `tests/visual/baselines.json` is regenerated on ubuntu-latest by the `update-visual-baselines` workflow (trigger: `workflow_dispatch` once promoted, or a commit containing `[update-visual-baselines]`). Baselines can only match one environment, and the CI gate is the one that matters — so a dev machine with different Chromium/font rendering may now fail `npm run test:visual` locally (typically the kitchen-sink default theme) even though CI is green.
|
||||
- **Workaround:** Run visual tests in the pinned container via `scripts/run-playwright-docker.sh`, or rely on CI. Never regenerate baselines from a dev machine.
|
||||
### Suggestions
|
||||
- **Commit Hooks**: Implement a pre-commit hook that runs the linter and potentially the build to ensure generated files are in sync, or configure CI to fail if they are not.
|
||||
- **Dockerized Testing**: Running tests in a consistent Docker container with Xvfb properly configured would help reproduce environment-specific failures locally.
|
||||
- **Visual Testing improvements**: Ensure that test fixtures (like `moderation/fixtures/index.html`) correctly force UI updates after state injection to avoid race conditions.
|
||||
@@ -0,0 +1,20 @@
|
||||
# Lint Issues Report
|
||||
|
||||
## Summary
|
||||
Automated linting and formatting checks were run. No auto-fixable formatting issues were found. However, one linting error persists which requires manual intervention.
|
||||
|
||||
## Issues
|
||||
|
||||
### css/tailwind.source.css
|
||||
|
||||
The `npm run lint:tokens` check failed with the following error:
|
||||
|
||||
```
|
||||
css/tailwind.source.css:5757 → 767.98px
|
||||
@media (max-width: 767.98px) {
|
||||
```
|
||||
|
||||
**Recommendation:**
|
||||
This raw measurement (`767.98px`) should be moved into `css/tokens.css` as a design token, or the linter configuration (`scripts/check-design-tokens.mjs`) should be updated to whitelist this specific value if it represents a standard responsive breakpoint for mobile layout fixes.
|
||||
|
||||
Note: This error currently prevents `npm run lint` from completing successfully, meaning subsequent checks (`lint:tailwind-brackets`, `lint:tailwind-colors`) are skipped in the standard run script. These subsequent checks were run manually and passed.
|
||||
@@ -1,56 +0,0 @@
|
||||
# NIP Inventory
|
||||
|
||||
| NIP / Kind | Description | Repo Locations | Status | Notes |
|
||||
|------------|-------------|----------------|--------|-------|
|
||||
| **NIP-01** | Basic Protocol Flow | `js/nostr/client.js`, `docs/nips/01.md` | Compliant | Base implementation verified via `client.js`. |
|
||||
| **NIP-04** | Encrypted Direct Message | `js/nostr/dmDecryptWorker.js`, `js/nostr/client.js` | Compliant | Verified by `tests/nostr-specs/nip04-nip44.test.mjs`. |
|
||||
| **NIP-07** | `window.nostr` Capability | `js/nostr/nip07Permissions.js`, `js/nostr/adapters/nip07Adapter.js` | Compliant | Verified in `tests/compliance/nip07_compliance.test.mjs`. |
|
||||
| **NIP-09** | Event Deletion | `js/nostr/client.js`, `js/nostrEventSchemas.js` | Compliant | `deleteAllVersions` calls `_hardDeleteVersions` which uses Kind 5. |
|
||||
| **NIP-10** | Text Notes & Threads | `js/nostr/commentEvents.js`, `docs/nips/10.md` | Compliant | `buildCommentEvent` implements NIP-10 threading markers (E, P, K tags). |
|
||||
| **NIP-17** | Private Direct Messages | `js/nostr/client.js`, `js/ui/profileModal/ProfileDirectMessageRenderer.js` | Compliant | Explicit support for Gift Wraps (Kind 1059) and Seals (Kind 13). |
|
||||
| **NIP-18** | Reposts | `js/nostrEventSchemas.js` | Compliant | Implements Kind 6 and 16. |
|
||||
| **NIP-19** | bech32-encoded entities | `js/utils/nostrHelpers.js`, `js/nostr/nip71.js` | Compliant | Uses `nostr-tools` for correct encoding/decoding. |
|
||||
| **NIP-21** | `nostr:` URI scheme | `js/app/routerCoordinator.js`, `js/utils/nostrHelpers.js` | Partial | Router handles `nostr:` prefix but only for hex/npub. `nprofile`/`nevent` not supported in helper. |
|
||||
| **NIP-25** | Reactions | `js/nostr/reactionEvents.js`, `js/nostrEventSchemas.js` | Compliant | Implements Kind 7 reaction events. |
|
||||
| **NIP-33** | Addressable Events | `js/nostr/client.js` | Compliant | `d` tag usage verified in `video_note_compliance.test.mjs`. |
|
||||
| **NIP-42** | Authentication of clients to relays | `js/nostr/client.js` | Non-compliant | No `AUTH` command handling found in client or pool. |
|
||||
| **NIP-44** | Encrypted Payloads (Versioned) | `js/nostr/dmDecryptWorker.js`, `js/nostr/client.js` | Compliant | Verified by `tests/nostr-specs/nip04-nip44.test.mjs`. |
|
||||
| **NIP-46** | Nostr Remote Signing | `js/nostr/nip46Client.js` | Compliant | Full client implementation for remote signing. |
|
||||
| **NIP-47** | Wallet Connect | `js/payments/nwcClient.js` | Compliant | Implements NWC client for zaps. |
|
||||
| **NIP-51** | Lists | `js/userBlocks.js`, `js/subscriptions.js` | Compliant | Mute list (Kind 10000) and Subscription list (Kind 30000) logic aligns with spec. |
|
||||
| **NIP-56** | Reporting | `js/services/moderationService.js`, `docs/nips/56.md` | Compliant | `buildReportEvent` implements Kind 1984. |
|
||||
| **NIP-57** | Zaps | `js/payments/zapRequests.js`, `js/payments/zapSplit.js` | Compliant | Implements Kind 9734/9735 flow. |
|
||||
| **NIP-59** | Gift Wrap | `js/nostr/client.js` | Compliant | Implemented as part of NIP-17. |
|
||||
| **NIP-65** | Relay List Metadata | `js/relayManager.js` | Compliant | Code supports Kind 10002. Verified by `tests/nostr-specs/nip65_compliance.test.mjs`. |
|
||||
| **NIP-71** | Video Events | `js/nostr/nip71.js` | Partial | Kinds 21/22 supported in schema, but Kind 30078 is primary. Verified tag generation in `tests/nostr-specs/kind30078.test.mjs`. |
|
||||
| **NIP-78** | Application-specific data | `js/services/hashtagPreferencesService.js` | Compliant | Used for hashtag preferences (Kind 30015). |
|
||||
| **NIP-94** | File Metadata | `js/nostr/videoPublisher.js` | Compliant | `buildVideoMirrorEvent` implements Kind 1063. |
|
||||
| **NIP-96** | HTTP File Storage Integration | `js/nostr/videoPublisher.js` | Partial | References `service nip96` in NIP-71 tags. |
|
||||
| **NIP-98** | HTTP Auth | `js/services/r2Service.js` | Compliant | Used for R2 service authentication (Kind 27235). |
|
||||
| **Kind 0** | Profile Metadata | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 1** | Share | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 4** | Legacy DM | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 5** | Deletion | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 6** | Repost | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 7** | Reaction | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 13** | Seal | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 14** | Chat Message | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 16** | Generic Repost | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 21** | NIP-71 Video | `js/nostr/nip71.js` | Compliant | Implemented. |
|
||||
| **Kind 22** | NIP-71 Short Video | `js/nostr/nip71.js` | Compliant | Implemented. |
|
||||
| **Kind 1059** | Gift Wrap | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 1111** | Video Comment | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 1984** | Report | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 9734** | Zap Request | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 9735** | Zap Receipt | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 10000** | Mute List | `js/userBlocks.js` | Compliant | Uses standard NIP-51 (no d tag for main list). |
|
||||
| **Kind 10002** | Relay List | `js/relayManager.js` | Compliant | Verified. |
|
||||
| **Kind 10050** | DM Relay List | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 20001** | DM Read Receipt | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 20002** | DM Typing | `js/nostrEventSchemas.js` | Compliant | Implemented. |
|
||||
| **Kind 27235** | HTTP Auth | `js/services/r2Service.js` | Compliant | Implemented. |
|
||||
| **Kind 1063** | File Header | `js/nostr/videoPublisher.js` | Compliant | Implemented for NIP-94 mirroring. |
|
||||
| **Kind 30000** | Subscription List | `js/subscriptions.js` | Compliant | Implements NIP-51 follow sets. |
|
||||
| **Kind 30015** | Hashtag Preferences | `js/services/hashtagPreferencesService.js` | Compliant | Implemented. |
|
||||
| **Kind 30078** | App Data | `js/nostr/client.js`, `js/nostr/videoPayloadBuilder.js` | Compliant | Verified by `tests/nostr-specs/kind30078.test.mjs`. |
|
||||
| **Kind 30079** | Watch History | `js/nostr/watchHistory.js`, `config/instance-config.js` | Compliant | Parameterized replaceable list (custom kind). Implements bucketing and encryption. |
|
||||
@@ -1,59 +0,0 @@
|
||||
# Onboarding Audit Report
|
||||
|
||||
**Date:** 2026-02-21
|
||||
**Agent:** onboarding-audit-agent
|
||||
**Headline:** ⚠️ Onboarding failures found
|
||||
|
||||
## 1. Environment Assumptions
|
||||
- **Node**: v22.22.0
|
||||
- **NPM**: 10.9.0
|
||||
- **OS**: Linux
|
||||
|
||||
## 2. Steps Executed
|
||||
1. `npm ci`
|
||||
2. `npx playwright install`
|
||||
3. `npm run build` (Simulating `npm start` build phase)
|
||||
4. `npm run test:unit:shard1`
|
||||
5. `npm run test:smoke`
|
||||
6. `npm run format`
|
||||
7. `npm run lint`
|
||||
8. `npm run audit`
|
||||
|
||||
## 3. Results
|
||||
|
||||
| Command | Status | Notes |
|
||||
| :--- | :--- | :--- |
|
||||
| `npm ci` | ✅ Pass | Installed dependencies successfully. |
|
||||
| `npx playwright install` | ✅ Pass | Downloaded Chromium, Firefox, WebKit. |
|
||||
| `npm run build` | ✅ Pass | Build completed, assets hashed. |
|
||||
| `npm run test:unit:shard1` | ✅ Pass | Unit tests passed. |
|
||||
| `npm run test:smoke` | ✅ Pass | Smoke test passed. |
|
||||
| `npm run format` | ✅ Pass | No formatting changes needed. |
|
||||
| `npm run lint` | ❌ Fail | **File size violation** in `js/subscriptions.js`. |
|
||||
| `npm run audit` | ✅ Pass | Audit report generated. |
|
||||
|
||||
## 4. Failures
|
||||
|
||||
### `npm run lint`
|
||||
|
||||
**Error Log:**
|
||||
```
|
||||
1 file size violation(s):
|
||||
✗ GREW: js/subscriptions.js (2426 lines, was 2374, limit 2424)
|
||||
|
||||
New files must stay under 1000 lines. Grandfathered files must not grow.
|
||||
To decompose a large file, extract logic into smaller modules and re-export.
|
||||
```
|
||||
|
||||
**Root Cause:**
|
||||
`js/subscriptions.js` has grown beyond its grandfathered limit + buffer. The documented limit is 2424 lines, but the file is now 2426 lines.
|
||||
|
||||
**Recommendation:**
|
||||
1. Immediate fix: Increase the limit in `scripts/check-file-size.mjs` slightly to unblock CI if decomposition is not immediately possible.
|
||||
2. Long term: Decompose `js/subscriptions.js`.
|
||||
|
||||
## 5. Docs Changes Made
|
||||
- None. Documentation accurately reflects the commands, but the codebase fails the lint check.
|
||||
|
||||
## 6. Devcontainer/Docker
|
||||
- Not required. Environment setup (`npm ci`, `playwright install`) worked reliably.
|
||||
@@ -1,50 +0,0 @@
|
||||
# Optimization Task Stubs
|
||||
|
||||
The following tasks were identified and implemented to resolve high CPU/GPU usage and potential crashes on the website.
|
||||
|
||||
## Completed Tasks
|
||||
|
||||
### 1. Optimize Ambient Background Animation
|
||||
**Problem:** The `AmbientBackground` controller was calling `resizeCanvas` inside the `requestAnimationFrame` loop. This function accessed `getBoundingClientRect()`, causing synchronous layout thrashing (forced reflow) on every frame, leading to high CPU/GPU usage.
|
||||
**Fix:**
|
||||
- Refactor `js/ui/ambientBackground.js` to use `ResizeObserver`.
|
||||
- Only update canvas dimensions when the element actually resizes.
|
||||
- Remove layout reads from the animation loop.
|
||||
|
||||
### 2. Async Chunking for Explore Data Service
|
||||
**Problem:** `ExploreDataService` performed heavy synchronous iterations over large datasets (Watch History and Video Tags) on the main thread. This could cause the UI to freeze (long tasks) during initialization or updates.
|
||||
**Fix:**
|
||||
- Refactor `buildWatchHistoryTagCounts` and `buildTagIdf` in `js/services/exploreDataService.js`.
|
||||
- Implement processing in chunks (e.g., 500 items).
|
||||
- Yield to the main thread using `setTimeout` between chunks to allow user interaction and frame rendering.
|
||||
|
||||
### 3. Throttle URL Health Video Probes
|
||||
**Problem:** The `UrlHealthController` spawned a `<video>` element for every video card to probe connectivity. When loading a grid of 50+ videos, this caused a storm of simultaneous media decoding requests, leading to resource exhaustion and browser instability.
|
||||
**Fix:**
|
||||
- Refactor `js/ui/urlHealthController.js`.
|
||||
- Implement a concurrency limiter (queue) for `probeUrlWithVideoElement`.
|
||||
- Limit active video probes to a maximum of 3 concurrent instances.
|
||||
|
||||
## Future Optimization Tasks
|
||||
|
||||
### 4. Virtualize Video List Rendering
|
||||
**Description:** Implement virtual scrolling (windowing) for the main video grid.
|
||||
**Benefit:** Reduces DOM node count and memory usage when displaying thousands of videos.
|
||||
**Action:**
|
||||
- Create a `VirtualScroller` component.
|
||||
- Only render video cards that are currently in the viewport (plus a buffer).
|
||||
|
||||
### 5. Move Heavy Computation to Web Worker
|
||||
**Description:** Move the tag IDF and Watch History analysis entirely off the main thread.
|
||||
**Benefit:** Zero impact on UI responsiveness during data refreshes.
|
||||
**Action:**
|
||||
- Create `js/workers/exploreData.worker.js`.
|
||||
- Move `ExploreDataService` logic into the worker.
|
||||
- Use `postMessage` to send video data and receive calculated stats.
|
||||
|
||||
### 6. Optimize Image Loading with `loading="lazy"` & `decoding="async"`
|
||||
**Description:** Ensure all thumbnails and avatars use modern browser lazy loading.
|
||||
**Benefit:** Faster initial page load and lower bandwidth usage.
|
||||
**Action:**
|
||||
- Audit `VideoCard` and `VideoModal` templates.
|
||||
- Ensure `<img>` tags have `loading="lazy"` and `decoding="async"`.
|
||||
@@ -1,62 +0,0 @@
|
||||
# Protocol Inventory
|
||||
|
||||
This document tracks external protocol and specification dependencies used by the codebase. It complements `NIP_INVENTORY.md` which specifically tracks Nostr Implementation Possibilities.
|
||||
|
||||
## 1. Nostr (NIPs)
|
||||
|
||||
For a detailed inventory of supported NIPs (Nostr Implementation Possibilities), please refer to [NIP_INVENTORY.md](./NIP_INVENTORY.md).
|
||||
|
||||
**Summary of Key NIPs:**
|
||||
- **NIP-01:** Basic Protocol Flow (Compliant)
|
||||
- **NIP-71:** Video Events (Partial/Compliant)
|
||||
- **NIP-94:** File Metadata (Compliant)
|
||||
- **NIP-44:** Encrypted Payloads (Compliant)
|
||||
|
||||
## 2. BitTorrent / WebTorrent
|
||||
|
||||
| Protocol | Spec | Source URL | Implementation | Status |
|
||||
|----------|------|------------|----------------|--------|
|
||||
| **BitTorrent** | BEP-0003 | [bittorrent.org](http://www.bittorrent.org/beps/bep_0003.html) | `js/services/playbackService.js` | Compliant (via WebTorrent) |
|
||||
| **Magnet URI** | BEP-0009 | [bittorrent.org](http://www.bittorrent.org/beps/bep_0009.html) | `js/magnetUtils.js` | Compliant |
|
||||
| **WebSeed** | BEP-0019 | [bittorrent.org](http://www.bittorrent.org/beps/bep_0019.html) | `js/magnetUtils.js` | Compliant |
|
||||
| **WebTorrent** | WebRTC-based BitTorrent | [webtorrent.io](https://webtorrent.io/docs) | `js/services/playbackService.js` | Compliant |
|
||||
|
||||
**Notes:**
|
||||
- `js/magnetUtils.js` implements parsing and normalization of magnet links, ensuring `xt`, `ws`, and `xs` parameters are handled correctly.
|
||||
- `js/services/playbackService.js` handles the fallback logic between HTTP and WebTorrent playback.
|
||||
|
||||
## 3. Media Streaming
|
||||
|
||||
| Protocol | Spec | Source URL | Implementation | Status |
|
||||
|----------|------|------------|----------------|--------|
|
||||
| **HLS** | RFC 8216 | [rfc-editor.org](https://datatracker.ietf.org/doc/html/rfc8216) | Native Browser / `video` tag | Compliant |
|
||||
|
||||
**Notes:**
|
||||
- The application supports `.m3u8` (HLS) playback natively via the browser's video element (Safari) or via HLS.js if integrated (currently relies on browser/device native support or passthrough).
|
||||
- Inputs in `components/upload-modal.html` accept `.m3u8` and `.ts` files.
|
||||
|
||||
## 4. Lightning Network (LNURL)
|
||||
|
||||
| Protocol | Spec | Source URL | Implementation | Status |
|
||||
|----------|------|------------|----------------|--------|
|
||||
| **LNURL** | LUD-01, LUD-06, LUD-16 | [github.com/lnurl](https://github.com/lnurl/luds) | `js/payments/lnurl.js` | Compliant |
|
||||
| **Zap Requests** | NIP-57 | [nips.be](https://github.com/nostr-protocol/nips/blob/master/57.md) | `js/payments/zapRequests.js` | Compliant |
|
||||
|
||||
**Notes:**
|
||||
- `js/payments/lnurl.js` implements Bech32 decoding/encoding and LNURL resolution.
|
||||
- `js/payments/zapReceiptValidator.js` validates receipts against the LNURL server's public key.
|
||||
|
||||
## 5. HTTP & Authentication
|
||||
|
||||
| Protocol | Spec | Source URL | Implementation | Status |
|
||||
|----------|------|------------|----------------|--------|
|
||||
| **Nostr HTTP Auth** | NIP-98 / Kind 27235 | [nips.be](https://github.com/nostr-protocol/nips/blob/master/98.md) | `js/services/r2Service.js` | Compliant |
|
||||
| **S3 / R2 API** | AWS S3 Compat | [aws.amazon.com](https://docs.aws.amazon.com/s3/) | `js/services/r2Service.js` | Compliant |
|
||||
|
||||
**Notes:**
|
||||
- `js/services/r2Service.js` uses NIP-98 style authentication for uploads to compatible storage services (Cloudflare R2).
|
||||
|
||||
## Compliance & Remediation
|
||||
|
||||
- **NIP-42 (Auth):** Marked as `Non-compliant` in `NIP_INVENTORY.md`. Remediation involves implementing `AUTH` command handling in `js/nostr/client.js`.
|
||||
- **HLS:** Reliance on native browser support might limit compatibility on some desktop browsers (Firefox/Chrome on Windows without extensions). Consider integrating `hls.js` if not already present.
|
||||
@@ -30,9 +30,7 @@
|
||||
|
||||
1. **Visit the Site**: Navigate to the live instance of **bitvid** (e.g., `[https://bitvid.network](https://bitvid.network)`).
|
||||
2. **Login with Nostr**:
|
||||
- Use a compatible NIP-07 browser extension or manually input your public key.
|
||||
- For the most reliable experience we recommend a well-maintained signer such as [nos2x](https://github.com/fiatjaf/nos2x) or [Alby](https://getalby.com/). Encrypted features (DMs, hashtag preferences, watch history, block/subscription lists) require the extension to respond to decryption requests.
|
||||
- **Troubleshooting:** if those encrypted lists never finish loading after login, bitvid will surface a notice — your extension's signer is likely locked or its background worker went to sleep. Unlock/reload the extension and refresh the page. (bitvid caps relay fan-out and fast-fails an unresponsive signer so the tab no longer pins the CPU while waiting.)
|
||||
- Use a compatible Nostr browser extension or manually input your public key.
|
||||
|
||||
### Upload a video
|
||||
|
||||
@@ -45,6 +43,7 @@ Pick the flow that matches your source material. Supported S3 upload modes inclu
|
||||
1. **Browser-held S3 keys (trusted operator only):** Enter your S3 credentials in the Storage tab to upload directly from the browser.
|
||||
> **Security Warning:** This mode requires storing encrypted credentials in the browser's IndexedDB. While keys are encrypted at rest, they are decrypted in memory during use. Use this mode only on self-hosted, trusted deployments where you control the environment. Do not enter high-value credentials on public or untrusted instances.
|
||||
2. **Manual upload via provider console:** Upload your file to your storage provider (e.g., R2, S3) manually, then paste the public URL into the upload form.
|
||||
3. **Operator-provided presigned manifests:** Use a presigned JSON manifest prepared externally to authorize the upload without exposing long-lived credentials to the browser.
|
||||
|
||||
**Upload File (direct S3 upload)**:
|
||||
If you are using **Mode 1** (Browser-held keys), enter your credentials in the guided form or Storage tab. Optionally expand the **Advanced options** accordion to override pathing or access controls, then drop media files for bitvid to upload through the S3 API. The modal tracks progress, applies your metadata selections, auto-fills the primary `imeta` variant once the upload completes, and publishes the resulting URL back into the note automatically.
|
||||
@@ -82,8 +81,8 @@ Info JSON: https://cdn.example.com/uploads/demo/video.info.json
|
||||
|
||||
### How playback works
|
||||
|
||||
1. **Configurable Priority**: `playVideoWithFallback({ url, magnet })` attempts the preferred source (URL or WebTorrent) based on the `DEFAULT_PLAYBACK_SOURCE` configuration.
|
||||
2. **Seamless Fallback**: If the preferred source fails, stalls, or is unavailable, bitvid automatically switches to the alternative source.
|
||||
1. **URL-first**: `playVideoWithFallback({ url, magnet })` attempts the hosted URL immediately. Healthy URLs deliver the full experience without touching P2P resources.
|
||||
2. **WebTorrent fallback**: If the URL probe fails or returns an error status, bitvid falls back to WebTorrent using the raw magnet. The helpers append HTTPS `ws=`/`xs=` hints so peers seed quickly.
|
||||
3. **Safety checks**: Magnets are decoded with `safeDecodeMagnet()` and normalized via `normalizeAndAugmentMagnet()` before reaching WebTorrent. Trackers remain WSS-only to satisfy browser constraints.
|
||||
4. **Operator playbook**: If a deployment causes playback regressions, flip the relevant feature flags back to their default values in `js/constants.js` and redeploy. Capture the rollback steps in AGENTS.md and the PR description so the Main channel stays stable.
|
||||
5. **Deep dive**: See [`docs/playback-fallback.md`](docs/playback-fallback.md) for the call flow into `playbackService`, magnet normalization details, and fallback hand-off points.
|
||||
@@ -145,87 +144,52 @@ To run **bitvid** locally:
|
||||
|
||||
2. Install dependencies:
|
||||
|
||||
Use `npm ci` to install dependencies exactly as specified in `package-lock.json`. If you intend to run smoke, visual, or end-to-end tests, also install Playwright browsers.
|
||||
Use `npm ci` to install dependencies exactly as specified in `package-lock.json`. This ensures `npx` finds the correct local `tailwindcss` version.
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
npx playwright install
|
||||
```
|
||||
|
||||
3. Start the application:
|
||||
3. Build the project:
|
||||
|
||||
```bash
|
||||
npm start
|
||||
npm run build
|
||||
```
|
||||
|
||||
This command runs a full production build (generating `dist/` and `css/tailwind.generated.css`) and starts a local server.
|
||||
(This generates `css/tailwind.generated.css`, which is gitignored and required for styling.)
|
||||
|
||||
4. Open the site in your browser:
|
||||
4. Start a local server:
|
||||
- Using Python:
|
||||
```bash
|
||||
python -m http.server 8000
|
||||
```
|
||||
- Or with Node.js:
|
||||
```bash
|
||||
npx serve
|
||||
```
|
||||
|
||||
```
|
||||
http://localhost:3000
|
||||
```
|
||||
5. Open the site in your browser:
|
||||
|
||||
_(Note: The application runs via `npx serve`. The default port is 3000, but it may select a different port if 3000 is occupied. Check your terminal output for the correct URL.)_
|
||||
|
||||
_Note: If you prefer manual steps, run `npm run build` followed by `npx serve dist`. Because `dist` is the document root in this mode, always open `/` rather than appending `/dist`._
|
||||
|
||||
_If you use a static server from the repository root (for example VS Code Live Server or `python3 -m http.server`), open `http://127.0.0.1:8000/dist/` with the trailing slash._
|
||||
|
||||
5. Verify setup:
|
||||
|
||||
Run tests and linting to ensure everything is working correctly.
|
||||
|
||||
```bash
|
||||
npm run test:unit:shard1 # Run a subset of tests for speed
|
||||
npm run test:smoke # Critical path verification
|
||||
npm run format
|
||||
npm run lint
|
||||
npm run audit # Design system audit
|
||||
```
|
||||
|
||||
_Tip: Use `npm run test:unit` to run the full suite (can be slow)._
|
||||
|
||||
#### Quick Reference
|
||||
|
||||
- **Run unit tests**: `npm run test:unit`
|
||||
- **Run smoke tests**: `npm run test:smoke`
|
||||
- **Format code**: `npm run format` (CSS, HTML, MD, Config - no JS logic)
|
||||
- **Lint code**: `npm run lint` (Styles, Tokens, Hex, Tailwind guards, file size, innerHTML, assets, SW compat - no ESLint/logic linting)
|
||||
- **Visual tests**: `npm run test:visual` (Playwright snapshots)
|
||||
|
||||
### Dev Container
|
||||
|
||||
This project includes a `.devcontainer` configuration. If you use VS Code, you can open the project in a container to get a pre-configured environment with all dependencies installed.
|
||||
```
|
||||
http://localhost:8000
|
||||
```
|
||||
|
||||
### Developer Quickstart
|
||||
|
||||
See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for the full developer guide.
|
||||
|
||||
For detailed architecture and system documentation, see the [Documentation Index](docs/README.md).
|
||||
|
||||
**Verify your work:**
|
||||
|
||||
- **Run unit tests**: `npm run test:unit` (Required before PRs). _Tip: Use `npm run test:unit:shard1`, `shard2`, or `shard3` for faster local feedback._
|
||||
- **Format code**: `npm run format` (Required before PRs - only formats CSS, HTML, MD, and Config)
|
||||
- **Lint code**: `npm run lint` (Checks for CSS, hex colors, inline styles, design tokens, Tailwind guards, file size, innerHTML, assets, and SW compat - no ESLint/logic linting)
|
||||
- **Run unit tests**: `npm run test:unit` (Required before PRs). _Tip: Use `npm run test:unit:shard1` for faster local feedback._
|
||||
- **Format code**: `npm run format` (Required before PRs)
|
||||
- **Lint code**: `npm run lint` (Checks for CSS, hex colors, inline styles)
|
||||
|
||||
**Other commands:**
|
||||
|
||||
- **Run load tests**: `npm run test:load`
|
||||
- **Run DM unit tests**: `npm run test:dm:unit`
|
||||
- **Run DM integration tests**: `npm run test:dm:integration`
|
||||
- **Run headless E2E tests (Chromium + Firefox)**: `npm run test:e2e`
|
||||
- **Run E2E tests (Chromium only)**: `npm run test:e2e:chromium`
|
||||
- **Run E2E tests (Firefox only)**: `npm run test:e2e:firefox`
|
||||
- **Run deterministic E2E matrix**: `npm run test:e2e:deterministic`
|
||||
- **Run NIP-07 extension smoke (opt-in)**: `PLAYWRIGHT_EXTENSION_PATH=/abs/path/to/extension npm run test:e2e:extension`
|
||||
- Uses persistent-context launcher: `scripts/playwright/run-extension-persistent.mjs`
|
||||
- Optional profile dir: `PLAYWRIGHT_EXTENSION_USER_DATA_DIR=/abs/path/to/profile`
|
||||
- **Run headless E2E tests**: `npm run test:e2e`
|
||||
- **Run visual regression tests**: `npm run test:visual`
|
||||
- **Update visual baselines**: `npm run test:visual:update`
|
||||
- **Run design system audit**: `npm run audit` (Generates remediation report)
|
||||
- **Aggregate telemetry**: `npm run telemetry:aggregate`
|
||||
- **Cancel CI runs**: See [`docs/cancelling-ci-runs.md`](docs/cancelling-ci-runs.md) for a script to clear pending workflows.
|
||||
|
||||
### Docs navigation & TOC updates
|
||||
@@ -262,14 +226,13 @@ To quickly view the location of these artifacts:
|
||||
|
||||
Use these artifacts to inspect the UI state at the moment of failure and diagnose rendering issues or regressions.
|
||||
|
||||
### Quickstart: Send your first video post
|
||||
### Send your first video post
|
||||
|
||||
To programmatically publish videos, use the event builders in `js/nostrEventSchemas.js` (the source of truth for all event definitions) to construct valid video notes. See [`docs/nostr-event-schemas.md`](docs/nostr-event-schemas.md) for full schema documentation.
|
||||
Use the event builders in `js/nostrEventSchemas.js` (the source of truth for all event definitions) to construct valid video notes. See [`docs/nostr-event-schemas.md`](docs/nostr-event-schemas.md) for full schema documentation.
|
||||
|
||||
```javascript
|
||||
import { buildVideoPostEvent } from "./js/nostrEventSchemas.js";
|
||||
|
||||
// Ensure dependencies are installed (npm ci)
|
||||
// 1. Build the event object (useful for inspection or custom publishing)
|
||||
const event = buildVideoPostEvent({
|
||||
// Provide your hex pubkey (not npub)
|
||||
@@ -280,7 +243,7 @@ const event = buildVideoPostEvent({
|
||||
version: 3,
|
||||
title: "My First Video",
|
||||
videoRootId: "my-first-video", // Logical ID, matches the d-tag
|
||||
url: "https://example.com/video.mp4", // The builder automatically derives the required 's' storage tag from this URL
|
||||
url: "https://example.com/video.mp4",
|
||||
description: "This is a test video post sent via the SDK."
|
||||
// magnet: "magnet:?xt=urn:btih:..." // Optional fallback (provide the raw magnet string)
|
||||
}
|
||||
@@ -288,18 +251,23 @@ const event = buildVideoPostEvent({
|
||||
|
||||
console.log("Event constructed:", event);
|
||||
|
||||
// 2. Publish the event (requires browser/extension or active signer)
|
||||
// In an application context (e.g. browser console or module):
|
||||
// 2. Publish using the high-level client (requires browser/extension or active signer)
|
||||
/*
|
||||
import { nostrClient } from "./js/nostrClientFacade.js";
|
||||
|
||||
// Ensure client is connected
|
||||
await nostrClient.init();
|
||||
|
||||
// Login (prompts NIP-07 extension)
|
||||
await nostrClient.loginWithExtension();
|
||||
await nostrClient.login();
|
||||
|
||||
// Publish the built event
|
||||
await nostrClient.signAndPublishEvent(event);
|
||||
// Publish! (Handles signing and relay broadcasting)
|
||||
await nostrClient.publishVideo({
|
||||
title: "My First Video",
|
||||
url: "https://example.com/video.mp4",
|
||||
description: "Published via bitvid SDK"
|
||||
}, nostrClient.pubkey);
|
||||
*/
|
||||
```
|
||||
|
||||
### CSS build pipeline
|
||||
@@ -315,9 +283,9 @@ package scripts to keep formatting, linting, and generated output consistent:
|
||||
- **Core scripts:**
|
||||
|
||||
```bash
|
||||
npm run format # normalize CSS/HTML/MD/Config sources with Prettier + tailwindcss plugin
|
||||
npm run format # normalize CSS/HTML/JS/MD sources with Prettier + tailwindcss plugin
|
||||
npm run lint:css # enforce design token usage and guard against raw hex colors
|
||||
npm run build # run the full production build (generates dist/ and css/tailwind.generated.css)
|
||||
npm run build # run the Tailwind build locally (output remains gitignored)
|
||||
```
|
||||
|
||||
- **No hard-coded colors:** Follow the token-first rules in `AGENTS.md`—reach
|
||||
@@ -328,10 +296,10 @@ package scripts to keep formatting, linting, and generated output consistent:
|
||||
```bash
|
||||
npm install # install Prettier, Stylelint, and Tailwind toolchain
|
||||
npm run format # format CSS/HTML/MD with Prettier + tailwindcss plugin
|
||||
npm run lint # run CSS, hex, inline-style, tokens, Tailwind, file-size, innerHTML, assets, and SW compat guards
|
||||
npm run lint # run CSS, hex color, inline-style, design-token, and Tailwind color/bracket guards in one pass
|
||||
npm run lint:css # enforce token usage and forbid raw hex colors
|
||||
npm run lint:inline-styles # fail CI if inline style attributes or element.style usage slip in
|
||||
npm run build # run the full production build (cleans dist/, runs build:css, and copies assets)
|
||||
npm run build # run the Tailwind build (delegates to npm run build:css)
|
||||
npm run build:beacon # bundle torrent/dist assets and re-run the inline-style guard
|
||||
npm run build:beacon:bundle # bundle beacon assets without running the guard (rarely needed)
|
||||
```
|
||||
@@ -344,7 +312,7 @@ commands from the repo root:
|
||||
1. Install dependencies (only required after cloning or when packages change):
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
npm install
|
||||
```
|
||||
|
||||
2. Rebuild the Tailwind bundle for local verification (the output stays
|
||||
@@ -358,46 +326,6 @@ The generated `css/tailwind.generated.css` artifact is ignored in git. CI
|
||||
workflows and Netlify deploys run `npm run build` to produce the compiled
|
||||
stylesheet during deployment, so source changes are all you need to commit.
|
||||
|
||||
Deploy targets must publish the `dist/` directory as the web root (never the
|
||||
repository root). CI enforces deploy artifact integrity with
|
||||
`npm run verify:dist:deploy-artifact` immediately after `npm run build`, and
|
||||
hosts that support a publish/output directory (for example Netlify and Vercel)
|
||||
should be configured to use `dist`.
|
||||
|
||||
#### Netlify cache policy for safe fast rollouts
|
||||
|
||||
bitvid uses path-class cache rules so deployments propagate quickly without
|
||||
breaking long-term static asset caching:
|
||||
|
||||
- `index.html`, `embed.html`, and other `*.html` shell pages are served with
|
||||
`Cache-Control: no-cache, must-revalidate` so clients always revalidate the
|
||||
app entry document before booting a new session.
|
||||
- Hashed bundles under `/css/*` and `/js/*` are served with
|
||||
`Cache-Control: public, max-age=31536000, immutable` so browsers and CDNs can
|
||||
keep them for a year with zero revalidation churn.
|
||||
- Service-worker-related files (`/sw.min.js`, `/site.webmanifest`) use short,
|
||||
revalidation-friendly cache controls (`max-age=0, must-revalidate`) so rollout
|
||||
metadata and worker updates are picked up promptly.
|
||||
|
||||
This split is required for safe fast rollouts: HTML needs rapid update pickup,
|
||||
while fingerprinted static assets should remain aggressively cacheable for
|
||||
performance and cost control.
|
||||
|
||||
> Migration note: runtime `ASSET_VERSION` query-parameter mutation has been
|
||||
> removed. Static asset freshness now comes from build-time hashed filenames
|
||||
> recorded in `dist/asset-manifest.json` and rewritten into `dist/index.html`
|
||||
> / `dist/embed.html` during `npm run build`.
|
||||
|
||||
#### Service worker rollback playbook
|
||||
|
||||
If a deploy regresses playback and you suspect `sw.min.js`, use this rollback runbook:
|
||||
|
||||
1. **Freeze impact**: redeploy the last known-good commit so clients fetch the previous worker script immediately.
|
||||
2. **Invalidate active workers**: from DevTools > Application > Service Workers, click **Unregister** for `sw.min.js` and hard reload once to verify playback without stale worker state.
|
||||
3. **Confirm claim flow**: in the browser console, confirm worker lifecycle messages (`BITVID_SW_LIFECYCLE`) appear and that requests to `/webtorrent/*` carry the `X-Bitvid-SW-Version` response header.
|
||||
4. **Check compatibility guardrails**: run `npm run lint:sw-compat` before shipping the fix. This fails deploys when service-worker runtime paths/scope changes are not accompanied by `_headers`, `index.html`, and `embed.html` updates in the same commit.
|
||||
5. **Redeploy + monitor**: publish the fix, then replay the URL-first fallback QA script in `docs/qa.md` and capture logs/screenshots in the PR.
|
||||
|
||||
Inline styles are intentionally blocked. `npm run lint:inline-styles` scans HTML
|
||||
and scripts for `style=` attributes, `element.style`, or `style.cssText` usage
|
||||
and will fail CI until offending markup is moved into the shared CSS/token
|
||||
@@ -458,14 +386,13 @@ call the facade to keep API surfaces consistent.
|
||||
|
||||
### Nostr video fetch limits
|
||||
|
||||
The `nostrClient` uses `subscribeVideos(callback, options)` for the main feed to support buffering and streaming. It accepts an optional `options.limit` to control how many video events are requested per relay. The request size defaults
|
||||
`nostrClient.fetchVideos(options)` now accepts an optional `options.limit` to
|
||||
control how many video events are requested per relay. The request size defaults
|
||||
to `DEFAULT_VIDEO_REQUEST_LIMIT` (150) and is clamped to
|
||||
`MAX_VIDEO_REQUEST_LIMIT` (500) to avoid accidental firehose requests as the
|
||||
network grows. Use a smaller limit for lightweight surfaces or a larger value
|
||||
when running batch jobs that can tolerate additional load.
|
||||
|
||||
`nostrClient.fetchVideos(options)` is a legacy wrapper around subscription and is deprecated.
|
||||
|
||||
The build command compiles Tailwind with `tailwind.config.cjs`, runs it through
|
||||
the PostCSS pipeline defined in `postcss.config.cjs` (for autoprefixing), and
|
||||
emits the purged, minified stylesheet at `css/tailwind.generated.css`. That
|
||||
@@ -502,11 +429,8 @@ artifacts now that the deploy pipeline owns the build step.
|
||||
preparing a new deployment.
|
||||
- See [`docs/instance-config.md`](docs/instance-config.md) for a full
|
||||
reference of every setting and how to tune it.
|
||||
- `IS_DEV_MODE` and `IS_VERBOSE_DEV_MODE` default to `false` for production.
|
||||
If you need dev logging in a staging or QA build without editing source,
|
||||
inject `window.__BITVID_DEV_MODE_OVERRIDE__` and/or
|
||||
`window.__BITVID_VERBOSE_DEV_MODE_OVERRIDE__` before `js/config.js` loads.
|
||||
The flag flows into `js/config.js` as `isDevMode`, seeds the
|
||||
- Flip `IS_DEV_MODE` to `false` before shipping production builds. The flag
|
||||
flows into `js/config.js` as `isDevMode`, seeds the
|
||||
`window.__BITVID_DEV_MODE__` global for inline scripts, and gates whether the
|
||||
dev logging channel emits to the console. See
|
||||
[`docs/logging.md`](docs/logging.md) for rollout guidance.
|
||||
@@ -567,24 +491,16 @@ Please see [`CONTRIBUTING.md`](./CONTRIBUTING.md) for detailed setup instruction
|
||||
## Testing
|
||||
|
||||
Continuous integration runs CSS linting/builds, the DM unit/integration suites, the Playwright kitchen-sink snapshots, headless E2E flows, and the Node-based unit tests on every push.
|
||||
|
||||
Before pushing, run `npm run build` locally so the Tailwind bundle regenerates.
|
||||
|
||||
- **Unit Tests**: Run `npm run test:unit` for application logic changes.
|
||||
- _Tip_: Use `npm run test:unit:shard1`, `shard2`, or `shard3` for faster local feedback.
|
||||
- Custom shards: `cross-env UNIT_TEST_SHARD=1/3 node scripts/run-unit-tests.mjs` or pass `--shard=1/3`.
|
||||
- Timeout override: `cross-env UNIT_TEST_TIMEOUT_MS=120000` to abort stalled files.
|
||||
|
||||
- **Visual Regression**: Run `npm run test:visual` to verify UI presentation against baselines.
|
||||
- Update baselines: `npm run test:visual:update`.
|
||||
|
||||
- **Direct Messages**: Run `npm run test:dm:unit` and `npm run test:dm:integration` for DM flows.
|
||||
|
||||
- **End-to-End**:
|
||||
- `npm run test:e2e` runs deterministic Playwright journeys on Chromium + Firefox.
|
||||
- `npm run test:e2e:chromium` / `npm run test:e2e:firefox` runs a single browser target.
|
||||
- `npm run test:e2e:extension` runs the opt-in Chromium extension suite (set `PLAYWRIGHT_EXTENSION_PATH` and optionally `PLAYWRIGHT_ENABLE_EXTENSION_E2E=1`).
|
||||
- Recommendations/roadmap: `docs/testing/playwright-integration-recommendations-2026-02-22.md`
|
||||
Pair that with `npm run test:unit` for application logic changes, or a shard
|
||||
(`npm run test:unit:shard1`, `test:unit:shard2`, `test:unit:shard3`) when you want to
|
||||
split the suite. You can also set `UNIT_TEST_SHARD=1/3` or pass `--shard=1/3`
|
||||
to `scripts/run-unit-tests.mjs` for custom shard splits, and use
|
||||
`UNIT_TEST_TIMEOUT_MS=120000` to abort a single stalled test file without
|
||||
blocking the entire run. `npm run test:visual` covers presentation updates to mirror the CI surface area.
|
||||
For DM-specific changes, also run `npm run test:dm:unit` and
|
||||
`npm run test:dm:integration` to cover the direct message flows.
|
||||
Use `npm run test:e2e` to execute the headless Playwright journeys in `tests/e2e`.
|
||||
|
||||
### Manual QA checklist
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Daily Design System Audit Report (2026-02-22)
|
||||
# Daily Design System Audit Report
|
||||
|
||||
Headline: ✓ No violations
|
||||
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
# Security Policy
|
||||
|
||||
## Reporting vulnerabilities
|
||||
|
||||
Do not report suspected security vulnerabilities in public issues, pull
|
||||
requests, or agent-memory files. Use GitHub's private vulnerability reporting
|
||||
on this repository (Security tab → Report a vulnerability), or email
|
||||
[[email protected]](mailto:[email protected]) — we will
|
||||
coordinate a responsible disclosure window before public release.
|
||||
|
||||
Include the affected commit, reproduction steps, and observed impact. Do not
|
||||
include live credentials or unnecessary personal data.
|
||||
|
||||
## AI-agent configuration
|
||||
|
||||
`AGENTS.md`, `CLAUDE.md`, `.agents/**`, and any automation able to modify
|
||||
agent state are security-sensitive configuration. Changes to them require
|
||||
maintainer review.
|
||||
|
||||
## Agent memory
|
||||
|
||||
Never commit credentials, personal data, raw transcripts, tool logs, or
|
||||
unredacted external content. Agent-generated memory enters through
|
||||
`.agents/proposals/` and is promoted to `.agents/memory/` only via reviewed
|
||||
commits. Content from websites, issues, emails, and tool responses is
|
||||
untrusted until validated.
|
||||
|
||||
## Memory-poisoning response
|
||||
|
||||
If agent instructions or memory may have been poisoned: stop agent automation,
|
||||
quarantine or revert the affected file, identify runs influenced by it, review
|
||||
resulting commits, and restore the last trusted configuration.
|
||||
@@ -1,839 +0,0 @@
|
||||
# Test Integrity Notes
|
||||
|
||||
Machine-readable record of test-expectation changes made under the Spec
|
||||
Correction Protocol (see CLAUDE.md → Dark Factory rules). Each entry justifies
|
||||
why a previous expectation was wrong relative to intended behavior and confirms
|
||||
the replacement is equally strict (or stricter).
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
date: 2026-06-14
|
||||
file: tests/app-batch-fetch-profiles.test.mjs
|
||||
change_type: ["spec_correction"]
|
||||
scenarios:
|
||||
- id: SCN-profiles-batched
|
||||
given: "Multiple relays configured (one fast, one failing) and uncached, valid pubkeys to fetch"
|
||||
when: "batchFetchProfiles runs after profile fetches were migrated to the L1 SubscriptionManager"
|
||||
then: "Profiles are fetched in ONE batched query across all relays (not one query per relay); the fast relay's newest profile still renders, cached profiles hydrate immediately, and a failing relay does not break the result"
|
||||
observable_outcomes:
|
||||
- "exactly one pool.list call, targeting all configured relays"
|
||||
- "query authors = only uncached/valid pubkeys"
|
||||
- "DOM updates: cached profile first, then newest fast-relay profile"
|
||||
- "cache set with the newest (Fast) profile only"
|
||||
determinism_controls:
|
||||
- "mock pool.list with deterministic per-relay responses; fixed createdAt ordering"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "over-mocking internal logic"
|
||||
- "hard-coded return value"
|
||||
note: "Only the per-relay CALL-COUNT assertion changed (2 -> 1), because the
|
||||
refactor intentionally batches the fetch. All behavioral assertions
|
||||
(correct/newest profile rendered, cached hydration, failing relay
|
||||
tolerated) are unchanged, and a new assertion verifies the single batched
|
||||
query targets all relays — so coverage is equal or stronger."
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
date: 2026-06-14
|
||||
files:
|
||||
- tests/relay-subscribe-cap.test.mjs
|
||||
- tests/user-blocks.test.mjs
|
||||
- tests/subscriptions-manager.test.mjs
|
||||
- tests/nostr/client.test.mjs
|
||||
change_type: ["spec_correction"]
|
||||
scenarios:
|
||||
- id: SCN-relay-reads-bounded
|
||||
given: "A user's NIP-65 read set (in prod often ~20 relays, most dead) and a
|
||||
cold login that must decrypt encrypted lists (blocks, subs, hashtags) via
|
||||
the nip-07 extension"
|
||||
when: "Reads/subscriptions are built via capReadRelays — the user's own
|
||||
relays first, with RESERVED_DEFAULT_RELAY_SLOTS reserved for reliable
|
||||
default aggregators, bounded to MAX_SUBSCRIBE_RELAYS=8; writes stay
|
||||
uncapped"
|
||||
then: "Every configured relay is still queried when the user's set is small
|
||||
(data lives on the user's own relays); the distinct read fan-out never
|
||||
exceeds 8 (so a large dead list can't storm the pool and starve nip-07
|
||||
decryption); at least the reserved reliable defaults remain reachable even
|
||||
when the user supplied none; write reach is unchanged and defaults are NOT
|
||||
injected into writes"
|
||||
observable_outcomes:
|
||||
- "read/subscribe relay set length <= 8"
|
||||
- "writeRelays == full configured set; no default injected into writes"
|
||||
- ">= RESERVED_DEFAULT_RELAY_SLOTS reliable defaults present in the read set"
|
||||
- "user-blocks: every configured relay queried; fast-then-full background
|
||||
ordering preserved; block list hydrates from the background relay payload"
|
||||
- "subscriptions-manager: every configured relay queried even when one
|
||||
rejects; only the newest event decrypted"
|
||||
- "nostr/client: same events arriving from multiple seeded relays still
|
||||
dedupe to the expected set; relay fan-out bounded"
|
||||
determinism_controls:
|
||||
- "deterministic per-relay mock pool.list responses; fixed created_at ordering"
|
||||
- "capReadRelays is test-aware: the reserved core resolves to the test-relay
|
||||
override under test, keeping harnesses isolated from prod default URLs"
|
||||
- "tests set nostrClient.readRelays to the user's relays to mirror the
|
||||
logged-in state applyRelayPreferences establishes in prod (the fetcher ranks
|
||||
candidates by read preference)"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "hard-coded return value"
|
||||
- "over-mocking internal logic"
|
||||
- "retry/sleep-based flake masking"
|
||||
note: "Only incidental EXACT relay-count assertions were loosened to BOUNDS
|
||||
(<=8) because the storm fix intentionally adds a small reliable-default
|
||||
backstop to the read set. Every behavioral assertion (correct/newest event
|
||||
decrypted, block hydration from the right relay, dedup correctness, per-relay
|
||||
coverage, writes uncapped) is unchanged or strengthened — coverage is equal
|
||||
or stronger, and new assertions pin the reserved-defaults liveness guarantee."
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: "Exact-count assertions became bounded-count
|
||||
assertions, but this reflects intended new behavior (reliable-default
|
||||
backstop) rather than weakening a real correctness check; coverage of the
|
||||
actual security/decrypt behavior is preserved."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
date: 2026-06-23
|
||||
file: tests/nip71-mirror-flags.test.mjs
|
||||
change_type: ["spec_correction"]
|
||||
scenarios:
|
||||
- id: SCN-mirror-delete-unconditional
|
||||
given: "A video that was shared to NIP-71 on one device/session, then deleted from another device (or after the per-video opt-in flag — browser-local localStorage — was cleared)"
|
||||
when: "resolveDeleteSync runs during delete with FEATURE_NIP71_MIRROR on but the local enabled flag false/absent"
|
||||
then: "The mirror teardown (NIP-09 + empty tombstone, idempotent) is still attempted, so the NIP-71 mirror is not orphaned on other apps; the feature flag still fully gates it"
|
||||
observable_outcomes:
|
||||
- "resolveDeleteSync({featureOn:true, enabled:false|undefined}) -> {action:'unshare'}"
|
||||
- "resolveDeleteSync({featureOn:false, ...}) -> {action:'none'} (feature flag still gates)"
|
||||
determinism_controls:
|
||||
- "pure function; explicit input matrix"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "hard-coded return value"
|
||||
note: "The previous expectation (enabled:false -> none) encoded the bug: it
|
||||
gated teardown on a browser-local flag, orphaning the mirror across devices.
|
||||
The corrected spec is STRICTER — teardown fires whenever the feature is on —
|
||||
and adds the enabled:undefined case. The feature-flag gate assertion is
|
||||
retained, so no real gate was weakened."
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
date: 2026-06-23
|
||||
file: tests/nostr-delete-flow.test.mjs
|
||||
change_type: ["spec_correction", "refactor_tests"]
|
||||
scenarios:
|
||||
- id: SCN-delete-surfaces-relay-failures
|
||||
given: "A logged-in delete where one write relay rejects the kind-5 deletion"
|
||||
when: "deleteAllVersions publishes to the WRITE set via getDeletePublishRelays() (the afb6200b relay-scope fix)"
|
||||
then: "The delete summary surfaces the failing relay"
|
||||
- id: SCN-buffered-feed-tombstone-guard
|
||||
given: "A delete event seeds a tombstone, then an OLDER non-deleted event for the same root arrives on the live stream"
|
||||
when: "events flow through the real VideoEventBuffer (the path subscribeVideos builds via the SubscriptionManager), not the removed direct pool.sub() injection"
|
||||
then: "The older event is tombstone-guarded (marked deleted, kept out of activeMap) and never surfaces as a LIVE video; a deletion event surfaces marked deleted:true so the UI removes the card"
|
||||
observable_outcomes:
|
||||
- "deleteSummary.summary.failed identifies wss://relay.fail (writeRelays now configured so the injected failure is exercised)"
|
||||
- "no callback video with the deleted/older event id and deleted:false"
|
||||
- "client.activeMap cleared for the root; tombstone advanced; stored event marked deleted"
|
||||
determinism_controls:
|
||||
- "videoEventVerifier virtualizes the off-thread signature worker (all events valid)"
|
||||
- "buffer.scheduleFlush(true) awaited for synchronous commit"
|
||||
- "real NostrClient + real VideoEventBuffer (no mocked tombstone guard)"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "over-mocking internal logic"
|
||||
- "snapshot rubber-stamping"
|
||||
note: "Two corrections. (1) The file used bare assert + top-level await, so the
|
||||
unit runner (which requires a node:test import) SILENTLY EXCLUDED it — it had
|
||||
rotted and was failing on main unnoticed. Converted to node:test so it runs
|
||||
in CI. (2) The relay-failure test set only client.relays, but deletes moved to
|
||||
the write set (getDeletePublishRelays); it now sets writeRelays so the
|
||||
injected failure is actually exercised — the assertion was previously passing
|
||||
vacuously. (3) The subscription assertions drove the REMOVED pool.sub() path
|
||||
and expected 'no callback at all' for deleted events; the current
|
||||
VideoEventBuffer intentionally surfaces deleted events marked deleted:true so
|
||||
the UI can remove the card. Rewritten to drive the real buffer + real client
|
||||
and assert the stricter, accurate invariant (never surfaces as LIVE; guarded
|
||||
and removed from activeMap). Coverage is stronger: the buffer's own unit test
|
||||
mocks the client's tombstone guard, whereas this exercises the real guard."
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
date: 2026-06-23
|
||||
file: tests/watch-history.test.mjs
|
||||
change_type: ["spec_correction"]
|
||||
scenarios:
|
||||
- id: SCN-watch-history-partial-acceptance-durable
|
||||
given: "A logged-in user snapshots watch history to 3 write relays where 2 accept and 1 rejects (single attempt, no escalation)"
|
||||
when: "watchHistoryService.snapshot runs after the 565a9618 fix (a snapshot is durable as soon as ANY relay accepts; reads take the newest event per d-tag)"
|
||||
then: "The snapshot SUCCEEDS — it does not throw, the result is ok and not retryable, no republish is scheduled, the month result is flagged partial with the accepting/rejecting relays captured, and the pointer queue is emptied (the pointer was durably published)"
|
||||
- id: SCN-watch-history-logged-in-not-session
|
||||
given: "A logged-in user (nostrClient.pubkey set) records a watch and the entry is published and re-loaded"
|
||||
when: "publishView resolves the owning actor as the logged-in pubkey and sets the session flag only when nobody is logged in"
|
||||
then: "The round-tripped entry is NOT flagged session=true (it is the logged-in user's history, not a local-only session entry); the queue files under the logged-in pubkey so getQueuedPointers(actor) sees it"
|
||||
observable_outcomes:
|
||||
- "snapshot() resolves (does not throw); result.ok === true; result.retryable === false"
|
||||
- "scheduleWatchHistoryRepublish NOT called"
|
||||
- "result.results[0].partial === true; relayStatus.pointer shows relay.one/two accepted, relay.three rejected"
|
||||
- "getQueuedPointers(actor).length === 0 after a successful snapshot"
|
||||
- "resolvedItems[0].session !== true for a logged-in user"
|
||||
determinism_controls:
|
||||
- "poolHarness resolver with a fixed accept/reject plan per relay url"
|
||||
- "session crypto + recordVideoView virtualized; stable relay set"
|
||||
- "logged-in pubkey aligned with the queried actor (matches the convention used by the other tests in the file)"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "snapshot rubber-stamping"
|
||||
- "hard-coded return value"
|
||||
note: "Three corrections in this file, all matching shipped behavior. (1) The
|
||||
partial-acceptance test asserted the INVERSE of intended behavior — that
|
||||
snapshot() THROWS on partial acceptance and retries until EVERY relay accepts —
|
||||
encoding exactly the all-relays false-failure bug 565a9618 fixed. Rewritten to
|
||||
the success path (no throw, partial flag, per-relay status, queue drained, no
|
||||
spurious republish). (2) testWatchHistoryServiceIntegration set the logged-in
|
||||
pubkey to a value DIFFERENT from the actor it queried; since watch history now
|
||||
files under the logged-in pubkey, the queue assertions looked at the wrong key.
|
||||
Aligned pubkey to the queried actor (the convention every other test uses) — a
|
||||
setup fix, no assertion weakened. (3) The same test asserted session===true for
|
||||
a logged-in watch, which is the pre-fix bug (logged-in watches were wrongly
|
||||
flagged session by comparing against the view actor); corrected to session!==true
|
||||
per the current rule that session marks only logged-out, local-only entries.
|
||||
With these the full file is green and was REMOVED from the run-unit-tests
|
||||
QUARANTINE."
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
date: 2026-06-23
|
||||
files:
|
||||
- tests/zap-shared-state.test.mjs
|
||||
- tests/video-modal-zap.test.mjs
|
||||
change_type: ["spec_correction", "refactor_tests"]
|
||||
scenarios:
|
||||
- id: SCN-platform-fee-unparseable-override
|
||||
given: "An unparseable platform-fee override value (e.g. 'not-a-number') with PLATFORM_FEE_PERCENT configured > 0"
|
||||
when: "resolvePlatformFeePercent runs"
|
||||
then: "It falls back to the configured platform default (getDefaultPlatformFeePercent), NOT to 0 — a junk override cannot silently disable/bypass the platform fee"
|
||||
- id: SCN-zap-completion-state-resets-then-completes
|
||||
given: "A zap whose receipts validate to a warning (awaiting validated receipt)"
|
||||
when: "sendZap runs"
|
||||
then: "The modal completion state is reset to false at the start of the send and set true at the terminal path, so two completion-state changes are recorded and the end state is true"
|
||||
- id: SCN-zap-receipts-render-into-controller-element
|
||||
given: "VideoModal.renderZapReceipts called with one validated (or one failed) receipt"
|
||||
when: "rendering delegates to the inner zapController"
|
||||
then: "Exactly one entry is rendered into the controller's modalZapReceipts element"
|
||||
observable_outcomes:
|
||||
- "resolvePlatformFeePercent('not-a-number') === getDefaultPlatformFeePercent() (> 0)"
|
||||
- "completedStates grows by 2 (false then true) on a completing send; end state true"
|
||||
- "controller.modalZapReceipts.children.length === 1 per rendered receipt"
|
||||
determinism_controls:
|
||||
- "pure fee function with explicit inputs; configured PLATFORM_FEE_PERCENT read via getDefaultPlatformFeePercent (not hard-coded)"
|
||||
- "modal stub records setZapCompleted/resetZapForm calls; DummyElement DOM"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "hard-coded return value"
|
||||
- "over-mocking internal logic"
|
||||
note: "Three corrections, all to match shipped behavior. (1) The fee-fallback test
|
||||
asserted 0; the function correctly falls back to the configured platform default
|
||||
so a garbage override cannot zero out (bypass) the fee — corrected to assert
|
||||
against getDefaultPlatformFeePercent and that the result is > 0 (STRICTER: pins
|
||||
the no-bypass guarantee). (2) The completion-count test asserted +1; sendZap
|
||||
legitimately resets completed=false at the start of every send and sets true at
|
||||
the terminal path (+2), with the end-state==true assertion retained as the real
|
||||
invariant. (3) The receipt-render tests set modalZapReceipts on the outer
|
||||
VideoModal, but rendering was refactored to delegate to the inner zapController
|
||||
which owns that element — set/assert on the controller's element (a harness fix,
|
||||
no assertion weakened). NOTE: these accompany three PRODUCTION bug fixes found
|
||||
via the same tests — NWC getPublicKey hex->bytes (connection was broken), the
|
||||
in-flight 'Sending…' status mis-toned as warning, and the success path not using
|
||||
the holistic resetZapForm."
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
date: 2026-06-23
|
||||
file: tests/video-modal-zap.test.mjs
|
||||
change_type: ["spec_correction"]
|
||||
scenarios:
|
||||
- id: SCN-zap-paid-but-receipt-unconfirmed-is-success
|
||||
given: "A zap share whose PAYMENT succeeded (NWC returned a preimage) but whose kind-9735 zap receipt could not be validated on the advertised relays"
|
||||
when: "sendZap finishes"
|
||||
then: "It is reported as a SUCCESS (Sent N sats) with a soft note that the on-relay receipt couldn't be confirmed — NOT as a warning/error. The form resets and the attempt is marked completed."
|
||||
observable_outcomes:
|
||||
- "last zap status tone === 'success' (was 'warning')"
|
||||
- "status message matches /sent 750 sats/i and /couldn't confirm the zap receipt/i (was /awaiting validated zap receipt/i)"
|
||||
- "receipts rendered in partial mode; form reset; completedStates +2 ending true"
|
||||
determinism_controls:
|
||||
- "injected splitAndZap returns a paid receipt (status:success, payment.preimage) with validation.status:'failed'"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "snapshot rubber-stamping"
|
||||
- "hard-coded return value"
|
||||
note: "The previous expectation asserted the BUG: a paid share whose 9735 receipt
|
||||
wasn't found was surfaced as a 'warning' error ('Awaiting validated zap receipt')
|
||||
and routed through notifyError — telling users a SUCCESSFUL zap had failed
|
||||
(confirmed live: the platform fee landed but the UI showed a red error). The NWC
|
||||
payment preimage is proof the invoice was paid; the 9735 receipt is supplementary
|
||||
and is commonly not seen by a static client (relay coverage/timing). Corrected to
|
||||
assert success-with-a-soft-note. Genuine PAYMENT failures (status !== 'success')
|
||||
still go through the failure/retry path, unchanged."
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
date: 2026-06-23
|
||||
file: tests/zap-split.test.mjs
|
||||
change_type: ["spec_correction"]
|
||||
scenarios:
|
||||
- id: SCN-zap-receipt-found-by-indexed-tags
|
||||
given: "A published kind-9735 zap receipt for a video zap (the zap request carries #p recipient + #e event tags)"
|
||||
when: "validateZapReceipt queries relays for the receipt"
|
||||
then: "It filters by the reliably-indexed #e + #p tags (not #bolt11, which most relays don't index), then confirms via author pubkey + bolt11 + description hash"
|
||||
observable_outcomes:
|
||||
- "the relay query filter has filters[0]['#e'] === [eventId] and ['#p'] === [recipient]"
|
||||
- "filters[0]['#bolt11'] is absent"
|
||||
- "a matching receipt still validates as status:'passed'"
|
||||
determinism_controls:
|
||||
- "mock SimplePool.list captures the filter; fixed zap request tags + test bolt11 with matching description hash"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "snapshot rubber-stamping"
|
||||
- "over-mocking internal logic"
|
||||
note: "The previous test asserted filters[0]['#bolt11'][0] === invoice — encoding the
|
||||
bug. Relays generally do not index arbitrary tags like bolt11, so that query found
|
||||
nothing and a successfully-paid zap was reported as having no receipt. Corrected to
|
||||
assert the reliably-indexed #e/#p anchors (added an #e tag to the request to model a
|
||||
real video zap). The receipt-matching assertions (passed status, correct event,
|
||||
checked relays) are unchanged/retained — coverage is stronger, not weaker."
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
date: 2026-06-24
|
||||
file: tests/view-counter.test.mjs
|
||||
change_type: ["spec_correction", "flake_fix"]
|
||||
scenarios:
|
||||
- id: SCN-view-counter-legacy-path
|
||||
given: "The view-counter unit harness mocks the legacy per-pointer view APIs (list/count/subscribe) on the singleton client"
|
||||
when: "A pointer is subscribed and hydrated"
|
||||
then: "viewCounter exercises the legacy per-pointer hydrate/subscribe path (the one viewCounter.js explicitly designates 'for tests / mocks'), so the mocked APIs actually fire"
|
||||
- id: SCN-view-counter-dedupe-window-aligned
|
||||
given: "Two views by the same viewer within one fixed dedupe window"
|
||||
when: "Counted"
|
||||
then: "They dedupe to one (floor(created_at/window) bucket, matching the replaceable view-event d-tag)"
|
||||
observable_outcomes:
|
||||
- "hydration triggers a list()/count() call (legacy path) instead of the batched SubscriptionManager path silently taking over"
|
||||
- "two same-pubkey views in one aligned bucket yield total === 1"
|
||||
determinism_controls:
|
||||
- "nostrClient.getSubscriptionManager pinned to () => null so the path is deterministic"
|
||||
- "the dedupe test's base timestamp is aligned to a window-bucket boundary (was Date.now(), which made the +window/2 offset straddle a boundary depending on time of day)"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "over-mocking internal logic"
|
||||
- "retry/sleep-based flake masking"
|
||||
note: "The batched SubscriptionManager path was added later (relay-storm work); the
|
||||
test mocks the legacy APIs but never pinned getSubscriptionManager, so the real
|
||||
singleton's manager took over and the mocks never fired. Pinning it to null restores
|
||||
the intended (and code-designated 'tests/mocks') legacy-path coverage. The dedupe
|
||||
assertion (count === 1) is unchanged — only its setup was made deterministic."
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
date: 2026-06-24
|
||||
file: tests/view-counter.test.mjs
|
||||
change_type: ["spec_correction"]
|
||||
scenarios:
|
||||
- id: SCN-hydrate-root-timestamp
|
||||
given: "A latest video revision whose root event is fetched by hydrateVideoHistory"
|
||||
when: "History is hydrated, then the timestamp-sync step runs"
|
||||
then: "rootCreatedAtByRoot caches the earliest (root) created_at, AND the active video's rootCreatedAt FIELD is set by syncActiveVideoRootTimestamp"
|
||||
observable_outcomes:
|
||||
- "nostrClient.rootCreatedAtByRoot.get(rootId) === root.created_at (hydrateVideoHistory's direct output)"
|
||||
- "after syncActiveVideoRootTimestamp(...), latestVideo.rootCreatedAt === root.created_at"
|
||||
determinism_controls:
|
||||
- "pool.get returns a fixed root event; rootCreatedAtByRoot seeded empty"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "snapshot rubber-stamping"
|
||||
note: "hydrateVideoHistory's contract is to populate the per-root created_at MAP; the
|
||||
video OBJECT's rootCreatedAt field is applied by a separate util
|
||||
(syncActiveVideoRootTimestamp) after a refactor moved that unit boundary. The test
|
||||
previously expected hydrateVideoHistory to mutate the passed object directly, which it
|
||||
no longer does. Corrected to assert the map (its real output) and to drive the sync
|
||||
util for the field — stronger, not weaker (it now exercises the full real pipeline)."
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2026-06-25 — todo-11b triage: un-quarantine nostr-boost-actions + admin-list-store
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
change_type: ["spec_correction", "refactor_tests"]
|
||||
scenarios:
|
||||
- id: SCN-repost-optional-relay
|
||||
given: "A repost is built with no relay hint available (buildRepostEvent, nostrEventSchemas.js)"
|
||||
when: "buildRepostEvent({ eventId, authorPubkey, targetKind }) is called without eventRelay"
|
||||
then: "It returns a VALID repost (kind 16 for a non-kind-1 target, two-element ['e', id] tag, ['p', author], ['k', kind]) instead of throwing"
|
||||
- id: SCN-community-blacklist-merge-batched
|
||||
given: "An admin community-blacklist sources list references two curator kind-30000 lists, each with p-tag members"
|
||||
when: "loadAdminState() runs and fetches curator lists via the BATCHED SubscriptionManager path"
|
||||
then: "adminState.blacklist merges the curator members with the direct entry (deduped, guards respected)"
|
||||
observable_outcomes:
|
||||
- "buildRepostEvent output shape (kind/tags) with no relay — asserted exactly, stricter than the old throws-check"
|
||||
- "adminState.blacklist === [direct, communityMemberOne, communityMemberTwo]"
|
||||
determinism_controls:
|
||||
- "pure builder (no IO) for repost; in-memory list registry + mocked pool.list AND getSubscriptionManager for the admin store"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "hard-coded return value"
|
||||
- "over-mocking internal logic"
|
||||
note: |
|
||||
nostr-boost-actions: STALE SPEC. The test required buildRepostEvent to throw
|
||||
/missing-event-relay/ when no relay hint is given, but a relay hint is a NIP-18
|
||||
SHOULD (not MUST). The builder intentionally degrades to a two-element `e` tag so a
|
||||
user can always repost. Replaced the throws-assertion with an EXACT assertion of the
|
||||
valid output (kind 16 + e/p/k tags) — strictly stronger.
|
||||
|
||||
admin-list-store: STALE HARNESS, no production change, no assertion weakened. Three
|
||||
fidelity fixes so the test exercises the real batched community-blacklist path:
|
||||
(1) curator lists are now fetched via the batched SubscriptionManager (cold-start
|
||||
relay-storm fix), which the harness didn't mock — added a getSubscriptionManager().list
|
||||
mock serving the same registry; (2) curator coordinates now use REAL 64-char hex
|
||||
pubkeys (the old mock-"hex" started with "npub", so parseCommunityBlacklistReferences'
|
||||
isHexPubkey()/npub branch decoded them twice and the batched filter no longer matched);
|
||||
(3) createListEvent now emits a `d` tag (real kind-30000 lists always have one;
|
||||
selectNewestEventsForReferences matches curator events to references by their d tag).
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
## 2026-07-05 — todo-11b final: un-quarantine nwc-client (+ user-blocks / nostr-publish-rejection hangs)
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
change_type: ["spec_correction", "refactor_tests", "flake_fix"]
|
||||
scenarios:
|
||||
- id: SCN-nwc-unsupported-encryption-scheme
|
||||
given: "An NWC wallet whose info event (kind 13194) advertises ONLY an encryption scheme bitvid does not implement (nip44_v3)"
|
||||
when: "ensureEncryptionForContext(context) negotiates a scheme"
|
||||
then: "It rejects with message /Wallet advertises unsupported encryption schemes: nip44_v3\\./ AND error.code === 'UNSUPPORTED_ENCRYPTION'"
|
||||
- id: SCN-nwc-mock-toolkit-selection
|
||||
given: "Each nwc-client section installs a per-section window.NostrTools mock to drive encryption-scheme selection"
|
||||
when: "The nostr-tools bootstrap has installed its frozen canonical toolkit on the global scope"
|
||||
then: "Removing scope.__BITVID_CANONICAL_NOSTR_TOOLS__ lets readToolkitFromScope fall through to the section mock, so the wiring under test runs against the mock (not real @noble against fake keys)"
|
||||
observable_outcomes:
|
||||
- "ensureEncryptionForContext rejection message + error.code (UNSUPPORTED_ENCRYPTION) — asserted exactly"
|
||||
- "nip44_v2 section still resolves via the mock's nip44 (assert.match on the mock ciphertext shape)"
|
||||
determinism_controls:
|
||||
- "per-section in-memory window.NostrTools mocks; canonical-toolkit removal is deterministic (one-time, nothing re-installs it); no network"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "over-mocking internal logic"
|
||||
- "hard-coded return value"
|
||||
note: |
|
||||
nwc-client: TWO issues. (1) MOCK SHADOW (not a spec change): the bootstrap installs a
|
||||
frozen canonical toolkit that readToolkitFromScope() prefers over window.NostrTools, so
|
||||
the per-section mocks never took effect and real @noble ran against the fake test keys
|
||||
("bad point: is not on curve"). Deleting the scope canonical lets the resolver use each
|
||||
section's mock — the tests exercise the NWC client's encryption-SELECTION wiring, not
|
||||
@noble crypto (which is real elsewhere; the parseNwcUri hex-vs-bytes production bug is
|
||||
guarded by tests/nwc-parse-uri.test.mjs). (2) SPEC CORRECTION: one section asserted a
|
||||
rejection when the toolkit "lacks nip44" by omitting nip44 from the mock. That precondition
|
||||
is architecturally unreachable — the bootstrap's mergeWithCanonical ALWAYS backfills the
|
||||
canonical nip44 (even an explicit `nip44: null` is overwritten by `!merged.nip44`), so
|
||||
nip44_v2 is never an unsupported scheme. Replaced with a wallet advertising a scheme bitvid
|
||||
genuinely cannot provide (nip44_v3), exercising the SAME UNSUPPORTED_ENCRYPTION rejection
|
||||
via a reachable scenario, and strengthened the check to also assert error.code — strictly
|
||||
stronger than the old message-only match.
|
||||
|
||||
user-blocks + nostr-publish-rejection: FLAKE_FIX (no assertion changed). Both are
|
||||
bare-assert files that PASS all assertions then hang on lingering handles after completion
|
||||
(user-blocks: a never-resolving decrypt's background retry timer that manager.reset() doesn't
|
||||
cancel; nostr-publish-rejection: js/app.js + subscriptions + userBlocks module-load
|
||||
timers/connection managers). Applied the repo's established post-completion
|
||||
`setTimeout(() => process.exit(0), 50)` exit after cleanup. No behavior or expectation was
|
||||
altered — the process simply exits once the assertions have all run.
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
## 2026-07-05 — todo-11: uploadModal-reset zombie-callback test made deterministic (correct mock boundary)
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
change_type: ["flake_fix", "refactor_tests"]
|
||||
scenarios:
|
||||
- id: SCN-upload-zombie-callback-guard
|
||||
given: "An upload is in progress (videoUploadState.status === 'uploading') via a controllable pending mediaUploader.uploadVideo"
|
||||
when: "resetUploads() runs mid-upload (bumping videoUploadId), then the in-flight upload later resolves (a 'zombie' completion)"
|
||||
then: "The stale completion is ignored — status stays 'idle' and results.videoUrl stays '' — because handleVideoSelection guards on videoUploadId !== currentUploadId"
|
||||
observable_outcomes:
|
||||
- "videoUploadState.status: 'uploading' after start, 'idle' after reset, still 'idle' after the zombie resolve"
|
||||
- "results.videoUrl.value === '' after the zombie resolve"
|
||||
- "test exits 0 with no async-after-test activity (was leaking webtorrent/Blob errors)"
|
||||
determinism_controls:
|
||||
- "mediaUploader.uploadVideo replaced with a manually-resolved promise; captureVideoMetadata stubbed; jsdom DOM; no webtorrent, no network, no real Blob ops"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "over-mocking internal logic"
|
||||
- "retry/sleep-based flake masking"
|
||||
note: |
|
||||
FLAKE_FIX + REFACTOR_TESTS, no assertion weakened. The subtest PASSED its asserts but
|
||||
leaked async activity after the test ended, which node:test flags as a failure. Root
|
||||
cause: it mocked modal.generateTorrentMetadata / resolveUploadIdentifier, but
|
||||
handleVideoSelection drives the upload through this.mediaUploader.uploadVideo — a
|
||||
DIFFERENT object with its OWN helpers — so the mediaUploader still ran real
|
||||
createTorrentMetadata()/hashing on a synthetic {name:'video.mp4'} file ("invalid input
|
||||
type" async), and captureVideoMetadata() ran URL.createObjectURL(file) ("must be an
|
||||
instance of Blob"). Fixed by mocking at the correct DI boundary
|
||||
(modal.mediaUploader.uploadVideo returns the controllable pending promise) and stubbing
|
||||
captureVideoMetadata. The unit under test is the modal's videoUploadId zombie-guard, so
|
||||
mocking the uploader boundary is correct isolation, not over-mocking (real upload/torrent
|
||||
paths are covered by the mediaUploader / s3-upload suites).
|
||||
mutation_verification:
|
||||
- "Broke the guard (`if (this.videoUploadId !== currentUploadId) return` → `if (false)`) → the test FAILS ('State should remain idle after zombie completion', # fail 1). Reverted."
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
## 2026-07-05 — todo-11b: un-quarantine dm-block-filter (hermetic subscription; no force-exit)
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
change_type: ["flake_fix"]
|
||||
scenarios:
|
||||
- id: SCN-dm-block-filter-hermetic
|
||||
given: "The 'integration with loaded user block list' test loads standard + legacy block lists and filters incoming DMs"
|
||||
when: "manager.loadBlocks() runs against stubbed fetchListIncrementally, with the live block-list subscription stubbed out"
|
||||
then: "Both blocked contacts (standard + legacy) are filtered (dmMessages === [ALLOWED]) AND the process opens NO real relay sockets, so node:test exits naturally with the correct exit code"
|
||||
observable_outcomes:
|
||||
- "manager.isBlocked(legacy) && manager.isBlocked(standard) === true; dmMessages length 1 (ALLOWED only)"
|
||||
- "process.getActiveResourcesInfo() shows no TCPSocketWrap after loadBlocks; node exits 0 on pass, 1 on a forced failure (verified — failures NOT masked)"
|
||||
determinism_controls:
|
||||
- "stubbed nostrClient.fetchListIncrementally; truthy stub nostrClient.pool; no-op nostrClient.getSubscriptionManager; window.nostr.nip04.decrypt stub. All restored in finally. No network."
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "retry/sleep-based flake masking"
|
||||
- "over-mocking internal logic"
|
||||
note: |
|
||||
FLAKE_FIX, no assertion changed. The file PASSED all subtests then hung: loadBlocks()
|
||||
opens a LIVE block-list subscription through nostrClient's real SimplePool aimed at the
|
||||
test's fake relay URLs, leaking TCP sockets + reconnect timers that outlive the run so
|
||||
node:test never exits (surfaced only once the runner was given a per-file timeout).
|
||||
Diagnosed with process.getActiveResourcesInfo() — 4 TCPSocketWrap + reconnect Timeouts;
|
||||
NOT the decrypt-retry timer (verified absent). Nulling the pool did not help because
|
||||
loadBlocks calls ensurePool() (userBlocks.js:967) to re-create+connect a real pool when
|
||||
pool is falsy. Fix keeps the test hermetic: a TRUTHY stub pool (so ensurePool is skipped)
|
||||
+ a no-op getSubscriptionManager (so the subscription opens nothing). The block-merge
|
||||
logic under test still runs fully through the stubbed fetchListIncrementally. A force
|
||||
`process.exit` in an after() hook was explicitly REJECTED after verifying it masks real
|
||||
failures (process.exitCode is not set when the hook's timer fires — a deliberately broken
|
||||
assertion still exited 0 under that approach). Under this fix, the forced-failure control
|
||||
correctly exits 1.
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
# client-reliability-1
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
change_type: ["flake_fix", "new_tests"]
|
||||
scenarios:
|
||||
- id: SCN-profile-focus-style-contract
|
||||
given: "modal controls include visible, disabled, CSS-hidden, inherited-hidden, aria-hidden, hidden-input, and hidden-attribute cases"
|
||||
when: "the real controller collects focus targets using fixture and native JSDOM styles, and the user tabs from the last control"
|
||||
then: "both resolvers retain only visible enabled controls and Tab wraps to the first"
|
||||
observable_outcomes:
|
||||
- "focus target control IDs match the strict expected list"
|
||||
- "Tab is prevented and document.activeElement moves to the first control"
|
||||
- "all 26 existing modal scenarios preserve their assertions and complete naturally"
|
||||
determinism_controls:
|
||||
- "stylesheet-free full-markup fixture virtualizes only display and visibility"
|
||||
- "small contract scenario runs the same assertions against native JSDOM computed styles"
|
||||
- "explicit test stylesheet, local services, real DOM focus and event dispatch; no network"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "hard-coded focus list: varied hidden and visible controls"
|
||||
- "over-mocking controller behavior: real updateFocusTrap and keyboard listener"
|
||||
- "style resolver rubber-stamping: native resolver must satisfy the same scenario"
|
||||
- "retry/sleep-based flake masking: no timeouts, retries, or sleeps added"
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
Mutation evidence: removing the product display/visibility exclusion causes this scenario to fail with the hidden control IDs in its focus list (exit 1, 1 failed/0 passed). Mutant reverted. This fixes expensive JSDOM style evaluation in the test harness, not a demonstrated browser defect. Application CSS/layout remains outside this unit fixture's scope.
|
||||
|
||||
Fixture mutation: omitting native hidden-attribute filtering also fails the contract (exit 1, 1 failed/0 passed); restored before final checks.
|
||||
|
||||
---
|
||||
|
||||
# client-reliability-2
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
change_type: ["flake_fix", "new_tests"]
|
||||
scenarios:
|
||||
- id: SCN-concurrent-init-hermetic-subscription
|
||||
given: "two init callers share a pool initialization held at a deterministic barrier, with a virtual successful relay connection"
|
||||
when: "pool initialization is released and the second caller opens then closes a video subscription"
|
||||
then: "the second caller waits for pool readiness, real L1 feed setup reaches the fake pool, and unsubscribe closes the transport exactly once with no reconnect timer"
|
||||
observable_outcomes:
|
||||
- "second init promise remains pending until the pool barrier is released"
|
||||
- "pool is ready after awaiting the second caller; both init promises settle"
|
||||
- "post-init subscription requests video events from a nonempty relay set"
|
||||
- "subscription transport closes once, including repeated unsubscribe"
|
||||
- "the process exits naturally with no public relay IO or reconnect retries"
|
||||
determinism_controls:
|
||||
- "deferred pool barrier replaces the old 50ms delay"
|
||||
- "fake pool at the actual transport boundary; real init, L1, and feed cleanup"
|
||||
- "manager connection boundary reports success rather than triggering background reconnect"
|
||||
- "local-data/signer restore are virtualized; teardown awaits init, closes feed and resets reconnect state even after failure"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "early-return init mutant fails while pool initialization is held"
|
||||
- "no-op subscription cannot satisfy the observed transport request"
|
||||
- "no-op cleanup cannot satisfy exact close count"
|
||||
- "failure fixture cannot hide a reconnect timer behind a passing assertion"
|
||||
- "retry/sleep/forced-exit masking: no timeout changes or forced exit"
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
Original concurrent-promise, pool-ready and post-init no-throw assertions remain. The old empty connection result accidentally modeled failure; init correctly scheduled manager-owned retries that bypassed its client-level stub. The fixture now models successful init at the manager boundary and releases its feed subscription. This is harness cleanup, not a Nostr product change.
|
||||
|
||||
Mutants: a test-local historical early-return init variant fails the pending-barrier assertion (exit1, 1 failed); a connection-failure fixture variant fails the no-retry assertion (exit1, 1 failed). Both exit naturally and are reverted. No product file was edited for either mutant.
|
||||
|
||||
---
|
||||
|
||||
# client-reliability-3
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
change_type: ["new_tests"]
|
||||
scenarios:
|
||||
- id: SCN-last-probe-owner-disposal
|
||||
given: "five real DOM cards register through actual gridHealth/cardObserver; four probes are active and one queued"
|
||||
when: "the feed is disposed/removed and active probes finish"
|
||||
then: "zero obsolete probes start"
|
||||
- id: SCN-shared-queued-owner
|
||||
given: "two cards share one queued torrent source"
|
||||
when: "one registration disposes while its DOM remains connected"
|
||||
then: "the live owner still probes and becomes healthy; disposed owner receives no stale UI/callback"
|
||||
- id: SCN-cancelled-replacement-inflight
|
||||
given: "last owner cancels queued work then a replacement requests the same source before old settlement"
|
||||
when: "old completion drains and another owner joins before a slot frees"
|
||||
then: "no unhealthy cancellation cache is written, only one new probe starts, and both replacements become healthy/cacheable"
|
||||
- id: SCN-probe-priority-concurrency
|
||||
given: "four active probes, queued mixed priorities and a cancelled source"
|
||||
when: "slots free one at a time"
|
||||
then: "four-slot maximum and stable priority order remain; cancelled work never starts"
|
||||
- id: SCN-hidden-healthy-reveal
|
||||
given: "a hide-all card is hidden pending liveness"
|
||||
when: "registration eagerly probes and returns healthy"
|
||||
then: "raw magnet/webseed bytes reach probe IO and the card reveals without an intersection"
|
||||
- id: SCN-active-shared-late-entry
|
||||
given: "an active source loses its owner, receives a late observer entry and gains a live owner"
|
||||
when: "the unchanged active probe completes"
|
||||
then: "no duplicate starts or disposed result writes; live owner becomes healthy"
|
||||
- id: SCN-repeat-disposal-reattach
|
||||
given: "a disposed container has a new queued registration"
|
||||
when: "the old disposer is called again"
|
||||
then: "new owner survives and becomes healthy"
|
||||
- id: SCN-ownerless-active-cache
|
||||
given: "an already active probe has no remaining owner"
|
||||
when: "it finishes before a later live card requests that source"
|
||||
then: "the active result remains cached; no new probe or stale UI write occurs"
|
||||
- id: SCN-existing-probe-cache-ttl
|
||||
given: "completed healthy and negative results"
|
||||
when: "cards request before, at, and after the existing TTL boundary"
|
||||
then: "both cached outcomes reuse until the existing inclusive TTL expires, then both probe again"
|
||||
observable_outcomes:
|
||||
- "actual probePeers start count/order, arguments and maximum active count"
|
||||
- "real DOM badge health/hidden state, observer disposal and callback counts"
|
||||
- "storage cache absence for cancellation and reuse/expiry for completed probes"
|
||||
determinism_controls:
|
||||
- "actual gridHealth/cardObserver and DOM, controllable observer and deferred probePeers IO"
|
||||
- "explicit viewport geometry, unique sources and isolated storage; fake Date.now only for TTL scenario"
|
||||
- "task-turn promise draining without wall-clock sleeps, polling or retries"
|
||||
- "native Chromium/Firefox observer smoke against built dist, external traffic blocked"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "unconditional queue cancellation: shared-owner mutant fails"
|
||||
- "no-op cancellation, stale inflight deletion or cancelled cache poisoning"
|
||||
- "changed concurrency/priority or hidden eager path"
|
||||
- "stale result/listener/observer effects and repeated old disposal"
|
||||
- "cancelling or dropping cache from already active work"
|
||||
- "timeout/retry/sleep masking or hard-coded healthy results"
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
Grouped mutation coverage: last-owner cancellation mutant kills SCN-last-probe-owner-disposal; unconditional cancel kills SCN-shared-queued-owner; unconditional inflight deletion and cancelled-normalization mutants each kill SCN-cancelled-replacement-inflight; reversed queue priority kills SCN-probe-priority-concurrency; disabled eager path kills SCN-hidden-healthy-reveal; stale result guard and late-entry membership mutants each kill SCN-active-shared-late-entry; non-idempotent disposer kills SCN-repeat-disposal-reattach; owner-dependent active caching kills SCN-ownerless-active-cache; missing cache writes kills SCN-existing-probe-cache-ttl. All11 variants exit1 with1 failed scenario,0 cancelled, and are reverted. Browser checks corroborate the same disposal/shared-owner/hidden-reveal/source-visibility scenarios with native observers; no browser CPU or actual media fallback claim.
|
||||
|
||||
Additional client-reliability-3 scenarios (same invariant and controls):
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
change_type: ["new_tests"]
|
||||
scenarios:
|
||||
- id: SCN-shared-badge-listener-lifetime
|
||||
given: "two feed registrations share the app callback"
|
||||
when: "badge updates occur and registrations dispose one at a time"
|
||||
then: "each event notifies once, one surviving owner retains the callback, last disposal stops notifications"
|
||||
- id: SCN-checking-callback-disposal
|
||||
given: "a live card's checking callback synchronously disposes the feed"
|
||||
when: "badge notification returns to probe submission"
|
||||
then: "no probe is submitted after unregister"
|
||||
observable_outcomes:
|
||||
- "callback event count/state sequence and external probe start count"
|
||||
determinism_controls:
|
||||
- "real badge/observer path, synchronous disposal callback and deferred probe IO"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "duplicated shared callbacks or dropping live callback owners"
|
||||
- "post-disposal work submitted after synchronous reentrant teardown"
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
Duplicate wrapper and unconditional listener release variants each fail SCN-shared-badge-listener-lifetime. Removing the post-checking membership guard fails SCN-checking-callback-disposal (actual starts1 vs expected0). These3 additional variants exit1 with1 failed/0 cancelled and are reverted; total14 killed variants for11 lifecycle scenarios. Original source/priority/observer expectations remain unchanged.
|
||||
|
||||
|
||||
## client-reliability-4 — queued URL media ownership
|
||||
|
||||
```yaml
|
||||
test_integrity_note:
|
||||
change_type: ["new_tests"]
|
||||
scenarios:
|
||||
- id: SCN-url-last-owner
|
||||
given: "four cards, three active media and one queued"
|
||||
when: "last registration is disposed and an active slot frees"
|
||||
then: "queued promise settles null, no cache entry or obsolete media start"
|
||||
- id: SCN-url-shared-owner
|
||||
given: "two feeds share a queued event/source"
|
||||
when: "one feed disposes"
|
||||
then: "exactly one media probe serves the live badge; disposed connected badge stays checking"
|
||||
- id: SCN-url-last-shared-owner
|
||||
given: "two feeds share a queued event/source"
|
||||
when: "both feeds dispose"
|
||||
then: "queued promise settles null and never starts media"
|
||||
- id: SCN-url-cancel-rerequest
|
||||
given: "cancelled queued event/source has pending promise continuations"
|
||||
when: "a new feed requests the same source immediately"
|
||||
then: "new inflight record survives old settlement and live badge becomes healthy"
|
||||
- id: SCN-url-cancel-mirror
|
||||
given: "queued primary has a mirror"
|
||||
when: "last owner disposes"
|
||||
then: "cancelled work settles without mirror HEAD/media or stale UI/cache"
|
||||
- id: SCN-url-registration-reuse
|
||||
given: "hidden old feed queues an eager callback"
|
||||
when: "dispose, reuse container, deliver old callback and old disposer"
|
||||
then: "only the new event reaches onCheck and starts IO"
|
||||
- id: SCN-url-active-cache
|
||||
given: "active media belongs to a connected card"
|
||||
when: "dispose its registration and complete active media"
|
||||
then: "active result caches healthy, disposed badge stays checking, new card uses cache"
|
||||
- id: SCN-url-hidden-reveal
|
||||
given: "URL-only card is hidden pending health"
|
||||
when: "eager media confirmation succeeds"
|
||||
then: "card becomes visible with healthy badge"
|
||||
- id: SCN-url-media-limit
|
||||
given: "three active media probes plus FIFO queued work"
|
||||
when: "slot releases while a new card enters"
|
||||
then: "existing queued source runs first; active media stays three"
|
||||
- id: SCN-url-mirror-order
|
||||
given: "primary and two mirrors exist"
|
||||
when: "primary errors then first mirror succeeds"
|
||||
then: "primary then first mirror are requested; second mirror is untouched"
|
||||
- id: SCN-url-legacy-callback
|
||||
given: "connected badge lacks observer ownership"
|
||||
when: "legacy caller invokes controller"
|
||||
then: "media settles and healthy badge paints"
|
||||
- id: SCN-url-cross-controller
|
||||
given: "shared real inflight cache and two controllers"
|
||||
when: "creator feed disposes while other feed remains"
|
||||
then: "queued shared source starts once and other controller paints healthy"
|
||||
observable_outcomes:
|
||||
- "HEAD and native media IO starts, promise settlement, real cache/inflight records, connected badge and card visibility"
|
||||
- "Observer callback emissions after disposal and container reuse"
|
||||
determinism_controls:
|
||||
- "jsdom cards, controllable IntersectionObserver, explicit loadeddata/error events and stubbed fetch boundary; real observer/controller/cache"
|
||||
- "Unique event/source keys and task-turn drain; no live traffic, arbitrary sleeps, retries or relaxed assertions"
|
||||
anti_cheat_rationale:
|
||||
prevents:
|
||||
- "hard-coded healthy or cancelled results"
|
||||
- "testing a copied queue instead of real controller and observer"
|
||||
- "cancelling shared live work or caching cancellation as offline"
|
||||
- "stale connected DOM callbacks hidden by isConnected guards"
|
||||
- "retry/sleep-based flake masking"
|
||||
relaxation:
|
||||
did_relax_any_assertion: false
|
||||
if_true_explain_spec_basis: ""
|
||||
```
|
||||
|
||||
All existing assertions preserved. `tests/url-health-lifecycle.test.mjs` adds12 scenarios. Mutations are temporary edits restored before gates. `python3 /tmp/item4-mutants.py` final run:13/13 variants naturally exit1 with named assertion failures (no timeouts); logs `/tmp/item4-mutant-*.log`, results `/tmp/item4-mutants.json`. No production test runner/gate changes.
|
||||
|
||||
Coverage grouping: no-unregister→last owner; cancel-shared→shared owner/cross-controller; reuse-cancelled-inflight→immediate retry/new inflight; cache-cancellation→last/shared owner/retry/mirror cache outcomes; mirror-fallthrough→cancelled primary; grouped stale guards→shared/active disposed UI (remove both redundant owner guards together; two equivalent variants); eager-callback-stale→registration reuse; no-eager-reveal→hidden reveal; concurrency-four→three-media cap/FIFO; reverse-mirrors→mirror ordering; break-legacy-consumer→callback compatibility; controller-local-records→shared cache ownership across controllers. Initial mutation pass exposed callback-emission and first-source gaps; new assertions were strengthened, then all mutants rejected. Initial no-unregister full-file run failed assertions but hung in another scenario awaiting its intentionally broken promise; final targeted last-owner variant naturally exits1. No timeout is counted as successful mutant evidence.
|
||||
@@ -1,69 +0,0 @@
|
||||
# Validation Report
|
||||
|
||||
This report documents the verification of user-facing documentation in `/content` against the codebase.
|
||||
|
||||
## 1. Storage Configuration (CORS)
|
||||
|
||||
**Claim:** Users must configure CORS with specific headers to allow browser uploads.
|
||||
**Source:** `content/docs/guides/upload-content.md`
|
||||
**Code:** `js/storage/s3-multipart.js` (function `ensureBucketCors`)
|
||||
|
||||
**Verification:**
|
||||
The `ensureBucketCors` function hardcodes the following CORS rules:
|
||||
- `AllowedHeaders`: `["*"]` (Matches docs)
|
||||
- `AllowedMethods`: `["GET", "HEAD", "PUT", "POST", "DELETE", "OPTIONS"]` (Matches docs, order irrelevant)
|
||||
- `ExposeHeaders`: `["ETag", "Content-Length", "Content-Range", "Accept-Ranges"]` (Matches docs)
|
||||
- `MaxAgeSeconds`: `3600` (Matches docs)
|
||||
|
||||
The `AllowedOrigins` in code is dynamic (`allowedOrigins` variable), while the docs provide a concrete example (`["http://localhost:5500", "https://bitvid.network"]`) which is correct for users.
|
||||
|
||||
## 2. File Type Limits
|
||||
|
||||
**Claim:** Accepted file types are `.mp4, .webm, .mov, .mkv, .ts, .m3u8, .mpg, .mpeg`.
|
||||
**Source:** `content/docs/guides/upload-content.md`
|
||||
**Code:** `components/upload-modal.html`
|
||||
|
||||
**Verification:**
|
||||
The input element is defined as:
|
||||
```html
|
||||
<input id="input-file" type="file" class="hidden" accept="video/*,.m3u8,.ts,.mp4,.webm,.mov,.mkv,.mpg,.mpeg" />
|
||||
```
|
||||
The documentation matches the specific extensions listed in the code. The docs now also clarify that "other standard video formats" are accepted via `video/*`.
|
||||
|
||||
## 3. File Size Limit
|
||||
|
||||
**Claim:** Recommended limit is 2GB due to browser memory.
|
||||
**Source:** `content/docs/guides/upload-content.md`
|
||||
**Code:** `js/utils/torrentHash.js`
|
||||
|
||||
**Verification:**
|
||||
The client-side hashing logic uses `FileReader.readAsArrayBuffer(file)`. This loads the entire file into memory. Browser implementations (especially Chrome) typically crash or fail when allocating ArrayBuffers larger than ~2GB. This technical constraint confirms the documentation's warning.
|
||||
|
||||
## 4. Moderation (Whitelist Mode)
|
||||
|
||||
**Claim:** "Whitelist Mode" restricts visibility to approved accounts.
|
||||
**Source:** `content/docs/guides/upload-content.md` & `getting-started.md`
|
||||
**Code:** `js/accessControl.js`
|
||||
|
||||
**Verification:**
|
||||
The `AccessControl` class implements `canAccess(candidate)`:
|
||||
```javascript
|
||||
if (this.whitelistEnabled && !this.whitelistPubkeys.has(hex)) {
|
||||
return false;
|
||||
}
|
||||
```
|
||||
If `whitelistEnabled` is true (Whitelist Mode), non-whitelisted pubkeys return `false`, blocking their content from being displayed in feeds that use this check. This confirms the documentation.
|
||||
|
||||
## 5. Upload Lifecycle
|
||||
|
||||
**Claim:** Direct upload to bucket -> Client-side hashing -> NIP-71/Nostr publication.
|
||||
**Source:** `content/docs/guides/upload-content.md`
|
||||
**Code:** `js/ui/components/UploadModal.js`
|
||||
|
||||
**Verification:**
|
||||
`handleVideoSelection` in `UploadModal.js`:
|
||||
1. Calls `service.uploadFile` (Direct upload to R2/S3).
|
||||
2. Calls `generateTorrentMetadata` (Client-side hashing).
|
||||
3. Calls `publish` -> `publishVideoNote` (Nostr publication).
|
||||
|
||||
This flow matches the documentation exactly.
|
||||
@@ -1,24 +1,2 @@
|
||||
/*
|
||||
Content-Security-Policy: frame-ancestors *
|
||||
|
||||
/index.html
|
||||
Cache-Control: no-cache, must-revalidate
|
||||
|
||||
/embed.html
|
||||
Cache-Control: no-cache, must-revalidate
|
||||
|
||||
/*.html
|
||||
Cache-Control: no-cache, must-revalidate
|
||||
|
||||
/css/*
|
||||
Cache-Control: public, max-age=31536000, immutable
|
||||
|
||||
/js/*
|
||||
Cache-Control: public, max-age=31536000, immutable
|
||||
|
||||
/sw.min.js
|
||||
Cache-Control: public, max-age=0, must-revalidate
|
||||
X-Bitvid-SW-Version: bitvid-sw-2026-02-10
|
||||
|
||||
/site.webmanifest
|
||||
Cache-Control: public, max-age=0, must-revalidate
|
||||
@@ -1,28 +0,0 @@
|
||||
# Telemetry Report - 2026-02-24
|
||||
|
||||
**Total Unique Issues:** 1
|
||||
**Generated:** 2026-02-24T13:31:15.378Z
|
||||
|
||||
## Top 10 Priority Issues
|
||||
|
||||
| Priority | Count | Issue | Owner | Sources |
|
||||
| :--- | :---: | :--- | :--- | :--- |
|
||||
| **Medium** | 1 | Load Test Bottleneck: Cryptographic Bottleneck (Avg Sign ... | P2P Team | load-test:load-report-20260204.json |
|
||||
|
||||
## Detailed Breakdown
|
||||
|
||||
### [Medium] Load Test Bottleneck: Cryptographic Bottleneck (Avg Sign Time 5.87ms > 5ms)
|
||||
- **Occurrences:** 1
|
||||
- **Sources:** load-test:load-report-20260204.json
|
||||
- **Suggested Owner:** P2P Team
|
||||
- **Fingerprint:** `00257328`
|
||||
|
||||
**Stack Trace / Details:**
|
||||
```
|
||||
Bottleneck: Cryptographic Bottleneck (Avg Sign Time 5.87ms > 5ms)
|
||||
Remediation: Client-side event signing is slow. Review cryptographic library (nostr-tools) usage or client hardware capabilities.
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
*Privacy Notice: PII (IPs, emails, keys) has been sanitized from this report.*
|
||||
@@ -1,72 +0,0 @@
|
||||
# Weekly Agent Synthesis — 2026-02-25 (covers 2026-02-18 → 2026-02-25)
|
||||
|
||||
## Summary
|
||||
- Total PRs opened: 8 (currently open)
|
||||
- Total PRs merged: 48 (in the last 7 days)
|
||||
- Notable themes:
|
||||
- **Testing & CI Stability:** Significant effort on stabilizing flaky E2E tests (#2683, #2669), improving coverage (#2707, #2667), and adding comprehensive E2E suites (#2666).
|
||||
- **Performance:** Optimizations in feed moderation (#2665) and mute pruning (#2653).
|
||||
- **Refactoring:** Cleaning up `app.js` (#2681) and test harnesses (#2688).
|
||||
- **Routine Maintenance:** High volume of daily agent executions (todo-triage, style, audit).
|
||||
|
||||
## PRs Opened / Updated (Selected)
|
||||
- **test(smoke): add smoke-test.mjs harness** — Open — Status: Open
|
||||
- Notes: New harness for smoke testing.
|
||||
- Risk: None (test infra).
|
||||
- **docs(agents): sync scheduler rosters** — Open — Status: Open
|
||||
- Notes: Routine scheduler updates.
|
||||
- Risk: None.
|
||||
- **Add unit tests for js/nostr/utils.js (test-coverage-agent)** — #2707 — Status: Merged
|
||||
- Notes: Improved coverage for core utilities.
|
||||
- Risk: None.
|
||||
- **[ci] Stabilize flaky E2E tests & skip deploy-index verification** — #2683 — Status: Merged
|
||||
- Notes: Addressed CI flakes.
|
||||
- Risk: None (test infra).
|
||||
- **refactor(ui): extract bindThumbnailFallbacks from app.js** — #2681 — Status: Merged
|
||||
- Notes: Extracted logic from the main `bitvidApp` class.
|
||||
- Risk: **Requires UI regression check** (thumbnails).
|
||||
- **perf(feed): optimize moderation stage with batch author lookups** — #2665 — Status: Merged
|
||||
- Notes: Changed how authors are looked up during feed rendering.
|
||||
- Risk: **Requires protocol review** (feed correctness).
|
||||
- **fix: race condition in app initialization** — #2674 — Status: Merged
|
||||
- Notes: Fixed startup race.
|
||||
- Risk: **Requires protocol review** (startup timing).
|
||||
- **Replace alert() with non-blocking notifications in UploadModal** — #2652 — Status: Merged
|
||||
- Notes: UX improvement.
|
||||
- Risk: None.
|
||||
|
||||
## Issues Created / Updated
|
||||
*(Derived from PR descriptions and titles, as direct issue fetching via git is limited)*
|
||||
- **Stabilize flaky E2E tests** (referenced in #2683) — Priority: P1
|
||||
- **Race condition in app initialization** (referenced in #2674) — Priority: P1
|
||||
|
||||
## Tests / Quality
|
||||
- **Tests added/updated:**
|
||||
- Unit tests for `js/nostr/utils.js` (#2707).
|
||||
- Comprehensive E2E test suite for accessibility/playback (#2666).
|
||||
- Refactored smoke test harness (#2688).
|
||||
- **Coverage:**
|
||||
- Coverage improved for `js/nostr/utils.js` and E2E scenarios.
|
||||
|
||||
## Security / Dependencies
|
||||
- **Daily Agent: Audit Agent** (#2702) — #2702
|
||||
- Routine audit run. No critical vulnerabilities flagged in summary.
|
||||
- **daily: nip-research-agent NIP-42 update** — #2661
|
||||
- Rationale: Touches authentication protocols.
|
||||
- Risk: **requires-protocol-review**.
|
||||
|
||||
## Requires Human Review (Do Not Auto-Merge)
|
||||
- **#2661 (NIP-42 update)** — Touches authentication logic — [PR #2661](https://github.com/PR0M3TH3AN/bitvid/pull/2661)
|
||||
- **#2665 (Batch author lookups)** — Complex logic change in feed rendering — [PR #2665](https://github.com/PR0M3TH3AN/bitvid/pull/2665)
|
||||
- **#2681 (Refactor app.js)** — Core UI refactor — [PR #2681](https://github.com/PR0M3TH3AN/bitvid/pull/2681)
|
||||
|
||||
## Top 5 Recommended Human Actions (ranked)
|
||||
1. **Verify NIP-42/Auth Changes (#2661, #2669):** Ensure authentication flows remain secure and functional.
|
||||
2. **Review Feed Optimization (#2665):** Verify that batch author lookups correctly handle all moderation cases.
|
||||
3. **Validate App.js Refactor (#2681):** Check thumbnail loading across the app to ensure no regressions.
|
||||
4. **Confirm CI Stability (#2683, #2703):** Monitor CI for recurrence of flakes; verify tests weren't simply disabled/loosened.
|
||||
5. **Review New E2E Suite (#2666):** Ensure new tests align with "Scenario-First" guidelines.
|
||||
|
||||
## Method & Limitations
|
||||
- Data sources used: GitHub API (`curl`), `git log`.
|
||||
- Links are derived from API output.
|
||||
@@ -1,363 +0,0 @@
|
||||
// Per-video OpenGraph / Twitter-player rendering for crawlers.
|
||||
//
|
||||
// bitvid is a static SPA: index.html carries one set of site-wide OG tags, so
|
||||
// every `/?v=<nevent>` link previewed as the same generic bitvid card. Crawlers
|
||||
// don't run JS, so the client can't fix that — this module renders the tags a
|
||||
// crawler needs, and a thin host adapter (api/og.js on Vercel) feeds it.
|
||||
//
|
||||
// PURE by design: no network, no host globals. All I/O lives in the adapter so
|
||||
// the escaping and gating rules below stay unit-testable.
|
||||
//
|
||||
// Rollback: remove the crawler rewrite from vercel.json. The static site keeps
|
||||
// serving its existing tags and nothing else changes — this is never on the
|
||||
// path of a real user's page load, and `npm run archive` (nsite) is unaffected.
|
||||
|
||||
// Player card dimensions. Twitter refuses a player card without explicit
|
||||
// dimensions, and 16:9 matches bitvid's embed shell.
|
||||
export const DEFAULT_PLAYER_WIDTH = 1280;
|
||||
export const DEFAULT_PLAYER_HEIGHT = 720;
|
||||
|
||||
const MAX_TITLE_LENGTH = 120;
|
||||
const MAX_DESCRIPTION_LENGTH = 200;
|
||||
|
||||
/**
|
||||
* Escape a value for use inside a double-quoted HTML attribute.
|
||||
*
|
||||
* Titles and descriptions come from arbitrary nostr events — treat every one as
|
||||
* hostile. A title of `"><script>…` would otherwise break out of the meta tag
|
||||
* and inject markup into a page we serve from our own origin.
|
||||
*/
|
||||
export function escapeHtmlAttribute(value) {
|
||||
if (typeof value !== "string") {
|
||||
return "";
|
||||
}
|
||||
return value
|
||||
.replace(/&/g, "&")
|
||||
.replace(/</g, "<")
|
||||
.replace(/>/g, ">")
|
||||
.replace(/"/g, """)
|
||||
.replace(/'/g, "'");
|
||||
}
|
||||
|
||||
/**
|
||||
* Only http(s) URLs may reach a meta tag. Anything else (javascript:, data:,
|
||||
* relative paths) is dropped — a crawler resolving them is at best useless and
|
||||
* at worst a vector.
|
||||
*/
|
||||
export function sanitizeAbsoluteUrl(value) {
|
||||
const trimmed = typeof value === "string" ? value.trim() : "";
|
||||
if (!trimmed) {
|
||||
return "";
|
||||
}
|
||||
let parsed;
|
||||
try {
|
||||
parsed = new URL(trimmed);
|
||||
} catch (err) {
|
||||
return "";
|
||||
}
|
||||
if (parsed.protocol !== "http:" && parsed.protocol !== "https:") {
|
||||
return "";
|
||||
}
|
||||
return parsed.toString();
|
||||
}
|
||||
|
||||
/** Collapse whitespace and hard-truncate for preview surfaces. */
|
||||
export function normalizeText(value, maxLength) {
|
||||
const collapsed =
|
||||
typeof value === "string" ? value.replace(/\s+/g, " ").trim() : "";
|
||||
if (!collapsed || !Number.isFinite(maxLength) || maxLength <= 0) {
|
||||
return collapsed;
|
||||
}
|
||||
if (collapsed.length <= maxLength) {
|
||||
return collapsed;
|
||||
}
|
||||
return `${collapsed.slice(0, maxLength - 1).trimEnd()}…`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Decide whether a video may be described in a link preview.
|
||||
*
|
||||
* A crawler never authenticates, so anything emitted here is fully public and
|
||||
* outlives us in third-party caches. The rule is fail-closed: only a video that
|
||||
* is affirmatively public gets a rich card; everything else — including the
|
||||
* "we couldn't determine it" case — falls back to the generic bitvid card.
|
||||
*
|
||||
* @returns {{allowed: boolean, reason: string}}
|
||||
*/
|
||||
export function isPubliclyShareable(video, options = {}) {
|
||||
if (!video || typeof video !== "object") {
|
||||
return { allowed: false, reason: "missing-video" };
|
||||
}
|
||||
if (video.invalid) {
|
||||
return { allowed: false, reason: "invalid-video" };
|
||||
}
|
||||
if (video.deleted === true) {
|
||||
return { allowed: false, reason: "deleted" };
|
||||
}
|
||||
if (video.isPrivate === true) {
|
||||
return { allowed: false, reason: "private" };
|
||||
}
|
||||
// NSFW thumbnails must never be injected into an unsuspecting timeline.
|
||||
if (video.isNsfw === true) {
|
||||
return { allowed: false, reason: "nsfw" };
|
||||
}
|
||||
|
||||
const pubkey =
|
||||
typeof video.pubkey === "string" ? video.pubkey.trim().toLowerCase() : "";
|
||||
if (!pubkey) {
|
||||
return { allowed: false, reason: "missing-author" };
|
||||
}
|
||||
|
||||
const blacklist = options.blacklist instanceof Set ? options.blacklist : null;
|
||||
if (blacklist && blacklist.has(pubkey)) {
|
||||
return { allowed: false, reason: "blacklisted" };
|
||||
}
|
||||
|
||||
if (options.whitelistEnabled) {
|
||||
const whitelist =
|
||||
options.whitelist instanceof Set ? options.whitelist : null;
|
||||
// No usable whitelist while whitelist mode is on means we cannot prove the
|
||||
// author is allowed. Fail closed rather than leak a gated video's metadata.
|
||||
if (!whitelist || whitelist.size === 0) {
|
||||
return { allowed: false, reason: "whitelist-unavailable" };
|
||||
}
|
||||
if (!whitelist.has(pubkey)) {
|
||||
return { allowed: false, reason: "not-whitelisted" };
|
||||
}
|
||||
}
|
||||
|
||||
return { allowed: true, reason: "ok" };
|
||||
}
|
||||
|
||||
// bitvid's own notes are kind 30078 with a v3 JSON body. Other clients
|
||||
// (nostube/slidestr and anything NIP-71 native) publish kind 21/22/34235/34236
|
||||
// with the metadata in TAGS and the description in `content`. bitvid normalizes
|
||||
// both in the browser, so the preview must understand both too — parsing only
|
||||
// the JSON shape made every NIP-71 video fall back to the generic card.
|
||||
export const NIP71_VIDEO_KINDS = Object.freeze([21, 22, 34235, 34236]);
|
||||
|
||||
function firstTagValue(tags, name) {
|
||||
if (!Array.isArray(tags)) {
|
||||
return "";
|
||||
}
|
||||
for (const tag of tags) {
|
||||
if (Array.isArray(tag) && tag[0] === name && typeof tag[1] === "string") {
|
||||
const value = tag[1].trim();
|
||||
if (value) {
|
||||
return value;
|
||||
}
|
||||
}
|
||||
}
|
||||
return "";
|
||||
}
|
||||
|
||||
function hasTag(tags, name) {
|
||||
return (
|
||||
Array.isArray(tags) &&
|
||||
tags.some((tag) => Array.isArray(tag) && tag[0] === name)
|
||||
);
|
||||
}
|
||||
|
||||
/** First `image <url>` entry inside any imeta tag. */
|
||||
function imetaImageUrl(tags) {
|
||||
if (!Array.isArray(tags)) {
|
||||
return "";
|
||||
}
|
||||
for (const tag of tags) {
|
||||
if (!Array.isArray(tag) || tag[0] !== "imeta") {
|
||||
continue;
|
||||
}
|
||||
for (let i = 1; i < tag.length; i += 1) {
|
||||
const entry = typeof tag[i] === "string" ? tag[i].trim() : "";
|
||||
if (/^image\s+/i.test(entry)) {
|
||||
const url = sanitizeAbsoluteUrl(entry.replace(/^image\s+/i, ""));
|
||||
if (url) {
|
||||
return url;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return "";
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalize a raw nostr event into the fields the preview needs, for both the
|
||||
* bitvid v3 JSON shape and the NIP-71 tag shape. Returns null when the event is
|
||||
* not a recognizable video note (caller renders the generic card).
|
||||
*/
|
||||
export function parseVideoEvent(event) {
|
||||
if (!event || typeof event !== "object") {
|
||||
return null;
|
||||
}
|
||||
|
||||
const base = { pubkey: event.pubkey, deleted: false, isPrivate: false };
|
||||
|
||||
// --- bitvid native (kind 30078, JSON content) ---
|
||||
if (typeof event.content === "string" && event.content.trim().startsWith("{")) {
|
||||
try {
|
||||
const content = JSON.parse(event.content);
|
||||
if (content && typeof content === "object") {
|
||||
return {
|
||||
...base,
|
||||
title: content.title,
|
||||
description: content.description,
|
||||
thumbnail: content.thumbnail,
|
||||
deleted: content.deleted === true,
|
||||
isPrivate: content.isPrivate === true,
|
||||
isNsfw: content.isNsfw === true || hasTag(event.tags, "content-warning"),
|
||||
invalid: !content.title || (!content.url && !content.magnet),
|
||||
};
|
||||
}
|
||||
} catch (err) {
|
||||
// Not JSON after all — fall through to the NIP-71 reading.
|
||||
}
|
||||
}
|
||||
|
||||
// --- NIP-71 (metadata in tags, description in content) ---
|
||||
if (NIP71_VIDEO_KINDS.includes(event.kind)) {
|
||||
const title = firstTagValue(event.tags, "title");
|
||||
const thumbnail =
|
||||
imetaImageUrl(event.tags) ||
|
||||
sanitizeAbsoluteUrl(firstTagValue(event.tags, "image")) ||
|
||||
sanitizeAbsoluteUrl(firstTagValue(event.tags, "thumb"));
|
||||
const description =
|
||||
(typeof event.content === "string" && event.content.trim()) ||
|
||||
firstTagValue(event.tags, "summary") ||
|
||||
firstTagValue(event.tags, "alt");
|
||||
return {
|
||||
...base,
|
||||
title,
|
||||
description,
|
||||
thumbnail,
|
||||
// NIP-71 has no privacy flag; `content-warning` is the NSFW signal.
|
||||
isNsfw: hasTag(event.tags, "content-warning"),
|
||||
invalid: !title,
|
||||
};
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
function metaTag(attribute, name, content) {
|
||||
return ` <meta ${attribute}="${escapeHtmlAttribute(name)}" content="${escapeHtmlAttribute(content)}" />`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Render the crawler-facing HTML document.
|
||||
*
|
||||
* @param {object} params
|
||||
* @param {object|null} params.video Normalized video object, or null.
|
||||
* @param {string} params.shareUrl Canonical `/?v=<nevent>` URL.
|
||||
* @param {string} [params.embedUrl] `/embed.html?pointer=<nevent>` player URL.
|
||||
* @param {object} params.fallback Site-wide defaults (title/description/image/url).
|
||||
* @param {object} [params.gate] Result of isPubliclyShareable().
|
||||
* @returns {string} A complete HTML document.
|
||||
*/
|
||||
export function renderOgHtml({
|
||||
video = null,
|
||||
shareUrl = "",
|
||||
embedUrl = "",
|
||||
fallback = {},
|
||||
gate = null,
|
||||
} = {}) {
|
||||
const siteName = normalizeText(fallback.siteName || "bitvid", 60);
|
||||
const fallbackTitle = normalizeText(
|
||||
fallback.title || "bitvid - Decentralized Video Sharing",
|
||||
MAX_TITLE_LENGTH
|
||||
);
|
||||
const fallbackDescription = normalizeText(
|
||||
fallback.description || "Decentralized video sharing on Nostr.",
|
||||
MAX_DESCRIPTION_LENGTH
|
||||
);
|
||||
const fallbackImage = sanitizeAbsoluteUrl(fallback.image);
|
||||
const canonical = sanitizeAbsoluteUrl(shareUrl) || sanitizeAbsoluteUrl(fallback.url);
|
||||
|
||||
const decision = gate || isPubliclyShareable(video);
|
||||
const useVideo = decision.allowed === true;
|
||||
|
||||
const title = useVideo
|
||||
? normalizeText(video.title, MAX_TITLE_LENGTH) || fallbackTitle
|
||||
: fallbackTitle;
|
||||
const description = useVideo
|
||||
? normalizeText(video.description, MAX_DESCRIPTION_LENGTH) ||
|
||||
fallbackDescription
|
||||
: fallbackDescription;
|
||||
const image = useVideo
|
||||
? sanitizeAbsoluteUrl(video.thumbnail) || fallbackImage
|
||||
: fallbackImage;
|
||||
const player = useVideo ? sanitizeAbsoluteUrl(embedUrl) : "";
|
||||
|
||||
const lines = [
|
||||
"<!doctype html>",
|
||||
'<html lang="en">',
|
||||
" <head>",
|
||||
' <meta charset="utf-8" />',
|
||||
' <meta name="viewport" content="width=device-width, initial-scale=1" />',
|
||||
` <title>${escapeHtmlAttribute(title)}</title>`,
|
||||
];
|
||||
|
||||
if (canonical) {
|
||||
lines.push(` <link rel="canonical" href="${escapeHtmlAttribute(canonical)}" />`);
|
||||
}
|
||||
|
||||
lines.push(metaTag("name", "description", description));
|
||||
lines.push(metaTag("property", "og:site_name", siteName));
|
||||
lines.push(metaTag("property", "og:type", useVideo ? "video.other" : "website"));
|
||||
lines.push(metaTag("property", "og:title", title));
|
||||
lines.push(metaTag("property", "og:description", description));
|
||||
if (canonical) {
|
||||
lines.push(metaTag("property", "og:url", canonical));
|
||||
}
|
||||
if (image) {
|
||||
lines.push(metaTag("property", "og:image", image));
|
||||
lines.push(metaTag("property", "og:image:alt", title));
|
||||
}
|
||||
|
||||
if (player) {
|
||||
// A player card is what makes a shared bitvid link behave like a YouTube
|
||||
// link: the video plays inline in the timeline instead of showing a still.
|
||||
lines.push(metaTag("property", "og:video:url", player));
|
||||
lines.push(metaTag("property", "og:video:secure_url", player));
|
||||
lines.push(metaTag("property", "og:video:type", "text/html"));
|
||||
lines.push(metaTag("property", "og:video:width", String(DEFAULT_PLAYER_WIDTH)));
|
||||
lines.push(metaTag("property", "og:video:height", String(DEFAULT_PLAYER_HEIGHT)));
|
||||
lines.push(metaTag("name", "twitter:card", "player"));
|
||||
lines.push(metaTag("name", "twitter:player", player));
|
||||
lines.push(metaTag("name", "twitter:player:width", String(DEFAULT_PLAYER_WIDTH)));
|
||||
lines.push(metaTag("name", "twitter:player:height", String(DEFAULT_PLAYER_HEIGHT)));
|
||||
} else {
|
||||
lines.push(metaTag("name", "twitter:card", image ? "summary_large_image" : "summary"));
|
||||
}
|
||||
|
||||
lines.push(metaTag("name", "twitter:title", title));
|
||||
lines.push(metaTag("name", "twitter:description", description));
|
||||
if (image) {
|
||||
lines.push(metaTag("name", "twitter:image", image));
|
||||
}
|
||||
|
||||
lines.push(" </head>");
|
||||
lines.push(" <body>");
|
||||
// A human should never land here (only crawler user-agents are rewritten),
|
||||
// but if one does, give them a real link rather than a blank page.
|
||||
lines.push(
|
||||
canonical
|
||||
? ` <p><a href="${escapeHtmlAttribute(canonical)}">${escapeHtmlAttribute(title)}</a></p>`
|
||||
: ` <p>${escapeHtmlAttribute(title)}</p>`
|
||||
);
|
||||
lines.push(" </body>");
|
||||
lines.push("</html>");
|
||||
|
||||
return `${lines.join("\n")}\n`;
|
||||
}
|
||||
|
||||
// Conservative crawler match. Being wrong in the "not a bot" direction is free
|
||||
// (the visitor gets the normal SPA); being wrong the other way would serve a
|
||||
// human this stub page, so the pattern stays narrow and explicit.
|
||||
export const CRAWLER_USER_AGENT_PATTERN =
|
||||
/(facebookexternalhit|twitterbot|slackbot|discordbot|telegrambot|whatsapp|linkedinbot|pinterest|redditbot|embedly|quora link preview|nostrbot|primal|iframely|opengraph|mastodon|bluesky|skypeuripreview|vkshare|googlebot|bingbot|applebot|yandexbot|duckduckbot|baiduspider|petalbot|semrushbot|ahrefsbot|developers\.google\.com\/\+\/web\/snippet)/i;
|
||||
|
||||
export function isCrawlerUserAgent(userAgent) {
|
||||
return typeof userAgent === "string"
|
||||
? CRAWLER_USER_AGENT_PATTERN.test(userAgent)
|
||||
: false;
|
||||
}
|
||||
@@ -1,273 +0,0 @@
|
||||
// Vercel serverless handler: renders per-video OpenGraph / Twitter-player tags
|
||||
// for crawlers hitting `/?v=<nevent>`.
|
||||
//
|
||||
// Nothing is pre-generated and nothing is persisted. This is a stateless
|
||||
// function invoked per crawler request; `dist/` is byte-identical with or
|
||||
// without it. The only caching is the CDN edge cache via Cache-Control below.
|
||||
//
|
||||
// This must never become load-bearing for the app: real users are not routed
|
||||
// here (see the user-agent rewrite in vercel.json), and a static/nsite deploy
|
||||
// without any functions keeps working exactly as it does today, just with the
|
||||
// site-wide card.
|
||||
|
||||
import { nip19 } from "nostr-tools";
|
||||
import { SimplePool, useWebSocketImplementation } from "nostr-tools/pool";
|
||||
import WebSocket from "ws";
|
||||
|
||||
import {
|
||||
isCrawlerUserAgent,
|
||||
isPubliclyShareable,
|
||||
parseVideoEvent,
|
||||
renderOgHtml,
|
||||
} from "./_lib/ogRenderer.mjs";
|
||||
|
||||
// Imported, not duplicated: these modules are plain ESM with no DOM access, so
|
||||
// the function reads the SAME admin-list identity and relay set the browser
|
||||
// does. A hardcoded copy would silently drift the moment an operator retunes
|
||||
// the instance, and the failure mode (previews gated forever, or worse, a stale
|
||||
// whitelist) would be invisible.
|
||||
import {
|
||||
ADMIN_LIST_NAMESPACE,
|
||||
ADMIN_SUPER_NPUB,
|
||||
} from "../js/config.js";
|
||||
import { DEFAULT_RELAY_URLS } from "../js/nostr/toolkit.js";
|
||||
import { ADMIN_LIST_IDENTIFIERS } from "../js/nostrEventSchemas.js";
|
||||
|
||||
useWebSocketImplementation(WebSocket);
|
||||
|
||||
const RELAYS = Array.from(DEFAULT_RELAY_URLS);
|
||||
|
||||
// Admin moderation lists are addressable kind-30000 sets published by the
|
||||
// instance's super admin (js/adminListStore.js).
|
||||
const ADMIN_LIST_KIND = 30000;
|
||||
|
||||
// Measured: a COLD pool's first read across these relays can take ~3s (WSS
|
||||
// handshake + REQ round trip on four connections). 1.5s and 2.5s both cut it
|
||||
// off and served the generic card every time. Twitter allows ~5s and Facebook
|
||||
// ~10s, so 4s buys a correct card on a cold container while still leaving
|
||||
// headroom under Vercel's function limit. Warm containers answer in <600ms.
|
||||
const RELAY_TIMEOUT_MS = 4000;
|
||||
|
||||
// Admin lists are identical for every request, so re-reading them on each crawl
|
||||
// is pure waste (and it was starving the video read of its budget). Memoized in
|
||||
// module scope: warm invocations skip the relay round trip entirely. This is a
|
||||
// per-container, in-memory cache of PUBLIC data that dies with the container —
|
||||
// nothing is persisted anywhere.
|
||||
const ADMIN_LIST_TTL_MS = 5 * 60 * 1000;
|
||||
let adminListCache = { expiresAt: 0, whitelist: null, blacklist: null };
|
||||
|
||||
const SITE_ORIGIN = process.env.BITVID_SITE_ORIGIN || "https://bitvid.network";
|
||||
const FALLBACK = Object.freeze({
|
||||
siteName: "bitvid",
|
||||
title: "bitvid - Decentralized Video Sharing",
|
||||
description:
|
||||
"bitvid is a decentralized video sharing platform built on Nostr and WebTorrent.",
|
||||
image: `${SITE_ORIGIN}/assets/jpg/bitvid.jpg`,
|
||||
url: SITE_ORIGIN,
|
||||
});
|
||||
|
||||
function withTimeout(promise, ms, fallbackValue) {
|
||||
return Promise.race([
|
||||
promise.catch(() => fallbackValue),
|
||||
new Promise((resolve) => setTimeout(() => resolve(fallbackValue), ms)),
|
||||
]);
|
||||
}
|
||||
|
||||
/** Decode `?v=` (nevent/naddr/note/raw hex) into a relay filter. */
|
||||
function pointerToFilter(pointer) {
|
||||
const trimmed = typeof pointer === "string" ? pointer.trim() : "";
|
||||
if (!trimmed) {
|
||||
return null;
|
||||
}
|
||||
if (/^[0-9a-f]{64}$/i.test(trimmed)) {
|
||||
return { ids: [trimmed.toLowerCase()] };
|
||||
}
|
||||
try {
|
||||
const decoded = nip19.decode(trimmed);
|
||||
if (decoded.type === "nevent" && decoded.data?.id) {
|
||||
return { ids: [decoded.data.id] };
|
||||
}
|
||||
if (decoded.type === "note" && typeof decoded.data === "string") {
|
||||
return { ids: [decoded.data] };
|
||||
}
|
||||
if (decoded.type === "naddr" && decoded.data?.identifier) {
|
||||
return {
|
||||
kinds: [decoded.data.kind],
|
||||
authors: [decoded.data.pubkey],
|
||||
"#d": [decoded.data.identifier],
|
||||
};
|
||||
}
|
||||
} catch (err) {
|
||||
// Unparseable pointer -> generic card.
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function extractPubkeySet(event) {
|
||||
const out = new Set();
|
||||
if (!event || !Array.isArray(event.tags)) {
|
||||
return out;
|
||||
}
|
||||
for (const tag of event.tags) {
|
||||
if (!Array.isArray(tag) || tag[0] !== "p" || typeof tag[1] !== "string") {
|
||||
continue;
|
||||
}
|
||||
const value = tag[1].trim().toLowerCase();
|
||||
if (/^[0-9a-f]{64}$/.test(value)) {
|
||||
out.add(value);
|
||||
continue;
|
||||
}
|
||||
try {
|
||||
const decoded = nip19.decode(value);
|
||||
if (decoded.type === "npub" && typeof decoded.data === "string") {
|
||||
out.add(decoded.data.toLowerCase());
|
||||
}
|
||||
} catch (err) {
|
||||
// ignore malformed entries
|
||||
}
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
export default async function handler(req, res) {
|
||||
const host = req.headers?.host || new URL(SITE_ORIGIN).host;
|
||||
const proto = req.headers?.["x-forwarded-proto"] || "https";
|
||||
const requestUrl = new URL(req.url || "/", `${proto}://${host}`);
|
||||
const pointer = requestUrl.searchParams.get("v") || "";
|
||||
|
||||
// Derive the origin from the REQUEST, not from a constant. Otherwise every
|
||||
// non-production deployment (unstable, previews) advertises production's
|
||||
// canonical URL and — worse — a twitter:player pointing at production's
|
||||
// embed, so testing a preview link silently exercises the live site.
|
||||
const origin = `${proto}://${host}`;
|
||||
|
||||
const shareUrl = pointer
|
||||
? `${origin}/?v=${encodeURIComponent(pointer)}`
|
||||
: origin;
|
||||
const embedUrl = pointer
|
||||
? `${origin}/embed.html?pointer=${encodeURIComponent(pointer)}`
|
||||
: "";
|
||||
|
||||
const renderFallback = (reason) => {
|
||||
// Short TTL: a video may be published, edited or moderated at any time, and
|
||||
// we would rather re-ask the relays than pin a wrong card in someone's CDN.
|
||||
res.setHeader("Content-Type", "text/html; charset=utf-8");
|
||||
res.setHeader("Cache-Control", "public, s-maxage=300, stale-while-revalidate=600");
|
||||
res.setHeader("X-Bitvid-OG", reason);
|
||||
res.status(200).send(
|
||||
renderOgHtml({
|
||||
video: null,
|
||||
shareUrl,
|
||||
fallback: { ...FALLBACK, url: origin, image: `${origin}/assets/jpg/bitvid.jpg` },
|
||||
})
|
||||
);
|
||||
};
|
||||
|
||||
// Defensive: the rewrite should only send crawlers here, but never serve a
|
||||
// human this stub if the rule ever widens.
|
||||
if (!isCrawlerUserAgent(req.headers?.["user-agent"])) {
|
||||
res.setHeader("Cache-Control", "no-store");
|
||||
res.redirect(302, shareUrl);
|
||||
return;
|
||||
}
|
||||
|
||||
const filter = pointerToFilter(pointer);
|
||||
if (!filter) {
|
||||
renderFallback("no-pointer");
|
||||
return;
|
||||
}
|
||||
|
||||
const pool = new SimplePool();
|
||||
let superAdminHex = "";
|
||||
try {
|
||||
const decoded = nip19.decode(ADMIN_SUPER_NPUB);
|
||||
superAdminHex = decoded.type === "npub" ? decoded.data : "";
|
||||
} catch (err) {
|
||||
superAdminHex = "";
|
||||
}
|
||||
|
||||
try {
|
||||
const listFilter = (identifier) => ({
|
||||
kinds: [ADMIN_LIST_KIND],
|
||||
"#d": [`${ADMIN_LIST_NAMESPACE}:${identifier}`],
|
||||
...(superAdminHex ? { authors: [superAdminHex] } : {}),
|
||||
});
|
||||
|
||||
// One shared deadline across all three reads.
|
||||
const now = Date.now();
|
||||
const adminListsFresh =
|
||||
adminListCache.expiresAt > now && adminListCache.whitelist instanceof Set;
|
||||
|
||||
const [videoEvent, whitelistEvent, blacklistEvent] = await Promise.all([
|
||||
withTimeout(pool.get(RELAYS, filter), RELAY_TIMEOUT_MS, null),
|
||||
adminListsFresh
|
||||
? Promise.resolve(null)
|
||||
: withTimeout(
|
||||
pool.get(RELAYS, listFilter(ADMIN_LIST_IDENTIFIERS.whitelist)),
|
||||
RELAY_TIMEOUT_MS,
|
||||
null
|
||||
),
|
||||
adminListsFresh
|
||||
? Promise.resolve(null)
|
||||
: withTimeout(
|
||||
pool.get(RELAYS, listFilter(ADMIN_LIST_IDENTIFIERS.blacklist)),
|
||||
RELAY_TIMEOUT_MS,
|
||||
null
|
||||
),
|
||||
]);
|
||||
|
||||
let whitelist = adminListsFresh ? adminListCache.whitelist : null;
|
||||
let blacklist = adminListsFresh ? adminListCache.blacklist : null;
|
||||
if (!adminListsFresh) {
|
||||
whitelist = extractPubkeySet(whitelistEvent);
|
||||
blacklist = extractPubkeySet(blacklistEvent);
|
||||
// Only cache a whitelist we actually got. Caching an empty one would pin
|
||||
// "whitelist-unavailable" for the whole TTL after a single slow read.
|
||||
if (whitelist.size > 0) {
|
||||
adminListCache = {
|
||||
expiresAt: now + ADMIN_LIST_TTL_MS,
|
||||
whitelist,
|
||||
blacklist,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
const video = parseVideoEvent(videoEvent);
|
||||
if (!video) {
|
||||
renderFallback("event-not-found");
|
||||
return;
|
||||
}
|
||||
|
||||
const gate = isPubliclyShareable(video, {
|
||||
whitelistEnabled: true,
|
||||
whitelist,
|
||||
blacklist,
|
||||
});
|
||||
|
||||
if (!gate.allowed) {
|
||||
renderFallback(`gated:${gate.reason}`);
|
||||
return;
|
||||
}
|
||||
|
||||
res.setHeader("Content-Type", "text/html; charset=utf-8");
|
||||
res.setHeader("Cache-Control", "public, s-maxage=300, stale-while-revalidate=600");
|
||||
res.setHeader("X-Bitvid-OG", "video");
|
||||
res.status(200).send(
|
||||
renderOgHtml({
|
||||
video,
|
||||
shareUrl,
|
||||
embedUrl,
|
||||
fallback: { ...FALLBACK, url: origin, image: `${origin}/assets/jpg/bitvid.jpg` },
|
||||
gate,
|
||||
})
|
||||
);
|
||||
} catch (err) {
|
||||
renderFallback("error");
|
||||
} finally {
|
||||
try {
|
||||
pool.close(RELAYS);
|
||||
} catch (err) {
|
||||
// ignore
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,130 +0,0 @@
|
||||
|
||||
import os
|
||||
|
||||
filepath = 'js/dmDecryptor.js'
|
||||
|
||||
with open(filepath, 'r') as f:
|
||||
content = f.read()
|
||||
|
||||
search_block = """ for (const decryptor of ordered) {
|
||||
for (const remotePubkey of remoteCandidates) {
|
||||
try {
|
||||
const plaintext = await decryptor.decrypt(remotePubkey, ciphertext, {
|
||||
event,
|
||||
stage: "content",
|
||||
remotePubkey,
|
||||
});
|
||||
|
||||
if (typeof plaintext === "string") {
|
||||
const resolvedScheme =
|
||||
normalizeScheme(hints.algorithms?.[0]) ||
|
||||
normalizeScheme(decryptor.scheme) ||
|
||||
"";
|
||||
return buildDecryptResult({
|
||||
ok: true,
|
||||
event,
|
||||
message: {
|
||||
...cloneEvent(event),
|
||||
content: plaintext,
|
||||
},
|
||||
plaintext,
|
||||
recipients,
|
||||
senderPubkey,
|
||||
actorPubkey,
|
||||
decryptor,
|
||||
scheme: resolvedScheme,
|
||||
});
|
||||
}
|
||||
} catch (error) {
|
||||
errors.push({
|
||||
scheme: decryptor.scheme || "",
|
||||
source: decryptor.source || "",
|
||||
stage: "content",
|
||||
remotePubkey,
|
||||
error,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return buildDecryptResult({
|
||||
ok: false,
|
||||
event,
|
||||
actorPubkey,
|
||||
errors,
|
||||
});"""
|
||||
|
||||
replace_block = """ const attemptDecryption = async (decryptor, remotePubkey) => {
|
||||
try {
|
||||
const plaintext = await decryptor.decrypt(remotePubkey, ciphertext, {
|
||||
event,
|
||||
stage: "content",
|
||||
remotePubkey,
|
||||
});
|
||||
|
||||
if (typeof plaintext === "string") {
|
||||
const resolvedScheme =
|
||||
normalizeScheme(hints.algorithms?.[0]) ||
|
||||
normalizeScheme(decryptor.scheme) ||
|
||||
"";
|
||||
return buildDecryptResult({
|
||||
ok: true,
|
||||
event,
|
||||
message: {
|
||||
...cloneEvent(event),
|
||||
content: plaintext,
|
||||
},
|
||||
plaintext,
|
||||
recipients,
|
||||
senderPubkey,
|
||||
actorPubkey,
|
||||
decryptor,
|
||||
scheme: resolvedScheme,
|
||||
});
|
||||
}
|
||||
throw new Error("Decrypted content was not a valid string.");
|
||||
} catch (error) {
|
||||
throw {
|
||||
scheme: decryptor.scheme || "",
|
||||
source: decryptor.source || "",
|
||||
stage: "content",
|
||||
remotePubkey,
|
||||
error,
|
||||
};
|
||||
}
|
||||
};
|
||||
|
||||
const attempts = [];
|
||||
for (const decryptor of ordered) {
|
||||
for (const remotePubkey of remoteCandidates) {
|
||||
attempts.push(attemptDecryption(decryptor, remotePubkey));
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
return await Promise.any(attempts);
|
||||
} catch (aggregateError) {
|
||||
const aggregatedErrors = aggregateError.errors || [];
|
||||
errors.push(...aggregatedErrors);
|
||||
|
||||
return buildDecryptResult({
|
||||
ok: false,
|
||||
event,
|
||||
actorPubkey,
|
||||
errors,
|
||||
});
|
||||
}"""
|
||||
|
||||
if search_block in content:
|
||||
new_content = content.replace(search_block, replace_block)
|
||||
with open(filepath, 'w') as f:
|
||||
f.write(new_content)
|
||||
print("Successfully replaced content.")
|
||||
else:
|
||||
print("Search block not found.")
|
||||
# Debug: print what we have roughly where it should be
|
||||
start_idx = content.find("for (const decryptor of ordered) {")
|
||||
if start_idx != -1:
|
||||
print("Found start of block, but full block mismatch.")
|
||||
print("Existing content snippet:")
|
||||
print(content[start_idx:start_idx+500])
|
||||
@@ -1,29 +0,0 @@
|
||||
# Onboarding Audit Report
|
||||
Date: 2025-02-11
|
||||
|
||||
## Summary
|
||||
The onboarding process was audited by simulating a fresh checkout and running the documented commands. All steps passed successfully. To further improve reliability, strict Node version enforcement was added.
|
||||
|
||||
## Environment
|
||||
- **Node Version**: v22.22.0
|
||||
- **NPM Version**: 11.7.0
|
||||
- **OS**: Linux (Sandbox)
|
||||
|
||||
## Commands Executed
|
||||
1. `npm ci` - **PASS**
|
||||
- Clean install of dependencies.
|
||||
- Added 424 packages.
|
||||
2. `npm run build:css` - **PASS**
|
||||
- Built Tailwind CSS successfully.
|
||||
3. `npm run format` - **PASS**
|
||||
- Checked formatting for CSS, HTML, MD, Config.
|
||||
- No files were modified (compliance verified).
|
||||
|
||||
## Configuration Checks
|
||||
- **package.json**: `engines.node` is set to `>=22`.
|
||||
- **.devcontainer/devcontainer.json**: Uses `mcr.microsoft.com/devcontainers/javascript-node:22`, consistent with `package.json`.
|
||||
- **Dockerfile**: Uses `mcr.microsoft.com/playwright:v1.58.0-jammy`. Verified compatible with Node 22 requirement.
|
||||
|
||||
## Improvements Implemented
|
||||
- **Enforce Node Version**: created `.npmrc` with `engine-strict=true`. This ensures developers are using the required Node version (>=22) during `npm install`/`ci`.
|
||||
- **Documentation**: Updated `README.md` and `CONTRIBUTING.md` to explicitly mention the Node version requirement and its enforcement.
|
||||
@@ -1,224 +0,0 @@
|
||||
{
|
||||
"grandfathered_files": 43,
|
||||
"grandfathered_excess_lines": 49463,
|
||||
"new_oversized_files": 0,
|
||||
"new_excess_lines": 0,
|
||||
"grandfathered_list": [
|
||||
{
|
||||
"path": "js/adminListStore.js",
|
||||
"lines": 1033,
|
||||
"excess": 33
|
||||
},
|
||||
{
|
||||
"path": "js/app/authSessionCoordinator.js",
|
||||
"lines": 1743,
|
||||
"excess": 743
|
||||
},
|
||||
{
|
||||
"path": "js/app/feedCoordinator.js",
|
||||
"lines": 1767,
|
||||
"excess": 767
|
||||
},
|
||||
{
|
||||
"path": "js/app/playbackCoordinator.js",
|
||||
"lines": 1217,
|
||||
"excess": 217
|
||||
},
|
||||
{
|
||||
"path": "js/app.js",
|
||||
"lines": 5245,
|
||||
"excess": 4245
|
||||
},
|
||||
{
|
||||
"path": "js/channelProfile.js",
|
||||
"lines": 5530,
|
||||
"excess": 4530
|
||||
},
|
||||
{
|
||||
"path": "js/feedEngine/stages.js",
|
||||
"lines": 1350,
|
||||
"excess": 350
|
||||
},
|
||||
{
|
||||
"path": "js/historyView.js",
|
||||
"lines": 2547,
|
||||
"excess": 1547
|
||||
},
|
||||
{
|
||||
"path": "js/index.js",
|
||||
"lines": 1407,
|
||||
"excess": 407
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/client.js",
|
||||
"lines": 3990,
|
||||
"excess": 2990
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/managers/SignerManager.js",
|
||||
"lines": 1106,
|
||||
"excess": 106
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/nip46Client.js",
|
||||
"lines": 2102,
|
||||
"excess": 1102
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/nip46Connector.js",
|
||||
"lines": 1094,
|
||||
"excess": 94
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/nip71.js",
|
||||
"lines": 1531,
|
||||
"excess": 531
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/publishHelpers.js",
|
||||
"lines": 1415,
|
||||
"excess": 415
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/watchHistory.js",
|
||||
"lines": 2211,
|
||||
"excess": 1211
|
||||
},
|
||||
{
|
||||
"path": "js/nostrEventSchemas.js",
|
||||
"lines": 2908,
|
||||
"excess": 1908
|
||||
},
|
||||
{
|
||||
"path": "js/payments/nwcClient.js",
|
||||
"lines": 1642,
|
||||
"excess": 642
|
||||
},
|
||||
{
|
||||
"path": "js/services/authService.js",
|
||||
"lines": 1321,
|
||||
"excess": 321
|
||||
},
|
||||
{
|
||||
"path": "js/services/commentThreadService.js",
|
||||
"lines": 1122,
|
||||
"excess": 122
|
||||
},
|
||||
{
|
||||
"path": "js/services/hashtagPreferencesService.js",
|
||||
"lines": 1435,
|
||||
"excess": 435
|
||||
},
|
||||
{
|
||||
"path": "js/services/moderationService.js",
|
||||
"lines": 2513,
|
||||
"excess": 1513
|
||||
},
|
||||
{
|
||||
"path": "js/services/nostrService.js",
|
||||
"lines": 2227,
|
||||
"excess": 1227
|
||||
},
|
||||
{
|
||||
"path": "js/services/playbackService.js",
|
||||
"lines": 1289,
|
||||
"excess": 289
|
||||
},
|
||||
{
|
||||
"path": "js/services/r2Service.js",
|
||||
"lines": 1194,
|
||||
"excess": 194
|
||||
},
|
||||
{
|
||||
"path": "js/state/cache.js",
|
||||
"lines": 1829,
|
||||
"excess": 829
|
||||
},
|
||||
{
|
||||
"path": "js/subscriptions.js",
|
||||
"lines": 2374,
|
||||
"excess": 1374
|
||||
},
|
||||
{
|
||||
"path": "js/ui/applicationBootstrap.js",
|
||||
"lines": 1169,
|
||||
"excess": 169
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/EditModal.js",
|
||||
"lines": 1130,
|
||||
"excess": 130
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/RevertModal.js",
|
||||
"lines": 1663,
|
||||
"excess": 663
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/SimilarContentCard.js",
|
||||
"lines": 1303,
|
||||
"excess": 303
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/UploadModal.js",
|
||||
"lines": 1320,
|
||||
"excess": 320
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/VideoCard.js",
|
||||
"lines": 3130,
|
||||
"excess": 2130
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/VideoModal.js",
|
||||
"lines": 6285,
|
||||
"excess": 5285
|
||||
},
|
||||
{
|
||||
"path": "js/ui/loginModalController.js",
|
||||
"lines": 2552,
|
||||
"excess": 1552
|
||||
},
|
||||
{
|
||||
"path": "js/ui/moreMenuController.js",
|
||||
"lines": 1601,
|
||||
"excess": 601
|
||||
},
|
||||
{
|
||||
"path": "js/ui/overlay/popoverEngine.js",
|
||||
"lines": 1070,
|
||||
"excess": 70
|
||||
},
|
||||
{
|
||||
"path": "js/ui/profileModalController.js",
|
||||
"lines": 8757,
|
||||
"excess": 7757
|
||||
},
|
||||
{
|
||||
"path": "js/ui/views/VideoListView.js",
|
||||
"lines": 1392,
|
||||
"excess": 392
|
||||
},
|
||||
{
|
||||
"path": "js/ui/zapController.js",
|
||||
"lines": 1206,
|
||||
"excess": 206
|
||||
},
|
||||
{
|
||||
"path": "js/userBlocks.js",
|
||||
"lines": 2305,
|
||||
"excess": 1305
|
||||
},
|
||||
{
|
||||
"path": "js/watchHistoryService.js",
|
||||
"lines": 1400,
|
||||
"excess": 400
|
||||
},
|
||||
{
|
||||
"path": "js/webtorrent.js",
|
||||
"lines": 1038,
|
||||
"excess": 38
|
||||
}
|
||||
],
|
||||
"new_list": []
|
||||
}
|
||||
@@ -1,177 +0,0 @@
|
||||
{
|
||||
"total_assignments": 87,
|
||||
"files_count": 34,
|
||||
"top_offenders": [
|
||||
{
|
||||
"path": "js/channelProfile.js",
|
||||
"count": 10,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/RevertModal.js",
|
||||
"count": 10,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/docsView.js",
|
||||
"count": 8,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/subscriptions.js",
|
||||
"count": 7,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/subscriptionHistoryController.js",
|
||||
"count": 7,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/historyView.js",
|
||||
"count": 4,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/DeleteModal.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/ShareNostrModal.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/DMSettingsModalController.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/loginModalController.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/views/VideoListView.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/viewManager.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/utils/qrcode.js",
|
||||
"count": 2,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/app/feedCoordinator.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/app.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/exploreView.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/forYouView.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/index.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/kidsView.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/EditModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/EmbedVideoModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/EventDetailsModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/UploadModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/VideoModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/nip71FormManager.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/AppShell.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/Composer.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/ConversationList.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/DMRelaySettings.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/MessageThread.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/NotificationCenter.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/moreMenuController.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/profileModalController.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/videoListViewController.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
}
|
||||
],
|
||||
"violations": []
|
||||
}
|
||||
@@ -1,11 +0,0 @@
|
||||
{
|
||||
"total_failures": 0,
|
||||
"files_with_errors": [],
|
||||
"skipped_checks": [
|
||||
{
|
||||
"check": "lint:assets",
|
||||
"reason": "Missing dist/asset-manifest.json.",
|
||||
"details": "asset reference check (build required)."
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,40 +0,0 @@
|
||||
Title: Audit Report — 2026-02-12 (unstable)
|
||||
|
||||
**Summary**
|
||||
|
||||
* Date: 2026-02-12
|
||||
* Branch: unstable
|
||||
|
||||
**Metrics**
|
||||
|
||||
* Grandfathered oversized files: 43 files (total excess lines: 49463)
|
||||
* New oversized files: 0 files (total excess lines: 0)
|
||||
* Total innerHTML assignments: 87 across 34 files
|
||||
|
||||
* Top offenders:
|
||||
|
||||
1. js/channelProfile.js — 10
|
||||
2. js/ui/components/RevertModal.js — 10
|
||||
3. js/docsView.js — 8
|
||||
4. js/subscriptions.js — 7
|
||||
5. js/ui/subscriptionHistoryController.js — 7
|
||||
6. js/historyView.js — 4
|
||||
7. js/ui/components/DeleteModal.js — 3
|
||||
8. js/ui/components/ShareNostrModal.js — 3
|
||||
9. js/ui/dm/DMSettingsModalController.js — 3
|
||||
10. js/ui/loginModalController.js — 3
|
||||
|
||||
* Lint failures: 0
|
||||
* Skipped checks: 1
|
||||
* lint:assets: Missing dist/asset-manifest.json.
|
||||
|
||||
**High-priority items**
|
||||
|
||||
* None. Keep it up!
|
||||
|
||||
**Artifacts**
|
||||
|
||||
* file-size-report.json
|
||||
* innerhtml-report.json
|
||||
* lint-report.json
|
||||
* raw logs
|
||||
@@ -1,224 +0,0 @@
|
||||
{
|
||||
"grandfathered_files": 43,
|
||||
"grandfathered_excess_lines": 45216,
|
||||
"new_oversized_files": 0,
|
||||
"new_excess_lines": 0,
|
||||
"grandfathered_list": [
|
||||
{
|
||||
"path": "js/adminListStore.js",
|
||||
"lines": 1033,
|
||||
"excess": 33
|
||||
},
|
||||
{
|
||||
"path": "js/app/authSessionCoordinator.js",
|
||||
"lines": 1743,
|
||||
"excess": 743
|
||||
},
|
||||
{
|
||||
"path": "js/app/feedCoordinator.js",
|
||||
"lines": 1767,
|
||||
"excess": 767
|
||||
},
|
||||
{
|
||||
"path": "js/app/playbackCoordinator.js",
|
||||
"lines": 1217,
|
||||
"excess": 217
|
||||
},
|
||||
{
|
||||
"path": "js/app.js",
|
||||
"lines": 5133,
|
||||
"excess": 4133
|
||||
},
|
||||
{
|
||||
"path": "js/channelProfile.js",
|
||||
"lines": 5579,
|
||||
"excess": 4579
|
||||
},
|
||||
{
|
||||
"path": "js/feedEngine/stages.js",
|
||||
"lines": 1350,
|
||||
"excess": 350
|
||||
},
|
||||
{
|
||||
"path": "js/historyView.js",
|
||||
"lines": 2547,
|
||||
"excess": 1547
|
||||
},
|
||||
{
|
||||
"path": "js/index.js",
|
||||
"lines": 1409,
|
||||
"excess": 409
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/client.js",
|
||||
"lines": 4001,
|
||||
"excess": 3001
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/managers/SignerManager.js",
|
||||
"lines": 1107,
|
||||
"excess": 107
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/nip46Client.js",
|
||||
"lines": 2104,
|
||||
"excess": 1104
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/nip46Connector.js",
|
||||
"lines": 1094,
|
||||
"excess": 94
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/nip71.js",
|
||||
"lines": 1600,
|
||||
"excess": 600
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/publishHelpers.js",
|
||||
"lines": 1415,
|
||||
"excess": 415
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/watchHistory.js",
|
||||
"lines": 2211,
|
||||
"excess": 1211
|
||||
},
|
||||
{
|
||||
"path": "js/nostrEventSchemas.js",
|
||||
"lines": 3192,
|
||||
"excess": 2192
|
||||
},
|
||||
{
|
||||
"path": "js/payments/nwcClient.js",
|
||||
"lines": 1642,
|
||||
"excess": 642
|
||||
},
|
||||
{
|
||||
"path": "js/services/authService.js",
|
||||
"lines": 1321,
|
||||
"excess": 321
|
||||
},
|
||||
{
|
||||
"path": "js/services/commentThreadService.js",
|
||||
"lines": 1122,
|
||||
"excess": 122
|
||||
},
|
||||
{
|
||||
"path": "js/services/hashtagPreferencesService.js",
|
||||
"lines": 1435,
|
||||
"excess": 435
|
||||
},
|
||||
{
|
||||
"path": "js/services/moderationService.js",
|
||||
"lines": 2557,
|
||||
"excess": 1557
|
||||
},
|
||||
{
|
||||
"path": "js/services/nostrService.js",
|
||||
"lines": 2227,
|
||||
"excess": 1227
|
||||
},
|
||||
{
|
||||
"path": "js/services/playbackService.js",
|
||||
"lines": 1316,
|
||||
"excess": 316
|
||||
},
|
||||
{
|
||||
"path": "js/services/r2Service.js",
|
||||
"lines": 1194,
|
||||
"excess": 194
|
||||
},
|
||||
{
|
||||
"path": "js/state/cache.js",
|
||||
"lines": 1829,
|
||||
"excess": 829
|
||||
},
|
||||
{
|
||||
"path": "js/subscriptions.js",
|
||||
"lines": 2410,
|
||||
"excess": 1410
|
||||
},
|
||||
{
|
||||
"path": "js/ui/applicationBootstrap.js",
|
||||
"lines": 1169,
|
||||
"excess": 169
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/EditModal.js",
|
||||
"lines": 1130,
|
||||
"excess": 130
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/RevertModal.js",
|
||||
"lines": 1509,
|
||||
"excess": 509
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/SimilarContentCard.js",
|
||||
"lines": 1303,
|
||||
"excess": 303
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/UploadModal.js",
|
||||
"lines": 1320,
|
||||
"excess": 320
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/VideoCard.js",
|
||||
"lines": 3130,
|
||||
"excess": 2130
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/VideoModal.js",
|
||||
"lines": 4976,
|
||||
"excess": 3976
|
||||
},
|
||||
{
|
||||
"path": "js/ui/loginModalController.js",
|
||||
"lines": 2574,
|
||||
"excess": 1574
|
||||
},
|
||||
{
|
||||
"path": "js/ui/moreMenuController.js",
|
||||
"lines": 1601,
|
||||
"excess": 601
|
||||
},
|
||||
{
|
||||
"path": "js/ui/overlay/popoverEngine.js",
|
||||
"lines": 1070,
|
||||
"excess": 70
|
||||
},
|
||||
{
|
||||
"path": "js/ui/profileModalController.js",
|
||||
"lines": 5541,
|
||||
"excess": 4541
|
||||
},
|
||||
{
|
||||
"path": "js/ui/views/VideoListView.js",
|
||||
"lines": 1392,
|
||||
"excess": 392
|
||||
},
|
||||
{
|
||||
"path": "js/ui/zapController.js",
|
||||
"lines": 1206,
|
||||
"excess": 206
|
||||
},
|
||||
{
|
||||
"path": "js/userBlocks.js",
|
||||
"lines": 2302,
|
||||
"excess": 1302
|
||||
},
|
||||
{
|
||||
"path": "js/watchHistoryService.js",
|
||||
"lines": 1400,
|
||||
"excess": 400
|
||||
},
|
||||
{
|
||||
"path": "js/webtorrent.js",
|
||||
"lines": 1038,
|
||||
"excess": 38
|
||||
}
|
||||
],
|
||||
"new_list": []
|
||||
}
|
||||
@@ -1,147 +0,0 @@
|
||||
{
|
||||
"total_assignments": 37,
|
||||
"files_count": 28,
|
||||
"top_offenders": [
|
||||
{
|
||||
"path": "js/ui/dm/DMSettingsModalController.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/loginModalController.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/views/VideoListView.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/viewManager.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/utils/qrcode.js",
|
||||
"count": 2,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/app/feedCoordinator.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/app.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/docsView.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/exploreView.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/forYouView.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/index.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/kidsView.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/EditModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/EmbedVideoModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/EventDetailsModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/UploadModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/VideoModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/nip71FormManager.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/AppShell.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/Composer.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/ConversationList.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/DMRelaySettings.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/MessageThread.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/NotificationCenter.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/moreMenuController.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/profileModalController.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/subscriptionHistoryController.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/videoListViewController.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
}
|
||||
],
|
||||
"violations": []
|
||||
}
|
||||
@@ -1,11 +0,0 @@
|
||||
{
|
||||
"total_failures": 0,
|
||||
"files_with_errors": [],
|
||||
"skipped_checks": [
|
||||
{
|
||||
"check": "lint:assets",
|
||||
"reason": "Missing dist/asset-manifest.json.",
|
||||
"details": "asset reference check (build required)."
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,47 +0,0 @@
|
||||
|
||||
43 grandfathered oversized file(s):
|
||||
⚠ grandfathered: js/adminListStore.js (1033 lines)
|
||||
⚠ grandfathered: js/app/authSessionCoordinator.js (1743 lines)
|
||||
⚠ grandfathered: js/app/feedCoordinator.js (1767 lines)
|
||||
⚠ grandfathered: js/app/playbackCoordinator.js (1217 lines)
|
||||
⚠ grandfathered: js/app.js (5133 lines)
|
||||
⚠ grandfathered: js/channelProfile.js (5579 lines)
|
||||
⚠ grandfathered: js/feedEngine/stages.js (1350 lines)
|
||||
⚠ grandfathered: js/historyView.js (2547 lines)
|
||||
⚠ grandfathered: js/index.js (1409 lines)
|
||||
⚠ grandfathered: js/nostr/client.js (4001 lines)
|
||||
⚠ grandfathered: js/nostr/managers/SignerManager.js (1107 lines)
|
||||
⚠ grandfathered: js/nostr/nip46Client.js (2104 lines)
|
||||
⚠ grandfathered: js/nostr/nip46Connector.js (1094 lines)
|
||||
⚠ grandfathered: js/nostr/nip71.js (1600 lines)
|
||||
⚠ grandfathered: js/nostr/publishHelpers.js (1415 lines)
|
||||
⚠ grandfathered: js/nostr/watchHistory.js (2211 lines)
|
||||
⚠ grandfathered: js/nostrEventSchemas.js (3192 lines)
|
||||
⚠ grandfathered: js/payments/nwcClient.js (1642 lines)
|
||||
⚠ grandfathered: js/services/authService.js (1321 lines)
|
||||
⚠ grandfathered: js/services/commentThreadService.js (1122 lines)
|
||||
⚠ grandfathered: js/services/hashtagPreferencesService.js (1435 lines)
|
||||
⚠ grandfathered: js/services/moderationService.js (2557 lines)
|
||||
⚠ grandfathered: js/services/nostrService.js (2227 lines)
|
||||
⚠ grandfathered: js/services/playbackService.js (1316 lines)
|
||||
⚠ grandfathered: js/services/r2Service.js (1194 lines)
|
||||
⚠ grandfathered: js/state/cache.js (1829 lines)
|
||||
⚠ grandfathered: js/subscriptions.js (2410 lines)
|
||||
⚠ grandfathered: js/ui/applicationBootstrap.js (1169 lines)
|
||||
⚠ grandfathered: js/ui/components/EditModal.js (1130 lines)
|
||||
⚠ grandfathered: js/ui/components/RevertModal.js (1509 lines)
|
||||
⚠ grandfathered: js/ui/components/SimilarContentCard.js (1303 lines)
|
||||
⚠ grandfathered: js/ui/components/UploadModal.js (1320 lines)
|
||||
⚠ grandfathered: js/ui/components/VideoCard.js (3130 lines)
|
||||
⚠ grandfathered: js/ui/components/VideoModal.js (4976 lines)
|
||||
⚠ grandfathered: js/ui/loginModalController.js (2574 lines)
|
||||
⚠ grandfathered: js/ui/moreMenuController.js (1601 lines)
|
||||
⚠ grandfathered: js/ui/overlay/popoverEngine.js (1070 lines)
|
||||
⚠ grandfathered: js/ui/profileModalController.js (5541 lines)
|
||||
⚠ grandfathered: js/ui/views/VideoListView.js (1392 lines)
|
||||
⚠ grandfathered: js/ui/zapController.js (1206 lines)
|
||||
⚠ grandfathered: js/userBlocks.js (2302 lines)
|
||||
⚠ grandfathered: js/watchHistoryService.js (1400 lines)
|
||||
⚠ grandfathered: js/webtorrent.js (1038 lines)
|
||||
|
||||
No violations. 43 grandfathered file(s) remain as decomposition targets.
|
||||
@@ -1,30 +0,0 @@
|
||||
innerHTML usage: 37 assignments across 28 files
|
||||
|
||||
js/ui/dm/DMSettingsModalController.js: 3
|
||||
js/ui/loginModalController.js: 3
|
||||
js/ui/views/VideoListView.js: 3
|
||||
js/viewManager.js: 3
|
||||
js/utils/qrcode.js: 2
|
||||
js/app/feedCoordinator.js: 1
|
||||
js/app.js: 1
|
||||
js/docsView.js: 1
|
||||
js/exploreView.js: 1
|
||||
js/forYouView.js: 1
|
||||
js/index.js: 1
|
||||
js/kidsView.js: 1
|
||||
js/ui/components/EditModal.js: 1
|
||||
js/ui/components/EmbedVideoModal.js: 1
|
||||
js/ui/components/EventDetailsModal.js: 1
|
||||
js/ui/components/UploadModal.js: 1
|
||||
js/ui/components/VideoModal.js: 1
|
||||
js/ui/components/nip71FormManager.js: 1
|
||||
js/ui/dm/AppShell.js: 1
|
||||
js/ui/dm/Composer.js: 1
|
||||
js/ui/dm/ConversationList.js: 1
|
||||
js/ui/dm/DMRelaySettings.js: 1
|
||||
js/ui/dm/MessageThread.js: 1
|
||||
js/ui/dm/NotificationCenter.js: 1
|
||||
js/ui/moreMenuController.js: 1
|
||||
js/ui/profileModalController.js: 1
|
||||
js/ui/subscriptionHistoryController.js: 1
|
||||
js/ui/videoListViewController.js: 1
|
||||
@@ -1,48 +0,0 @@
|
||||
|
||||
> [email protected] lint
|
||||
> npm run lint:css && npm run lint:hex && npm run lint:inline-styles && npm run lint:tokens && npm run lint:tailwind-brackets && npm run lint:tailwind-colors && npm run lint:file-size && npm run lint:innerhtml && npm run lint:assets && npm run lint:sw-compat
|
||||
|
||||
|
||||
> [email protected] lint:css
|
||||
> stylelint css/tailwind.source.css css/tokens.css css/docs.css
|
||||
|
||||
|
||||
> [email protected] lint:hex
|
||||
> node scripts/check-hex.js
|
||||
|
||||
|
||||
> [email protected] lint:inline-styles
|
||||
> node scripts/check-inline-styles.mjs
|
||||
|
||||
No inline style usage found.
|
||||
|
||||
> [email protected] lint:tokens
|
||||
> node scripts/check-design-tokens.mjs --check=tokens
|
||||
|
||||
|
||||
> [email protected] lint:tailwind-brackets
|
||||
> node scripts/check-design-tokens.mjs --check=brackets
|
||||
|
||||
|
||||
> [email protected] lint:tailwind-colors
|
||||
> node scripts/check-tailwind-colors.mjs
|
||||
|
||||
|
||||
> [email protected] lint:file-size
|
||||
> node scripts/check-file-size.mjs
|
||||
|
||||
|
||||
> [email protected] lint:innerhtml
|
||||
> node scripts/check-innerhtml.mjs
|
||||
|
||||
|
||||
> [email protected] lint:assets
|
||||
> node scripts/check-asset-references.mjs
|
||||
|
||||
[lint:assets] Missing dist/asset-manifest.json. Skipping asset reference check (build required).
|
||||
|
||||
> [email protected] lint:sw-compat
|
||||
> node scripts/check-sw-compat.mjs
|
||||
|
||||
[sw-compat] Skipping check: unable to determine HEAD^ or git history unavailable.
|
||||
[sw-compat] No commit delta found; skipping compatibility check.
|
||||
@@ -1,47 +0,0 @@
|
||||
# Audit Report — 2026-02-21 (unstable)
|
||||
|
||||
**Summary**
|
||||
|
||||
* **Date:** 2026-02-21 15:15 UTC
|
||||
* **Node:** v22.22.0 / **OS:** Linux
|
||||
* **Status:** ✅ Clean. Significant improvements in technical debt metrics.
|
||||
|
||||
**Metrics**
|
||||
|
||||
* **Grandfathered oversized files:** 43 files
|
||||
* Total excess lines: **45,216** (was 49,463)
|
||||
* Delta: **-4,247 lines** (Improvement)
|
||||
* **New oversized files:** 0 files (total excess lines: 0)
|
||||
* **Total innerHTML assignments:** **37** (was 87)
|
||||
* Delta: **-50 assignments** (Improvement)
|
||||
* Files with innerHTML: 28 (was 34)
|
||||
|
||||
**Top offenders (innerHTML):**
|
||||
1. `js/ui/dm/DMSettingsModalController.js` — 3
|
||||
2. `js/ui/loginModalController.js` — 3
|
||||
3. `js/ui/views/VideoListView.js` — 3
|
||||
4. `js/viewManager.js` — 3
|
||||
5. `js/utils/qrcode.js` — 2
|
||||
|
||||
* **Lint failures:** 0 (files: 0)
|
||||
|
||||
**Delta vs previous (2026-02-12)**
|
||||
|
||||
* **Grandfathered:** 0 files, **-4,247** excess lines
|
||||
* **InnerHTML:** **-50** total assignments, **-6** files
|
||||
* **Lint:** 0 failures
|
||||
|
||||
**High-priority items**
|
||||
|
||||
* No new regressions.
|
||||
* Continue targeting the remaining 43 grandfathered files for decomposition.
|
||||
* Continue migrating the remaining 37 `innerHTML` assignments to safe DOM APIs.
|
||||
|
||||
**Artifacts**
|
||||
|
||||
* `file-size-report.json`
|
||||
* `innerhtml-report.json`
|
||||
* `lint-report.json`
|
||||
* `raw-check-file-size.log`
|
||||
* `raw-check-innerhtml.log`
|
||||
* `raw-lint.log`
|
||||
@@ -1,224 +0,0 @@
|
||||
{
|
||||
"grandfathered_files": 43,
|
||||
"grandfathered_excess_lines": 45288,
|
||||
"new_oversized_files": 0,
|
||||
"new_excess_lines": 0,
|
||||
"grandfathered_list": [
|
||||
{
|
||||
"path": "js/adminListStore.js",
|
||||
"lines": 1078,
|
||||
"excess": 78
|
||||
},
|
||||
{
|
||||
"path": "js/app/authSessionCoordinator.js",
|
||||
"lines": 1770,
|
||||
"excess": 770
|
||||
},
|
||||
{
|
||||
"path": "js/app/feedCoordinator.js",
|
||||
"lines": 1767,
|
||||
"excess": 767
|
||||
},
|
||||
{
|
||||
"path": "js/app/playbackCoordinator.js",
|
||||
"lines": 1217,
|
||||
"excess": 217
|
||||
},
|
||||
{
|
||||
"path": "js/app.js",
|
||||
"lines": 5077,
|
||||
"excess": 4077
|
||||
},
|
||||
{
|
||||
"path": "js/channelProfile.js",
|
||||
"lines": 5579,
|
||||
"excess": 4579
|
||||
},
|
||||
{
|
||||
"path": "js/feedEngine/stages.js",
|
||||
"lines": 1388,
|
||||
"excess": 388
|
||||
},
|
||||
{
|
||||
"path": "js/historyView.js",
|
||||
"lines": 2613,
|
||||
"excess": 1613
|
||||
},
|
||||
{
|
||||
"path": "js/index.js",
|
||||
"lines": 1409,
|
||||
"excess": 409
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/client.js",
|
||||
"lines": 4004,
|
||||
"excess": 3004
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/managers/SignerManager.js",
|
||||
"lines": 1135,
|
||||
"excess": 135
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/nip46Client.js",
|
||||
"lines": 2104,
|
||||
"excess": 1104
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/nip46Connector.js",
|
||||
"lines": 1094,
|
||||
"excess": 94
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/nip71.js",
|
||||
"lines": 1600,
|
||||
"excess": 600
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/publishHelpers.js",
|
||||
"lines": 1415,
|
||||
"excess": 415
|
||||
},
|
||||
{
|
||||
"path": "js/nostr/watchHistory.js",
|
||||
"lines": 2335,
|
||||
"excess": 1335
|
||||
},
|
||||
{
|
||||
"path": "js/nostrEventSchemas.js",
|
||||
"lines": 3192,
|
||||
"excess": 2192
|
||||
},
|
||||
{
|
||||
"path": "js/payments/nwcClient.js",
|
||||
"lines": 1642,
|
||||
"excess": 642
|
||||
},
|
||||
{
|
||||
"path": "js/services/authService.js",
|
||||
"lines": 1343,
|
||||
"excess": 343
|
||||
},
|
||||
{
|
||||
"path": "js/services/commentThreadService.js",
|
||||
"lines": 1122,
|
||||
"excess": 122
|
||||
},
|
||||
{
|
||||
"path": "js/services/hashtagPreferencesService.js",
|
||||
"lines": 1451,
|
||||
"excess": 451
|
||||
},
|
||||
{
|
||||
"path": "js/services/moderationService.js",
|
||||
"lines": 2140,
|
||||
"excess": 1140
|
||||
},
|
||||
{
|
||||
"path": "js/services/nostrService.js",
|
||||
"lines": 2227,
|
||||
"excess": 1227
|
||||
},
|
||||
{
|
||||
"path": "js/services/playbackService.js",
|
||||
"lines": 1316,
|
||||
"excess": 316
|
||||
},
|
||||
{
|
||||
"path": "js/services/r2Service.js",
|
||||
"lines": 1194,
|
||||
"excess": 194
|
||||
},
|
||||
{
|
||||
"path": "js/state/cache.js",
|
||||
"lines": 1829,
|
||||
"excess": 829
|
||||
},
|
||||
{
|
||||
"path": "js/subscriptions.js",
|
||||
"lines": 2437,
|
||||
"excess": 1437
|
||||
},
|
||||
{
|
||||
"path": "js/ui/applicationBootstrap.js",
|
||||
"lines": 1169,
|
||||
"excess": 169
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/EditModal.js",
|
||||
"lines": 1130,
|
||||
"excess": 130
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/RevertModal.js",
|
||||
"lines": 1509,
|
||||
"excess": 509
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/SimilarContentCard.js",
|
||||
"lines": 1303,
|
||||
"excess": 303
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/UploadModal.js",
|
||||
"lines": 1326,
|
||||
"excess": 326
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/VideoCard.js",
|
||||
"lines": 3141,
|
||||
"excess": 2141
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/VideoModal.js",
|
||||
"lines": 4976,
|
||||
"excess": 3976
|
||||
},
|
||||
{
|
||||
"path": "js/ui/loginModalController.js",
|
||||
"lines": 2574,
|
||||
"excess": 1574
|
||||
},
|
||||
{
|
||||
"path": "js/ui/moreMenuController.js",
|
||||
"lines": 1601,
|
||||
"excess": 601
|
||||
},
|
||||
{
|
||||
"path": "js/ui/overlay/popoverEngine.js",
|
||||
"lines": 1070,
|
||||
"excess": 70
|
||||
},
|
||||
{
|
||||
"path": "js/ui/profileModalController.js",
|
||||
"lines": 5572,
|
||||
"excess": 4572
|
||||
},
|
||||
{
|
||||
"path": "js/ui/views/VideoListView.js",
|
||||
"lines": 1392,
|
||||
"excess": 392
|
||||
},
|
||||
{
|
||||
"path": "js/ui/zapController.js",
|
||||
"lines": 1206,
|
||||
"excess": 206
|
||||
},
|
||||
{
|
||||
"path": "js/userBlocks.js",
|
||||
"lines": 2403,
|
||||
"excess": 1403
|
||||
},
|
||||
{
|
||||
"path": "js/watchHistoryService.js",
|
||||
"lines": 1400,
|
||||
"excess": 400
|
||||
},
|
||||
{
|
||||
"path": "js/webtorrent.js",
|
||||
"lines": 1038,
|
||||
"excess": 38
|
||||
}
|
||||
],
|
||||
"new_list": []
|
||||
}
|
||||
@@ -1,147 +0,0 @@
|
||||
{
|
||||
"total_assignments": 37,
|
||||
"files_count": 28,
|
||||
"top_offenders": [
|
||||
{
|
||||
"path": "js/ui/dm/DMSettingsModalController.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/loginModalController.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/views/VideoListView.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/viewManager.js",
|
||||
"count": 3,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/utils/qrcode.js",
|
||||
"count": 2,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/app/feedCoordinator.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/app.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/docsView.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/exploreView.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/forYouView.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/index.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/kidsView.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/EditModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/EmbedVideoModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/EventDetailsModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/UploadModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/VideoModal.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/components/nip71FormManager.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/AppShell.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/Composer.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/ConversationList.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/DMRelaySettings.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/MessageThread.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/dm/NotificationCenter.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/moreMenuController.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/profileModalController.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/subscriptionHistoryController.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
},
|
||||
{
|
||||
"path": "js/ui/videoListViewController.js",
|
||||
"count": 1,
|
||||
"is_new": false
|
||||
}
|
||||
],
|
||||
"violations": []
|
||||
}
|
||||
@@ -1,11 +0,0 @@
|
||||
{
|
||||
"total_failures": 0,
|
||||
"files_with_errors": [],
|
||||
"skipped_checks": [
|
||||
{
|
||||
"check": "lint:assets",
|
||||
"reason": "Missing dist/asset-manifest.json.",
|
||||
"details": "asset reference check (build required)."
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,47 +0,0 @@
|
||||
|
||||
43 grandfathered oversized file(s):
|
||||
⚠ grandfathered: js/adminListStore.js (1078 lines)
|
||||
⚠ grandfathered: js/app/authSessionCoordinator.js (1770 lines)
|
||||
⚠ grandfathered: js/app/feedCoordinator.js (1767 lines)
|
||||
⚠ grandfathered: js/app/playbackCoordinator.js (1217 lines)
|
||||
⚠ grandfathered: js/app.js (5077 lines)
|
||||
⚠ grandfathered: js/channelProfile.js (5579 lines)
|
||||
⚠ grandfathered: js/feedEngine/stages.js (1388 lines)
|
||||
⚠ grandfathered: js/historyView.js (2613 lines)
|
||||
⚠ grandfathered: js/index.js (1409 lines)
|
||||
⚠ grandfathered: js/nostr/client.js (4004 lines)
|
||||
⚠ grandfathered: js/nostr/managers/SignerManager.js (1135 lines)
|
||||
⚠ grandfathered: js/nostr/nip46Client.js (2104 lines)
|
||||
⚠ grandfathered: js/nostr/nip46Connector.js (1094 lines)
|
||||
⚠ grandfathered: js/nostr/nip71.js (1600 lines)
|
||||
⚠ grandfathered: js/nostr/publishHelpers.js (1415 lines)
|
||||
⚠ grandfathered: js/nostr/watchHistory.js (2335 lines)
|
||||
⚠ grandfathered: js/nostrEventSchemas.js (3192 lines)
|
||||
⚠ grandfathered: js/payments/nwcClient.js (1642 lines)
|
||||
⚠ grandfathered: js/services/authService.js (1343 lines)
|
||||
⚠ grandfathered: js/services/commentThreadService.js (1122 lines)
|
||||
⚠ grandfathered: js/services/hashtagPreferencesService.js (1451 lines)
|
||||
⚠ grandfathered: js/services/moderationService.js (2140 lines)
|
||||
⚠ grandfathered: js/services/nostrService.js (2227 lines)
|
||||
⚠ grandfathered: js/services/playbackService.js (1316 lines)
|
||||
⚠ grandfathered: js/services/r2Service.js (1194 lines)
|
||||
⚠ grandfathered: js/state/cache.js (1829 lines)
|
||||
⚠ grandfathered: js/subscriptions.js (2437 lines)
|
||||
⚠ grandfathered: js/ui/applicationBootstrap.js (1169 lines)
|
||||
⚠ grandfathered: js/ui/components/EditModal.js (1130 lines)
|
||||
⚠ grandfathered: js/ui/components/RevertModal.js (1509 lines)
|
||||
⚠ grandfathered: js/ui/components/SimilarContentCard.js (1303 lines)
|
||||
⚠ grandfathered: js/ui/components/UploadModal.js (1326 lines)
|
||||
⚠ grandfathered: js/ui/components/VideoCard.js (3141 lines)
|
||||
⚠ grandfathered: js/ui/components/VideoModal.js (4976 lines)
|
||||
⚠ grandfathered: js/ui/loginModalController.js (2574 lines)
|
||||
⚠ grandfathered: js/ui/moreMenuController.js (1601 lines)
|
||||
⚠ grandfathered: js/ui/overlay/popoverEngine.js (1070 lines)
|
||||
⚠ grandfathered: js/ui/profileModalController.js (5572 lines)
|
||||
⚠ grandfathered: js/ui/views/VideoListView.js (1392 lines)
|
||||
⚠ grandfathered: js/ui/zapController.js (1206 lines)
|
||||
⚠ grandfathered: js/userBlocks.js (2403 lines)
|
||||
⚠ grandfathered: js/watchHistoryService.js (1400 lines)
|
||||
⚠ grandfathered: js/webtorrent.js (1038 lines)
|
||||
|
||||
No violations. 43 grandfathered file(s) remain as decomposition targets.
|
||||
@@ -1,30 +0,0 @@
|
||||
innerHTML usage: 37 assignments across 28 files
|
||||
|
||||
js/ui/dm/DMSettingsModalController.js: 3
|
||||
js/ui/loginModalController.js: 3
|
||||
js/ui/views/VideoListView.js: 3
|
||||
js/viewManager.js: 3
|
||||
js/utils/qrcode.js: 2
|
||||
js/app/feedCoordinator.js: 1
|
||||
js/app.js: 1
|
||||
js/docsView.js: 1
|
||||
js/exploreView.js: 1
|
||||
js/forYouView.js: 1
|
||||
js/index.js: 1
|
||||
js/kidsView.js: 1
|
||||
js/ui/components/EditModal.js: 1
|
||||
js/ui/components/EmbedVideoModal.js: 1
|
||||
js/ui/components/EventDetailsModal.js: 1
|
||||
js/ui/components/UploadModal.js: 1
|
||||
js/ui/components/VideoModal.js: 1
|
||||
js/ui/components/nip71FormManager.js: 1
|
||||
js/ui/dm/AppShell.js: 1
|
||||
js/ui/dm/Composer.js: 1
|
||||
js/ui/dm/ConversationList.js: 1
|
||||
js/ui/dm/DMRelaySettings.js: 1
|
||||
js/ui/dm/MessageThread.js: 1
|
||||
js/ui/dm/NotificationCenter.js: 1
|
||||
js/ui/moreMenuController.js: 1
|
||||
js/ui/profileModalController.js: 1
|
||||
js/ui/subscriptionHistoryController.js: 1
|
||||
js/ui/videoListViewController.js: 1
|
||||
@@ -1,48 +0,0 @@
|
||||
|
||||
> [email protected] lint
|
||||
> npm run lint:css && npm run lint:hex && npm run lint:inline-styles && npm run lint:tokens && npm run lint:tailwind-brackets && npm run lint:tailwind-colors && npm run lint:file-size && npm run lint:innerhtml && npm run lint:assets && npm run lint:sw-compat
|
||||
|
||||
|
||||
> [email protected] lint:css
|
||||
> stylelint css/tailwind.source.css css/tokens.css css/docs.css
|
||||
|
||||
|
||||
> [email protected] lint:hex
|
||||
> node scripts/check-hex.js
|
||||
|
||||
|
||||
> [email protected] lint:inline-styles
|
||||
> node scripts/check-inline-styles.mjs
|
||||
|
||||
No inline style usage found.
|
||||
|
||||
> [email protected] lint:tokens
|
||||
> node scripts/check-design-tokens.mjs --check=tokens
|
||||
|
||||
|
||||
> [email protected] lint:tailwind-brackets
|
||||
> node scripts/check-design-tokens.mjs --check=brackets
|
||||
|
||||
|
||||
> [email protected] lint:tailwind-colors
|
||||
> node scripts/check-tailwind-colors.mjs
|
||||
|
||||
|
||||
> [email protected] lint:file-size
|
||||
> node scripts/check-file-size.mjs
|
||||
|
||||
|
||||
> [email protected] lint:innerhtml
|
||||
> node scripts/check-innerhtml.mjs
|
||||
|
||||
|
||||
> [email protected] lint:assets
|
||||
> node scripts/check-asset-references.mjs
|
||||
|
||||
[lint:assets] Missing dist/asset-manifest.json. Skipping asset reference check (build required).
|
||||
|
||||
> [email protected] lint:sw-compat
|
||||
> node scripts/check-sw-compat.mjs
|
||||
|
||||
[sw-compat] Skipping check: unable to determine HEAD^ or git history unavailable.
|
||||
[sw-compat] No commit delta found; skipping compatibility check.
|
||||
@@ -1,29 +0,0 @@
|
||||
Title: `Audit Report — 2026-02-24 (unstable)`
|
||||
|
||||
**Summary**
|
||||
* Date: 2026-02-24
|
||||
|
||||
**Metrics**
|
||||
* Grandfathered oversized files: 43 files (total excess lines: 45288)
|
||||
* New oversized files: 0 files (total excess lines: 0)
|
||||
* Total innerHTML assignments: 37 (across 28 files)
|
||||
* Top offenders:
|
||||
1. js/ui/dm/DMSettingsModalController.js — 3
|
||||
1. js/ui/loginModalController.js — 3
|
||||
1. js/ui/views/VideoListView.js — 3
|
||||
1. js/viewManager.js — 3
|
||||
1. js/utils/qrcode.js — 2
|
||||
* Lint failures: 0
|
||||
|
||||
**Delta vs previous (2026-02-21)**
|
||||
* Grandfathered: +0 files, +72 excess lines
|
||||
* innerHTML: +0 total assignments
|
||||
* lint: +0 failures
|
||||
|
||||
**High-priority items**
|
||||
|
||||
**Artifacts**
|
||||
* file-size-report.json
|
||||
* innerhtml-report.json
|
||||
* lint-report.json
|
||||
* raw logs
|
||||
@@ -1,20 +0,0 @@
|
||||
# CI Health Report - 2026-02-21 (Evening Run)
|
||||
|
||||
## Summary
|
||||
- **Agent:** ci-health-agent
|
||||
- **Command:** `npm run test:unit`, `npm run test:dm:unit`, `npm run test:dm:integration`
|
||||
- **Status:** PASS (with one timeout)
|
||||
- **Flakes Detected:** 0 (Reliable reproduction failed)
|
||||
|
||||
## Details
|
||||
Executed the unit test suite 2 times locally:
|
||||
- **Run 1:** Passed successfully.
|
||||
- **Run 2:** Timed out after 400s. The log ended during `tests/nostr/nip46Connector.test.mjs`.
|
||||
|
||||
Targeted execution of `tests/nostr/nip46Connector.test.mjs` (10 times) passed reliably and quickly (~30ms per run). The timeout in Run 2 is attributed to environmental load (running multiple suites in parallel or resource contention) rather than a code flake.
|
||||
|
||||
DM tests (`test:dm:unit`, `test:dm:integration`) passed successfully.
|
||||
|
||||
## Recommendations
|
||||
- Monitor `tests/nostr/nip46Connector.test.mjs` in CI for potential hangs, though none were reproduced in isolation.
|
||||
- `tests/visual/overlay-layers.spec.ts` contains potential timing issues (`waitForTimeout`) but was not modified as visual tests cannot be verified in the current environment.
|
||||
@@ -1 +0,0 @@
|
||||
{"dependencies":[],"devDependencies":["autoprefixer","cross-env","postcss","prettier","serve","stylelint","tailwindcss"],"missing":{"@scure/base":["/app/vendor/crypto-helpers.entry.js","/app/tests/zap-split.test.mjs"],"https:":["/app/js/nostrToolsBootstrap.js"]},"using":{"playwright":["/app/debug_sidebar.mjs","/app/tests/embed_playback_check.spec.mjs"],"@playwright/test":["/app/playwright.config.ts","/app/tests/visual/embed-layout.spec.ts","/app/tests/visual/kitchen-sink.spec.ts","/app/tests/visual/moderation.spec.ts","/app/tests/visual/overlay-layers.spec.ts","/app/tests/visual/reduced-motion.spec.ts","/app/tests/e2e/popover.spec.ts","/app/tests/e2e/repro_issue.spec.ts","/app/tests/e2e/toast-service.spec.ts","/app/tests/e2e/ui-modals.spec.ts","/app/tests/e2e/video-modal-share-bug.spec.ts","/app/tests/e2e/webseed-playback.spec.ts","/app/tests/e2e/helpers/uiTestUtils.ts","/app/examples/reproducers/playwright.config.ts","/app/examples/reproducers/issue-sidebar-layout/repro.spec.ts","/app/examples/reproducers/issue-popover-viewport/repro.spec.ts","/app/examples/reproducers/issue-moderation-visibility/repro.spec.ts","/app/examples/reproducers/issue-moderation-ui/playwright.config.ts","/app/examples/reproducers/issue-moderation-ui/repro.spec.ts","/app/examples/reproducers/issue-1-moderation-ui/playwright.config.ts","/app/examples/reproducers/issue-1-moderation-ui/repro.spec.ts","/app/examples/reproducers/issue-003-popover-ref-error/repro.spec.ts","/app/examples/reproducers/issue-002-login-modal-nsec/repro.spec.ts","/app/examples/reproducers/003-video-modal-reg/repro.spec.ts","/app/examples/reproducers/002-sidebar-layout/repro.spec.ts","/app/examples/reproducers/001-popover-404/repro.spec.ts"],"prettier-plugin-tailwindcss":["/app/prettier.config.cjs"],"@tailwindcss/typography":["/app/tailwind.config.cjs"],"@scure/base":["/app/vendor/crypto-helpers.entry.js","/app/tests/zap-split.test.mjs"],"@noble/hashes":["/app/vendor/crypto-helpers.entry.js"],"jsdom":["/app/tests/design-system-metrics.test.mjs","/app/tests/discussion-count-service.test.mjs","/app/tests/edit-modal-submit-state.test.mjs","/app/tests/login-modal-controller.test.mjs","/app/tests/media-loader.test.mjs","/app/tests/modal-accessibility.test.mjs","/app/tests/nip71-form-manager.test.mjs","/app/tests/position-floating-panel.test.mjs","/app/tests/profile-modal-controller.test.mjs","/app/tests/subscriptions-manager.test.mjs","/app/tests/test-setup.mjs","/app/tests/video-card-source-visibility.test.mjs","/app/tests/video-modal-accessibility.test.mjs","/app/tests/ui/app-chrome-controller.test.mjs","/app/tests/ui/hashtag-strip-helper-bounce.test.mjs","/app/tests/ui/popoverEngine.test.mjs","/app/tests/ui/profile-modal-moderation-settings.test.mjs","/app/tests/ui/tag-pill-list.test.mjs","/app/tests/ui/tag-preference-menu.test.mjs","/app/tests/ui/url-health-controller.test.mjs","/app/tests/ui/video-list-view-popular-tags.test.mjs","/app/tests/ui/video-list-view-sorting.test.mjs","/app/tests/ui/helpers/jsdom-test-helpers.mjs","/app/tests/torrent/style-helpers.test.mjs","/app/tests/torrent/toast-service.test.mjs","/app/tests/services/link-preview-service.test.mjs","/app/tests/moderation/video-card.test.mjs","/app/tests/app/channel-profile-moderation.test.mjs","/app/tests/app/hash-change-handler.test.mjs","/app/tests/app/hydrate-sidebar-navigation.test.mjs","/app/examples/reproducers/issue-channel-moderation-test-crash/repro.mjs","/app/examples/reproducers/issue-001-video-card-logic/repro.mjs"],"fake-indexeddb":["/app/tests/dm-db.test.mjs","/app/tests/dm-normalization.test.mjs","/app/tests/nostr-session-actor.test.mjs","/app/tests/storage-service.test.mjs","/app/tests/ui/storageService.test.mjs","/app/tests/services/link-preview-service.test.mjs","/app/tests/nostr/dm-direct-message-flow.test.mjs","/app/tests/nostr/session-actor.test.mjs","/app/scripts/agent/smoke-test.mjs"],"nostr-tools":["/app/tests/dm-decryptor.test.mjs","/app/tests/nostr-private-key-signer.test.mjs","/app/tests/nostr-publish-rejection.test.mjs","/app/tests/nostr-send-direct-message.test.mjs","/app/tests/nostr/adapters.test.mjs","/app/tests/nostr/dm-direct-message-flow.test.mjs","/app/tests/nostr/dmSignalEvents.test.mjs","/app/tests/nostr/integration-remote-flow.test.mjs","/app/tests/nostr/nip46Client.test.js","/app/tests/e2e/repro_issue.spec.ts","/app/scripts/agent/interop-test.mjs","/app/scripts/agent/load-test-relay.mjs","/app/scripts/agent/load-test.mjs","/app/scripts/agent/simple-relay.mjs","/app/scripts/agent/smoke-test.mjs","/app/js/nostrToolsBootstrap.js"],"pixelmatch":["/app/tests/visual/kitchen-sink.spec.ts"],"pngjs":["/app/tests/visual/kitchen-sink.spec.ts"],"ws":["/app/tests/e2e/repro_issue.spec.ts","/app/scripts/agent/interop-test.mjs","/app/scripts/agent/load-test-relay.mjs","/app/scripts/agent/load-test.mjs","/app/scripts/agent/setup-test-env.js","/app/scripts/agent/simple-relay.mjs","/app/scripts/agent/smoke-test.mjs"],"esbuild":["/app/scripts/build-beacon.mjs"],"@floating-ui/domLine truncated
|
||||
@@ -1,33 +0,0 @@
|
||||
# Dependency Report - 2026-02-20
|
||||
|
||||
## Vulnerabilities
|
||||
### HIGH (3)
|
||||
- **minimatch**: minimatch has a ReDoS via repeated wildcards with non-matching literal in pattern
|
||||
- Path: Direct dependency? No
|
||||
- Fix Available: true
|
||||
- **serve**: ajv, serve-handler
|
||||
- Path: Direct dependency? Yes
|
||||
- Fix Available: {"name":"serve","version":"6.5.8","isSemVerMajor":true}
|
||||
- **serve-handler**: minimatch
|
||||
- Path: Direct dependency? No
|
||||
- Fix Available: true
|
||||
### MODERATE (1)
|
||||
- **ajv**: ajv has ReDoS when using `$data` option
|
||||
|
||||
## Outdated Packages
|
||||
### Major Updates (Risky)
|
||||
- **pixelmatch** (undefined): 5.3.0 -> 7.1.0
|
||||
- **postcss-import** (undefined): 15.1.0 -> 16.1.1
|
||||
- **prettier-plugin-tailwindcss** (undefined): 0.6.14 -> 0.7.2
|
||||
- **stylelint-config-standard** (undefined): 36.0.1 -> 40.0.0
|
||||
- **tailwindcss** (undefined): 3.4.19 -> 4.2.0
|
||||
|
||||
### Minor Updates (Safe-ish)
|
||||
- **nostr-tools** (undefined): 2.19.4 -> 2.23.1 (Latest: 2.23.1)
|
||||
- **stylelint** (undefined): 16.12.0 -> 16.26.1 (Latest: 17.3.0)
|
||||
|
||||
### Patch Updates (Safe)
|
||||
|
||||
## Triage & Actions
|
||||
- [ ] **HIGH**: Check for safe upgrades for minimatch, serve, serve-handler.
|
||||
- [ ] **Safe Candidates**: nostr-tools, stylelint
|
||||
@@ -1,13 +1,74 @@
|
||||
[
|
||||
{
|
||||
"fingerprint": "00257328",
|
||||
"title": "Load Test Bottleneck: Cryptographic Bottleneck (Avg Sign Time 5.87ms > 5ms)",
|
||||
"fingerprint": "56489eaa",
|
||||
"title": "handleModerationBlock requests a block, clears overrides, and refreshes hidden state",
|
||||
"count": 6,
|
||||
"sources": [
|
||||
"unit-test:test_unit_debug_2.log",
|
||||
"unit-test:test_unit_debug_3.log",
|
||||
"unit-test:test_unit_pre_commit.log",
|
||||
"unit-test:test_unit_retry.log",
|
||||
"unit-test:test_unit_retry_3.log",
|
||||
"unit-test:test_unit_retry_4.log"
|
||||
],
|
||||
"severity": "High",
|
||||
"stack": "TestContext.<anonymous> (file://$REPO/tests$REPO/moderation-overrides.test.mjs:228:10)\n async Test.run (node:internal/test_runner/test:1054:7)\n async Test.processPendingSubtests (node:internal/test_runner/test:744:7)\n ...\n# Subtest: handleModerationBlock returns false when viewer is logged out",
|
||||
"owner": "QA Team"
|
||||
},
|
||||
{
|
||||
"fingerprint": "bcbb97f7",
|
||||
"title": "handleModerationOverride resumes deferred playback",
|
||||
"count": 2,
|
||||
"sources": [
|
||||
"unit-test:test_unit_retry_2.log",
|
||||
"unit-test:test_unit_retry_3.log"
|
||||
],
|
||||
"severity": "High",
|
||||
"stack": "TestContext.<anonymous> (file://$REPO/tests$REPO/moderation-overrides.test.mjs:104:10)\n async Test.run (node:internal/test_runner/test:1054:7)\n async Test.processPendingSubtests (node:internal/test_runner/test:744:7)\n ...\n# Subtest: handleModerationBlock requests a block, clears overrides, and refreshes hidden state",
|
||||
"owner": "QA Team"
|
||||
},
|
||||
{
|
||||
"fingerprint": "80a22b69",
|
||||
"title": "handleModerationBlock requests a block, clears overrides, and refreshes hidden state",
|
||||
"count": 1,
|
||||
"sources": [
|
||||
"load-test:load-report-20260204.json"
|
||||
"unit-test:test_unit_debug_4.log"
|
||||
],
|
||||
"severity": "Medium",
|
||||
"stack": "Bottleneck: Cryptographic Bottleneck (Avg Sign Time 5.87ms > 5ms)\nRemediation: Client-side event signing is slow. Review cryptographic library (nostr-tools) usage or client hardware capabilities.",
|
||||
"owner": "P2P Team"
|
||||
"severity": "High",
|
||||
"stack": "TestContext.<anonymous> (file://$REPO/tests$REPO/moderation-overrides.test.mjs:229:10)\n async Test.run (node:internal/test_runner/test:1054:7)\n async Test.processPendingSubtests (node:internal/test_runner/test:744:7)\n ...\n# Subtest: handleModerationBlock returns false when viewer is logged out",
|
||||
"owner": "QA Team"
|
||||
},
|
||||
{
|
||||
"fingerprint": "5e159618",
|
||||
"title": "handleModerationBlock requests a block, clears overrides, and refreshes hidden state",
|
||||
"count": 1,
|
||||
"sources": [
|
||||
"unit-test:test_unit_final.log"
|
||||
],
|
||||
"severity": "High",
|
||||
"stack": "TestContext.<anonymous> (file://$REPO/tests$REPO/moderation-overrides.test.mjs:232:10)\n async Test.run (node:internal/test_runner/test:1054:7)\n async Test.processPendingSubtests (node:internal/test_runner/test:744:7)\n ...\n# Subtest: handleModerationBlock returns false when viewer is logged out",
|
||||
"owner": "QA Team"
|
||||
},
|
||||
{
|
||||
"fingerprint": "4a2440b4",
|
||||
"title": "handleModerationOverride decorates stored and current videos then refreshes UI",
|
||||
"count": 1,
|
||||
"sources": [
|
||||
"unit-test:test_unit_retry_2.log"
|
||||
],
|
||||
"severity": "High",
|
||||
"stack": "TestContext.<anonymous> (file://$REPO/tests$REPO/moderation-overrides.test.mjs:67:10)\n async Test.run (node:internal/test_runner/test:1054:7)\n async startSubtestAfterBootstrap (node:internal/test_runner/harness:296:3)\n ...\n# Subtest: handleModerationOverride resumes deferred playback",
|
||||
"owner": "QA Team"
|
||||
},
|
||||
{
|
||||
"fingerprint": "a879eb91",
|
||||
"title": "handleModerationBlock requests a block, clears overrides, and refreshes hidden state",
|
||||
"count": 1,
|
||||
"sources": [
|
||||
"unit-test:test_unit_retry_2.log"
|
||||
],
|
||||
"severity": "High",
|
||||
"stack": "TestContext.<anonymous> (file://$REPO/tests$REPO/moderation-overrides.test.mjs:202:10)\n async Test.run (node:internal/test_runner/test:1054:7)\n async Test.processPendingSubtests (node:internal/test_runner/test:744:7)\n ...\n# Subtest: handleModerationBlock returns false when viewer is logged out",
|
||||
"owner": "QA Team"
|
||||
}
|
||||
]
|
||||
@@ -1,25 +0,0 @@
|
||||
# todo: Investigate why visibility check fails in fixture environment
|
||||
|
||||
Found TODOs in `tests/visual/moderation.spec.ts` related to Playwright test failures in headless mode.
|
||||
|
||||
## Context
|
||||
Several tests in `tests/visual/moderation.spec.ts` have commented-out assertions and interactions due to visibility checks failing or clicks timing out when running in the fixture environment (headless).
|
||||
|
||||
## TODOs
|
||||
- `// TODO: Investigate why visibility check fails in fixture environment (headless)`
|
||||
- `// TODO: Investigate why click times out in fixture environment (headless)`
|
||||
- `// TODO: Investigate visibility check failure`
|
||||
- `// TODO: Investigate click timeout failure`
|
||||
|
||||
## Code Excerpt
|
||||
```typescript
|
||||
// TODO: Investigate why visibility check fails in fixture environment (headless)
|
||||
// await expect(showAnywayButton).toBeVisible();
|
||||
await expect(restoreButtonQuery).toHaveCount(0);
|
||||
|
||||
// TODO: Investigate why click times out in fixture environment (headless)
|
||||
// await showAnywayButton.click({ force: true });
|
||||
```
|
||||
|
||||
## Suggested Next Step
|
||||
Investigate the `tests/visual/moderation.spec.ts` execution in headless mode. It might be related to rendering timing, fixture loading state, or specific CSS properties affecting visibility in the headless renderer.
|
||||
@@ -1,392 +0,0 @@
|
||||
{
|
||||
"meta": {
|
||||
"clients": 100,
|
||||
"duration": 60,
|
||||
"targetRatePerClient": 0.5
|
||||
},
|
||||
"results": {
|
||||
"totalSent": 2900,
|
||||
"totalReceivedByObserver": 2958,
|
||||
"totalErrors": 0,
|
||||
"errorRate": 0,
|
||||
"avgLatencyMs": 8.5,
|
||||
"maxLatencyMs": 42,
|
||||
"avgSignTimeMs": 5.869976568218849,
|
||||
"hot_functions": [
|
||||
{
|
||||
"name": "Event Signing (Client)",
|
||||
"avgTimeMs": 5.869976568218849,
|
||||
"calls": 2900
|
||||
}
|
||||
]
|
||||
},
|
||||
"bottlenecks": [
|
||||
"Cryptographic Bottleneck (Avg Sign Time 5.87ms > 5ms)"
|
||||
],
|
||||
"metrics": {
|
||||
"timestamps": [
|
||||
"2026-02-04T19:06:10.186Z",
|
||||
"2026-02-04T19:06:11.827Z",
|
||||
"2026-02-04T19:06:12.831Z",
|
||||
"2026-02-04T19:06:14.256Z",
|
||||
"2026-02-04T19:06:15.314Z",
|
||||
"2026-02-04T19:06:16.285Z",
|
||||
"2026-02-04T19:06:17.281Z",
|
||||
"2026-02-04T19:06:18.280Z",
|
||||
"2026-02-04T19:06:19.280Z",
|
||||
"2026-02-04T19:06:20.280Z",
|
||||
"2026-02-04T19:06:21.281Z",
|
||||
"2026-02-04T19:06:22.284Z",
|
||||
"2026-02-04T19:06:23.281Z",
|
||||
"2026-02-04T19:06:24.282Z",
|
||||
"2026-02-04T19:06:25.282Z",
|
||||
"2026-02-04T19:06:26.282Z",
|
||||
"2026-02-04T19:06:27.288Z",
|
||||
"2026-02-04T19:06:28.283Z",
|
||||
"2026-02-04T19:06:29.290Z",
|
||||
"2026-02-04T19:06:30.284Z",
|
||||
"2026-02-04T19:06:31.289Z",
|
||||
"2026-02-04T19:06:32.283Z",
|
||||
"2026-02-04T19:06:33.288Z",
|
||||
"2026-02-04T19:06:34.283Z",
|
||||
"2026-02-04T19:06:35.303Z",
|
||||
"2026-02-04T19:06:36.287Z",
|
||||
"2026-02-04T19:06:37.287Z",
|
||||
"2026-02-04T19:06:38.288Z",
|
||||
"2026-02-04T19:06:39.288Z",
|
||||
"2026-02-04T19:06:40.288Z",
|
||||
"2026-02-04T19:06:41.288Z",
|
||||
"2026-02-04T19:06:42.288Z",
|
||||
"2026-02-04T19:06:43.289Z",
|
||||
"2026-02-04T19:06:44.289Z",
|
||||
"2026-02-04T19:06:45.289Z",
|
||||
"2026-02-04T19:06:46.289Z",
|
||||
"2026-02-04T19:06:47.290Z",
|
||||
"2026-02-04T19:06:48.290Z",
|
||||
"2026-02-04T19:06:49.290Z",
|
||||
"2026-02-04T19:06:50.291Z",
|
||||
"2026-02-04T19:06:51.292Z",
|
||||
"2026-02-04T19:06:52.292Z",
|
||||
"2026-02-04T19:06:53.292Z",
|
||||
"2026-02-04T19:06:54.292Z",
|
||||
"2026-02-04T19:06:55.292Z",
|
||||
"2026-02-04T19:06:56.292Z",
|
||||
"2026-02-04T19:06:57.292Z",
|
||||
"2026-02-04T19:06:58.293Z",
|
||||
"2026-02-04T19:06:59.292Z",
|
||||
"2026-02-04T19:07:00.292Z",
|
||||
"2026-02-04T19:07:01.293Z",
|
||||
"2026-02-04T19:07:02.293Z",
|
||||
"2026-02-04T19:07:03.293Z",
|
||||
"2026-02-04T19:07:04.294Z",
|
||||
"2026-02-04T19:07:05.293Z",
|
||||
"2026-02-04T19:07:06.302Z",
|
||||
"2026-02-04T19:07:07.293Z",
|
||||
"2026-02-04T19:07:08.294Z"
|
||||
],
|
||||
"cpu": [
|
||||
1.2891,
|
||||
75.4605,
|
||||
1.1246,
|
||||
110.9914,
|
||||
13.9201,
|
||||
98.5274,
|
||||
6.3944,
|
||||
64.1486,
|
||||
6.0738,
|
||||
63.4177,
|
||||
6.2085,
|
||||
66.0653,
|
||||
5.9001,
|
||||
62.525,
|
||||
5.7544,
|
||||
69.5987,
|
||||
6.6041,
|
||||
60.1274,
|
||||
6.8777,
|
||||
66.1227,
|
||||
6.6576,
|
||||
61.7225,
|
||||
6.5692,
|
||||
62.586,
|
||||
10.3549,
|
||||
69.6933,
|
||||
5.8595,
|
||||
62.5952,
|
||||
5.8479,
|
||||
69.4633,
|
||||
5.9227,
|
||||
59.5779,
|
||||
5.9434,
|
||||
58.9378,
|
||||
5.7777,
|
||||
65.1409,
|
||||
5.7253,
|
||||
58.8193,
|
||||
6.3755,
|
||||
64.0124,
|
||||
6.9732,
|
||||
61.4041,
|
||||
5.724,
|
||||
58.3382,
|
||||
5.5851,
|
||||
58.7335,
|
||||
6.0968,
|
||||
59.5833,
|
||||
5.6418,
|
||||
60.6467,
|
||||
5.742,
|
||||
60.2272,
|
||||
5.617,
|
||||
59.7526,
|
||||
6.6313,
|
||||
63.0884,
|
||||
5.8035,
|
||||
61.0101
|
||||
],
|
||||
"memory": [
|
||||
14.21099853515625,
|
||||
12.053665161132812,
|
||||
13.577583312988281,
|
||||
11.293220520019531,
|
||||
13.9764404296875,
|
||||
13.597808837890625,
|
||||
12.902915954589844,
|
||||
17.456069946289062,
|
||||
15.924842834472656,
|
||||
13.108901977539062,
|
||||
11.620040893554688,
|
||||
16.124671936035156,
|
||||
14.659011840820312,
|
||||
11.750862121582031,
|
||||
17.709686279296875,
|
||||
14.97283935546875,
|
||||
15.023307800292969,
|
||||
17.9583740234375,
|
||||
18.069061279296875,
|
||||
13.631416320800781,
|
||||
13.709136962890625,
|
||||
16.736785888671875,
|
||||
16.66020965576172,
|
||||
12.300872802734375,
|
||||
19.781394958496094,
|
||||
15.29693603515625,
|
||||
13.89215087890625,
|
||||
18.39887237548828,
|
||||
16.973892211914062,
|
||||
14.178886413574219,
|
||||
12.703651428222656,
|
||||
17.223411560058594,
|
||||
15.726631164550781,
|
||||
12.830970764160156,
|
||||
18.700477600097656,
|
||||
15.878158569335938,
|
||||
14.343246459960938,
|
||||
18.87677764892578,
|
||||
17.446983337402344,
|
||||
14.474784851074219,
|
||||
13.017341613769531,
|
||||
17.500404357910156,
|
||||
16.13226318359375,
|
||||
13.164146423339844,
|
||||
19.092933654785156,
|
||||
16.134384155273438,
|
||||
14.735084533691406,
|
||||
19.123802185058594,
|
||||
17.696151733398438,
|
||||
14.804244995117188,
|
||||
13.346839904785156,
|
||||
17.821983337402344,
|
||||
16.359207153320312,
|
||||
13.470359802246094,
|
||||
19.442214965820312,
|
||||
16.46966552734375,
|
||||
15.026473999023438,
|
||||
19.590980529785156
|
||||
],
|
||||
"latency": [
|
||||
12,
|
||||
10,
|
||||
11,
|
||||
11,
|
||||
42,
|
||||
11,
|
||||
6,
|
||||
7,
|
||||
6,
|
||||
7,
|
||||
7,
|
||||
10,
|
||||
6,
|
||||
7,
|
||||
6,
|
||||
6,
|
||||
11,
|
||||
7,
|
||||
14,
|
||||
8,
|
||||
13,
|
||||
6,
|
||||
12,
|
||||
7,
|
||||
23,
|
||||
6,
|
||||
7,
|
||||
7,
|
||||
6,
|
||||
7,
|
||||
7,
|
||||
6,
|
||||
6,
|
||||
7,
|
||||
7,
|
||||
6,
|
||||
7,
|
||||
6,
|
||||
7,
|
||||
7,
|
||||
7,
|
||||
7,
|
||||
7,
|
||||
7,
|
||||
6,
|
||||
7,
|
||||
7,
|
||||
7,
|
||||
7,
|
||||
6,
|
||||
7,
|
||||
6,
|
||||
6,
|
||||
6,
|
||||
7,
|
||||
15,
|
||||
6,
|
||||
7
|
||||
],
|
||||
"throughput": [
|
||||
1,
|
||||
101,
|
||||
1,
|
||||
101,
|
||||
11,
|
||||
91,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93,
|
||||
9,
|
||||
93
|
||||
],
|
||||
"avgSignTime": [
|
||||
0,
|
||||
6.090444670000015,
|
||||
0,
|
||||
10.09357892,
|
||||
10.334544000000195,
|
||||
9.704539101123578,
|
||||
5.840137249999998,
|
||||
5.749988358695646,
|
||||
5.691442000000279,
|
||||
5.735636086956576,
|
||||
5.9182750000002216,
|
||||
5.890629923913069,
|
||||
5.588866250000137,
|
||||
5.850060869565309,
|
||||
5.676161750001484,
|
||||
5.6353527065217035,
|
||||
5.762921555554688,
|
||||
5.728557747252825,
|
||||
6.10907399999956,
|
||||
5.90219461538456,
|
||||
5.862068444444351,
|
||||
5.8458819999998,
|
||||
5.776876333333348,
|
||||
5.937595384615213,
|
||||
9.20721633333354,
|
||||
6.482018351648579,
|
||||
5.615201250000155,
|
||||
5.785851652173891,
|
||||
5.64396275000081,
|
||||
5.771455956521964,
|
||||
5.550119749998885,
|
||||
5.582937739129746,
|
||||
5.7709488749997035,
|
||||
5.643515130434737,
|
||||
5.749425124999107,
|
||||
6.210867510869914,
|
||||
5.636921000000257,
|
||||
5.659433999999949,
|
||||
6.089611750000586,
|
||||
5.987438336956668,
|
||||
6.957270124999013,
|
||||
5.891856141305059,
|
||||
5.555353749998176,
|
||||
5.548610880434985,
|
||||
5.590769124999497,
|
||||
5.557453586956794,
|
||||
5.865140124999016,
|
||||
5.646670826087163,
|
||||
5.6239324999996825,
|
||||
5.723344728261272,
|
||||
5.6432206250010495,
|
||||
5.7358725434777345,
|
||||
5.5553546250012005,
|
||||
5.647155880434224,
|
||||
5.598165125001287,
|
||||
5.917939250000058,
|
||||
5.63759575000131,
|
||||
5.651182891304653
|
||||
]
|
||||
},
|
||||
"remediation": [
|
||||
"Client-side event signing is slow. Review cryptographic library (nostr-tools) usage or client hardware capabilities."
|
||||
],
|
||||
"requiresSecurityReview": true
|
||||
}
|
||||
@@ -1,129 +0,0 @@
|
||||
{
|
||||
"config": {
|
||||
"clients": 1000,
|
||||
"duration": 60,
|
||||
"rate": 0.2,
|
||||
"relay": null,
|
||||
"outputDir": "artifacts"
|
||||
},
|
||||
"timestamp": "2026-02-12T19:10:35.621Z",
|
||||
"durationSec": 63.068,
|
||||
"throughput": 158.78099828756262,
|
||||
"totalSent": 10014,
|
||||
"totalAccepted": 10014,
|
||||
"totalRejected": 0,
|
||||
"totalErrors": 0,
|
||||
"latency": {
|
||||
"p50": 0,
|
||||
"p95": 1,
|
||||
"p99": 1,
|
||||
"min": 0,
|
||||
"max": 6,
|
||||
"avg": 0.2518474136209307
|
||||
},
|
||||
"signingTime": {
|
||||
"avg": 0.7027462706211202,
|
||||
"max": 3.145286999999371
|
||||
},
|
||||
"resources": [
|
||||
{
|
||||
"time": 7994,
|
||||
"cpuUser": 2231161,
|
||||
"cpuSystem": 437532,
|
||||
"rss": 119869440,
|
||||
"heapTotal": 55013376,
|
||||
"heapUsed": 28269464
|
||||
},
|
||||
{
|
||||
"time": 12994,
|
||||
"cpuUser": 3142379,
|
||||
"cpuSystem": 522268,
|
||||
"rss": 122753024,
|
||||
"heapTotal": 56848384,
|
||||
"heapUsed": 26284072
|
||||
},
|
||||
{
|
||||
"time": 17994,
|
||||
"cpuUser": 3977010,
|
||||
"cpuSystem": 616834,
|
||||
"rss": 125243392,
|
||||
"heapTotal": 58683392,
|
||||
"heapUsed": 24239504
|
||||
},
|
||||
{
|
||||
"time": 22993,
|
||||
"cpuUser": 4886434,
|
||||
"cpuSystem": 708145,
|
||||
"rss": 128258048,
|
||||
"heapTotal": 60256256,
|
||||
"heapUsed": 35053272
|
||||
},
|
||||
{
|
||||
"time": 27993,
|
||||
"cpuUser": 5695214,
|
||||
"cpuSystem": 818451,
|
||||
"rss": 131010560,
|
||||
"heapTotal": 62328832,
|
||||
"heapUsed": 32881992
|
||||
},
|
||||
{
|
||||
"time": 32994,
|
||||
"cpuUser": 6598049,
|
||||
"cpuSystem": 901079,
|
||||
"rss": 133763072,
|
||||
"heapTotal": 64163840,
|
||||
"heapUsed": 29520680
|
||||
},
|
||||
{
|
||||
"time": 37994,
|
||||
"cpuUser": 7410460,
|
||||
"cpuSystem": 1001266,
|
||||
"rss": 135860224,
|
||||
"heapTotal": 65212416,
|
||||
"heapUsed": 40101552
|
||||
},
|
||||
{
|
||||
"time": 42994,
|
||||
"cpuUser": 8255994,
|
||||
"cpuSystem": 1088486,
|
||||
"rss": 138219520,
|
||||
"heapTotal": 67047424,
|
||||
"heapUsed": 36800544
|
||||
},
|
||||
{
|
||||
"time": 47994,
|
||||
"cpuUser": 9094489,
|
||||
"cpuSystem": 1172380,
|
||||
"rss": 141234176,
|
||||
"heapTotal": 68882432,
|
||||
"heapUsed": 34655312
|
||||
},
|
||||
{
|
||||
"time": 52994,
|
||||
"cpuUser": 9929570,
|
||||
"cpuSystem": 1275658,
|
||||
"rss": 143724544,
|
||||
"heapTotal": 69898240,
|
||||
"heapUsed": 36593096
|
||||
},
|
||||
{
|
||||
"time": 57995,
|
||||
"cpuUser": 10749951,
|
||||
"cpuSystem": 1294454,
|
||||
"rss": 143724544,
|
||||
"heapTotal": 69898240,
|
||||
"heapUsed": 33902488
|
||||
}
|
||||
],
|
||||
"topHotFunctions": [
|
||||
{
|
||||
"function": "finalizeEvent (client signing)",
|
||||
"avgTime": "0.70ms",
|
||||
"impact": "Low/Moderate CPU usage"
|
||||
}
|
||||
],
|
||||
"errors": 0,
|
||||
"proposedRemediation": [
|
||||
"Signing speed is good (<10ms). Focus on network I/O."
|
||||
]
|
||||
}
|
||||
@@ -1,122 +1,22 @@
|
||||
{
|
||||
"auditReportVersion": 2,
|
||||
"vulnerabilities": {
|
||||
"ajv": {
|
||||
"name": "ajv",
|
||||
"severity": "moderate",
|
||||
"isDirect": false,
|
||||
"via": [
|
||||
{
|
||||
"source": 1113214,
|
||||
"name": "ajv",
|
||||
"dependency": "ajv",
|
||||
"title": "ajv has ReDoS when using `$data` option",
|
||||
"url": "https://github.com/advisories/GHSA-2g4f-4pwh-qvx6",
|
||||
"severity": "moderate",
|
||||
"cwe": [
|
||||
"CWE-400"
|
||||
],
|
||||
"cvss": {
|
||||
"score": 0,
|
||||
"vectorString": null
|
||||
},
|
||||
"range": "<8.18.0"
|
||||
}
|
||||
],
|
||||
"effects": [
|
||||
"serve"
|
||||
],
|
||||
"range": "<8.18.0",
|
||||
"nodes": [
|
||||
"node_modules/ajv"
|
||||
],
|
||||
"fixAvailable": {
|
||||
"name": "serve",
|
||||
"version": "6.5.8",
|
||||
"isSemVerMajor": true
|
||||
}
|
||||
},
|
||||
"minimatch": {
|
||||
"name": "minimatch",
|
||||
"severity": "high",
|
||||
"isDirect": false,
|
||||
"via": [
|
||||
{
|
||||
"source": 1113296,
|
||||
"name": "minimatch",
|
||||
"dependency": "minimatch",
|
||||
"title": "minimatch has a ReDoS via repeated wildcards with non-matching literal in pattern",
|
||||
"url": "https://github.com/advisories/GHSA-3ppc-4f35-3m26",
|
||||
"severity": "high",
|
||||
"cwe": [
|
||||
"CWE-1333"
|
||||
],
|
||||
"cvss": {
|
||||
"score": 0,
|
||||
"vectorString": null
|
||||
},
|
||||
"range": "<10.2.1"
|
||||
}
|
||||
],
|
||||
"effects": [
|
||||
"serve-handler"
|
||||
],
|
||||
"range": "<10.2.1",
|
||||
"nodes": [
|
||||
"node_modules/minimatch"
|
||||
],
|
||||
"fixAvailable": true
|
||||
},
|
||||
"serve": {
|
||||
"name": "serve",
|
||||
"severity": "high",
|
||||
"isDirect": true,
|
||||
"via": [
|
||||
"ajv",
|
||||
"serve-handler"
|
||||
],
|
||||
"effects": [],
|
||||
"range": ">=7.0.0",
|
||||
"nodes": [
|
||||
"node_modules/serve"
|
||||
],
|
||||
"fixAvailable": {
|
||||
"name": "serve",
|
||||
"version": "6.5.8",
|
||||
"isSemVerMajor": true
|
||||
}
|
||||
},
|
||||
"serve-handler": {
|
||||
"name": "serve-handler",
|
||||
"severity": "high",
|
||||
"isDirect": false,
|
||||
"via": [
|
||||
"minimatch"
|
||||
],
|
||||
"effects": [],
|
||||
"range": ">=1.1.0",
|
||||
"nodes": [
|
||||
"node_modules/serve-handler"
|
||||
],
|
||||
"fixAvailable": true
|
||||
}
|
||||
},
|
||||
"vulnerabilities": {},
|
||||
"metadata": {
|
||||
"vulnerabilities": {
|
||||
"info": 0,
|
||||
"low": 0,
|
||||
"moderate": 1,
|
||||
"high": 3,
|
||||
"moderate": 0,
|
||||
"high": 0,
|
||||
"critical": 0,
|
||||
"total": 4
|
||||
"total": 0
|
||||
},
|
||||
"dependencies": {
|
||||
"prod": 111,
|
||||
"dev": 340,
|
||||
"optional": 53,
|
||||
"prod": 50,
|
||||
"dev": 291,
|
||||
"optional": 27,
|
||||
"peer": 0,
|
||||
"peerOptional": 0,
|
||||
"total": 477
|
||||
"total": 340
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,10 +1,17 @@
|
||||
{
|
||||
"nostr-tools": {
|
||||
"current": "2.19.4",
|
||||
"wanted": "2.23.1",
|
||||
"latest": "2.23.1",
|
||||
"cross-env": {
|
||||
"current": "7.0.3",
|
||||
"wanted": "7.0.3",
|
||||
"latest": "10.1.0",
|
||||
"dependent": "app",
|
||||
"location": "/app/node_modules/nostr-tools"
|
||||
"location": "/app/node_modules/cross-env"
|
||||
},
|
||||
"esbuild": {
|
||||
"current": "0.25.12",
|
||||
"wanted": "0.25.12",
|
||||
"latest": "0.27.2",
|
||||
"dependent": "app",
|
||||
"location": "/app/node_modules/esbuild"
|
||||
},
|
||||
"pixelmatch": {
|
||||
"current": "5.3.0",
|
||||
@@ -13,13 +20,6 @@
|
||||
"dependent": "app",
|
||||
"location": "/app/node_modules/pixelmatch"
|
||||
},
|
||||
"postcss-import": {
|
||||
"current": "15.1.0",
|
||||
"wanted": "15.1.0",
|
||||
"latest": "16.1.1",
|
||||
"dependent": "app",
|
||||
"location": "/app/node_modules/postcss-import"
|
||||
},
|
||||
"prettier-plugin-tailwindcss": {
|
||||
"current": "0.6.14",
|
||||
"wanted": "0.6.14",
|
||||
@@ -28,23 +28,16 @@
|
||||
"location": "/app/node_modules/prettier-plugin-tailwindcss"
|
||||
},
|
||||
"stylelint": {
|
||||
"current": "16.12.0",
|
||||
"current": "16.26.1",
|
||||
"wanted": "16.26.1",
|
||||
"latest": "17.3.0",
|
||||
"latest": "17.0.0",
|
||||
"dependent": "app",
|
||||
"location": "/app/node_modules/stylelint"
|
||||
},
|
||||
"stylelint-config-standard": {
|
||||
"current": "36.0.1",
|
||||
"wanted": "36.0.1",
|
||||
"latest": "40.0.0",
|
||||
"dependent": "app",
|
||||
"location": "/app/node_modules/stylelint-config-standard"
|
||||
},
|
||||
"tailwindcss": {
|
||||
"current": "3.4.19",
|
||||
"wanted": "3.4.19",
|
||||
"latest": "4.2.0",
|
||||
"latest": "4.1.18",
|
||||
"dependent": "app",
|
||||
"location": "/app/node_modules/tailwindcss"
|
||||
}
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
js/ui/profileModalController.js:203: "Formats npub strings for display using the canonical short representation (npubXXXX…XXXX).",
|
||||
tests/visual/moderation.spec.ts:89: // TODO: Investigate why visibility check fails in fixture environment (headless)
|
||||
tests/visual/moderation.spec.ts:93: // TODO: Investigate why click times out in fixture environment (headless)
|
||||
tests/visual/moderation.spec.ts:166: // TODO: Investigate visibility check failure
|
||||
tests/visual/moderation.spec.ts:170: // TODO: Investigate click timeout failure
|
||||
tests/visual/moderation.spec.ts:219: // TODO: Investigate visibility check failure
|
||||
tests/visual/moderation.spec.ts:223: // TODO: Investigate click timeout failure
|
||||
|
||||
Note: The TODOs in tests/visual/moderation.spec.ts are already tracked in issues/todo-moderation-tests.md. No other actionable TODOs found.
|
||||
|
After Width: | Height: | Size: 160 KiB |
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg width="100%" height="100%" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2">
|
||||
<path d="M12,0C5.373,0 0,5.373 0,12C0,18.627 5.373,24 12,24C18.627,24 24,18.627 24,12C24,5.373 18.627,0 12,0ZM9.967,16.01C10.531,14.221 11.599,12.078 11.788,11.536C12.061,10.749 11.577,10.4 10.048,11.745L9.708,11.105C11.452,9.208 15.043,8.779 13.821,11.718C13.058,13.553 12.512,14.792 12.2,15.748C11.745,17.141 12.894,16.576 14.019,15.537C14.172,15.787 14.222,15.868 14.375,16.156C11.877,18.534 9.104,18.744 9.967,16.01ZM14.709,7.841C14.177,8.294 13.389,8.284 12.948,7.819C12.507,7.354 12.581,6.611 13.112,6.158C13.644,5.705 14.432,5.716 14.873,6.18C15.312,6.646 15.24,7.389 14.709,7.841Z" fill="#5C6F8A" fill-rule="nonzero"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.1 KiB |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M17.374 20.235c2.444-2.981 6.626-8.157 6.626-8.157l-3.846-3.092s-2.857 3.523-6.571 8.097c-4.312 5.312-11.881-2.41-6.671-6.671 4.561-3.729 8.097-6.57 8.097-6.57l-3.092-3.842s-5.173 4.181-8.157 6.621c-2.662 2.175-3.76 4.749-3.76 7.24 0 5.254 4.867 10.139 10.121 10.139 2.487 0 5.064-1.095 7.253-3.765zm4.724-7.953l-1.699 2.111-1.74-1.397 1.701-2.114 1.738 1.4zm-10.386-10.385l1.4 1.738-2.113 1.701-1.397-1.74 2.11-1.699z"/></svg>
|
||||
|
After Width: | Height: | Size: 519 B |
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg width="100%" height="100%" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2">
|
||||
<path d="M23.334,11.96C22.621,11.234 22.462,10.131 22.941,9.233C23.283,8.593 23.307,7.832 23.005,7.171C22.704,6.511 22.112,6.029 21.404,5.869C20.413,5.644 19.682,4.802 19.601,3.788C19.542,3.065 19.15,2.41 18.539,2.018C17.93,1.625 17.172,1.54 16.489,1.789C15.533,2.136 14.463,1.821 13.847,1.013C13.407,0.437 12.723,0.098 11.997,0.098C11.272,0.098 10.588,0.437 10.148,1.013C9.535,1.822 8.465,2.137 7.509,1.79C6.827,1.542 6.069,1.627 5.459,2.019C4.849,2.411 4.456,3.066 4.398,3.789C4.316,4.803 3.586,5.646 2.595,5.87C1.887,6.03 1.295,6.512 0.994,7.172C0.693,7.832 0.717,8.594 1.059,9.233C1.538,10.13 1.379,11.234 0.667,11.96C0.158,12.477 -0.08,13.202 0.023,13.92C0.126,14.638 0.559,15.267 1.193,15.62C2.081,16.115 2.545,17.13 2.337,18.125C2.19,18.835 2.381,19.573 2.856,20.121C3.332,20.67 4.036,20.965 4.758,20.919C5.774,20.856 6.711,21.459 7.075,22.408C7.334,23.086 7.895,23.603 8.592,23.807C9.287,24.011 10.039,23.879 10.623,23.45C11.442,22.847 12.559,22.847 13.377,23.45C13.961,23.88 14.713,24.012 15.408,23.807C16.105,23.603 16.666,23.085 16.926,22.408C17.289,21.459 18.227,20.855 19.242,20.919C19.966,20.965 20.669,20.67 21.144,20.121C21.619,19.573 21.811,18.835 21.663,18.125C21.456,17.13 21.919,16.115 22.808,15.62C23.441,15.266 23.873,14.638 23.977,13.92C24.081,13.202 23.842,12.477 23.334,11.96ZM10.75,17.39L6.25,13.026L8.107,11.169L10.75,13.675L16.393,7.891L18.25,9.748L10.75,17.39Z" fill="#5C6F8A" fill-rule="nonzero"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.8 KiB |
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg width="100%" height="100%" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2">
|
||||
<path d="M12,6.453L21,14.828L21,24L15,24L15,18L9,18L9,24L3,24L3,14.828L12,6.453ZM24,12.148L12,1L0,12.133L1.361,13.598L12,3.73L22.639,13.613L24,12.148Z" fill="#5C6F8A" fill-rule="nonzero"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 642 B |
@@ -0,0 +1,16 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg width="100%" height="100%" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2">
|
||||
<g id="iconmonstr-weather-64.svg" transform="matrix(1,0,0,1,12,12)">
|
||||
<g id="iconmonstr-whats-hot-1.svg" transform="matrix(1,0,0,1,-12,-12)">
|
||||
<clipPath id="_clip1">
|
||||
<rect x="0" y="0" width="24" height="24"/>
|
||||
</clipPath>
|
||||
<g clip-path="url(#_clip1)">
|
||||
<path d="M8.625,0C9.235,7.189 3,9.664 3,15.996C3,20.297 6.069,23.968 12,24C17.931,24.032 21,19.586 21,15.044C21,10.903 18.938,6.998 15.048,4.57C15.972,7.177 14.742,9.558 13.547,10.378C13.617,7.041 12.422,2.089 8.625,0ZM13.336,13C17.091,16.989 14.785,22 11.769,22C9.934,22 8.99,20.735 9,19.423C9.019,16.99 11.737,16.988 13.336,13Z" fill="#5C6F8A"/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="iconmonstr-whats-hot-1.svg1" serif:id="iconmonstr-whats-hot-1.svg">
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.2 KiB |
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg width="100%" height="100%" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2">
|
||||
<path d="M21.337,0.458L17.4,4.394C14.951,2.928 11.73,3.25 9.62,5.36L5.359,9.622C3.249,11.732 2.926,14.953 4.391,17.402L0.456,21.337C-0.153,21.946 -0.153,22.934 0.456,23.544C1.065,24.154 2.054,24.153 2.663,23.544L6.598,19.609C9.047,21.074 12.268,20.753 14.378,18.642L18.639,14.381C20.749,12.271 21.072,9.05 19.607,6.6L23.543,2.664C24.152,2.055 24.152,1.067 23.543,0.457C22.934,-0.153 21.946,-0.152 21.337,0.458ZM16.475,12.215L12.214,16.476C11.319,17.37 10.038,17.645 8.904,17.303L10.536,15.671C11.145,15.062 11.145,14.074 10.536,13.464C9.927,12.854 8.938,12.855 8.329,13.464L6.698,15.096C6.355,13.963 6.631,12.681 7.524,11.787L11.785,7.526C12.68,6.632 13.961,6.357 15.095,6.699L13.464,8.329C12.855,8.938 12.855,9.926 13.464,10.536C14.073,11.146 15.062,11.145 15.671,10.536L17.301,8.906C17.644,10.039 17.368,11.321 16.475,12.215Z" fill="#5C6F8A" fill-rule="nonzero"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.3 KiB |
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg width="100%" height="100%" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2">
|
||||
<path d="M22,16.75C22,16.336 21.664,16 21.25,16L2.75,16C2.336,16 2,16.336 2,16.75C2,17.164 2.336,17.5 2.75,17.5L21.25,17.5C21.664,17.5 22,17.164 22,16.75ZM22,11.75C22,11.336 21.664,11 21.25,11L2.75,11C2.336,11 2,11.336 2,11.75C2,12.164 2.336,12.5 2.75,12.5L21.25,12.5C21.664,12.5 22,12.164 22,11.75ZM22,6.75C22,6.336 21.664,6 21.25,6L2.75,6C2.336,6 2,6.336 2,6.75C2,7.164 2.336,7.5 2.75,7.5L21.25,7.5C21.664,7.5 22,7.164 22,6.75Z" fill="#111827" fill-rule="nonzero"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 921 B |
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg width="100%" height="100%" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2">
|
||||
<path d="M23.961,8.429C23.13,9.411 22.347,10.347 22,12.204L22,18.887L18,21.366L18,12.205C17.653,10.348 16.87,9.412 16.039,8.43C15.131,7.355 14,6.019 14,3.801L14.019,3.456L12,2L6.455,6L0,2L0,20L6.455,24L12,20L17.545,24L24,20L24,8.382L23.961,8.429ZM11,18.255L7,21.14L7,8.073L11,5.187L11,18.255ZM20,0C17.9,0 16,1.702 16,3.801C16,6.922 19.188,7.252 20,12C20.812,7.252 24,6.922 24,3.801C24,1.702 22.1,0 20,0ZM20,5.5C19.172,5.5 18.5,4.829 18.5,4C18.5,3.171 19.172,2.5 20,2.5C20.828,2.5 21.5,3.171 21.5,4C21.5,4.829 20.828,5.5 20,5.5Z" fill="#5C6F8A" fill-rule="nonzero"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1019 B |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M5 7c2.761 0 5 2.239 5 5s-2.239 5-5 5-5-2.239-5-5 2.239-5 5-5zm11.122 12.065c-.073.301-.122.611-.122.935 0 2.209 1.791 4 4 4s4-1.791 4-4-1.791-4-4-4c-1.165 0-2.204.506-2.935 1.301l-5.488-2.927c-.23.636-.549 1.229-.943 1.764l5.488 2.927zm7.878-15.065c0-2.209-1.791-4-4-4s-4 1.791-4 4c0 .324.049.634.122.935l-5.488 2.927c.395.535.713 1.127.943 1.764l5.488-2.927c.731.795 1.77 1.301 2.935 1.301 2.209 0 4-1.791 4-4z"/></svg>
|
||||
|
After Width: | Height: | Size: 513 B |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="currentColor"><path d="M19.35 10.04C18.67 6.59 15.64 4 12 4 9.11 4 6.6 5.64 5.35 8.04 2.34 8.36 0 10.91 0 14c0 3.31 2.69 6 6 6h13c2.76 0 5-2.24 5-5 0-2.64-2.05-4.78-4.65-4.96zM14 13v4h-4v-4H7l5-5 5 5h-3z"/></svg>
|
||||
|
After Width: | Height: | Size: 301 B |
@@ -1,16 +0,0 @@
|
||||
# Audit Report (Unstable Branch)
|
||||
|
||||
## File Size
|
||||
- **Grandfathered Oversized Files:** 44
|
||||
- **Total Excess Lines:** 54,278 (sum of lines exceeding the 1000-line limit for each file)
|
||||
|
||||
## innerHTML Usage
|
||||
- **Total Assignments:** 125
|
||||
|
||||
## Lint Status
|
||||
- **Failures:** None
|
||||
- `lint:assets` skipped (build required)
|
||||
- `lint:sw-compat` skipped (git history unavailable)
|
||||
|
||||
## Comparison
|
||||
No previous report found in the repository for comparison.
|
||||
@@ -1,55 +0,0 @@
|
||||
|
||||
import { performance } from "perf_hooks";
|
||||
|
||||
// Mock IndexedDB if running in Node
|
||||
if (!globalThis.indexedDB) {
|
||||
const { indexedDB, IDBKeyRange } = await import("fake-indexeddb");
|
||||
globalThis.indexedDB = indexedDB;
|
||||
globalThis.IDBKeyRange = IDBKeyRange;
|
||||
}
|
||||
|
||||
// Mock console to suppress logs
|
||||
const originalConsoleWarn = console.warn;
|
||||
console.warn = () => {};
|
||||
|
||||
// Import after mocking console
|
||||
const { writeMessages, clearDmDb } = await import("../js/storage/dmDb.js");
|
||||
|
||||
async function runBenchmark() {
|
||||
await clearDmDb();
|
||||
|
||||
const iterations = 1000;
|
||||
const messages = [];
|
||||
|
||||
for (let i = 0; i < iterations; i++) {
|
||||
messages.push({
|
||||
id: `msg-${i}`,
|
||||
conversation_id: "conv-1",
|
||||
sender_pubkey: "sender",
|
||||
receiver_pubkey: "receiver",
|
||||
created_at: Date.now(),
|
||||
kind: 4,
|
||||
content: `Message ${i}`,
|
||||
});
|
||||
}
|
||||
|
||||
console.log(`Starting benchmark with ${iterations} writes...`);
|
||||
|
||||
const start = performance.now();
|
||||
|
||||
// Simulate N+1 writes
|
||||
for (const msg of messages) {
|
||||
await writeMessages(msg);
|
||||
}
|
||||
|
||||
const end = performance.now();
|
||||
const duration = end - start;
|
||||
|
||||
console.log(`Total time: ${duration.toFixed(2)}ms`);
|
||||
console.log(`Average time per write: ${(duration / iterations).toFixed(2)}ms`);
|
||||
|
||||
// Restore console
|
||||
console.warn = originalConsoleWarn;
|
||||
}
|
||||
|
||||
runBenchmark().catch(console.error);
|
||||
@@ -1,85 +0,0 @@
|
||||
|
||||
import { decryptDM } from "../js/dmDecryptor.js";
|
||||
|
||||
// Valid 64-char hex strings
|
||||
const WRAP_PUBKEY = "0000000000000000000000000000000000000000000000000000000000000001";
|
||||
const SEAL_PUBKEY = "0000000000000000000000000000000000000000000000000000000000000002";
|
||||
const SENDER_PUBKEY = "0000000000000000000000000000000000000000000000000000000000000003";
|
||||
const RECIPIENT_PUBKEY = "0000000000000000000000000000000000000000000000000000000000000004";
|
||||
|
||||
const sealEvent = {
|
||||
id: "seal-event",
|
||||
pubkey: SEAL_PUBKEY,
|
||||
content: "seal-ciphertext",
|
||||
created_at: Math.floor(Date.now() / 1000),
|
||||
};
|
||||
|
||||
const rumorEvent = {
|
||||
id: "rumor-event",
|
||||
pubkey: SENDER_PUBKEY,
|
||||
content: "Hello World",
|
||||
created_at: Math.floor(Date.now() / 1000),
|
||||
tags: [["p", RECIPIENT_PUBKEY]],
|
||||
};
|
||||
|
||||
const wrapEvent = {
|
||||
kind: 1059,
|
||||
pubkey: WRAP_PUBKEY,
|
||||
content: "wrap-ciphertext",
|
||||
created_at: Math.floor(Date.now() / 1000),
|
||||
tags: [["p", RECIPIENT_PUBKEY]],
|
||||
};
|
||||
|
||||
const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
|
||||
|
||||
const createDecryptor = (name, shouldFail, delayMs) => {
|
||||
return {
|
||||
scheme: "nip44",
|
||||
supportsGiftWrap: true,
|
||||
decrypt: async (pubkey, ciphertext, context) => {
|
||||
await delay(delayMs);
|
||||
if (shouldFail) {
|
||||
throw new Error(`${name} failed`);
|
||||
}
|
||||
|
||||
// If we are unwrapping the outer wrap, return the seal
|
||||
if (context.stage === "wrap") {
|
||||
return JSON.stringify(sealEvent);
|
||||
}
|
||||
// If we are unwrapping the seal, return the rumor
|
||||
if (context.stage === "seal") {
|
||||
return JSON.stringify(rumorEvent);
|
||||
}
|
||||
|
||||
return "";
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
async function runBenchmark() {
|
||||
console.log("Running DM Decrypt Benchmark...");
|
||||
|
||||
const decryptors = [
|
||||
createDecryptor("D1", true, 100),
|
||||
createDecryptor("D2", true, 100),
|
||||
createDecryptor("D3", false, 50),
|
||||
];
|
||||
|
||||
const context = {
|
||||
actorPubkey: RECIPIENT_PUBKEY,
|
||||
decryptors: decryptors,
|
||||
};
|
||||
|
||||
const start = performance.now();
|
||||
const result = await decryptDM(wrapEvent, context);
|
||||
const end = performance.now();
|
||||
|
||||
console.log(`Result OK: ${result.ok}`);
|
||||
if (!result.ok) {
|
||||
const errorMessages = result.errors.map(e => ({stage: e.stage, message: e.error.message}));
|
||||
console.log("Errors:", JSON.stringify(errorMessages, null, 2));
|
||||
}
|
||||
console.log(`Time taken: ${(end - start).toFixed(2)}ms`);
|
||||
}
|
||||
|
||||
runBenchmark();
|
||||
@@ -1,76 +0,0 @@
|
||||
|
||||
import { createFeedEngine } from "../js/feedEngine/index.js";
|
||||
import { performance } from "perf_hooks";
|
||||
|
||||
// Mock logger
|
||||
const logger = {
|
||||
log: () => {},
|
||||
warn: () => {},
|
||||
error: () => {},
|
||||
};
|
||||
|
||||
// Polyfill localStorage to silence errors
|
||||
if (typeof globalThis.localStorage === "undefined") {
|
||||
globalThis.localStorage = {
|
||||
getItem: () => null,
|
||||
setItem: () => {},
|
||||
removeItem: () => {},
|
||||
};
|
||||
}
|
||||
|
||||
async function runBenchmark() {
|
||||
const engine = createFeedEngine({ logger });
|
||||
const feedName = "bench-feed";
|
||||
|
||||
// Create items
|
||||
const itemCount = 100000;
|
||||
const items = [];
|
||||
for (let i = 0; i < itemCount; i++) {
|
||||
items.push({
|
||||
video: { id: `v${i}`, created_at: Date.now() },
|
||||
metadata: { some: "data" },
|
||||
});
|
||||
}
|
||||
|
||||
// Define stages
|
||||
const stages = [];
|
||||
|
||||
// 10 stages that return null (no change) - STRICT PASS THROUGH
|
||||
for (let i = 0; i < 10; i++) {
|
||||
stages.push(async (items) => {
|
||||
return null;
|
||||
});
|
||||
}
|
||||
|
||||
// 10 stages that return the same items array (identity) - STRICT PASS THROUGH
|
||||
for (let i = 0; i < 10; i++) {
|
||||
stages.push(async (items) => {
|
||||
return items;
|
||||
});
|
||||
}
|
||||
|
||||
engine.registerFeed(feedName, {
|
||||
source: async () => [...items],
|
||||
stages: stages,
|
||||
});
|
||||
|
||||
console.log(`Starting benchmark with ${itemCount} items and ${stages.length} stages...`);
|
||||
|
||||
const iterations = 50;
|
||||
const start = performance.now();
|
||||
|
||||
for (let i = 0; i < iterations; i++) {
|
||||
await engine.runFeed(feedName);
|
||||
if (i % 5 === 0) process.stdout.write(".");
|
||||
}
|
||||
|
||||
const end = performance.now();
|
||||
const totalTime = end - start;
|
||||
const avgTime = totalTime / iterations;
|
||||
|
||||
console.log("\n");
|
||||
console.log(`Total time: ${totalTime.toFixed(2)}ms`);
|
||||
console.log(`Average time per run: ${avgTime.toFixed(2)}ms`);
|
||||
}
|
||||
|
||||
runBenchmark().catch(console.error);
|
||||
@@ -1,81 +0,0 @@
|
||||
|
||||
import { normalizeHashtag } from "../js/utils/hashtagNormalization.js";
|
||||
import { getVideoTags } from "../js/feedEngine/utils.js";
|
||||
|
||||
// Mock video object
|
||||
function createMockVideo(tagCount) {
|
||||
const tags = [];
|
||||
for (let i = 0; i < tagCount; i++) {
|
||||
tags.push(["t", `tag${i}`]);
|
||||
}
|
||||
return {
|
||||
id: "video-" + Math.random(),
|
||||
tags: tags,
|
||||
nip71: {
|
||||
hashtags: ["extra1", "extra2"]
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
// Legacy Uncached collectVideoTags (for comparison)
|
||||
function collectVideoTags(video) {
|
||||
const videoTags = new Set();
|
||||
|
||||
if (Array.isArray(video.tags)) {
|
||||
for (const tag of video.tags) {
|
||||
if (Array.isArray(tag) && tag[0] === "t" && typeof tag[1] === "string") {
|
||||
const normalized = normalizeHashtag(tag[1]);
|
||||
if (normalized) {
|
||||
videoTags.add(normalized);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (Array.isArray(video.nip71?.hashtags)) {
|
||||
for (const tag of video.nip71.hashtags) {
|
||||
if (typeof tag === "string") {
|
||||
const normalized = normalizeHashtag(tag);
|
||||
if (normalized) {
|
||||
videoTags.add(normalized);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return videoTags;
|
||||
}
|
||||
|
||||
// Benchmark
|
||||
const VIDEOS_COUNT = 10000;
|
||||
const TAGS_PER_VIDEO = 10;
|
||||
const ITERATIONS = 100;
|
||||
|
||||
const videos = [];
|
||||
for (let i = 0; i < VIDEOS_COUNT; i++) {
|
||||
videos.push(createMockVideo(TAGS_PER_VIDEO));
|
||||
}
|
||||
|
||||
console.log(`Benchmarking with ${VIDEOS_COUNT} videos, ${ITERATIONS} iterations.`);
|
||||
|
||||
console.time("Uncached (collectVideoTags)");
|
||||
for (let i = 0; i < ITERATIONS; i++) {
|
||||
for (const video of videos) {
|
||||
collectVideoTags(video);
|
||||
}
|
||||
}
|
||||
console.timeEnd("Uncached (collectVideoTags)");
|
||||
|
||||
console.time("Cached (getVideoTags) - First Run");
|
||||
for (const video of videos) {
|
||||
getVideoTags(video);
|
||||
}
|
||||
console.timeEnd("Cached (getVideoTags) - First Run");
|
||||
|
||||
console.time("Cached (getVideoTags) - Second Run");
|
||||
for (let i = 0; i < ITERATIONS - 1; i++) {
|
||||
for (const video of videos) {
|
||||
getVideoTags(video);
|
||||
}
|
||||
}
|
||||
console.timeEnd("Cached (getVideoTags) - Second Run");
|
||||
@@ -1,63 +0,0 @@
|
||||
// benchmarks/kids_scoring_bench.js
|
||||
import { createKidsScorerStage } from "../js/feedEngine/kidsScoring.js";
|
||||
import { performance } from "perf_hooks";
|
||||
|
||||
async function runBenchmark() {
|
||||
const itemCount = 200000;
|
||||
const items = [];
|
||||
|
||||
// Create mock items with diverse data to exercise different paths
|
||||
for (let i = 0; i < itemCount; i++) {
|
||||
items.push({
|
||||
video: {
|
||||
id: `v${i}`,
|
||||
pubkey: `pubkey${i % 100}`,
|
||||
duration: 300 + (i % 600), // 5 to 15 minutes
|
||||
tags: [
|
||||
["t", "kids"],
|
||||
["t", "learning"],
|
||||
["t", i % 2 === 0 ? "preschool" : "science"],
|
||||
],
|
||||
viewCount: i * 10,
|
||||
created_at: Date.now() / 1000 - (i % 10000),
|
||||
moderation: { trustedCount: i % 5 },
|
||||
},
|
||||
metadata: {},
|
||||
});
|
||||
}
|
||||
|
||||
const context = {
|
||||
runtime: {
|
||||
ageGroup: "preschool",
|
||||
trustedAuthors: ["pubkey1", "pubkey2"],
|
||||
},
|
||||
addWhy: () => {}, // Mock addWhy
|
||||
};
|
||||
|
||||
const scorer = createKidsScorerStage();
|
||||
|
||||
console.log(`Starting kids scoring benchmark with ${itemCount} items...`);
|
||||
|
||||
// Warmup
|
||||
await scorer([...items.slice(0, 1000)], context);
|
||||
|
||||
const iterations = 100;
|
||||
let totalTime = 0;
|
||||
|
||||
for (let i = 0; i < iterations; i++) {
|
||||
// Reset metadata for each run to be cleaner
|
||||
items.forEach(item => item.metadata = {});
|
||||
|
||||
const start = performance.now();
|
||||
await scorer(items, context);
|
||||
const end = performance.now();
|
||||
totalTime += (end - start);
|
||||
|
||||
if (i % 5 === 0) process.stdout.write(".");
|
||||
}
|
||||
|
||||
const avgTime = totalTime / iterations;
|
||||
console.log(`\nAverage time per run: ${avgTime.toFixed(4)}ms`);
|
||||
}
|
||||
|
||||
runBenchmark().catch(console.error);
|
||||
@@ -1,121 +0,0 @@
|
||||
|
||||
// Mock Globals BEFORE imports
|
||||
global.localStorage = {
|
||||
getItem: () => null,
|
||||
setItem: () => {},
|
||||
removeItem: () => {},
|
||||
clear: () => {}
|
||||
};
|
||||
global.window = { localStorage: global.localStorage };
|
||||
|
||||
// Dynamic imports to ensure globals are set first
|
||||
const { ModerationService } = await import('../js/services/moderationService.js');
|
||||
const { createModerationStage } = await import('../js/feedEngine/stages.js');
|
||||
const { performance } = await import('node:perf_hooks');
|
||||
|
||||
// Mock Dependencies
|
||||
const mockClient = {
|
||||
pool: {},
|
||||
ensurePool: async () => {},
|
||||
pubkey: 'viewer-pubkey',
|
||||
};
|
||||
|
||||
const mockLogger = {
|
||||
log: () => {},
|
||||
dev: { log: () => {}, debug: () => {} },
|
||||
user: { warn: () => {}, info: () => {} }
|
||||
};
|
||||
|
||||
const service = new ModerationService({
|
||||
nostrClient: mockClient,
|
||||
logger: mockLogger,
|
||||
});
|
||||
|
||||
// Helper to generate valid hex
|
||||
function makeHex(prefix, index) {
|
||||
return `${prefix}${index.toString(16).padStart(64 - prefix.length, '0')}`;
|
||||
}
|
||||
|
||||
// Setup Data
|
||||
const AUTHOR_COUNT = 500;
|
||||
const MUTERS_PER_AUTHOR = 100;
|
||||
const now = Date.now() / 1000;
|
||||
|
||||
console.log(`Populating ${AUTHOR_COUNT} authors with ${MUTERS_PER_AUTHOR} muters each...`);
|
||||
|
||||
for (let i = 0; i < AUTHOR_COUNT; i++) {
|
||||
const author = makeHex('abc', i);
|
||||
const muters = new Map();
|
||||
const categories = new Map();
|
||||
|
||||
for (let j = 0; j < MUTERS_PER_AUTHOR; j++) {
|
||||
const muter = makeHex('def', j);
|
||||
muters.set(muter, now); // Not expired
|
||||
}
|
||||
|
||||
// Add some categories
|
||||
const catMuters = new Map();
|
||||
const firstMuter = makeHex('def', 0);
|
||||
catMuters.set(firstMuter, now);
|
||||
categories.set('spam', catMuters);
|
||||
|
||||
// We manually inject into internal map to bypass setter logic
|
||||
service.trustedMutedAuthors.set(author, {
|
||||
muters,
|
||||
categories,
|
||||
count: muters.size,
|
||||
lastPrunedAt: 0 // Force prune check
|
||||
});
|
||||
}
|
||||
|
||||
// Prepare items for stage
|
||||
const ITEM_COUNT = 5000;
|
||||
const items = [];
|
||||
for (let i = 0; i < ITEM_COUNT; i++) {
|
||||
const authorIndex = i % AUTHOR_COUNT;
|
||||
const author = makeHex('abc', authorIndex);
|
||||
items.push({
|
||||
video: {
|
||||
id: makeHex('123', i),
|
||||
pubkey: author,
|
||||
kind: 30078,
|
||||
moderation: {}
|
||||
},
|
||||
metadata: {}
|
||||
});
|
||||
}
|
||||
|
||||
const context = {
|
||||
runtime: {
|
||||
moderationThresholds: {
|
||||
autoplayBlockThreshold: 1,
|
||||
blurThreshold: 1,
|
||||
trustedSpamHideThreshold: 1,
|
||||
trustedMuteHideThresholds: {}
|
||||
},
|
||||
isAuthorBlocked: () => false
|
||||
},
|
||||
log: () => {},
|
||||
addWhy: () => {}
|
||||
};
|
||||
|
||||
async function runBenchmark() {
|
||||
console.log('Running Moderation Stage Benchmark (Sequential Lookups)...');
|
||||
|
||||
const moderationStage = createModerationStage({
|
||||
service: service,
|
||||
stageName: 'bench-moderation-sequential'
|
||||
});
|
||||
|
||||
// Warmup
|
||||
await moderationStage(items.slice(0, 100), context);
|
||||
|
||||
// Measure
|
||||
const start = performance.now();
|
||||
await moderationStage(items, context);
|
||||
const end = performance.now();
|
||||
|
||||
console.log(`Time: ${(end - start).toFixed(2)}ms`);
|
||||
}
|
||||
|
||||
runBenchmark().catch(console.error);
|
||||
@@ -1,74 +0,0 @@
|
||||
import { ModerationService } from '../js/services/moderationService.js';
|
||||
import { performance } from 'perf_hooks';
|
||||
|
||||
// Mock dependencies
|
||||
const mockClient = {
|
||||
pool: {},
|
||||
};
|
||||
const mockLogger = {
|
||||
log: () => {},
|
||||
dev: { log: () => {} },
|
||||
user: { warn: () => {}, info: () => {} }
|
||||
};
|
||||
|
||||
const service = new ModerationService({
|
||||
nostrClient: mockClient,
|
||||
logger: mockLogger,
|
||||
});
|
||||
|
||||
async function runBenchmark() {
|
||||
console.log('Starting Moderation Service Stress Benchmark...');
|
||||
|
||||
// Setup Data
|
||||
// 100 authors, each having 500 muters (spam scenario).
|
||||
// 50 muters are expired.
|
||||
|
||||
const AUTHOR_COUNT = 100;
|
||||
const MUTERS_PER_AUTHOR = 500;
|
||||
const now = Date.now() / 1000;
|
||||
const expiredTime = now - (61 * 24 * 60 * 60);
|
||||
|
||||
console.log(`Populating ${AUTHOR_COUNT} authors with ${MUTERS_PER_AUTHOR} muters each...`);
|
||||
|
||||
for (let i = 0; i < AUTHOR_COUNT; i++) {
|
||||
const author = `author-${i}`.padEnd(64, '0');
|
||||
const muters = new Map();
|
||||
|
||||
for (let j = 0; j < MUTERS_PER_AUTHOR; j++) {
|
||||
const muter = `muter-${j}`.padEnd(64, '0');
|
||||
// 10% expired
|
||||
const timestamp = (j % 10 === 0) ? expiredTime : now;
|
||||
muters.set(muter, timestamp);
|
||||
}
|
||||
|
||||
service.trustedMutedAuthors.set(author, {
|
||||
muters,
|
||||
categories: new Map(),
|
||||
count: muters.size
|
||||
});
|
||||
}
|
||||
|
||||
// Benchmark Read
|
||||
console.log('Benchmarking getActiveTrustedMutersForAuthor (Read + Prune)...');
|
||||
const READ_ITERATIONS = 10000; // 10k reads
|
||||
|
||||
const start = performance.now();
|
||||
|
||||
for (let i = 0; i < READ_ITERATIONS; i++) {
|
||||
const authorIndex = i % AUTHOR_COUNT;
|
||||
const author = `author-${authorIndex}`.padEnd(64, '0');
|
||||
// This call triggers pruneTrustedMuteAggregates EVERY time
|
||||
service.getActiveTrustedMutersForAuthor(author);
|
||||
}
|
||||
|
||||
const end = performance.now();
|
||||
const totalTime = end - start;
|
||||
const avgTime = totalTime / READ_ITERATIONS;
|
||||
|
||||
console.log('---------------------------------------------------');
|
||||
console.log(`Total time: ${totalTime.toFixed(2)}ms`);
|
||||
console.log(`Average time per call: ${(avgTime * 1000).toFixed(4)}µs`);
|
||||
console.log('---------------------------------------------------');
|
||||
}
|
||||
|
||||
runBenchmark().catch(console.error);
|
||||
@@ -1,150 +0,0 @@
|
||||
import { createModerationStage } from '../js/feedEngine/stages.js';
|
||||
import { performance } from 'perf_hooks';
|
||||
|
||||
// Mock Logger
|
||||
const logger = {
|
||||
log: () => {},
|
||||
dev: { log: () => {}, debug: () => {} },
|
||||
user: { warn: () => {}, info: () => {} }
|
||||
};
|
||||
|
||||
// Realistic Mock Service
|
||||
const mutedAuthors = new Set();
|
||||
const reportedVideos = new Map();
|
||||
|
||||
// Seed data
|
||||
for (let i = 0; i < 100; i++) {
|
||||
if (Math.random() < 0.1) {
|
||||
mutedAuthors.add(`pubkey-${i}`);
|
||||
}
|
||||
}
|
||||
|
||||
// Simulate pruning cost
|
||||
function pruneSimulation() {
|
||||
const map = new Map();
|
||||
for(let i=0; i<5; i++) map.set(i, Date.now()); // Simulate 5 muters
|
||||
for(const [k,v] of map) {
|
||||
if (v < 0) map.delete(k);
|
||||
}
|
||||
}
|
||||
|
||||
const mockService = {
|
||||
refreshViewerFromClient: async () => {},
|
||||
setActiveEventIds: async () => {},
|
||||
getAdminListSnapshot: () => ({
|
||||
whitelist: new Set(),
|
||||
whitelistHex: new Set(),
|
||||
blacklist: new Set(),
|
||||
blacklistHex: new Set()
|
||||
}),
|
||||
getAccessControlStatus: (pubkey) => ({
|
||||
hex: pubkey,
|
||||
whitelisted: false,
|
||||
blacklisted: false
|
||||
}),
|
||||
getTrustedReportSummary: (id) => {
|
||||
if (reportedVideos.has(id)) {
|
||||
return reportedVideos.get(id);
|
||||
}
|
||||
return null;
|
||||
},
|
||||
trustedReportCount: (id) => {
|
||||
const summary = reportedVideos.get(id);
|
||||
return summary ? summary.totalTrusted : 0;
|
||||
},
|
||||
getTrustedReporters: (id) => [],
|
||||
isAuthorMutedByTrusted: (pubkey) => {
|
||||
// Simulate the real service logic which calls prune
|
||||
pruneSimulation();
|
||||
return mutedAuthors.has(pubkey);
|
||||
},
|
||||
getTrustedMutersForAuthor: (pubkey) => {
|
||||
// Simulate prune here too if called
|
||||
pruneSimulation();
|
||||
if (mutedAuthors.has(pubkey)) {
|
||||
return ['trusted-muter-1', 'trusted-muter-2'];
|
||||
}
|
||||
return [];
|
||||
},
|
||||
getTrustedMuteCountsForAuthor: (pubkey) => {
|
||||
pruneSimulation();
|
||||
if (mutedAuthors.has(pubkey)) {
|
||||
return { total: 2, categories: { nudity: 1, spam: 1 } };
|
||||
}
|
||||
return { total: 0, categories: {} };
|
||||
},
|
||||
isAuthorMutedByViewer: (pubkey) => false,
|
||||
};
|
||||
|
||||
async function runBenchmark() {
|
||||
console.log('Starting Moderation Stage Benchmark (with prune cost)...');
|
||||
|
||||
const ITEM_COUNT = 10000;
|
||||
const items = [];
|
||||
|
||||
for (let i = 0; i < ITEM_COUNT; i++) {
|
||||
const videoId = `video-${i}`;
|
||||
const pubkey = `pubkey-${i % 100}`;
|
||||
|
||||
// Simulate some reported videos
|
||||
if (Math.random() < 0.05) {
|
||||
reportedVideos.set(videoId, {
|
||||
eventId: videoId,
|
||||
totalTrusted: 2,
|
||||
types: { nudity: { trusted: 2, total: 5, latest: Date.now() } },
|
||||
updatedAt: Date.now()
|
||||
});
|
||||
}
|
||||
|
||||
items.push({
|
||||
video: {
|
||||
id: videoId,
|
||||
pubkey: pubkey,
|
||||
kind: 30078,
|
||||
tags: []
|
||||
},
|
||||
metadata: {}
|
||||
});
|
||||
}
|
||||
|
||||
const context = {
|
||||
runtime: {
|
||||
moderationThresholds: {
|
||||
autoplayBlockThreshold: 1,
|
||||
blurThreshold: 1,
|
||||
trustedSpamHideThreshold: 1,
|
||||
trustedMuteHideThresholds: {}
|
||||
},
|
||||
isAuthorBlocked: () => false
|
||||
},
|
||||
log: logger.dev.log,
|
||||
addWhy: () => {}
|
||||
};
|
||||
|
||||
const moderationStage = createModerationStage({
|
||||
service: mockService,
|
||||
stageName: 'bench-moderation'
|
||||
});
|
||||
|
||||
// Warmup
|
||||
console.log('Warming up...');
|
||||
await moderationStage(items.slice(0, 100), context);
|
||||
|
||||
// Run
|
||||
console.log(`Processing ${ITEM_COUNT} items with ~10% muted authors and prune simulation...`);
|
||||
const start = performance.now();
|
||||
|
||||
const result = await moderationStage(items, context);
|
||||
|
||||
const end = performance.now();
|
||||
const totalTime = end - start;
|
||||
const avgTime = totalTime / ITEM_COUNT;
|
||||
|
||||
console.log('---------------------------------------------------');
|
||||
console.log(`Total time: ${totalTime.toFixed(2)}ms`);
|
||||
console.log(`Average time per item: ${(avgTime * 1000).toFixed(4)}µs`);
|
||||
console.log(`Items processed: ${result.length}`);
|
||||
console.log('---------------------------------------------------');
|
||||
}
|
||||
|
||||
runBenchmark().catch(console.error);
|
||||
@@ -1,28 +0,0 @@
|
||||
|
||||
import { normalizeNip46CiphertextPayload } from "../js/nostr/nip46Client.js";
|
||||
|
||||
const ITERATIONS = 100;
|
||||
const ARRAY_SIZE = 200;
|
||||
|
||||
function runBenchmark() {
|
||||
const largeArray = Array.from({ length: ARRAY_SIZE }, (_, i) => `string_${i}`);
|
||||
|
||||
// Wrap in a structure that triggers the recursive coerce and then the array handling
|
||||
const payload = {
|
||||
data: largeArray
|
||||
};
|
||||
|
||||
const start = performance.now();
|
||||
|
||||
for (let i = 0; i < ITERATIONS; i++) {
|
||||
normalizeNip46CiphertextPayload(payload);
|
||||
}
|
||||
|
||||
const end = performance.now();
|
||||
const duration = end - start;
|
||||
|
||||
console.log(`Time taken for ${ITERATIONS} iterations with array size ${ARRAY_SIZE}: ${duration.toFixed(2)}ms`);
|
||||
console.log(`Average time per iteration: ${(duration / ITERATIONS).toFixed(2)}ms`);
|
||||
}
|
||||
|
||||
runBenchmark();
|
||||
@@ -1,88 +0,0 @@
|
||||
import { profileCache } from "../js/state/profileCache.js";
|
||||
|
||||
class LegacyProfileCache {
|
||||
constructor() {
|
||||
this.memoryCache = new Map();
|
||||
}
|
||||
|
||||
set(pubkey, section, data) {
|
||||
this.memoryCache.set(`${pubkey}:${section}`, data);
|
||||
}
|
||||
|
||||
clearMemoryCache(pubkey) {
|
||||
const prefix = `${pubkey}:`;
|
||||
for (const key of this.memoryCache.keys()) {
|
||||
if (key.startsWith(prefix)) {
|
||||
this.memoryCache.delete(key);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function generatePubkey(i) {
|
||||
return i.toString(16).padStart(64, '0');
|
||||
}
|
||||
|
||||
function runBenchmark() {
|
||||
const legacy = new LegacyProfileCache();
|
||||
|
||||
// Clean actual cache just in case
|
||||
profileCache.memoryCache.clear();
|
||||
|
||||
const PUBKEY_COUNT = 1000;
|
||||
const SECTIONS_PER_PUBKEY = 20;
|
||||
const TARGET_PUBKEY = generatePubkey(500); // Middle one
|
||||
|
||||
console.log(`Setting up caches with ${PUBKEY_COUNT} pubkeys x ${SECTIONS_PER_PUBKEY} sections...`);
|
||||
|
||||
// Populate
|
||||
for (let i = 0; i < PUBKEY_COUNT; i++) {
|
||||
const pubkey = generatePubkey(i);
|
||||
for (let s = 0; s < SECTIONS_PER_PUBKEY; s++) {
|
||||
const section = `section-${s}`;
|
||||
const data = { value: `data-${i}-${s}` };
|
||||
|
||||
// Legacy
|
||||
legacy.set(pubkey, section, data);
|
||||
|
||||
// Actual (Optimized)
|
||||
// We use setMemoryDataForPubkey to bypass storage/logic overhead
|
||||
profileCache.setMemoryDataForPubkey(pubkey, section, data);
|
||||
}
|
||||
}
|
||||
|
||||
console.log(`Total entries: ${PUBKEY_COUNT * SECTIONS_PER_PUBKEY}`);
|
||||
|
||||
// Measure Legacy
|
||||
const startLegacy = performance.now();
|
||||
legacy.clearMemoryCache(TARGET_PUBKEY);
|
||||
const endLegacy = performance.now();
|
||||
const timeLegacy = endLegacy - startLegacy;
|
||||
|
||||
// Measure Optimized
|
||||
const startOptimized = performance.now();
|
||||
profileCache.clearMemoryCache(TARGET_PUBKEY);
|
||||
const endOptimized = performance.now();
|
||||
const timeOptimized = endOptimized - startOptimized;
|
||||
|
||||
console.log(`\nResults:`);
|
||||
console.log(`Legacy (Linear Scan): ${timeLegacy.toFixed(4)} ms`);
|
||||
console.log(`Optimized (Nested Map): ${timeOptimized.toFixed(4)} ms`);
|
||||
|
||||
if (timeLegacy > timeOptimized) {
|
||||
const factor = timeLegacy / (timeOptimized || 0.001); // avoid div by zero
|
||||
console.log(`Improvement: ~${factor.toFixed(1)}x faster`);
|
||||
} else {
|
||||
console.log("No improvement detected (dataset might be too small or optimized code has overhead)");
|
||||
}
|
||||
|
||||
// Verification
|
||||
if (profileCache.memoryCache.has(TARGET_PUBKEY)) {
|
||||
console.error("FAIL: Optimized cache did not clear the pubkey!");
|
||||
process.exit(1);
|
||||
} else {
|
||||
console.log("PASS: Optimized cache cleared successfully.");
|
||||
}
|
||||
}
|
||||
|
||||
runBenchmark();
|
||||
@@ -1,66 +0,0 @@
|
||||
import { profileCache } from "../js/state/profileCache.js";
|
||||
|
||||
// Polyfill localStorage
|
||||
const store = new Map();
|
||||
global.localStorage = {
|
||||
getItem: (key) => store.get(key) || null,
|
||||
setItem: (key, value) => store.set(key, value),
|
||||
removeItem: (key) => store.delete(key),
|
||||
clear: () => store.clear(),
|
||||
};
|
||||
|
||||
// Polyfill requestIdleCallback
|
||||
global.requestIdleCallback = (cb) => setTimeout(() => {
|
||||
cb({
|
||||
timeRemaining: () => 50,
|
||||
didTimeout: false
|
||||
});
|
||||
}, 0);
|
||||
|
||||
// Polyfill window (might be needed by logger or others)
|
||||
if (typeof window === 'undefined') {
|
||||
global.window = global;
|
||||
}
|
||||
|
||||
function generateLargeData() {
|
||||
const data = [];
|
||||
// Generate roughly 2MB of JSON data
|
||||
for (let i = 0; i < 20000; i++) {
|
||||
data.push({ id: i, content: "x".repeat(100) });
|
||||
}
|
||||
return data;
|
||||
}
|
||||
|
||||
async function runBenchmark() {
|
||||
const pubkey = "0".repeat(64);
|
||||
const section = "watchHistory";
|
||||
const data = generateLargeData();
|
||||
|
||||
// Set active profile to ensure logic runs
|
||||
profileCache.setActiveProfile(pubkey);
|
||||
|
||||
console.log("Benchmarking setProfileData with large payload...");
|
||||
|
||||
// Warmup
|
||||
profileCache.setProfileData(pubkey, section, [{id: 1}]);
|
||||
|
||||
const start = performance.now();
|
||||
// We call it multiple times to amplify the effect, but a single call with 2MB is enough to show blocking
|
||||
profileCache.setProfileData(pubkey, section, data);
|
||||
const end = performance.now();
|
||||
|
||||
console.log(`Execution time (Synchronous part): ${(end - start).toFixed(4)} ms`);
|
||||
|
||||
// Wait for idle callback
|
||||
await new Promise(resolve => setTimeout(resolve, 50));
|
||||
|
||||
// Verify data is "stored"
|
||||
const stored = localStorage.getItem(profileCache.getStorageKey(pubkey, section));
|
||||
if (stored) {
|
||||
console.log("Data successfully stored in localStorage (length: " + stored.length + ")");
|
||||
} else {
|
||||
console.log("Data NOT found in localStorage");
|
||||
}
|
||||
}
|
||||
|
||||
runBenchmark();
|
||||