Author SHA1 Message Date
sneak 1e63418f41 Bring the repo up to the standard layout (closes #1)
check / check (push) Failing after 2s
Adds the canonical .gitignore, .dockerignore and .editorconfig; the
first two also name this repo's build output, root-anchored so
cmd/bsdaily/ stays in. The Dockerfile gains a lint phase on the
golangci-lint image already pinned and a test phase on the Debian Go
image with sqlite3 and zstd; the build stage copies a file from each,
so a plain docker build cannot skip them. script/lint and script/test
build their phase uncached and tagged; script/cibuild, script/docker
and the CI workflow are the canonical copies. Nothing installs
golangci-lint on the host. REPO_POLICIES.md is re-vendored.

.golangci.yml and the lint cleanup: #6
Judgement call: .gitignore adds Go build output, per the Go styleguide.

Model: opus-5-5
2026-10-05 23:07:23 +00:00
18 changed files with 183 additions and 369 deletions
+1 -3
View File
@@ -71,9 +71,7 @@
**/.vscode **/.vscode
**/*.sublime-* **/*.sublime-*
# This repo's host-built artifacts: `make`, `go test -c` and # This repo's host-built artifacts: `make` and `make test-coverage`.
# `make test-coverage`.
/bsdaily /bsdaily
/*.test
/coverage.out /coverage.out
/coverage.html /coverage.html
-6
View File
@@ -10,9 +10,3 @@ insert_final_newline = true
[Makefile] [Makefile]
indent_style = tab indent_style = tab
[*.go]
indent_style = tab
# This repository's own sections, such as one for another language it
# uses, go below this comment, and a re-vendor keeps them.
+3 -6
View File
@@ -27,7 +27,7 @@ node_modules/
# Environment files. `*.env` covers bare `.env` and the `prod.env` # Environment files. `*.env` covers bare `.env` and the `prod.env`
# convention. Only the templates `example.env` and `sample.env` are # convention. Only the templates `example.env` and `sample.env` are
# re-included below. A repository that commits any other template adds # re-included below. A repository that commits any other template adds
# its own negation at the end of this file, for example `!.env.example`. # its own negation after these lines, for example `!.env.example`.
*.[eE][nN][vV] *.[eE][nN][vV]
.[eE][nN][vV].* .[eE][nN][vV].*
.[eE][nN][vV][rR][cC] .[eE][nN][vV][rR][cC]
@@ -46,11 +46,8 @@ node_modules/
[iI][dD]_[eE][dD]25519 [iI][dD]_[eE][dD]25519
[iI][dD]_[eE][dD]25519_[sS][kK] [iI][dD]_[eE][dD]25519_[sS][kK]
# This repository's own entries, such as its build outputs, go below # Go: logs, test binaries, coverage output, and the binary `make` writes
# this comment, and a re-vendor keeps them. Anchor a binary built at the # at the repo root, anchored so it does not also match `cmd/bsdaily/`.
# root: `/myapp`, never `myapp`, which also ignores `cmd/myapp/`.
# Go: logs, test binaries, coverage output, and the binary `make` builds.
*.log *.log
*.test *.test
*.out *.out
-2
View File
@@ -1,2 +0,0 @@
node_modules/
yarn.lock
-4
View File
@@ -1,4 +0,0 @@
{
"tabWidth": 4,
"proseWrap": "always"
}
+3 -3
View File
@@ -1,7 +1,7 @@
# Lint phase. The linter is invoked directly rather than through `make # Lint phase. The linter is invoked directly rather than through `make
# lint` or `script/lint`, which are themselves a docker build and would # lint` or `script/lint`, which are themselves a docker build and would
# recurse into a daemon that does not exist in a build step. # recurse into a daemon that does not exist in a build step.
# golangci/golangci-lint:v2.12.2-alpine, 2026-06-28 # golangci/golangci-lint:v2.12.2-alpine
FROM golangci/golangci-lint:v2.12.2-alpine@sha256:91b27804074a0bacea298707f016911e60cf0cdbc6c7bf5ccacb5f0606d18d60 AS lint FROM golangci/golangci-lint:v2.12.2-alpine@sha256:91b27804074a0bacea298707f016911e60cf0cdbc6c7bf5ccacb5f0606d18d60 AS lint
WORKDIR /src WORKDIR /src
@@ -41,7 +41,7 @@ RUN go test -timeout 90s -race -cover ./... || \
# are what make BuildKit build them first, so this stage cannot run # are what make BuildKit build them first, so this stage cannot run
# unless lint and test passed. A plain `docker build .` builds only the # unless lint and test passed. A plain `docker build .` builds only the
# last stage and what it depends on, so the runtime stage stays last. # last stage and what it depends on, so the runtime stage stays last.
# golang:1.26.4-alpine, 2026-06-28 # golang:1.26.4-alpine
FROM golang:1.26.4-alpine@sha256:3ad57304ad93bbec8548a0437ad9e06a455660655d9af011d58b993f6f615648 AS builder FROM golang:1.26.4-alpine@sha256:3ad57304ad93bbec8548a0437ad9e06a455660655d9af011d58b993f6f615648 AS builder
COPY --from=lint /src/go.sum /dev/null COPY --from=lint /src/go.sum /dev/null
@@ -62,7 +62,7 @@ COPY . .
RUN CGO_ENABLED=0 go build -o /bsdaily ./cmd/bsdaily RUN CGO_ENABLED=0 go build -o /bsdaily ./cmd/bsdaily
# Runtime stage # Runtime stage
# alpine:3.21, 2026-06-28 # alpine:3.21
FROM alpine:3.21@sha256:48b0309ca019d89d40f670aa1bc06e426dc0931948452e8491e3d65087abc07d FROM alpine:3.21@sha256:48b0309ca019d89d40f670aa1bc06e426dc0931948452e8491e3d65087abc07d
# bsdaily shells out to sqlite3, zstdmt, zstdcat at runtime # bsdaily shells out to sqlite3, zstdmt, zstdcat at runtime
+122 -121
View File
@@ -1,26 +1,28 @@
# bsdaily # bsdaily
[bsdaily](https://git.eeqj.de/sneak/bsdaily) is a command-line utility written [bsdaily](https://git.eeqj.de/sneak/bsdaily) is a command-line utility
in [Go](https://golang.org) that carves a single day (or a range of days) of written in [Go](https://golang.org) that carves a single day (or a range of
[Bluesky](https://bsky.app) firehose data out of a large, continuously-growing days) of [Bluesky](https://bsky.app) firehose data out of a large,
SQLite database and writes it out as a self-contained, continuously-growing SQLite database and writes it out as a self-contained,
[zstd](https://facebook.github.io/zstd/)-compressed SQL dump. The dumps are [zstd](https://facebook.github.io/zstd/)-compressed SQL dump. The dumps are
named by date (e.g. `2026-06-27.sql.zst`), organized into per-month directories, named by date (e.g. `2026-06-27.sql.zst`), organized into per-month
and are designed to be published, archived, mirrored, and later re-merged back directories, and are designed to be published, archived, mirrored, and later
into a single database. re-merged back into a single database.
The source database is read from a read-only [ZFS](https://openzfs.org) The source database is read from a read-only [ZFS](https://openzfs.org)
snapshot, so extraction never contends with the live firehose ingester that is snapshot, so extraction never contends with the live firehose ingester that
writing to the original database. The tool is operationally conservative: it is writing to the original database. The tool is operationally
checks free disk space before starting, copies the snapshot to fast scratch conservative: it checks free disk space before starting, copies the snapshot
storage, processes one day at a time to avoid SQLite lock contention, verifies to fast scratch storage, processes one day at a time to avoid SQLite lock
every compressed output before publishing it, and writes output atomically via a contention, verifies every compressed output before publishing it, and
temp-file-and-rename so a partial run never leaves a corrupt `.sql.zst` behind. writes output atomically via a temp-file-and-rename so a partial run never
leaves a corrupt `.sql.zst` behind.
This project was written by [@sneak](https://sneak.berlin) to produce a daily, This project was written by [@sneak](https://sneak.berlin) to produce a
mergeable, publicly-mirrorable archive of the Bluesky firehose. It is currently daily, mergeable, publicly-mirrorable archive of the Bluesky firehose. It is
a one-person effort. The current version is pre-1.0 and there has not yet been a currently a one-person effort. The current version is pre-1.0 and there has
versioned release; [SemVer](https://semver.org) will be used for releases. not yet been a versioned release; [SemVer](https://semver.org) will be used
for releases.
# Build Status # Build Status
@@ -31,14 +33,14 @@ branch must always be green.
Primary development happens on a privately-run Gitea instance at Primary development happens on a privately-run Gitea instance at
[https://git.eeqj.de/sneak/bsdaily](https://git.eeqj.de/sneak/bsdaily) and [https://git.eeqj.de/sneak/bsdaily](https://git.eeqj.de/sneak/bsdaily) and
issues are [tracked there](https://git.eeqj.de/sneak/bsdaily/issues). issues are [tracked
there](https://git.eeqj.de/sneak/bsdaily/issues).
Changes must always be formatted with `make fmt` (`go fmt` for Go, prettier for Changes must always be formatted with a standard `go fmt`, syntactically
Markdown), syntactically valid, and must pass the linting defined in the valid, and must pass the linting defined in the repository (presently the
repository (presently the `golangci-lint` defaults), which can be run with a `golangci-lint` defaults), which can be run with a `make lint`. The `main`
`make lint`. The `main` branch is protected and all changes must be made via branch is protected and all changes must be made via [pull
[pull requests](https://git.eeqj.de/sneak/bsdaily/pulls) and pass CI to be requests](https://git.eeqj.de/sneak/bsdaily/pulls) and pass CI to be merged.
merged.
See [`REPO_POLICIES.md`](REPO_POLICIES.md) for detailed coding standards, See [`REPO_POLICIES.md`](REPO_POLICIES.md) for detailed coding standards,
tooling requirements, and workflow conventions. tooling requirements, and workflow conventions.
@@ -48,55 +50,55 @@ tooling requirements, and workflow conventions.
This repository adheres to the This repository adheres to the
[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all) [Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
standard: normalized scripts in `script/` are the entrypoints for the standard: normalized scripts in `script/` are the entrypoints for the
development workflow, and the Makefile targets are thin shims that call them. We development workflow, and the Makefile targets are thin shims that call
provide: them. We provide:
- `script/bootstrap` — install all development dependencies (go, Go module - `script/bootstrap` — install all development dependencies (go, Go
download, node and yarn at pinned versions when absent, and the prettier module download); the linter is not installed on the host
pinned in `package.json` and `yarn.lock`); a node or yarn already installed is
used whatever its version; the linter is not installed on the host
- `script/setup` — make a fresh clone ready for development: runs - `script/setup` — make a fresh clone ready for development: runs
`script/bootstrap`, then `script/install-precommit` `script/bootstrap`, then `script/install-precommit`
- `script/projectname` — print the project name (used for the Docker image tags) - `script/projectname` — print the project name (used for the Docker
- `script/test` — build the Dockerfile's `test` phase, which runs the test suite image tags)
with `-race` (verbose rerun on failure) - `script/test` — build the Dockerfile's `test` phase, which runs the
test suite with `-race` (verbose rerun on failure)
- `script/lint` — build the Dockerfile's `lint` phase, which runs - `script/lint` — build the Dockerfile's `lint` phase, which runs
`golangci-lint run ./...` `golangci-lint run ./...`
- `script/fmt` — format the Go code with `go fmt` and every Markdown file with - `script/fmt` — format the Go code with `go fmt` (writes)
prettier (writes) - `script/fmt-check` — check the Go formatting with `gofmt` (read-only)
- `script/fmt-check` — check the Go formatting with `gofmt` and the Markdown - `script/check` — run `script/test`, `script/lint`, and
formatting with prettier (read-only) `script/fmt-check`
- `script/check` — run `script/test`, `script/lint`, and `script/fmt-check` - `script/docker` — build the Docker image tagged via
- `script/docker` — build the Docker image tagged via `script/projectname`; the `script/projectname`; the build runs the `lint` and `test` phases
build runs the `lint` and `test` phases first first
- `script/cibuild` — CI entrypoint: runs `script/bootstrap` and `script/check`, - `script/cibuild` — CI entrypoint: runs `script/bootstrap` and
then builds the Docker image tagged via `script/projectname` `script/check`, then builds the Docker image tagged via
- `script/precommit` — pre-commit gate: `go mod tidy` (must not change `go.mod` `script/projectname`
or `go.sum`) and `go fmt`, then `script/check` - `script/precommit` — pre-commit gate: `go mod tidy` (must not change
- `script/install-precommit` — install the git pre-commit hook that runs `go.mod` or `go.sum`) and `go fmt`, then `script/check`
`script/precommit` - `script/install-precommit` — install the git pre-commit hook that
runs `script/precommit`
Every Docker build in `script/` is uncached, so the `lint` and `test` phases Every Docker build in `script/` is uncached, so the `lint` and `test`
always run rather than being served from the build cache. phases always run rather than being served from the build cache.
# Problem Statement # Problem Statement
A Bluesky firehose ingester writes every observed post (and associated users, A Bluesky firehose ingester writes every observed post (and associated
hashtags, URLs, and media references) into a single ever-growing SQLite users, hashtags, URLs, and media references) into a single ever-growing
database, `firehose.db`. This database has several properties that make it SQLite database, `firehose.db`. This database has several properties that
awkward to publish or archive directly: make it awkward to publish or archive directly:
- It is **large and always growing**, so re-publishing the whole thing every day - It is **large and always growing**, so re-publishing the whole thing every
is wasteful. day is wasteful.
- It is **continuously written**, so reading from it directly risks lock - It is **continuously written**, so reading from it directly risks lock
contention with the live ingester and inconsistent reads. contention with the live ingester and inconsistent reads.
- It is **monolithic**, so there is no natural unit at which to mirror, share, - It is **monolithic**, so there is no natural unit at which to mirror,
or distribute "just yesterday's posts". share, or distribute "just yesterday's posts".
What is wanted instead is a stable, immutable, per-day artifact: a small file What is wanted instead is a stable, immutable, per-day artifact: a small
containing exactly one calendar day of firehose data, cheap to publish, cheap to file containing exactly one calendar day of firehose data, cheap to publish,
mirror, and trivially re-mergeable into a full database by anyone who collects a cheap to mirror, and trivially re-mergeable into a full database by anyone
set of them. who collects a set of them.
# Proposed Solution # Proposed Solution
@@ -106,81 +108,81 @@ A tool, `bsdaily`, that:
filesystem, so it reads from a consistent point-in-time copy that the live filesystem, so it reads from a consistent point-in-time copy that the live
ingester cannot be writing to; ingester cannot be writing to;
- copies the snapshot's database files to fast scratch storage; - copies the snapshot's database files to fast scratch storage;
- **extracts** a single day's `posts` (and all rows reachable from them) into a - **extracts** a single day's `posts` (and all rows reachable from them) into
fresh, minimal per-day SQLite database; a fresh, minimal per-day SQLite database;
- **dumps** that per-day database to SQL and pipes it through multithreaded zstd - **dumps** that per-day database to SQL and pipes it through multithreaded
compression; zstd compression;
- **verifies** the compressed output (zstd integrity check plus a sanity check - **verifies** the compressed output (zstd integrity check plus a sanity
that the decompressed stream actually looks like SQL); check that the decompressed stream actually looks like SQL);
- **publishes** the result atomically as - **publishes** the result atomically as
`DailiesBase/YYYY-MM/YYYY-MM-DD.sql.zst`. `DailiesBase/YYYY-MM/YYYY-MM-DD.sql.zst`.
Each daily dump is emitted with `INSERT` statements over the full schema Each daily dump is emitted with `INSERT` statements over the full schema
(including the deduplicated `users`, `hashtags`, and `urls` lookup tables), so (including the deduplicated `users`, `hashtags`, and `urls` lookup tables),
any collection of daily dumps can be merged into a single database by rewriting so any collection of daily dumps can be merged into a single database by
`INSERT INTO` to `INSERT OR IGNORE INTO` and replaying them in sequence. Two rewriting `INSERT INTO` to `INSERT OR IGNORE INTO` and replaying them in
helper scripts ([`merge_daily_dumps.sh`](merge_daily_dumps.sh) and sequence. Two helper scripts ([`merge_daily_dumps.sh`](merge_daily_dumps.sh)
[`regenerate_auxiliary_tables.sql`](regenerate_auxiliary_tables.sql)) are and [`regenerate_auxiliary_tables.sql`](regenerate_auxiliary_tables.sql)) are
included to do exactly this and to rebuild the aggregate statistics included to do exactly this and to rebuild the aggregate statistics
(`use_count`, `first_seen`, user `resolved_at`/`updated_at`) afterward. (`use_count`, `first_seen`, user `resolved_at`/`updated_at`) afterward.
# Design Goals # Design Goals
- **Never disturb the live ingester.** All reads come from a ZFS snapshot, never - **Never disturb the live ingester.** All reads come from a ZFS snapshot,
the live database. never the live database.
- **Crash-safe, idempotent runs.** Output is written to a temp file and - **Crash-safe, idempotent runs.** Output is written to a temp file and
atomically renamed; a day whose final output already exists is skipped, so atomically renamed; a day whose final output already exists is skipped, so
re-running a range is safe and resumable. re-running a range is safe and resumable.
- **Mergeable output.** Daily dumps re-combine losslessly into a full database - **Mergeable output.** Daily dumps re-combine losslessly into a full
via `INSERT OR IGNORE`. database via `INSERT OR IGNORE`.
- **Operationally cautious.** Free-space preflight checks on both scratch and - **Operationally cautious.** Free-space preflight checks on both scratch and
output filesystems; explicit verification of every artifact before it is output filesystems; explicit verification of every artifact before it is
published. published.
- **Fast where it's free.** Large snapshot copies use a 256MiB buffer, - **Fast where it's free.** Large snapshot copies use a 256MiB buffer,
pre-allocate the destination, and (on Linux) issue `posix_fadvise` pre-allocate the destination, and (on Linux) issue `posix_fadvise`
sequential/willneed hints; extraction uses aggressive, crash-unsafe-by-design sequential/willneed hints; extraction uses aggressive,
SQLite pragmas because the working data lives only in disposable scratch crash-unsafe-by-design SQLite pragmas because the working data lives only
space. in disposable scratch space.
# Non-Goals # Non-Goals
- **Real-time export.** `bsdaily` operates on daily snapshots; the freshest day - **Real-time export.** `bsdaily` operates on daily snapshots; the freshest
it can produce is the snapshot date minus one. day it can produce is the snapshot date minus one.
- **Schema ownership.** The schema is defined by the upstream firehose ingester; - **Schema ownership.** The schema is defined by the upstream firehose
[`schema.sql`](schema.sql) is included for reference only. `bsdaily` copies ingester; [`schema.sql`](schema.sql) is included for reference only.
whatever table and index DDL it finds in the source. `bsdaily` copies whatever table and index DDL it finds in the source.
- **Cross-platform deployment.** It is built and run on Linux (the free-space - **Cross-platform deployment.** It is built and run on Linux (the
check and fadvise hints use `golang.org/x/sys/unix`; a non-Linux build free-space check and fadvise hints use `golang.org/x/sys/unix`; a non-Linux
compiles but is a no-op for the fadvise hints). The hard-coded paths assume build compiles but is a no-op for the fadvise hints). The hard-coded paths
the production host's ZFS layout. assume the production host's ZFS layout.
# How It Works # How It Works
A single run proceeds as follows: A single run proceeds as follows:
1. **Find the snapshot.** Scan `SnapshotBase` for directories matching 1. **Find the snapshot.** Scan `SnapshotBase` for directories matching
`zfs-auto-snap_daily-YYYY-MM-DD-NNNN`, pick the most recent, and confirm it `zfs-auto-snap_daily-YYYY-MM-DD-NNNN`, pick the most recent, and confirm
contains `firehose.db`. it contains `firehose.db`.
2. **Determine target days.** Default to the snapshot date minus one day; or use 2. **Determine target days.** Default to the snapshot date minus one day;
`--date`, or every day in the inclusive `--from`/`--to` range. or use `--date`, or every day in the inclusive `--from`/`--to` range.
3. **Preflight disk space.** Require at least 500GiB free on the scratch 3. **Preflight disk space.** Require at least 500GiB free on the scratch
filesystem and 20GiB free on the output filesystem. filesystem and 20GiB free on the output filesystem.
4. **Copy the database to scratch.** Copy `firehose.db`, its `-wal`, and (if 4. **Copy the database to scratch.** Copy `firehose.db`, its `-wal`, and (if
present) its `-shm` from the snapshot into a fresh temp directory under present) its `-shm` from the snapshot into a fresh temp directory under
`TmpBase`. `TmpBase`.
5. **Per day**, processed strictly one at a time to avoid SQLite contention: 5. **Per day**, processed strictly one at a time to avoid SQLite contention:
- skip the day if its final output file already exists; - skip the day if its final output file already exists;
- `ATTACH` the copied source DB to a new empty per-day DB, recreate the - `ATTACH` the copied source DB to a new empty per-day DB, recreate the
table DDL, and `INSERT ... SELECT` the target day's `posts` plus all rows table DDL, and `INSERT ... SELECT` the target day's `posts` plus all
reachable from them (`posts_hashtags`, `posts_urls`, `hashtags`, `urls`, rows reachable from them (`posts_hashtags`, `posts_urls`, `hashtags`,
`users`, and `media` if that table exists); `urls`, `users`, and `media` if that table exists);
- abort the day cleanly if there are zero posts (`ErrNoPosts`), rather than - abort the day cleanly if there are zero posts (`ErrNoPosts`), rather
emitting an empty dump; than emitting an empty dump;
- recreate indexes, detach the source, and verify the inserted row count; - recreate indexes, detach the source, and verify the inserted row count;
- `sqlite3 .dump | zstdmt` into a hidden temp file; - `sqlite3 .dump | zstdmt` into a hidden temp file;
- run a zstd integrity check and confirm the decompressed head looks like - run a zstd integrity check and confirm the decompressed head looks like
SQL; SQL;
- atomically rename into place and delete the per-day scratch DB. - atomically rename into place and delete the per-day scratch DB.
6. **Clean up** the temp directory and log a processed/skipped/total summary. 6. **Clean up** the temp directory and log a processed/skipped/total summary.
# Usage # Usage
@@ -217,9 +219,9 @@ sqlite3 merged.db < regenerate_auxiliary_tables.sql
- **Go** (see [`go.mod`](go.mod) for the toolchain version) to build. - **Go** (see [`go.mod`](go.mod) for the toolchain version) to build.
- **Linux** for production use (ZFS snapshots, `statfs` free-space checks, - **Linux** for production use (ZFS snapshots, `statfs` free-space checks,
`posix_fadvise` hints). `posix_fadvise` hints).
- The **`sqlite3`** and **`zstdmt`** (multithreaded zstd) binaries on `PATH`; - The **`sqlite3`** and **`zstdmt`** (multithreaded zstd) binaries on
`zstdcat` is used for verification. SQLite reads/writes during extraction use `PATH`; `zstdcat` is used for verification. SQLite reads/writes during
the pure-Go [`modernc.org/sqlite`](https://pkg.go.dev/modernc.org/sqlite) extraction use the pure-Go [`modernc.org/sqlite`](https://pkg.go.dev/modernc.org/sqlite)
driver, so no cgo is required for that part. driver, so no cgo is required for that part.
# Configuration # Configuration
@@ -239,21 +241,21 @@ elsewhere.
# Data Model # Data Model
The firehose schema (reference copy in [`schema.sql`](schema.sql)) centers on a The firehose schema (reference copy in [`schema.sql`](schema.sql)) centers
`posts` table, with `users` keyed by DID and many-to-many junction tables on a `posts` table, with `users` keyed by DID and many-to-many junction
linking posts to deduplicated `hashtags` and `urls`. An optional `media` table tables linking posts to deduplicated `hashtags` and `urls`. An optional
tracks downloaded blobs by content hash. `bsdaily` does not own this schema; it `media` table tracks downloaded blobs by content hash. `bsdaily` does not
reflects whatever DDL exists in the source snapshot and selects forward from own this schema; it reflects whatever DDL exists in the source snapshot and
`posts` along the foreign-key relationships to produce a referentially-complete selects forward from `posts` along the foreign-key relationships to produce a
per-day slice. referentially-complete per-day slice.
# Use Cases # Use Cases
## Daily public archive ## Daily public archive
Publish one small, immutable file per day to static HTTP (or IPFS, or a mirror Publish one small, immutable file per day to static HTTP (or IPFS, or a
network) so that anyone can fetch exactly the day(s) they want and re-merge them mirror network) so that anyone can fetch exactly the day(s) they want and
locally. re-merge them locally.
## Backfilling a range ## Backfilling a range
@@ -263,17 +265,16 @@ safe to re-run.
## Reconstituting a full database ## Reconstituting a full database
Collect any set of daily dumps and merge them with `INSERT OR IGNORE` to rebuild Collect any set of daily dumps and merge them with `INSERT OR IGNORE` to
a complete, queryable SQLite database, then regenerate the aggregate statistics rebuild a complete, queryable SQLite database, then regenerate the aggregate
tables. statistics tables.
# See Also # See Also
## Links ## Links
- Repo: [https://git.eeqj.de/sneak/bsdaily](https://git.eeqj.de/sneak/bsdaily) - Repo: [https://git.eeqj.de/sneak/bsdaily](https://git.eeqj.de/sneak/bsdaily)
- Issues: - Issues: [https://git.eeqj.de/sneak/bsdaily/issues](https://git.eeqj.de/sneak/bsdaily/issues)
[https://git.eeqj.de/sneak/bsdaily/issues](https://git.eeqj.de/sneak/bsdaily/issues)
- Bluesky: [https://bsky.app](https://bsky.app) - Bluesky: [https://bsky.app](https://bsky.app)
- zstd: [https://facebook.github.io/zstd/](https://facebook.github.io/zstd/) - zstd: [https://facebook.github.io/zstd/](https://facebook.github.io/zstd/)
+11 -23
View File
@@ -1,6 +1,6 @@
--- ---
title: Repository Policies title: Repository Policies
last_modified: 2026-10-06 last_modified: 2026-10-04
--- ---
This document covers repository structure, tooling, and workflow standards. Code This document covers repository structure, tooling, and workflow standards. Code
@@ -118,9 +118,8 @@ style conventions are in separate documents:
and nothing else: and nothing else:
```sh ```sh
tag="$(script/projectname)" docker build --no-cache --target lint -t "$(script/projectname)-lint" .
docker build --no-cache --target lint -t "$tag-lint" . docker build --no-cache --target test -t "$(script/projectname)-test" .
docker build --no-cache --target test -t "$tag-test" .
``` ```
**A stage that is not the last one in the file is built only when the final **A stage that is not the last one in the file is built only when the final
@@ -133,9 +132,7 @@ style conventions are in separate documents:
**Every `docker build` in `script/` is tagged**, here and in **Every `docker build` in `script/` is tagged**, here and in
`script/cibuild` and `script/docker`. An untagged build leaves a dangling `script/cibuild` and `script/docker`. An untagged build leaves a dangling
image behind on every invocation, on every developer host and every CI image behind on every invocation, on every developer host and every CI
runner; a tagged one replaces the previous image. Each script assigns the runner; a tagged one replaces the previous image.
tag on its own line before the build, so `set -e` stops it where
`script/projectname` fails.
Inside a phase the tool is invoked directly — `golangci-lint`, `go test`, Inside a phase the tool is invoked directly — `golangci-lint`, `go test`,
`eslint`, `prettier` — never through `make lint` or `script/test`, which are `eslint`, `prettier` — never through `make lint` or `script/test`, which are
@@ -387,12 +384,9 @@ style conventions are in separate documents:
- `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`), - `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`),
editor files (`.swp`, `*~`), in-repo agent scratch directories (`.claude/`), editor files (`.swp`, `*~`), in-repo agent scratch directories (`.claude/`),
`node_modules/`, and the repo's own build outputs. Fetch the standard language build artifacts, and `node_modules/`. Fetch the standard `.gitignore`
`.gitignore` from from `https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when setting up setting up a new repo. These patterns are written to `.gitignore`'s own
a new repo. A repo's `.gitignore` is the standard file followed by the repo's
own entries, such as its binaries; a re-vendor replaces the standard part and
keeps those entries. These patterns are written to `.gitignore`'s own
semantics, in which an unanchored pattern already matches at every depth; they semantics, in which an unanchored pattern already matches at every depth; they
are not a `.dockerignore` and must not be transplanted into one unmodified. are not a `.dockerignore` and must not be transplanted into one unmodified.
@@ -440,15 +434,13 @@ style conventions are in separate documents:
byte-identically across repos: byte-identically across repos:
```sh ```sh
# The version and the tag each get their own line: a failing command # Own line: a failing command substitution inside an argument does not
# substitution inside an argument does not trip `set -e`, so the inline # trip `set -e`, so the inline form degrades to an empty constant.
# form degrades to an empty constant.
version="$(git describe --tags --always --dirty 2>/dev/null || true)" version="$(git describe --tags --always --dirty 2>/dev/null || true)"
[ -n "$version" ] || version="unknown" [ -n "$version" ] || version="unknown"
tag="$(script/projectname)"
docker build --no-cache \ docker build --no-cache \
--build-arg VERSION="$version" \ --build-arg VERSION="$version" \
-t "$tag" . -t "$(script/projectname)" .
``` ```
`--always` makes an untagged repo yield an abbreviated commit hash rather `--always` makes an untagged repo yield an abbreviated commit hash rather
@@ -644,11 +636,7 @@ style conventions are in separate documents:
Never edit existing migrations after release. Never edit existing migrations after release.
- All repos should have an `.editorconfig` enforcing the project's indentation - All repos should have an `.editorconfig` enforcing the project's indentation
settings: the standard file from settings.
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.editorconfig`, which sets
tabs for `Makefile` and Go files, followed by the repo's own sections, such as
one for another language it uses. A re-vendor replaces the standard part and
keeps those sections.
- Avoid putting files in the repo root unless necessary. Root should contain - Avoid putting files in the repo root unless necessary. Root should contain
only project-level config files (`README.md`, `AGENTS.md`, `Makefile`, only project-level config files (`README.md`, `AGENTS.md`, `Makefile`,
+27 -30
View File
@@ -1,12 +1,12 @@
# Workflow # Workflow
- branch (from `main`) * branch (from `main`)
- do the work in Next Step * do the work in Next Step
- move Next Step to the top of Completed Steps * move Next Step to the top of Completed Steps
- move the top item of Future Steps into Next Step * move the top item of Future Steps into Next Step
- commit (`TODO.md` changes in the same commit as the work) * commit (`TODO.md` changes in the same commit as the work)
- merge to `main` if the branch is not protected, otherwise open a PR * merge to `main` if the branch is not protected, otherwise open a PR
- push * push
# Status # Status
@@ -14,38 +14,35 @@ pre-1.0
# Next Step # Next Step
Add the canonical `.golangci.yml`, move the lint phase to golangci-lint v2.14.0 Add the canonical `.golangci.yml`, move the lint phase to golangci-lint
in the same commit, and fix the findings it surfaces v2.14.0 in the same commit, and fix the findings it surfaces
(https://git.eeqj.de/sneak/bsdaily/issues/6). (https://git.eeqj.de/sneak/bsdaily/issues/6).
# Completed Steps # Completed Steps
- 2026-10-06: Formatted Markdown with prettier: `script/fmt` writes and
`script/fmt-check` checks every Markdown file; prettier pinned in
`package.json` and `yarn.lock`, installed by `script/bootstrap`, which
installs node and yarn at pinned versions when absent and otherwise uses the
ones already installed; existing Markdown reformatted.
- 2026-10-05: Brought the repo up to the standard layout: canonical - 2026-10-05: Brought the repo up to the standard layout: canonical
`.gitignore`, `.dockerignore` and `.editorconfig`; `lint` and `test` phases in `.gitignore`, `.dockerignore` and `.editorconfig`; `lint` and `test`
the `Dockerfile`, built by `script/lint` and `script/test`; canonical phases in the `Dockerfile`, built by `script/lint` and `script/test`;
`script/cibuild`, `script/docker` and CI workflow; no linter installed on the canonical `script/cibuild`, `script/docker` and CI workflow; no linter
host; re-vendored `REPO_POLICIES.md`. installed on the host; re-vendored `REPO_POLICIES.md`.
- 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints, Makefile - 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints,
shims, README Entrypoints section Makefile shims, README Entrypoints section
- 2026-06-28: Fixed errcheck lint failures; added compilation smoke test; tidied - 2026-06-28: Fixed errcheck lint failures; added compilation smoke test;
go.mod. tidied go.mod.
- 2026-06-28: Added repo scaffolding: README, LICENSE, Makefile, Dockerfile, - 2026-06-28: Added repo scaffolding: README, LICENSE, Makefile,
REPO_POLICIES.md, and Gitea CI. Dockerfile, REPO_POLICIES.md, and Gitea CI.
- 2026-02-12: Fixed SQLite database locking by removing parallel processing; - 2026-02-12: Fixed SQLite database locking by removing parallel
fixed Linux build via golang.org/x/sys/unix Fadvise. processing; fixed Linux build via golang.org/x/sys/unix Fadvise.
- 2026-02-12: Optimized file copy for large databases; moved temp directory to - 2026-02-12: Optimized file copy for large databases; moved temp
NVMe scratch storage. directory to NVMe scratch storage.
- 2026-02-11: Added date range support. - 2026-02-11: Added date range support.
- 2026-02-09: Initial implementation: single-day extraction, specific-date - 2026-02-09: Initial implementation: single-day extraction, specific-date
targeting, faster pruning of throwaway database copies. targeting, faster pruning of throwaway database copies.
# Future Steps # Future Steps
- Expand tests beyond the compilation smoke test: unit tests for the extraction, - Format Markdown with prettier in `script/fmt` and `script/fmt-check`
verification, and atomic-publish paths. (https://git.eeqj.de/sneak/bsdaily/issues/7).
- Expand tests beyond the compilation smoke test: unit tests for the
extraction, verification, and atomic-publish paths.
- Cut a first SemVer release once compliance and test coverage land. - Cut a first SemVer release once compliance and test coverage land.
-5
View File
@@ -1,5 +0,0 @@
{
"devDependencies": {
"prettier": "3.8.1"
}
}
+2 -88
View File
@@ -3,23 +3,13 @@
# this repo. Idempotent: every install is guarded by a check so already # this repo. Idempotent: every install is guarded by a check so already
# installed tools are skipped. Base tooling comes from nix, apt, brew, # installed tools are skipped. Base tooling comes from nix, apt, brew,
# or apk (detected in that order); assumes NOTHING is present (not git, # or apk (detected in that order); assumes NOTHING is present (not git,
# make, go, or node). Node is used directly if installed; otherwise it # make, or go).
# is installed at a pinned version via nvm (installing nvm itself first,
# from a hash-verified release archive, never curl | sh).
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
# Pinned versions, 2026-07-06
NODE_VERSION="22.17.0"
NVM_VERSION="0.40.3"
# sha256 of https://github.com/nvm-sh/nvm/archive/refs/tags/v0.40.3.tar.gz
NVM_SHA256="5f4d6aaa04a177dc93c985e31dbc411ab6b8c6e1e21d8015dbc1372625fcd1d0"
YARN_VERSION="1.22.22"
PKGMGR="" PKGMGR=""
SUDO="" SUDO=""
APT_UPDATED=""
detect_pkgmgr() { detect_pkgmgr() {
[ -n "$PKGMGR" ] && return 0 [ -n "$PKGMGR" ] && return 0
@@ -48,14 +38,7 @@ pkg_install() {
detect_pkgmgr detect_pkgmgr
case "$PKGMGR" in case "$PKGMGR" in
nix) nix-env -iA "nixpkgs.$1" ;; nix) nix-env -iA "nixpkgs.$1" ;;
apt) apt) $SUDO env DEBIAN_FRONTEND=noninteractive apt-get install -y "$2" ;;
# Package lists may be empty (fresh images); refresh once per run.
if [ -z "$APT_UPDATED" ]; then
$SUDO env DEBIAN_FRONTEND=noninteractive apt-get update
APT_UPDATED=1
fi
$SUDO env DEBIAN_FRONTEND=noninteractive apt-get install -y "$2"
;;
brew) brew install "$3" ;; brew) brew install "$3" ;;
apk) apk add --no-cache "$4" ;; apk) apk add --no-cache "$4" ;;
esac esac
@@ -65,69 +48,6 @@ missing() {
! command -v "$1" >/dev/null 2>&1 ! command -v "$1" >/dev/null 2>&1
} }
# verify_sha256 <file> <expected-hash>
verify_sha256() {
if command -v sha256sum >/dev/null 2>&1; then
actual="$(sha256sum "$1" | cut -d' ' -f1)"
else
actual="$(shasum -a 256 "$1" | cut -d' ' -f1)"
fi
if [ "$actual" != "$2" ]; then
echo "bootstrap: sha256 mismatch for $1" >&2
echo " expected: $2" >&2
echo " actual: $actual" >&2
exit 1
fi
}
# nvm is a bash script; run a command in a bash with nvm loaded
nvm_sh() {
bash -c ". \"\$HOME/.nvm/nvm.sh\" && $*"
}
ensure_nvm() {
[ -s "$HOME/.nvm/nvm.sh" ] && return 0
# nvm prerequisites; nvm itself requires bash
if missing bash; then pkg_install bash bash bash bash; fi
if missing curl; then pkg_install curl curl curl curl; fi
if missing git; then pkg_install git git git git; fi
tmp="$(mktemp -d)"
curl -fsSL -o "$tmp/nvm.tar.gz" \
"https://github.com/nvm-sh/nvm/archive/refs/tags/v${NVM_VERSION}.tar.gz"
verify_sha256 "$tmp/nvm.tar.gz" "$NVM_SHA256"
mkdir -p "$HOME/.nvm"
tar -xzf "$tmp/nvm.tar.gz" -C "$HOME/.nvm" --strip-components=1
rm -rf "$tmp"
}
ensure_node() {
if ! missing node; then return 0; fi
ensure_nvm
nvm_sh "nvm install $NODE_VERSION"
}
ensure_yarn() {
if ! missing yarn; then return 0; fi
if ! missing corepack; then
corepack enable
corepack prepare "yarn@$YARN_VERSION" --activate
elif [ -s "$HOME/.nvm/nvm.sh" ]; then
nvm_sh "nvm use $NODE_VERSION >/dev/null && corepack enable && \
corepack prepare yarn@$YARN_VERSION --activate"
else
npm install -g "yarn@$YARN_VERSION"
fi
}
install_js_deps() {
if missing yarn && [ -s "$HOME/.nvm/nvm.sh" ]; then
nvm_sh "nvm use $NODE_VERSION >/dev/null && cd \"$ROOT\" && \
yarn install --frozen-lockfile"
else
yarn install --frozen-lockfile
fi
}
main() { main() {
cd "$ROOT" cd "$ROOT"
@@ -140,12 +60,6 @@ main() {
go mod download go mod download
# Node and yarn, then the prettier pinned in package.json and
# yarn.lock, which script/fmt and script/fmt-check run
ensure_node
ensure_yarn
install_js_deps
echo "bootstrap complete" echo "bootstrap complete"
} }
+5 -7
View File
@@ -14,17 +14,15 @@ main() {
cd "$ROOT" cd "$ROOT"
"$SCRIPT_DIR/bootstrap" "$SCRIPT_DIR/bootstrap"
"$SCRIPT_DIR/check" "$SCRIPT_DIR/check"
# The version and the tag each get their own line: a failing # Own line: a failing command substitution inside an argument does
# command substitution inside an argument does not trip `set -e`, # not trip `set -e`, so the inline form degrades silently to an
# so the inline form degrades silently to an empty constant. The # empty constant. The VERSION build argument takes precedence over
# VERSION build argument takes precedence over the version a build # the version a build stage derives from the .git in the context.
# stage derives from the .git in the context.
version="$(git describe --tags --always --dirty 2>/dev/null || true)" version="$(git describe --tags --always --dirty 2>/dev/null || true)"
[ -n "$version" ] || version="unknown" [ -n "$version" ] || version="unknown"
tag="$("$SCRIPT_DIR/projectname")"
docker build --no-cache \ docker build --no-cache \
--build-arg VERSION="$version" \ --build-arg VERSION="$version" \
-t "$tag" . -t "$("$SCRIPT_DIR/projectname")" .
} }
main "$@" main "$@"
+5 -7
View File
@@ -10,17 +10,15 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
main() { main() {
cd "$ROOT" cd "$ROOT"
# The version and the tag each get their own line: a failing # Own line: a failing command substitution inside an argument does
# command substitution inside an argument does not trip `set -e`, # not trip `set -e`, so the inline form degrades silently to an
# so the inline form degrades silently to an empty constant. The # empty constant. The VERSION build argument takes precedence over
# VERSION build argument takes precedence over the version a build # the version a build stage derives from the .git in the context.
# stage derives from the .git in the context.
version="$(git describe --tags --always --dirty 2>/dev/null || true)" version="$(git describe --tags --always --dirty 2>/dev/null || true)"
[ -n "$version" ] || version="unknown" [ -n "$version" ] || version="unknown"
tag="$("$SCRIPT_DIR/projectname")"
docker build --no-cache \ docker build --no-cache \
--build-arg VERSION="$version" \ --build-arg VERSION="$version" \
-t "$tag" . -t "$("$SCRIPT_DIR/projectname")" .
} }
main "$@" main "$@"
+1 -23
View File
@@ -1,34 +1,12 @@
#!/bin/sh #!/bin/sh
# script/fmt: format all files (writes): the Go code with go fmt and # script/fmt: format all files (writes).
# every Markdown file with prettier.
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
# Must match the pin in script/bootstrap.
NODE_VERSION="22.17.0"
# script/bootstrap installs node and yarn under nvm and leaves neither
# on the PATH of the shell that called it, so resolve the pinned
# toolchain here the way bootstrap's own install step does. nvm is a
# bash script, hence the subshell.
run_yarn() {
if command -v yarn >/dev/null 2>&1; then
exec yarn "$@"
fi
if [ ! -s "$HOME/.nvm/nvm.sh" ]; then
echo "fmt: no yarn; run script/bootstrap first" >&2
exit 1
fi
exec bash -c '. "$HOME/.nvm/nvm.sh" && nvm use "$1" >/dev/null &&
shift && exec yarn "$@"' bash "$NODE_VERSION" "$@"
}
main() { main() {
cd "$ROOT" cd "$ROOT"
go fmt ./... go fmt ./...
# run_yarn replaces this shell, so it stays the last step.
run_yarn run prettier --write '**/*.md' --tab-width 4 --prose-wrap always
} }
main "$@" main "$@"
+1 -23
View File
@@ -1,30 +1,10 @@
#!/bin/sh #!/bin/sh
# script/fmt-check: check formatting (read-only). Same scope as # script/fmt-check: check formatting (read-only). Same scope as
# script/fmt, the Go code and every Markdown file, but fails instead of # script/fmt, but fails instead of writing.
# writing.
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
# Must match the pin in script/bootstrap.
NODE_VERSION="22.17.0"
# script/bootstrap installs node and yarn under nvm and leaves neither
# on the PATH of the shell that called it, so resolve the pinned
# toolchain here the way bootstrap's own install step does. nvm is a
# bash script, hence the subshell.
run_yarn() {
if command -v yarn >/dev/null 2>&1; then
exec yarn "$@"
fi
if [ ! -s "$HOME/.nvm/nvm.sh" ]; then
echo "fmt-check: no yarn; run script/bootstrap first" >&2
exit 1
fi
exec bash -c '. "$HOME/.nvm/nvm.sh" && nvm use "$1" >/dev/null &&
shift && exec yarn "$@"' bash "$NODE_VERSION" "$@"
}
main() { main() {
cd "$ROOT" cd "$ROOT"
unformatted="$(gofmt -l .)" unformatted="$(gofmt -l .)"
@@ -33,8 +13,6 @@ main() {
echo "$unformatted" >&2 echo "$unformatted" >&2
exit 1 exit 1
fi fi
# run_yarn replaces this shell, so it stays the last step.
run_yarn run prettier --check '**/*.md' --tab-width 4 --prose-wrap always
} }
main "$@" main "$@"
+1 -5
View File
@@ -15,13 +15,9 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
main() { main() {
cd "$ROOT" cd "$ROOT"
# The tag gets its own line: a failing command substitution inside
# an argument does not trip `set -e`, so the inline form degrades
# silently to an empty constant.
tag="$("$SCRIPT_DIR/projectname")"
docker build --no-cache \ docker build --no-cache \
--target lint \ --target lint \
-t "$tag-lint" . -t "$("$SCRIPT_DIR/projectname")-lint" .
} }
main "$@" main "$@"
+1 -5
View File
@@ -11,13 +11,9 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
main() { main() {
cd "$ROOT" cd "$ROOT"
# The tag gets its own line: a failing command substitution inside
# an argument does not trip `set -e`, so the inline form degrades
# silently to an empty constant.
tag="$("$SCRIPT_DIR/projectname")"
docker build --no-cache \ docker build --no-cache \
--target test \ --target test \
-t "$tag-test" . -t "$("$SCRIPT_DIR/projectname")-test" .
} }
main "$@" main "$@"
-8
View File
@@ -1,8 +0,0 @@
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
# yarn lockfile v1
prettier@3.8.1:
version "3.8.1"
resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.8.1.tgz#edf48977cf991558f4fcbd8a3ba6015ba2a3a173"
integrity sha512-UOnG6LftzbdaHZcKoPFtOcCKztrQ57WkHDeRD9t/PTQtmT0NHSeWWepj6pS0z/N7+08BHFDQVUrfmfMRcZwbMg==