Compare commits
5 Commits
f3cf4af833
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 156fe871e8 | |||
| 118f8e22c3 | |||
| 69bd6d1539 | |||
| d79ed83f4d | |||
| 348f23bac9 |
@@ -1,8 +1,50 @@
|
||||
# Mirrors .gitignore, with one deliberate exception: .gitignore itself stays
|
||||
# in the build context, because prettier 3 reads it as a default ignore file
|
||||
# and dropping it would change what `make fmt-check` sees inside the image.
|
||||
|
||||
# VCS
|
||||
.git
|
||||
|
||||
# OS
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# Editors
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
*.bak
|
||||
.idea/
|
||||
.vscode/
|
||||
*.sublime-*
|
||||
|
||||
# Node
|
||||
node_modules
|
||||
|
||||
# TypeScript / build artifacts
|
||||
dist
|
||||
build
|
||||
*.tsbuildinfo
|
||||
coverage
|
||||
.DS_Store
|
||||
.nyc_output/
|
||||
|
||||
# Vitest
|
||||
.vitest-cache/
|
||||
|
||||
# Environment / secrets
|
||||
.env
|
||||
.env.*
|
||||
*.pem
|
||||
*.key
|
||||
|
||||
# Compiled binary (built by make build-bin); around 100 MB
|
||||
bin/quak
|
||||
|
||||
# quak runtime data (in case anyone runs the CLI from inside the repo)
|
||||
.quak/
|
||||
|
||||
# Local per-developer tool state, including agent worktrees. Correctness,
|
||||
# not context size: a worktree copied in here has its own test/ tree, which
|
||||
# vitest globs alongside the real one, so the containerised suite runs N+1
|
||||
# times over and still reports success.
|
||||
.claude/
|
||||
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -36,5 +36,6 @@ bin/quak
|
||||
# quak runtime data (in case anyone runs the CLI from inside the repo)
|
||||
.quak/
|
||||
|
||||
# Local Claude Code settings (per-developer)
|
||||
# Local per-developer tool settings and scratch state, including the
|
||||
# worktrees agents check out under this directory
|
||||
.claude/
|
||||
|
||||
33
Dockerfile
33
Dockerfile
@@ -1,10 +1,37 @@
|
||||
# node 22-alpine, 2026-02-22
|
||||
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34
|
||||
|
||||
# Lint stage — fast feedback on formatting and lint issues
|
||||
# node 22.22.0 on Alpine 3.23.3 (node:22-alpine), 2026-08-09
|
||||
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34 AS lint
|
||||
WORKDIR /app
|
||||
COPY script/ script/
|
||||
COPY package.json yarn.lock ./
|
||||
RUN script/bootstrap
|
||||
COPY . .
|
||||
RUN make fmt-check
|
||||
RUN make lint
|
||||
|
||||
# Check stage — the full suite and the build
|
||||
# node 22.22.0 on Alpine 3.23.3 (node:22-alpine), 2026-08-09
|
||||
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34 AS check
|
||||
WORKDIR /app
|
||||
|
||||
# Force BuildKit to run the lint stage before proceeding. Without this the
|
||||
# two stages run in parallel and a lint failure can lose the race.
|
||||
COPY --from=lint /app/yarn.lock /dev/null
|
||||
|
||||
COPY script/ script/
|
||||
COPY package.json yarn.lock ./
|
||||
RUN script/bootstrap
|
||||
COPY . .
|
||||
|
||||
# CHECK_EPOCH is a cache buster: without it Docker serves `make check` from
|
||||
# cache on an unchanged tree, the suite never executes, and the build still
|
||||
# exits 0. The guard makes an absent argument a hard failure — an unset ARG
|
||||
# is the empty string, which is a perfectly stable cache key, so a plain
|
||||
# `docker build .` would otherwise still get the false green. Fail closed.
|
||||
ARG CHECK_EPOCH
|
||||
RUN [ -n "$CHECK_EPOCH" ] || exit 1
|
||||
RUN make check
|
||||
|
||||
ARG CHECK_EPOCH
|
||||
RUN [ -n "$CHECK_EPOCH" ] || exit 1
|
||||
RUN make build
|
||||
|
||||
2
Makefile
2
Makefile
@@ -24,7 +24,7 @@ check:
|
||||
@script/check
|
||||
|
||||
build:
|
||||
@$(YARN) tsc
|
||||
@script/build
|
||||
|
||||
build-bin:
|
||||
nix-shell -p bun --run "bun build bin/quak.ts --compile --outfile bin/quak"
|
||||
|
||||
53
README.md
53
README.md
@@ -81,6 +81,9 @@ alpine. We provide:
|
||||
`script/bootstrap`, then `script/install-precommit`
|
||||
- `script/projectname` — output the project name (our own extension); used by
|
||||
`script/docker` for the image tag
|
||||
- `script/build` — compile the TypeScript sources into `dist/`, then verify that
|
||||
the entrypoints `package.json` declares (`main`, `types`, `bin`) are among the
|
||||
files the compiler wrote, and make the CLI executable (our own extension)
|
||||
- `script/test` — run the test suite (vitest, hard-capped at 30s where `timeout`
|
||||
is available, verbose rerun on failure)
|
||||
- `script/lint` — run eslint and a prettier check
|
||||
@@ -89,9 +92,9 @@ alpine. We provide:
|
||||
- `script/check` — run all checks: `test`, `lint`, `fmt-check` (our own
|
||||
extension)
|
||||
- `script/docker` — build the Docker image, tagged via `script/projectname`
|
||||
(byte-identical across repos)
|
||||
- `script/cibuild` — cd to the repo root and `docker build .` (what CI runs; the
|
||||
image build runs `make check`)
|
||||
- `script/cibuild` — cd to the repo root and run the image build (what CI runs;
|
||||
the build runs `make fmt-check` and `make lint` in a first stage, then
|
||||
`make check` and `make build` in a second)
|
||||
- `script/precommit` — run by the git pre-commit hook (our own extension); runs
|
||||
`script/lint` and `script/fmt-check` but deliberately not the tests, so the
|
||||
TDD red-phase commit can land
|
||||
@@ -100,6 +103,15 @@ alpine. We provide:
|
||||
|
||||
`make hooks` installs the pre-commit hook that runs `script/precommit`.
|
||||
|
||||
Both `script/docker` and `script/cibuild` pass
|
||||
`--build-arg CHECK_EPOCH="$(date +%s)"`. The Dockerfile refuses to build without
|
||||
it. This is deliberate: on an unchanged tree Docker would otherwise serve the
|
||||
`make check` layer from cache, so the suite would never run and the build would
|
||||
still exit 0. A changing epoch invalidates the check and build layers on every
|
||||
invocation while leaving the dependency layers below them cached, and the
|
||||
missing-argument guard means a bare `docker build .` fails loudly instead of
|
||||
quietly reporting a green it did not earn.
|
||||
|
||||
## Rationale
|
||||
|
||||
Ente is one of very few photo services with a credible end-to-end encryption
|
||||
@@ -133,8 +145,8 @@ All work on quak is test-driven. No exceptions.
|
||||
3. Subsequent commits add the implementation and any refactors needed to make
|
||||
the tests pass.
|
||||
4. A feature branch can only be merged into `main` when `make check` is green.
|
||||
`main` is always green. The Dockerfile runs `make check`, so a red branch
|
||||
cannot pass CI.
|
||||
`main` is always green. The Dockerfile runs `make check` and `make build`, so
|
||||
neither a red branch nor one that does not compile can pass CI.
|
||||
5. Tests are the canonical API documentation for this library. Every test file
|
||||
is commented thoroughly enough that a reader who has never seen quak can
|
||||
learn how to use it from the tests alone. Comments explain why a behavior
|
||||
@@ -150,8 +162,9 @@ All work on quak is test-driven. No exceptions.
|
||||
8. The pre-commit hook installed by `make hooks` runs `script/precommit`, which
|
||||
runs the lint and format checks but not the full `make check`. This is
|
||||
deliberate so the TDD red-phase commit (failing tests, no implementation yet)
|
||||
can land. The full `make check` runs as part of `docker build .`, which is
|
||||
what CI executes, so a red branch still cannot reach `main`.
|
||||
can land. The full `make check` runs as part of the image build, which is
|
||||
what CI executes via `script/cibuild`, so a red branch still cannot reach
|
||||
`main`.
|
||||
|
||||
## Design
|
||||
|
||||
@@ -183,6 +196,12 @@ quak/
|
||||
tsconfig.json
|
||||
```
|
||||
|
||||
`make build` compiles that tree into `dist/`, preserving its shape: the library
|
||||
lands in `dist/src/` and the CLI in `dist/bin/quak.js`, which is what
|
||||
`package.json` points `main`, `types` and `bin` at. The compiler's `rootDir` is
|
||||
the repository root rather than `src/`, because `bin/` is compiled too and
|
||||
`rootDir` has to contain everything that is compiled.
|
||||
|
||||
### Cryptography
|
||||
|
||||
All cryptography is done by `libsodium-wrappers-sumo` (the "sumo" build is
|
||||
@@ -305,12 +324,18 @@ only guarded the initial request would leave the same hang one layer down.
|
||||
**Non-idempotent requests are not blindly replayed.** `postJSON` and `putJSON`
|
||||
reach `/users/srp/create-session`, `/users/two-factor/verify` — which consumes
|
||||
one of a small number of second-factor attempts — and `/files/thumbnail`. They
|
||||
are retried only on failures that prove no request byte reached the server,
|
||||
which means the connection was never established (`ECONNREFUSED`, `ENOTFOUND`,
|
||||
and the like). A 5xx, a mid-flight reset and a deadline are all left to the
|
||||
caller, because each of them can happen after the server has already acted.
|
||||
`putFile` is exempt: a presigned PUT stores one whole object at one key in one
|
||||
request, so replaying it has no partial state to damage.
|
||||
are retried only on the three failures that establish no TCP connection to the
|
||||
server ever existed, so no request byte can have been transmitted: `ENOTFOUND`
|
||||
and `EAI_AGAIN` (name resolution produced no address) and `ECONNREFUSED` (the
|
||||
peer refused the connection). A 5xx, a mid-flight reset and a deadline are all
|
||||
left to the caller, because each of them can happen after the server has already
|
||||
acted. The routing errnos `EHOSTUNREACH`, `ENETUNREACH` and `ENETDOWN` are
|
||||
excluded for the same reason, despite looking like connect-time failures: on
|
||||
Linux an ICMP unreachable arriving mid-flight, or a local interface going down
|
||||
after the request was written, delivers them on an already-established socket.
|
||||
They stay retryable for the idempotent calls. `putFile` is exempt: a presigned
|
||||
PUT stores one whole object at one key in one request, so replaying it has no
|
||||
partial state to damage.
|
||||
|
||||
A download is retried as a whole — request, stream consumption, and decryption —
|
||||
because a socket reset after the response headers have arrived surfaces in the
|
||||
@@ -394,7 +419,7 @@ code is non-zero if any files failed.
|
||||
- [x] Retry policy: no retry on 4xx, exponential backoff on 5xx and network
|
||||
errors
|
||||
- [ ] Update the API reference section below to match the current implementation
|
||||
- [ ] `make docker` green
|
||||
- [x] `make docker` green
|
||||
- [ ] Tag `v1.0.0`
|
||||
|
||||
Future (desktop client, separate repo):
|
||||
|
||||
18
TODO.md
18
TODO.md
@@ -18,6 +18,23 @@ Update the README API reference section to match the current implementation.
|
||||
|
||||
# Completed Steps
|
||||
|
||||
- 2026-08-09: Made `make docker` green and policy-conformant. Multi-stage
|
||||
Dockerfile: a lint stage runs `make fmt-check` and `make lint`, and the check
|
||||
stage takes a `COPY --from=lint` dependency on it before running `make check`
|
||||
and `make build`. `CHECK_EPOCH` and a fail-closed guard stop Docker serving
|
||||
those two layers from cache, which is what let a build report success without
|
||||
running the suite. `script/projectname` says `quak`, so the image is tagged
|
||||
`quak`; `script/bootstrap` updates apt lists before installing, so a Debian
|
||||
base works; `.dockerignore` no longer ships the compiled binary, the caches or
|
||||
agent worktrees into the build context, and keeps `.gitignore` in it for
|
||||
prettier.
|
||||
- 2026-08-09: Fixed the TypeScript build. `rootDir` is the repo root, so `bin/`
|
||||
compiles alongside `src/` instead of failing with TS6059; output is
|
||||
`dist/src/` and `dist/bin/`, which is where `main`, `types` and `bin.quak` now
|
||||
point. `script/build` verifies the declared entrypoints exist after the
|
||||
compiler runs and makes the CLI executable, the Dockerfile runs `make build`
|
||||
as well as `make check`, and a `quak` script makes the README's
|
||||
`yarn quak <command>` examples work.
|
||||
- 2026-08-09: Retry policy: no retry on 4xx (except `408` and `429`),
|
||||
exponential backoff with full jitter on 5xx, transport failures and truncated
|
||||
transfers, under per-attempt deadlines that cover the response body as well as
|
||||
@@ -49,7 +66,6 @@ Update the README API reference section to match the current implementation.
|
||||
|
||||
# Future Steps
|
||||
|
||||
- Make `make docker` green.
|
||||
- Tag v1.0.0.
|
||||
- Future desktop client, separate repo:
|
||||
- Electron app skeleton consuming this library.
|
||||
|
||||
@@ -10,8 +10,8 @@
|
||||
"url": "https://git.eeqj.de/sneak/quak.git"
|
||||
},
|
||||
"type": "module",
|
||||
"main": "./dist/index.js",
|
||||
"types": "./dist/index.d.ts",
|
||||
"main": "./dist/src/index.js",
|
||||
"types": "./dist/src/index.d.ts",
|
||||
"bin": {
|
||||
"quak": "./dist/bin/quak.js"
|
||||
},
|
||||
@@ -21,7 +21,8 @@
|
||||
"LICENSE"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsc",
|
||||
"build": "script/build",
|
||||
"quak": "node ./dist/bin/quak.js",
|
||||
"test": "vitest run",
|
||||
"lint": "eslint .",
|
||||
"fmt": "prettier --write .",
|
||||
|
||||
@@ -19,6 +19,7 @@ YARN_VERSION="1.22.22"
|
||||
|
||||
PKGMGR=""
|
||||
SUDO=""
|
||||
APT_UPDATED=""
|
||||
|
||||
detect_pkgmgr() {
|
||||
[ -n "$PKGMGR" ] && return 0
|
||||
@@ -42,12 +43,24 @@ detect_pkgmgr() {
|
||||
fi
|
||||
}
|
||||
|
||||
# A fresh Debian image ships no package lists at all, so apt-get install
|
||||
# fails with "E: Unable to locate package make" until they are fetched.
|
||||
# Done once per run, since the lists do not go stale mid-bootstrap.
|
||||
apt_update_once() {
|
||||
[ -n "$APT_UPDATED" ] && return 0
|
||||
$SUDO env DEBIAN_FRONTEND=noninteractive apt-get update
|
||||
APT_UPDATED="yes"
|
||||
}
|
||||
|
||||
# pkg_install <nix-attr> <apt-pkg> <brew-formula> <apk-pkg>
|
||||
pkg_install() {
|
||||
detect_pkgmgr
|
||||
case "$PKGMGR" in
|
||||
nix) nix-env -iA "nixpkgs.$1" ;;
|
||||
apt) $SUDO env DEBIAN_FRONTEND=noninteractive apt-get install -y "$2" ;;
|
||||
apt)
|
||||
apt_update_once
|
||||
$SUDO env DEBIAN_FRONTEND=noninteractive apt-get install -y "$2"
|
||||
;;
|
||||
brew) brew install "$3" ;;
|
||||
apk) apk add --no-cache "$4" ;;
|
||||
esac
|
||||
|
||||
54
script/build
Executable file
54
script/build
Executable file
@@ -0,0 +1,54 @@
|
||||
#!/bin/sh
|
||||
# script/build: compile the TypeScript sources into dist/, then verify that
|
||||
# the artifacts package.json advertises are among the files the compiler
|
||||
# actually wrote. tsc reports success by exit status alone and knows nothing
|
||||
# about the manifest, so without this step a green build can still ship a
|
||||
# package whose main, types or bin resolve to nothing. Our own extension to
|
||||
# scripts-to-rule-them-all.
|
||||
set -eu
|
||||
|
||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||
|
||||
# Reads package.json, requires every declared entrypoint to exist, requires
|
||||
# each bin entry to have kept its shebang, and makes the bin entries
|
||||
# executable: tsc copies the shebang through but not the mode bits, and an
|
||||
# installed CLI has to be runnable.
|
||||
verify_entrypoints() {
|
||||
node -e '
|
||||
const { readFileSync, statSync, chmodSync } = require("node:fs");
|
||||
|
||||
const pkg = JSON.parse(readFileSync("package.json", "utf-8"));
|
||||
const bins = Object.values(pkg.bin ?? {});
|
||||
const fail = (message) => {
|
||||
console.error("build: " + message);
|
||||
process.exit(1);
|
||||
};
|
||||
|
||||
for (const declared of [pkg.main, pkg.types, ...bins]) {
|
||||
if (!declared) continue;
|
||||
try {
|
||||
statSync(declared);
|
||||
} catch {
|
||||
fail("package.json declares " + declared + ", which the build did not produce");
|
||||
}
|
||||
console.log("build: verified " + declared);
|
||||
}
|
||||
|
||||
for (const bin of bins) {
|
||||
const firstLine = readFileSync(bin, "utf-8").split("\n")[0];
|
||||
if (!firstLine.startsWith("#!")) {
|
||||
fail(bin + " lost its shebang, so it cannot be executed directly");
|
||||
}
|
||||
chmodSync(bin, 0o755);
|
||||
console.log("build: " + bin + " is executable (" + firstLine + ")");
|
||||
}
|
||||
'
|
||||
}
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
yarn run tsc
|
||||
verify_entrypoints
|
||||
}
|
||||
|
||||
main "$@"
|
||||
@@ -1,13 +1,17 @@
|
||||
#!/bin/sh
|
||||
# script/cibuild: run the CI build. The Dockerfile runs script/check, so
|
||||
# a successful build implies all checks pass.
|
||||
# script/cibuild: run the CI build. The Dockerfile runs script/check and
|
||||
# script/build, and CHECK_EPOCH differs on every invocation, so those two
|
||||
# layers cannot be served from Docker's cache: a green build here means
|
||||
# the checks ran now, not that a previous run was remembered. The layers
|
||||
# below the epoch (bootstrap, yarn install) are unaffected and stay
|
||||
# cached. A build that omits the argument fails by design.
|
||||
set -eu
|
||||
|
||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
docker build .
|
||||
docker build --build-arg CHECK_EPOCH="$(date +%s)" .
|
||||
}
|
||||
|
||||
main "$@"
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
#!/bin/sh
|
||||
# script/docker: build the Docker image tagged with the project name.
|
||||
# Identical in all repos; the tag comes from script/projectname.
|
||||
# CHECK_EPOCH is passed for the same reason script/cibuild passes it: the
|
||||
# Dockerfile refuses to build without it, so that no path to an image can
|
||||
# quietly serve the check and build layers from cache.
|
||||
set -eu
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||
@@ -8,7 +11,8 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
docker build -t "$("$SCRIPT_DIR/projectname")" .
|
||||
docker build --build-arg CHECK_EPOCH="$(date +%s)" \
|
||||
-t "$("$SCRIPT_DIR/projectname")" .
|
||||
}
|
||||
|
||||
main "$@"
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
set -eu
|
||||
|
||||
main() {
|
||||
echo "quack"
|
||||
echo "quak"
|
||||
}
|
||||
|
||||
main "$@"
|
||||
|
||||
@@ -227,11 +227,12 @@ export class ApiClient {
|
||||
// Idempotency: this reaches `/users/srp/create-session`,
|
||||
// `/users/two-factor/verify` and `/users/ott`, all of which change
|
||||
// server state — verifying a second factor consumes one of a small
|
||||
// number of attempts. So a POST is replayed only when the failure
|
||||
// proves the request never reached the server, which in practice means
|
||||
// the connection was never established. A 5xx, a mid-flight reset and
|
||||
// a timeout are all left to the caller, because each of them can occur
|
||||
// after the server has already acted.
|
||||
// number of attempts. So a POST is replayed only on a failure that
|
||||
// establishes no TCP connection to the server ever existed: DNS
|
||||
// produced no address, or the peer refused the connection. A 5xx, a
|
||||
// mid-flight reset, a routing errno (which Linux also delivers on an
|
||||
// established socket) and a timeout are all left to the caller,
|
||||
// because each of them can occur after the server has already acted.
|
||||
return withRetry(
|
||||
async () => {
|
||||
const resp = await this._fetch(url, {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import sodium from "libsodium-wrappers-sumo";
|
||||
import sodium, { type StateAddress } from "libsodium-wrappers-sumo";
|
||||
|
||||
// Plaintext chunk size used by Ente for file content streams. Hard-coded by
|
||||
// the server; clients must match.
|
||||
@@ -47,8 +47,10 @@ export const encryptBlob = (
|
||||
};
|
||||
|
||||
// Opaque handle to libsodium's secretstream pull state. Threaded through
|
||||
// successive pullStreamChunk calls.
|
||||
export type StreamPullState = sodium.StateAddress;
|
||||
// successive pullStreamChunk calls. The type comes from the named export;
|
||||
// the default import is the module's value side and has no type namespace
|
||||
// under it.
|
||||
export type StreamPullState = StateAddress;
|
||||
|
||||
// Initialise a pull stream from the per-file decryption header and the
|
||||
// per-file key.
|
||||
@@ -84,9 +86,13 @@ export const pullStreamChunk = (
|
||||
state: StreamPullState,
|
||||
ciphertext: Uint8Array,
|
||||
): { plaintext: Uint8Array; tag: number } => {
|
||||
// The additional-data argument is not optional in libsodium's signature.
|
||||
// null is "no additional data", matching the null passed on the push side
|
||||
// in encryptBlob; Ente's file streams carry none.
|
||||
const result = sodium.crypto_secretstream_xchacha20poly1305_pull(
|
||||
state,
|
||||
ciphertext,
|
||||
null,
|
||||
);
|
||||
if (result === false) {
|
||||
throw new Error("secretstream chunk authentication failed");
|
||||
|
||||
38
src/retry.ts
38
src/retry.ts
@@ -62,17 +62,22 @@ const TRANSPORT_CODES = new Set([
|
||||
"ENETDOWN",
|
||||
]);
|
||||
|
||||
// The subset of the above that can only happen before any request byte was
|
||||
// written: name resolution failed, or the connection was refused or never
|
||||
// routed. See `isSafeToReplay`.
|
||||
const CONNECT_CODES = new Set([
|
||||
"ENOTFOUND",
|
||||
"EAI_AGAIN",
|
||||
"ECONNREFUSED",
|
||||
"EHOSTUNREACH",
|
||||
"ENETUNREACH",
|
||||
"ENETDOWN",
|
||||
]);
|
||||
// The subset of the above that can only be reported before a TCP connection
|
||||
// exists, and therefore before any request byte could have been written: name
|
||||
// resolution produced no address (`ENOTFOUND`, `EAI_AGAIN`) or the peer
|
||||
// refused the connection with an RST to the SYN (`ECONNREFUSED`).
|
||||
//
|
||||
// The routing errnos — `EHOSTUNREACH`, `ENETUNREACH`, `ENETDOWN` — are
|
||||
// deliberately absent even though they look like connect-time failures. On
|
||||
// Linux they are also delivered on an already-established socket: an ICMP
|
||||
// destination-unreachable arriving mid-flight sets the socket error and the
|
||||
// next read or write returns it, and a local interface going down after the
|
||||
// request was fully written surfaces the same way. In those cases the server
|
||||
// may already have received and acted on the request, which is exactly the
|
||||
// ambiguity this set exists to exclude. They stay in `TRANSPORT_CODES`, so
|
||||
// they remain retryable for idempotent calls; only replay eligibility is
|
||||
// narrowed. See `isSafeToReplay`.
|
||||
const CONNECT_CODES = new Set(["ENOTFOUND", "EAI_AGAIN", "ECONNREFUSED"]);
|
||||
|
||||
// `cause` is an arbitrary user-settable property and nothing prevents it from
|
||||
// forming a cycle, so the walk is bounded. Hanging the process would be a
|
||||
@@ -148,13 +153,16 @@ export const isRetryable = (err: unknown): boolean => {
|
||||
// `isRetryable` is the wrong question for a request that changes state.
|
||||
// quak's non-idempotent calls are `/users/srp/create-session`,
|
||||
// `/users/two-factor/verify` — which consumes one of a small number of 2FA
|
||||
// attempts — and `/files/thumbnail`. They are replayed only when the failure
|
||||
// proves no request byte reached the server, which means the connection was
|
||||
// never established.
|
||||
// attempts — and `/files/thumbnail`. They are replayed only on the failures in
|
||||
// `CONNECT_CODES`, which establish that no TCP connection to the server ever
|
||||
// existed: there was no address to connect to, or the peer refused the
|
||||
// connection outright. A request byte cannot have been transmitted, so the
|
||||
// server cannot have acted.
|
||||
//
|
||||
// Everything else is ambiguous. A 5xx proves the server did process the
|
||||
// request. A reset or a broken pipe can arrive after it was fully sent and
|
||||
// acted on. A deadline says nothing at all about the server's state.
|
||||
// acted on. A routing errno can be delivered on an established socket. A
|
||||
// deadline says nothing at all about the server's state.
|
||||
export const isSafeToReplay = (err: unknown): boolean =>
|
||||
isRetryable(err) && causeCodes(err).some((code) => CONNECT_CODES.has(code));
|
||||
|
||||
|
||||
@@ -824,10 +824,11 @@ describe("ApiClient non-idempotent requests", () => {
|
||||
* state: `/users/srp/create-session`, `/users/two-factor/verify` — which
|
||||
* consumes one of a small number of 2FA attempts — and `/files/thumbnail`.
|
||||
*
|
||||
* They are retried only when the failure proves the request never reached
|
||||
* the server, which in practice means the connection was never
|
||||
* established. Everything else is ambiguous: a 5xx proves the server did
|
||||
* process the request, and a reset or a timeout can arrive after it did.
|
||||
* They are retried only on a failure that establishes no TCP connection to
|
||||
* the server ever existed — DNS produced no address, or the peer refused
|
||||
* the connection — so no request byte can have been transmitted.
|
||||
* Everything else is ambiguous: a 5xx proves the server did process the
|
||||
* request, and a reset or a timeout can arrive after it did.
|
||||
* Replaying under that ambiguity can burn a 2FA attempt or register a
|
||||
* thumbnail twice, and neither is worth the round trip it saves.
|
||||
*/
|
||||
|
||||
49
test/packaging/build-context.test.ts
Normal file
49
test/packaging/build-context.test.ts
Normal file
@@ -0,0 +1,49 @@
|
||||
// The Docker build context is load-bearing in two directions, and both
|
||||
// failures are silent.
|
||||
//
|
||||
// Excluding too little: a worktree left under `.claude/` is copied into the
|
||||
// image, vitest globs its `test/` tree as well as the real one, and the
|
||||
// containerised `make check` runs the whole suite twice over while reporting
|
||||
// success. A compiled `bin/quak` is ~100 MB of context nobody needs.
|
||||
//
|
||||
// Excluding too much: Prettier 3 reads `.gitignore` as a default ignore file,
|
||||
// so dropping it from the context silently changes which files
|
||||
// `make fmt-check` looks at inside the image compared to the host.
|
||||
//
|
||||
// Neither shows up as a build failure, so they are asserted here.
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { readFileSync } from "node:fs";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { join } from "node:path";
|
||||
|
||||
const repoRoot = fileURLToPath(new URL("../../", import.meta.url));
|
||||
|
||||
const patterns = (name: string): string[] =>
|
||||
readFileSync(join(repoRoot, name), "utf-8")
|
||||
.split("\n")
|
||||
.map((line) => line.trim())
|
||||
.filter((line) => line !== "" && !line.startsWith("#"));
|
||||
|
||||
const dockerignore = patterns(".dockerignore");
|
||||
|
||||
describe(".dockerignore", () => {
|
||||
// Everything here is either generated, enormous, or secret. `.claude/` is
|
||||
// the correctness one: see the header comment and issue #25.
|
||||
it.each([
|
||||
".claude/",
|
||||
".quak/",
|
||||
"bin/quak",
|
||||
"node_modules",
|
||||
"coverage",
|
||||
"dist",
|
||||
".vitest-cache/",
|
||||
".nyc_output/",
|
||||
"*.tsbuildinfo",
|
||||
])("keeps %s out of the build context", (pattern) => {
|
||||
expect(dockerignore).toContain(pattern);
|
||||
});
|
||||
|
||||
it("leaves .gitignore in the build context for prettier", () => {
|
||||
expect(dockerignore).not.toContain(".gitignore");
|
||||
});
|
||||
});
|
||||
116
test/packaging/entrypoints.test.ts
Normal file
116
test/packaging/entrypoints.test.ts
Normal file
@@ -0,0 +1,116 @@
|
||||
// The package manifest promises three files that only exist after a build:
|
||||
// `main`, `types`, and the `quak` binary. Nothing in the test suite used to
|
||||
// look at them, and `make check` runs test, lint and fmt-check but never the
|
||||
// build, so `tsconfig.json` and `package.json` were free to drift apart. They
|
||||
// did: `rootDir` was `./src` while `include` also pulled in `bin/**/*`, which
|
||||
// is TS6059, and no build had succeeded for as long as that was true.
|
||||
//
|
||||
// These tests read both files and check the contract between them, without
|
||||
// running a build, so they stay in the fast unit suite. The complementary
|
||||
// check — that the files really landed on disk — is in `script/build`, which
|
||||
// runs after the compiler and is the only place that can honestly answer it.
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { readFileSync } from "node:fs";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { join, posix } from "node:path";
|
||||
|
||||
interface TsConfig {
|
||||
compilerOptions: {
|
||||
outDir: string;
|
||||
rootDir: string;
|
||||
};
|
||||
include: string[];
|
||||
}
|
||||
|
||||
interface PackageJson {
|
||||
main: string;
|
||||
types: string;
|
||||
bin: Record<string, string>;
|
||||
scripts: Record<string, string>;
|
||||
}
|
||||
|
||||
const repoRoot = fileURLToPath(new URL("../../", import.meta.url));
|
||||
|
||||
const readJSON = <T>(name: string): T =>
|
||||
JSON.parse(readFileSync(join(repoRoot, name), "utf-8")) as T;
|
||||
|
||||
const tsconfig = readJSON<TsConfig>("tsconfig.json");
|
||||
const pkg = readJSON<PackageJson>("package.json");
|
||||
|
||||
// Paths in the two manifests are written with a leading "./"; normalize so
|
||||
// they can be compared and joined. Everything here is POSIX-style because
|
||||
// that is what both JSON files contain, regardless of the host OS.
|
||||
const clean = (p: string): string => posix.normalize(p);
|
||||
const outDir = clean(tsconfig.compilerOptions.outDir);
|
||||
const rootDir = clean(tsconfig.compilerOptions.rootDir);
|
||||
|
||||
// The directory prefix of a glob: the part before the first segment
|
||||
// containing a wildcard. "src/**/*" -> "src", "bin/**/*" -> "bin".
|
||||
const globRoot = (pattern: string): string => {
|
||||
const segments = clean(pattern).split("/");
|
||||
const wildcard = segments.findIndex((s) => s.includes("*"));
|
||||
return (
|
||||
segments
|
||||
.slice(0, wildcard === -1 ? segments.length : wildcard)
|
||||
.join("/") || "."
|
||||
);
|
||||
};
|
||||
|
||||
// Where tsc will write the output for a source file: the path relative to
|
||||
// rootDir, re-rooted under outDir, with the extension swapped.
|
||||
const emitted = (source: string, extension: string): string =>
|
||||
"./" +
|
||||
posix
|
||||
.join(outDir, posix.relative(rootDir, clean(source)))
|
||||
.replace(/\.ts$/, extension);
|
||||
|
||||
describe("tsconfig include and rootDir", () => {
|
||||
// TS6059 is not a style complaint: tsc refuses to emit anything at all
|
||||
// when a compiled file sits outside rootDir, so this single mismatch
|
||||
// took out both the library and the CLI artifacts.
|
||||
it("compiles only files that live under rootDir", () => {
|
||||
for (const pattern of tsconfig.include) {
|
||||
const root = globRoot(pattern);
|
||||
const relative = posix.relative(rootDir, root);
|
||||
expect(
|
||||
relative === "" || !relative.startsWith(".."),
|
||||
`include pattern ${pattern} matches files outside rootDir ` +
|
||||
`${rootDir}; tsc rejects that with TS6059`,
|
||||
).toBe(true);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe("package.json entrypoints", () => {
|
||||
// Each of these is the path a consumer resolves — `import { Client } from
|
||||
// "quak"` for main, the editor for types, `npx quak` for the bin — so a
|
||||
// wrong value is a broken package even when the build itself is green.
|
||||
it("names the file tsc emits for src/index.ts as main", () => {
|
||||
expect(pkg.main).toBe(emitted("src/index.ts", ".js"));
|
||||
});
|
||||
|
||||
it("names the declaration tsc emits for src/index.ts as types", () => {
|
||||
expect(pkg.types).toBe(emitted("src/index.ts", ".d.ts"));
|
||||
});
|
||||
|
||||
it("names the file tsc emits for bin/quak.ts as the quak binary", () => {
|
||||
expect(pkg.bin.quak).toBe(emitted("bin/quak.ts", ".js"));
|
||||
});
|
||||
|
||||
// The README's Getting Started block tells the reader to run
|
||||
// `yarn quak login` straight after `yarn build`. That only works if a
|
||||
// `quak` script exists and points at the built CLI, not at the source.
|
||||
it("runs the built CLI from the quak script", () => {
|
||||
expect(pkg.scripts.quak).toBeDefined();
|
||||
expect(pkg.scripts.quak).toContain(pkg.bin.quak);
|
||||
});
|
||||
});
|
||||
|
||||
describe("bin/quak.ts", () => {
|
||||
// tsc copies the shebang into the emitted file, so it has to be in the
|
||||
// source for the installed binary to be directly executable.
|
||||
it("starts with a node shebang", () => {
|
||||
const source = readFileSync(join(repoRoot, "bin/quak.ts"), "utf-8");
|
||||
expect(source.split("\n")[0]).toBe("#!/usr/bin/env node");
|
||||
});
|
||||
});
|
||||
30
test/packaging/projectname.test.ts
Normal file
30
test/packaging/projectname.test.ts
Normal file
@@ -0,0 +1,30 @@
|
||||
// `script/projectname` is the single source of the project's name for every
|
||||
// script that needs one — `script/docker` builds its image tag from it, which
|
||||
// is the whole reason that file exists. Nothing checked that it agreed with
|
||||
// `package.json`, and after the repo was renamed it did not: the script still
|
||||
// said "quack", so `make docker` produced an image tagged after a name this
|
||||
// project has not used since May.
|
||||
//
|
||||
// The script is executed rather than read, because what matters is the string
|
||||
// it prints, not the source it prints it from.
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { execFileSync } from "node:child_process";
|
||||
import { readFileSync } from "node:fs";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { join } from "node:path";
|
||||
|
||||
const repoRoot = fileURLToPath(new URL("../../", import.meta.url));
|
||||
|
||||
const pkg = JSON.parse(
|
||||
readFileSync(join(repoRoot, "package.json"), "utf-8"),
|
||||
) as { name: string };
|
||||
|
||||
describe("script/projectname", () => {
|
||||
it("prints the name package.json declares", () => {
|
||||
const printed = execFileSync(join(repoRoot, "script/projectname"), {
|
||||
cwd: repoRoot,
|
||||
encoding: "utf-8",
|
||||
}).trim();
|
||||
expect(printed).toBe(pkg.name);
|
||||
});
|
||||
});
|
||||
@@ -282,18 +282,13 @@ describe("isSafeToReplay", () => {
|
||||
* quak's non-idempotent calls are `/users/srp/create-session`,
|
||||
* `/users/two-factor/verify` (which consumes one of a limited number of
|
||||
* 2FA attempts) and `/files/thumbnail`. A blind replay of any of them can
|
||||
* do real damage, so they retry only on failures that prove no request
|
||||
* byte ever reached the server — which means the connection was never
|
||||
* established.
|
||||
* do real damage, so they retry only on the failures that establish no TCP
|
||||
* connection to the server ever existed — DNS produced no address, or the
|
||||
* peer refused the connection — and therefore that no request byte can
|
||||
* have been transmitted.
|
||||
*/
|
||||
it("replays only failures where the connection was never established", () => {
|
||||
for (const code of [
|
||||
"ENOTFOUND",
|
||||
"EAI_AGAIN",
|
||||
"ECONNREFUSED",
|
||||
"EHOSTUNREACH",
|
||||
"ENETUNREACH",
|
||||
]) {
|
||||
for (const code of ["ENOTFOUND", "EAI_AGAIN", "ECONNREFUSED"]) {
|
||||
expect(isSafeToReplay(errnoError(code))).toBe(true);
|
||||
}
|
||||
// Also when undici has buried it, which is how it actually arrives.
|
||||
@@ -317,6 +312,22 @@ describe("isSafeToReplay", () => {
|
||||
expect(isSafeToReplay(errnoError("ECONNRESET"))).toBe(false);
|
||||
expect(isSafeToReplay(errnoError("EPIPE"))).toBe(false);
|
||||
expect(isSafeToReplay(errnoError("ETIMEDOUT"))).toBe(false);
|
||||
// The routing errnos look like connect-time failures but are not. On
|
||||
// Linux an ICMP destination-unreachable delivered on an established
|
||||
// connection sets the socket error, and the next read or write returns
|
||||
// `EHOSTUNREACH` or `ENETUNREACH`; a local interface going down after
|
||||
// the request was fully written surfaces as `ENETDOWN` the same way.
|
||||
// In each case the server may already have consumed the request — a
|
||||
// replayed `/users/two-factor/verify` would burn a second attempt.
|
||||
// They remain retryable for the idempotent calls; this asserts only
|
||||
// that they are not replayable.
|
||||
expect(isSafeToReplay(errnoError("EHOSTUNREACH"))).toBe(false);
|
||||
expect(isSafeToReplay(errnoError("ENETUNREACH"))).toBe(false);
|
||||
expect(isSafeToReplay(errnoError("ENETDOWN"))).toBe(false);
|
||||
// ...and that the narrowing did not make them non-retryable.
|
||||
expect(isRetryable(errnoError("EHOSTUNREACH"))).toBe(true);
|
||||
expect(isRetryable(errnoError("ENETUNREACH"))).toBe(true);
|
||||
expect(isRetryable(errnoError("ENETDOWN"))).toBe(true);
|
||||
expect(
|
||||
isSafeToReplay(new DOMException("timed out", "TimeoutError")),
|
||||
).toBe(false);
|
||||
|
||||
@@ -5,7 +5,8 @@
|
||||
"moduleResolution": "NodeNext",
|
||||
"lib": ["ES2022"],
|
||||
"outDir": "./dist",
|
||||
"rootDir": "./src",
|
||||
"rootDir": ".",
|
||||
"noEmitOnError": true,
|
||||
"strict": true,
|
||||
"noImplicitOverride": true,
|
||||
"noUncheckedIndexedAccess": true,
|
||||
|
||||
Reference in New Issue
Block a user