tom/HealthLog
1
0 Fork 0
mirror of https://github.com/MBombeck/HealthLog.git synced 2026-11-12 22:26:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
655a1d65a5e9bf74408c1908ce1b010ee2c5616c
HealthLog/scripts/README.md
T
Marc-André Bombeck 655a1d65a5 chore(scripts): remove one-off scripts nothing runs 
Nothing in package.json, the workflows, the Dockerfile, the docs or the
other scripts named these: the bench result dumps of v1.44 and v1.45
that no document cites, the version-pinned release checks, the v1.42
correlation dry run, the read-only diagnostics and their cleanup and
conversion companions for defects fixed long ago, the one-off locale
builder from v1.4.25, and the four June seeders for the demo account.

Kept: the two bench results the benchmarks doc cites, the Google Health
sleep repair (the duplicate-night issue is still open), the demo
migration its password guard reads, the column-reader sweep its test
imports, and the message-bundle tools. The scripts README now lists the
kept tools that it did not name before and drops a reference to a file
that does not exist.
2026-11-11 22:16:47 +01:00

3.7 KiB
Raw Blame History

scripts/

One-shot operator and build scripts. They are not part of the running application: they are run by hand during a deploy, a backfill, or a release, or wired into CI. Recurring work belongs on pg-boss (src/lib/jobs/), not here.

How to run them

From a source checkout:

pnpm dlx tsx scripts/<file>.ts

The production image intentionally removes npm, pnpm, and Corepack. Only container-safe scripts named by an operator runbook use its pinned healthlog-tsx launcher; scripts that import the full application dependency graph must run from a source checkout. scripts/ is excluded from the project typecheck.

What lives here

  • generate-openapi.ts: emits docs/api/openapi.yaml from the registered Zod schemas (pnpm openapi:generate).
  • check-openapi.ts: compares a freshly generated spec against the committed YAML; CI fails on drift (pnpm openapi:check).
  • check-env.ts: pre-deploy env-var sanity check against env-manifest.json (pnpm check-env); wired into CI.
  • assert-deploy.ts: post-deploy /api/version assertion.
  • rotate-encryption-key.ts: AES-256-GCM key rotation; see docs/ops/encryption-key-rotation.md.
  • restore-backup.ts: restore an off-host AES-GCM backup from an S3-compatible bucket.
  • repair-apple-health-distance.ts: repair walking-distance rows the export.zip import stored 1000x too small; dry-run by default, see docs/ops/apple-health-distance-repair.md.
  • repair-intake-anomalies.ts: repair historic medication-ledger defects (duplicate dose-slot rows, implausible taken_at); dry-run by default, see docs/ops/intake-repair.md.
  • backfill-rollups.ts, drain-per-sample-cumulative.ts, backfill-mood-note-column.ts: historical data backfills (the boot-time rollup-full-backfill queue handles new accounts automatically; the CLI is the manual fallback).
  • seed-demo.ts + seed-demo-v15.sql: populate a demo tenant.
  • bench/: seed-large-account.ts (a synthetic ten-year account of about 1.26 million measurement rows) and run.ts (latency and SQL statements per request against it); see docs/contributing/benchmarks.md. Results land in bench/results/.
  • test-notifications.ts: exercise the notification dispatcher + reminder check.
  • fetch-geolite2.sh: download the MaxMind GeoLite2 MMDBs (needs a licence key) before docker build.
  • build-pdf-fonts.py: rebuild the fonts the doctor-report PDF embeds (src/lib/doctor-report-pdf/fonts/) from the upstream Noto sources; needs fonttools. The source URLs are in its header.
  • install-hooks.sh: install the local git hooks.
  • generate-sw-version.mjs, check-bundle-budget.mjs: service-worker version stamp and bundle-size report (pnpm bundle-report).
  • repair-google-health-sleep.ts: re-syncs every Google Health connection so nights stored twice before v1.28.18 collapse to one set; dry-run by default, --run to execute.
  • i18n-key-tool.mjs, split-description.mjs: edit one key across every messages/*.json (show, set, drop) and move an over-long card description's tail into its own key; measure-description-lengths.mjs measures the Settings and Admin description strings against the 120-character guideline.
  • audit-column-readers.ts: lists write-only schema columns and open @pending-consumer markers; a review tool, not a gate.
  • migrate-demo-edge01.sh: copies the demo account from one instance to a separate demo instance; see its README.
  • __tests__/: tests for the scripts above.

Conventions

See ../CLAUDE.md "Tests and commands" + "Self-hosting gotchas". Operator runbooks that drive these scripts live in ../docs/ops/.

Reference in new issue View Git Blame Copy Permalink