mirror of https://github.com/dreamhunter2333/cloudflare_temp_email.git synced 2026-05-07 05:32:45 +08:00

Files

jiaxin ebeb94ed23 fix: auto initialize default send balance (#985 )

* fix: auto initialize default send balance

* fix: tighten send access auto init flow

* refactor: centralize send balance state

* fix: separate legacy repair from admin control in send balance

Add an `address_sender.source` column to distinguish legacy / auto /
user / admin rows. `ensureDefaultSendBalance` now only repairs rows
with `source IS NULL`, so admin-disabled and user-requested rows are
never overwritten. Admin POST writes tag `source = 'admin'`; new
auto-init inserts tag `'auto'`; `requestSendMailAccess` inserts tag
`'user'`.

Bumps DB_VERSION to v0.0.8 with the usual `PRAGMA table_info` guarded
ALTER, plus a standalone SQL patch under db/.

Adds E2E regressions: legacy repair path, admin-disabled rows stay
disabled across settings and send, send after admin deletion
auto-initializes a fresh row.

* fix: drop runtime legacy repair; backfill source='legacy' on migrate

Pre-v0.0.8 schema cannot distinguish legacy request-send-access
remnants from admin-disabled rows — both share `balance = 0,
enabled = 0`. Letting ensureDefaultSendBalance repair that shape on
upgrade could silently re-enable an admin-disabled row.

Remove the runtime repair path entirely:

- `ensureDefaultSendBalance` now uses `ON CONFLICT(address) DO NOTHING`;
  existing rows are never touched.
- The v0.0.8 migration (and the matching SQL patch) backfills every
  pre-existing row with `source = 'legacy'`, making pre-migration
  state explicitly off-limits to runtime auto-init.
- E2E: flip the legacy test to the negative direction — a
  `source='legacy'` zero-balance row stays untouched by settings
  reads and send attempts. Harden `resetSenderToLegacy` to return
  404 when `meta.changes < 1`.
- Update changelog and docs: legacy/admin-disabled rows must be
  restored manually via the admin UI.

* refactor: collapse send balance auto-init to missing-row insert

Per review feedback: the runtime guarantee we actually need is
"create an address_sender row when one is missing, leave existing
rows alone". Once `ensureDefaultSendBalance` switched to
`ON CONFLICT DO NOTHING`, the `source` column, the v0.0.8 migration,
and the `resetSenderToLegacy` test endpoint became dead weight —
the DO NOTHING path already protects admin-disabled and admin-edited
rows without any provenance metadata.

- Drop `address_sender.source` and the v0.0.8 migration; revert
  DB_VERSION to v0.0.7. No schema change ships with this PR.
- Strip the `source` field from `ensureDefaultSendBalance`,
  `requestSendMailAccess`, and the admin-update path.
- Remove the `/admin/test/reset_sender_to_legacy` test endpoint and
  its E2E helper; the negative legacy-repair test it served is no
  longer needed because the runtime no longer touches existing rows.
- E2E coverage stays focused on the three guardrails: missing-row
  auto-init, admin-disabled rows stay disabled, admin deletion
  triggers a fresh re-insert.
- Tighten changelog and docs to "auto-initialize missing rows".

* docs: align common-issues with missing-row-only auto-init

The FAQ entries for "DEFAULT_SEND_BALANCE set but still No balance"
still described the old behaviour of repairing legacy
`balance = 0 && enabled = 0` rows. Rewrite both zh and en rows to
match the current runtime: only addresses with no existing
`address_sender` row get auto-initialised; legacy, admin-disabled,
and admin-edited rows must be restored manually through the admin
console.

2026-04-20 12:40:14 +08:00

fixtures

fix: auto initialize default send balance (#985 )

2026-04-20 12:40:14 +08:00

scripts

…

tests

fix: auto initialize default send balance (#985 )

2026-04-20 12:40:14 +08:00

docker-compose.yml

…

Dockerfile.e2e

…

Dockerfile.frontend

…

Dockerfile.worker

…

package-lock.json

…

package.json

…

playwright.config.ts

…

README.md

…

README.md

E2E Tests

End-to-end tests for Cloudflare Temp Email using Playwright and Mailpit, fully containerized with Docker Compose.

Prerequisites

Docker and Docker Compose

Quick Start

cd e2e

# Build, start all services, run tests, and exit
npm test

# Clean up containers and volumes
npm run test:down

npm test runs docker compose up --build, which:

Starts Mailpit (SMTP on :1025, HTTP API on :8025)
Builds and starts the Worker (wrangler dev on :8787)
Builds and starts the Frontend (vite dev on :5173)
Builds and runs the E2E runner (Playwright), which waits for services, initializes the DB, and runs all tests

The exit code reflects the test result.

Test Structure

Project	Directory	What it tests
`api`	`tests/api/`	Worker API endpoints — health check, address CRUD, send mail via SMTP
`browser`	`tests/browser/`	Frontend UI — login, inbox view, reply with HTML, XSS sanitization

Services

Service	Container	Port	Purpose
Mailpit SMTP	`mailpit`	1025	Captures outgoing emails
Mailpit HTTP	`mailpit`	8025	API to verify captured emails
Worker	`worker`	8787	Backend API with E2E config
Frontend	`frontend`	5173	Vue frontend dev server

Test Results

Test results and HTML reports are exported via volumes:

e2e/test-results/ — test artifacts
e2e/playwright-report/ — HTML report

Configuration

The E2E worker uses fixtures/wrangler.toml.e2e with:

E2E_TEST_MODE = true — enables test seed endpoint
DISABLE_ADMIN_PASSWORD_CHECK = true — allows unauthenticated admin calls
DEFAULT_SEND_BALANCE = 10 — allows sending without admin approval
SMTP pointed at Mailpit container (mailpit:1025)