Compare commits
12
Commits
9573724a0f
..
next2
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
04094a8cfb | ||
|
|
6a7a10f489 | ||
|
|
7740ebfd4d | ||
|
|
ae76eb3f74 | ||
|
|
f52c77f155 | ||
|
|
6757ddea94 | ||
|
|
36642f4448 | ||
|
|
fc396d1ecc | ||
|
|
cb61582ae6 | ||
|
|
cda57eebda | ||
|
|
c24c4dda4f | ||
|
|
4bb75ca323 |
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
# Mirrors .gitignore, with one deliberate exception: .gitignore itself stays
|
# Mirrors .gitignore, with one deliberate exception: .gitignore itself stays
|
||||||
# in the build context, because prettier 3 reads it as a default ignore file
|
# 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.
|
# and dropping it would change what the lint phase's prettier check sees.
|
||||||
|
|
||||||
# VCS
|
# VCS
|
||||||
.git
|
.git
|
||||||
|
|||||||
+58
-17
@@ -1,28 +1,69 @@
|
|||||||
# Test and build image: the suite, then the compile.
|
# Lint phase. The linters are invoked directly rather than through `make
|
||||||
|
# lint` or `script/lint`, which are themselves a docker build and would
|
||||||
|
# recurse into a daemon that does not exist in a build step.
|
||||||
#
|
#
|
||||||
# Linting deliberately does not happen here. `script/lint` is a build of
|
|
||||||
# Dockerfile.lint, and `script/check` calls `script/lint`, so running
|
|
||||||
# `make check` in this image would mean running `docker build` inside a
|
|
||||||
# container. Lint runs exactly once, in Dockerfile.lint; script/cibuild
|
|
||||||
# builds that first and this second.
|
|
||||||
# node 22.22.0 on Alpine 3.23.3 (node:22-alpine), 2026-08-09
|
# node 22.22.0 on Alpine 3.23.3 (node:22-alpine), 2026-08-09
|
||||||
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34 AS check
|
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34 AS lint
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
COPY script/ script/
|
COPY script/ script/
|
||||||
COPY package.json yarn.lock ./
|
COPY package.json yarn.lock ./
|
||||||
RUN script/bootstrap
|
RUN script/bootstrap
|
||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
# CHECK_EPOCH is a cache buster: without it Docker serves the test layer from
|
RUN yarn run eslint .
|
||||||
# cache on an unchanged tree, the suite never executes, and the build still
|
RUN yarn run prettier --check .
|
||||||
# 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
|
# Test phase, same shape and for the same reason. The suite runs without
|
||||||
# `docker build .` would otherwise still get the false green. Fail closed.
|
# verbose output first and is rerun verbosely only if it fails; the timeout
|
||||||
ARG CHECK_EPOCH
|
# catches a hung test.
|
||||||
RUN [ -n "$CHECK_EPOCH" ] || exit 1
|
#
|
||||||
RUN make test
|
# node 22.22.0 on Alpine 3.23.3 (node:22-alpine), 2026-08-09
|
||||||
|
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34 AS test
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
COPY script/ script/
|
||||||
|
COPY package.json yarn.lock ./
|
||||||
|
RUN script/bootstrap
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
# Unlike the template, the suite runs as the image's non-root `node` user:
|
||||||
|
# root ignores directory permissions, so the tests of a destination that is
|
||||||
|
# not writable would otherwise fail. vitest writes into /app.
|
||||||
|
RUN chown -R node:node /app
|
||||||
|
USER node
|
||||||
|
|
||||||
|
RUN timeout 90 yarn run vitest run --reporter=dot || \
|
||||||
|
{ echo "--- Rerunning with verbose for details ---"; \
|
||||||
|
timeout 90 yarn run vitest run --reporter=verbose; exit 1; }
|
||||||
|
|
||||||
|
# Build stage, and the last stage: a plain `docker build .` names no target
|
||||||
|
# and so builds this one. Nothing is wanted from the two phases above; the
|
||||||
|
# copies are what make BuildKit build them first, so this image cannot be
|
||||||
|
# produced unless lint and test passed. A stage appended after this one
|
||||||
|
# would drop all three out of a plain build.
|
||||||
|
#
|
||||||
|
# node 22.22.0 on Alpine 3.23.3 (node:22-alpine), 2026-08-09
|
||||||
|
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
COPY --from=lint /app/package.json /dev/null
|
||||||
|
COPY --from=test /app/package.json /dev/null
|
||||||
|
|
||||||
|
COPY script/ script/
|
||||||
|
COPY package.json yarn.lock ./
|
||||||
|
RUN script/bootstrap
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
# The version is computed on the host and passed in, because
|
||||||
|
# .dockerignore excludes .git.
|
||||||
|
ARG VERSION=dev
|
||||||
|
LABEL org.opencontainers.image.version="${VERSION}"
|
||||||
|
|
||||||
ARG CHECK_EPOCH
|
|
||||||
RUN [ -n "$CHECK_EPOCH" ] || exit 1
|
|
||||||
RUN make build
|
RUN make build
|
||||||
|
|||||||
@@ -1,35 +0,0 @@
|
|||||||
# Lint image: every lint run happens here, and nowhere else. The repo is
|
|
||||||
# COPYed into a digest-pinned image and the linters run as build steps, so a
|
|
||||||
# successful build IS a clean lint. `script/lint` does nothing but build this
|
|
||||||
# file, which also works where the docker daemon is remote and bind mounts are
|
|
||||||
# impossible. Nothing that runs inside a container may call `script/lint`:
|
|
||||||
# that is why Dockerfile no longer runs `make check`.
|
|
||||||
# node 22.22.0 on Alpine 3.23.3 (node:22-alpine), 2026-08-09
|
|
||||||
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34 AS lint
|
|
||||||
WORKDIR /app
|
|
||||||
|
|
||||||
# Manifests before sources, so the dependency install layer stays cached
|
|
||||||
# until package.json or yarn.lock changes. script/bootstrap ends in
|
|
||||||
# `yarn install --frozen-lockfile`; the lint steps below are deliberately
|
|
||||||
# not cached.
|
|
||||||
COPY script/ script/
|
|
||||||
COPY package.json yarn.lock ./
|
|
||||||
RUN script/bootstrap
|
|
||||||
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
# LINT_EPOCH is a cache buster, with the same fail-closed contract as
|
|
||||||
# CHECK_EPOCH in Dockerfile. No lint cache is wanted: on an unchanged tree
|
|
||||||
# Docker serves the linter layers in well under a second, having linted
|
|
||||||
# nothing, 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 -f Dockerfile.lint .` would
|
|
||||||
# otherwise get exactly that false green. Every layer below this one is a
|
|
||||||
# child of the guard, so a fresh epoch forces all of them to execute.
|
|
||||||
ARG LINT_EPOCH
|
|
||||||
RUN [ -n "$LINT_EPOCH" ] || exit 1
|
|
||||||
|
|
||||||
# The linters are invoked directly rather than through `make lint`, because
|
|
||||||
# `make lint` is the build of this file.
|
|
||||||
RUN yarn run eslint .
|
|
||||||
RUN yarn run prettier --check .
|
|
||||||
@@ -97,20 +97,18 @@ alpine. We provide:
|
|||||||
- `script/build` — compile the TypeScript sources into `dist/`, then verify that
|
- `script/build` — compile the TypeScript sources into `dist/`, then verify that
|
||||||
the entrypoints `package.json` declares (`main`, `types`, `bin`) are among the
|
the entrypoints `package.json` declares (`main`, `types`, `bin`) are among the
|
||||||
files the compiler wrote, and make the CLI executable (our own extension)
|
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`
|
- `script/test` — run the test suite, by building the `test` phase of the
|
||||||
is available, verbose rerun on failure)
|
`Dockerfile` (vitest, 90s timeout, verbose rerun on failure); requires docker
|
||||||
- `script/lint` — run eslint and a prettier check, by building
|
- `script/lint` — run eslint and a prettier check, by building the `lint` phase
|
||||||
`Dockerfile.lint`; requires docker (see Linting below)
|
of the `Dockerfile`; requires docker (see Linting and testing below)
|
||||||
- `script/fmt` — format all files with prettier (writes)
|
- `script/fmt` — format all files with prettier (writes)
|
||||||
- `script/fmt-check` — check formatting on the host (read-only); standalone, and
|
- `script/fmt-check` — check formatting on the host (read-only); standalone, and
|
||||||
not called by `script/check` or `script/precommit`, because `script/lint`
|
not called by `script/check` or `script/precommit`, because `script/lint`
|
||||||
already checks formatting in the container (see Linting below)
|
already checks formatting in the container
|
||||||
- `script/check` — run all checks: `test`, `lint` (our own extension)
|
- `script/check` — run all checks: `test`, `lint` (our own extension)
|
||||||
- `script/docker` — build the test and build image, tagged via
|
- `script/docker` — build the image, tagged via `script/projectname`
|
||||||
`script/projectname`
|
- `script/cibuild` — build the image (what CI runs); its last stage depends on
|
||||||
- `script/cibuild` — cd to the repo root and build both images (what CI runs):
|
the `lint` and `test` phases, so this one build lints, tests and compiles
|
||||||
`script/lint` first, then the `Dockerfile` image, which runs `make test` and
|
|
||||||
`make build`
|
|
||||||
- `script/precommit` — run by the git pre-commit hook (our own extension); runs
|
- `script/precommit` — run by the git pre-commit hook (our own extension); runs
|
||||||
`script/lint`, which checks both lint and formatting, but deliberately not the
|
`script/lint`, which checks both lint and formatting, but deliberately not the
|
||||||
tests, so the TDD red-phase commit can land
|
tests, so the TDD red-phase commit can land
|
||||||
@@ -119,50 +117,32 @@ alpine. We provide:
|
|||||||
|
|
||||||
`make hooks` installs the pre-commit hook that runs `script/precommit`.
|
`make hooks` installs the pre-commit hook that runs `script/precommit`.
|
||||||
|
|
||||||
### Linting
|
### Linting and testing
|
||||||
|
|
||||||
Linting runs in a container, one way, everywhere. `script/lint` builds
|
Linting and testing are phases of the `Dockerfile`. The `lint` phase copies the
|
||||||
`Dockerfile.lint`, which copies the repo into a digest-pinned node image and
|
repo into a digest-pinned node image and runs eslint and `prettier --check .`;
|
||||||
runs eslint and prettier as build steps, so a successful build is a clean lint.
|
the `test` phase does the same with the suite. `script/lint` and `script/test`
|
||||||
There is no host lint path: docker is required to lint, and that also works
|
each build one phase with `docker build --no-cache --target <phase>`. There is
|
||||||
where the docker daemon is remote and bind mounts are impossible.
|
no host lint or test path: docker is required, and that also works where the
|
||||||
|
docker daemon is remote and bind mounts are impossible.
|
||||||
|
|
||||||
The formatting check is part of that, not a step beside it. `script/check` and
|
The last stage of the `Dockerfile` compiles the package, and it copies a file
|
||||||
`script/precommit` therefore call `script/lint` and stop; neither calls
|
from each phase, so it cannot be built unless lint and the tests pass. That is
|
||||||
`script/fmt-check` as well, which would run prettier a second time over the same
|
why `script/cibuild` is a single `docker build`: it runs lint and the tests once
|
||||||
tree for the same verdict — and the weaker of the two, since the host's prettier
|
each and then compiles.
|
||||||
is whatever the working tree has installed. So `make check` and the pre-commit
|
|
||||||
hook both still fail on a badly formatted tree, and prettier runs exactly once
|
|
||||||
in each. `test/packaging/lint-once.test.ts` asserts that count by walking the
|
|
||||||
invocation graph, so a second pass cannot creep back in unnoticed.
|
|
||||||
|
|
||||||
|
Every `docker build` in `script/` passes `--no-cache`. On an unchanged tree
|
||||||
|
Docker would otherwise serve the lint and test steps from cache, nothing would
|
||||||
|
run, and the build would still exit 0.
|
||||||
|
|
||||||
|
The formatting check is part of the `lint` phase, not a step beside it, so
|
||||||
|
`script/check` and `script/precommit` do not call `script/fmt-check` as well;
|
||||||
|
that would run prettier a second time over the same tree for the same verdict.
|
||||||
`script/fmt-check` remains as a standalone entrypoint for asking the formatting
|
`script/fmt-check` remains as a standalone entrypoint for asking the formatting
|
||||||
question on its own, without docker and without the rest of lint. Its verdict
|
question on the host. Its verdict matches the container's: prettier is pinned to
|
||||||
cannot drift from the container's: prettier is pinned to an exact version,
|
an exact version, installed from `yarn.lock` under `--frozen-lockfile` in both
|
||||||
installed from `yarn.lock` under `--frozen-lockfile` in both places, and reads
|
places, and reads `.gitignore` as its default ignore file — which is why
|
||||||
`.gitignore` as its default ignore file — which is why `.dockerignore`
|
`.dockerignore` keeps `.gitignore` in the build context.
|
||||||
deliberately keeps `.gitignore` in the build context.
|
|
||||||
|
|
||||||
Lint happens in exactly one place, which constrains the rest of the build.
|
|
||||||
`script/check` calls `script/lint`, so `make check` cannot run inside a
|
|
||||||
container without asking for docker inside docker. The image built from
|
|
||||||
`Dockerfile` therefore runs `make test` and `make build` and does not lint;
|
|
||||||
`script/cibuild` builds `Dockerfile.lint` first and that image second, so CI
|
|
||||||
gets both verdicts.
|
|
||||||
|
|
||||||
### Build epochs
|
|
||||||
|
|
||||||
`script/lint` passes `--build-arg LINT_EPOCH="$(date +%s)"`, and `script/docker`
|
|
||||||
and `script/cibuild` pass `--build-arg CHECK_EPOCH="$(date +%s)"`. Both
|
|
||||||
Dockerfiles refuse to build without their argument. This is deliberate: on an
|
|
||||||
unchanged tree Docker would otherwise serve the linter and test layers from
|
|
||||||
cache, so nothing would run and the build would still exit 0 — a lint build over
|
|
||||||
an untouched tree returns success in well under a second, having linted nothing.
|
|
||||||
A changing epoch invalidates every layer below the guard on every invocation
|
|
||||||
while leaving the dependency layers above them cached, and the missing-argument
|
|
||||||
guard means a bare `docker build .` fails loudly instead of quietly reporting a
|
|
||||||
green it did not earn: an unset build argument is the empty string, which is a
|
|
||||||
perfectly stable cache key.
|
|
||||||
|
|
||||||
## Rationale
|
## Rationale
|
||||||
|
|
||||||
@@ -197,10 +177,9 @@ All work on quak is test-driven. No exceptions.
|
|||||||
3. Subsequent commits add the implementation and any refactors needed to make
|
3. Subsequent commits add the implementation and any refactors needed to make
|
||||||
the tests pass.
|
the tests pass.
|
||||||
4. A feature branch can only be merged into `main` when `make check` is green.
|
4. A feature branch can only be merged into `main` when `make check` is green.
|
||||||
`main` is always green. CI runs `script/cibuild`, which lints via
|
`main` is always green. CI runs `script/cibuild`, which builds the
|
||||||
`Dockerfile.lint` and then runs `make test` and `make build` in the
|
`Dockerfile`: its `lint` and `test` phases, then the compile, so neither a
|
||||||
`Dockerfile` image, so neither a red branch nor one that does not compile can
|
red branch nor one that does not compile can pass CI.
|
||||||
pass CI.
|
|
||||||
5. Tests are the canonical API documentation for this library. Every test file
|
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
|
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
|
learn how to use it from the tests alone. Comments explain why a behavior
|
||||||
@@ -217,7 +196,7 @@ All work on quak is test-driven. No exceptions.
|
|||||||
runs `script/lint` — eslint and the prettier check, in the container — but
|
runs `script/lint` — eslint and the prettier check, in the container — but
|
||||||
not the tests, and so not the full `make check`. This is deliberate so the
|
not the tests, and so not the full `make check`. This is deliberate so the
|
||||||
TDD red-phase commit (failing tests, no implementation yet) can land. The
|
TDD red-phase commit (failing tests, no implementation yet) can land. The
|
||||||
suite runs as part of the image build, which is what CI executes via
|
`test` phase is part of the image build, which is what CI executes via
|
||||||
`script/cibuild`, so a red branch still cannot reach `main`.
|
`script/cibuild`, so a red branch still cannot reach `main`.
|
||||||
|
|
||||||
## Design
|
## Design
|
||||||
@@ -235,18 +214,29 @@ quak/
|
|||||||
auth/ login flow (SRP + email OTP + TOTP), key unwrap
|
auth/ login flow (SRP + email OTP + TOTP), key unwrap
|
||||||
model/ decrypted Collection, File, Metadata types + decrypt fns
|
model/ decrypted Collection, File, Metadata types + decrypt fns
|
||||||
download/ streaming file/thumbnail download + decryption
|
download/ streaming file/thumbnail download + decryption
|
||||||
|
library/ the cache-backed Library: metadata store, read
|
||||||
|
surface, records, content cache, precache, ML data
|
||||||
|
and search, request pools
|
||||||
backup.ts resilient full-account backup with dedup
|
backup.ts resilient full-account backup with dedup
|
||||||
|
metadata-backup.ts
|
||||||
|
backup-metadata: all decrypted metadata as JSON
|
||||||
|
mldata-fetch.ts fetch + decrypt per-file ML data
|
||||||
|
filename.ts safe file names from server metadata
|
||||||
errors.ts error types shared across layers
|
errors.ts error types shared across layers
|
||||||
retry.ts retry classifier + exponential backoff with jitter
|
retry.ts retry classifier + exponential backoff with jitter
|
||||||
thumbnails.ts detect + regenerate missing thumbnails
|
thumbnails.ts detect + regenerate missing thumbnails
|
||||||
client.ts high-level Client class assembled from the above
|
client.ts high-level Client class assembled from the above
|
||||||
|
cli-commands.ts the CLI's commands as functions returning exit codes
|
||||||
|
cli-output.ts how the CLI prints a file's title and time
|
||||||
|
cli-read.ts fresh reads for the CLI's read commands
|
||||||
|
cli-run.ts run a command, print its error, exit with its code
|
||||||
|
cli-session.ts read the saved session file back into a Client
|
||||||
index.ts public library exports
|
index.ts public library exports
|
||||||
bin/
|
bin/
|
||||||
quak.ts CLI entrypoint (commander.js)
|
quak.ts CLI entrypoint (commander.js)
|
||||||
test/ unit + integration tests (vitest)
|
test/ unit + integration tests (vitest)
|
||||||
Makefile
|
Makefile
|
||||||
Dockerfile test suite and compile
|
Dockerfile lint phase, test phase, compile
|
||||||
Dockerfile.lint eslint and prettier, as build steps
|
|
||||||
package.json
|
package.json
|
||||||
tsconfig.json
|
tsconfig.json
|
||||||
```
|
```
|
||||||
@@ -318,6 +308,7 @@ Endpoints used:
|
|||||||
encrypted token plus key attributes.
|
encrypted token plus key attributes.
|
||||||
- `POST /users/ott` and `POST /users/verify-email`: email OTP fallback path.
|
- `POST /users/ott` and `POST /users/verify-email`: email OTP fallback path.
|
||||||
- `POST /users/two-factor/verify`: TOTP second factor.
|
- `POST /users/two-factor/verify`: TOTP second factor.
|
||||||
|
- `POST /users/logout`: end the calling token's session (`quak logout`).
|
||||||
- `GET /collections/v2?sinceTime=<usec>`: list collections changed since
|
- `GET /collections/v2?sinceTime=<usec>`: list collections changed since
|
||||||
microsecond timestamp; pass 0 for a full enumeration.
|
microsecond timestamp; pass 0 for a full enumeration.
|
||||||
- `GET /collections/v2/diff?collectionID=<id>&sinceTime=<usec>`: list files in a
|
- `GET /collections/v2/diff?collectionID=<id>&sinceTime=<usec>`: list files in a
|
||||||
@@ -432,7 +423,9 @@ whatever else fits their use case. `Client.fromJSON(snapshot)` restores a
|
|||||||
working client from that snapshot without re-authenticating; it checks every
|
working client from that snapshot without re-authenticating; it checks every
|
||||||
field and each key's length first, and throws an error naming the bad field.
|
field and each key's length first, and throws an error naming the bad field.
|
||||||
`client.logout()` clears the token and zeroes the key buffers in place; every
|
`client.logout()` clears the token and zeroes the key buffers in place; every
|
||||||
later call on that client throws.
|
later call on that client throws. It does not contact the server, so the token
|
||||||
|
stays valid there and in any saved snapshot; `await client.logoutOnServer()`
|
||||||
|
first ends the session on the server (`POST /users/logout`).
|
||||||
|
|
||||||
The CLI stores the snapshot at the platform-appropriate data directory via
|
The CLI stores the snapshot at the platform-appropriate data directory via
|
||||||
`env-paths`: `~/Library/Application Support/quak/session.json` on macOS,
|
`env-paths`: `~/Library/Application Support/quak/session.json` on macOS,
|
||||||
@@ -442,13 +435,21 @@ you would treat the password itself. A missing file is reported as "not logged
|
|||||||
in"; a file that exists but is corrupt is reported as such, naming the bad
|
in"; a file that exists but is corrupt is reported as such, naming the bad
|
||||||
field. Both exit with status 1.
|
field. Both exit with status 1.
|
||||||
|
|
||||||
|
`quak logout` ends the session on the server, so the token in `session.json`
|
||||||
|
stops working even in a copy of the file, and then deletes the file. If the
|
||||||
|
server call fails (or the file is corrupt), the file is still deleted, the
|
||||||
|
command says the server session could not be ended, and it exits with status 1.
|
||||||
|
It does not delete the cache: it prints the account's cache directory and says
|
||||||
|
it still holds decrypted data (file keys in `metadata.json`, cached originals
|
||||||
|
and thumbnails), for the user to delete if they want it gone.
|
||||||
|
|
||||||
### CLI surface
|
### CLI surface
|
||||||
|
|
||||||
```
|
```
|
||||||
quak [--cache-dir <path>] <command> global: local metadata/content cache location
|
quak [--cache-dir <path>] <command> global: local metadata/content cache location
|
||||||
quak login interactive or QUAK_EMAIL/QUAK_PASSWORD
|
quak login interactive or QUAK_EMAIL/QUAK_PASSWORD
|
||||||
quak whoami print logged-in account as JSON
|
quak whoami print logged-in account as JSON
|
||||||
quak logout delete saved session
|
quak logout end the session, delete it
|
||||||
quak collections [--json] list all collections
|
quak collections [--json] list all collections
|
||||||
quak files --collection <id> [--json] list files in a collection
|
quak files --collection <id> [--json] list files in a collection
|
||||||
quak get <fileID> [--out path] [--collection] download and decrypt a file
|
quak get <fileID> [--out path] [--collection] download and decrypt a file
|
||||||
@@ -460,10 +461,13 @@ quak helper fix-missing-thumbnails [--file ids] generate + upload missing thumbn
|
|||||||
```
|
```
|
||||||
|
|
||||||
Every command runs on the same cache-backed library. The read commands —
|
Every command runs on the same cache-backed library. The read commands —
|
||||||
`collections`, `files`, `get`, and `get-thumb` — force a fresh server round-trip
|
`collections`, `files`, `get`, `get-thumb`, `backup-metadata`,
|
||||||
before they answer, so they report current account state rather than whatever
|
`helper list-missing-thumbnails` and `helper fix-missing-thumbnails` — force a
|
||||||
the cache last held. `--cache-dir` overrides where the cache lives; without it
|
fresh server round-trip before they answer, so they report current account state
|
||||||
each account gets its own directory under the per-user cache path.
|
rather than whatever the cache last held. If that round-trip fails, the command
|
||||||
|
prints the error on one line and exits 1. `--cache-dir` overrides where the
|
||||||
|
cache lives; without it each account gets its own directory under the per-user
|
||||||
|
cache path.
|
||||||
|
|
||||||
`get` and `get-thumb` resolve the file by ID directly, so `--collection` is
|
`get` and `get-thumb` resolve the file by ID directly, so `--collection` is
|
||||||
accepted for backward compatibility but ignored. `backup-metadata --exif` (alias
|
accepted for backward compatibility but ignored. `backup-metadata --exif` (alias
|
||||||
@@ -480,7 +484,13 @@ on. The exit code is non-zero if any ML data request failed.
|
|||||||
only, because the bundled decoder (`jpeg-js`) decodes only JPEG. A non-JPEG
|
only, because the bundled decoder (`jpeg-js`) decodes only JPEG. A non-JPEG
|
||||||
image (PNG, HEIC) or a video is reported as `skipped` (unsupported format), kept
|
image (PNG, HEIC) or a video is reported as `skipped` (unsupported format), kept
|
||||||
distinct from a `failed` repair, and does not affect the exit code; a genuine
|
distinct from a `failed` repair, and does not affect the exit code; a genuine
|
||||||
failure still exits non-zero.
|
failure still exits non-zero. The server accepts a new thumbnail only from the
|
||||||
|
file's owner and only when it is no larger than the thumbnail size it records
|
||||||
|
for the file. So a file another account owns, in an album shared with you, is
|
||||||
|
skipped by both thumbnail helpers without being fetched, and the fixer skips a
|
||||||
|
file whose recorded thumbnail size is 0 or unknown. Otherwise the fixer lowers
|
||||||
|
the quality and size of the thumbnail until it fits, and skips the file if even
|
||||||
|
the smallest does not.
|
||||||
|
|
||||||
### Backup layout
|
### Backup layout
|
||||||
|
|
||||||
@@ -495,8 +505,15 @@ failure still exits non-zero.
|
|||||||
<name>/
|
<name>/
|
||||||
<title> -> ../../originals/<fileID>.<ext> (symlink)
|
<title> -> ../../originals/<fileID>.<ext> (symlink)
|
||||||
<name>.json collection metadata + file list
|
<name>.json collection metadata + file list
|
||||||
|
failures.json files that failed and have not yet succeeded
|
||||||
```
|
```
|
||||||
|
|
||||||
|
`failures.json` records each failed file with the kind of failure, how many
|
||||||
|
times it has been tried and when it was last tried. A file leaves it once it
|
||||||
|
succeeds, or once it is no longer in the library or in the backup's scope. The
|
||||||
|
library's `lib.backup({ includeThumbnails: true })` also writes
|
||||||
|
`thumbnails/<fileID>.jpg` beside `originals/`; `quak backup` does not.
|
||||||
|
|
||||||
A collection's directory and JSON are named after the collection, and a symlink
|
A collection's directory and JSON are named after the collection, and a symlink
|
||||||
after the file's title, both with unsafe characters replaced. When two
|
after the file's title, both with unsafe characters replaced. When two
|
||||||
collections would get the same name, or two files in one collection the same
|
collections would get the same name, or two files in one collection the same
|
||||||
@@ -512,22 +529,25 @@ symlink you put there stays, and a directory that still holds one after its
|
|||||||
symlinks are removed stays too, with its JSON.
|
symlinks are removed stays too, with its JSON.
|
||||||
|
|
||||||
Each file is downloaded exactly once regardless of how many collections it
|
Each file is downloaded exactly once regardless of how many collections it
|
||||||
appears in. On subsequent runs, existing originals are skipped. If a download
|
appears in, and written once: straight into `originals/`, with no copy left in
|
||||||
fails, the error is logged and the backup continues with the next file. The exit
|
the cache. An original the cache already held is copied from there instead. On
|
||||||
code is non-zero if any files failed.
|
subsequent runs, existing originals are skipped. If a download fails, the error
|
||||||
|
is logged and the backup continues with the next file. The exit code is non-zero
|
||||||
|
if any files failed. `quak backup` opens its library with the thumbnail and
|
||||||
|
originals precache off, so it fetches only what the backup stores.
|
||||||
|
|
||||||
Each original is copied to a temporary file named
|
Each original is written to a temporary file in the same directory, synced to
|
||||||
`.quak-backup-<fileID>.<ext>-<pid>-<random>.tmp` in the same directory, synced
|
disk, and renamed into place, so an original is either complete or absent, even
|
||||||
to disk, and renamed into place, so an original is either complete or absent,
|
after a power cut. A downloaded original's temporary file is named
|
||||||
even after a power cut. A run that is killed can leave one of these temporary
|
`.quak-<pid>-<random>.tmp`, one copied from the cache
|
||||||
files behind; the next backup deletes those whose process is no longer running.
|
`.quak-backup-<fileID>.<ext>-<pid>-<random>.tmp`. A run that is killed can leave
|
||||||
Downloads and the content cache use the same scheme with
|
one of these temporary files behind; the next backup deletes those whose process
|
||||||
`.quak-<pid>-<random>.tmp` names, and opening a library deletes those in the
|
is no longer running. The content cache uses the same scheme, and opening a
|
||||||
cache whose process is no longer running, so a download another process has in
|
library deletes the temporary files in the cache whose process is no longer
|
||||||
progress in the same cache is left alone. The rename replaces whatever was at
|
running, so a download another process has in progress in the same cache is left
|
||||||
the destination rather than writing through it: a symlink there is replaced, not
|
alone. The rename replaces whatever was at the destination rather than writing
|
||||||
followed, and the new file has the temporary file's permissions, not those of
|
through it: a symlink there is replaced, not followed, and the new file has the
|
||||||
the file it replaced.
|
temporary file's permissions, not those of the file it replaced.
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
@@ -535,7 +555,12 @@ the file it replaced.
|
|||||||
errors
|
errors
|
||||||
- [x] Update the API reference section below to match the current implementation
|
- [x] Update the API reference section below to match the current implementation
|
||||||
- [x] `make docker` green
|
- [x] `make docker` green
|
||||||
- [ ] Tag `v1.0.0`
|
- [ ] Store live photos in a form a photo viewer can open
|
||||||
|
(https://git.eeqj.de/sneak/quak/issues/107), once sneak has chosen between
|
||||||
|
keeping the ZIP and unpacking it
|
||||||
|
|
||||||
|
Tagging and releases are decided by sneak alone, and happen only when he
|
||||||
|
declares one.
|
||||||
|
|
||||||
Future (desktop client, separate repo):
|
Future (desktop client, separate repo):
|
||||||
|
|
||||||
@@ -555,10 +580,11 @@ test suite is the canonical, executable documentation — `test/library/` and
|
|||||||
### Opening a library
|
### Opening a library
|
||||||
|
|
||||||
`Library.open(options)` loads the on-disk cache, starts the background refresh
|
`Library.open(options)` loads the on-disk cache, starts the background refresh
|
||||||
loop, and resolves to a `Library`. On an empty cache it awaits the first refresh
|
loop, and resolves to a `Library`. On an empty cache it awaits the first
|
||||||
so it never opens onto empty data; on an existing cache it returns immediately
|
refresh, so it opens onto the account's data whenever the server is reachable;
|
||||||
and refreshes in the background, so an unreachable server does not block
|
if that refresh fails, it opens with no data and records the error in
|
||||||
opening.
|
`lib.status()`. On an existing cache it returns immediately and refreshes in the
|
||||||
|
background, so an unreachable server does not block opening.
|
||||||
|
|
||||||
`LibraryOptions`:
|
`LibraryOptions`:
|
||||||
|
|
||||||
@@ -669,12 +695,15 @@ photos newest first). `lib.subscribe({ onChange })` delivers a `LibraryChange`
|
|||||||
default limit 20). quak bundles no text encoder, so `searchByEmbedding` takes
|
default limit 20). quak bundles no text encoder, so `searchByEmbedding` takes
|
||||||
a query vector the caller produced elsewhere.
|
a query vector the caller produced elsewhere.
|
||||||
- `await lib.backup(opts?)` → `BackupResult`. It refreshes, fetches every
|
- `await lib.backup(opts?)` → `BackupResult`. It refreshes, fetches every
|
||||||
in-scope original (and, with `includeThumbnails`, thumbnails) through the
|
in-scope original not already in the backup (and, with `includeThumbnails`,
|
||||||
content cache, and rebuilds the on-disk backup tree with a durable failure
|
thumbnails) through the content cache, and rebuilds the on-disk backup tree
|
||||||
ledger. `BackupOptions`: `downloadDirectory` (falls back to the one `open()`
|
with a durable failure ledger. A fetched original is written straight into the
|
||||||
was given), `includeOriginals` (default `true`), `includeThumbnails` (default
|
backup's `originals/` and not into the cache, which then counts it as present;
|
||||||
`false`), `onlyAlbumNames`, and `onProgress`. See Backup layout above for the
|
one the cache already held is copied from there. `BackupOptions`:
|
||||||
tree it writes.
|
`downloadDirectory` (falls back to the one `open()` was given),
|
||||||
|
`includeOriginals` (default `true`), `includeThumbnails` (default `false`),
|
||||||
|
`onlyAlbumNames`, and `onProgress`. See Backup layout above for the tree it
|
||||||
|
writes.
|
||||||
|
|
||||||
### Request pools
|
### Request pools
|
||||||
|
|
||||||
@@ -759,20 +788,22 @@ documents:
|
|||||||
commented thoroughly. `main` is always green.
|
commented thoroughly. `main` is always green.
|
||||||
|
|
||||||
- **Required checks before every commit:** `make lint` must pass — that is
|
- **Required checks before every commit:** `make lint` must pass — that is
|
||||||
eslint plus the prettier check, and it builds `Dockerfile.lint`, so it needs
|
eslint plus the prettier check, and it builds the `lint` phase of the
|
||||||
docker. The pre-commit hook enforces exactly that. `make check` (which also
|
`Dockerfile`, so it needs docker. The pre-commit hook enforces exactly that.
|
||||||
runs the tests) must pass before merging to `main`. `make fmt-check` is
|
`make check` (which also runs the tests) must pass before merging to `main`.
|
||||||
available for a host-side formatting check on its own, but it is not a
|
`make fmt-check` is available for a host-side formatting check on its own, but
|
||||||
separate requirement: `make lint` already covers it, and running both would
|
it is not a separate requirement: `make lint` already covers it, and running
|
||||||
check formatting twice. Never invoke eslint or prettier directly; linting runs
|
both would check formatting twice. Never invoke eslint or prettier directly;
|
||||||
in the container only.
|
linting runs in the container only.
|
||||||
|
|
||||||
- **Formatting:** prettier with 4-space indents and `proseWrap: always` for
|
- **Formatting:** prettier with 4-space indents and `proseWrap: always` for
|
||||||
markdown. Use `make fmt` to format. Use `yarn` not `npm`.
|
markdown. Use `make fmt` to format. Use `yarn` not `npm`.
|
||||||
|
|
||||||
- **Testing:** vitest. Tests go in `test/` mirroring the `src/` structure.
|
- **Testing:** vitest. Tests go in `test/` mirroring the `src/` structure.
|
||||||
`make test` must complete in under 20 seconds. Use `mkdtempSync` for temporary
|
`make test` must finish in under 60 seconds (the hard cap) and should finish
|
||||||
directories, never manual timestamp paths.
|
in under 20. The 90-second `timeout` in the `test` phase of the `Dockerfile`
|
||||||
|
is a backstop that catches a hung test, not the time limit. Use `mkdtempSync`
|
||||||
|
for temporary directories, never manual timestamp paths.
|
||||||
|
|
||||||
- **Code style:** `const` for everything, `let` if reassignment is needed, never
|
- **Code style:** `const` for everything, `let` if reassignment is needed, never
|
||||||
`var`. Avoid unnecessary comments. No hand-rolled crypto. The
|
`var`. Avoid unnecessary comments. No hand-rolled crypto. The
|
||||||
|
|||||||
+270
-75
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Repository Policies
|
title: Repository Policies
|
||||||
last_modified: 2026-07-06
|
last_modified: 2026-09-08
|
||||||
---
|
---
|
||||||
|
|
||||||
This document covers repository structure, tooling, and workflow standards. Code
|
This document covers repository structure, tooling, and workflow standards. Code
|
||||||
@@ -60,17 +60,28 @@ style conventions are in separate documents:
|
|||||||
prerequisite since nvm requires bash. yarn is then pinned via
|
prerequisite since nvm requires bash. yarn is then pinned via
|
||||||
`corepack prepare yarn@<version> --activate`. Never install "latest" or "lts";
|
`corepack prepare yarn@<version> --activate`. Never install "latest" or "lts";
|
||||||
always exact versions. `script/cibuild` runs the CI build: it changes to the
|
always exact versions. `script/cibuild` runs the CI build: it changes to the
|
||||||
repo root and runs `docker build .`; the Gitea workflow calls it. Four further
|
repo root, runs `script/bootstrap`, runs `script/check`, and builds the image
|
||||||
scripts are our own extensions to the standard: `script/check` runs
|
with the version; the Gitea workflow calls it. **`script/cibuild` runs
|
||||||
`script/test`, `script/lint`, and `script/fmt-check`; `script/precommit` is
|
`script/bootstrap` first**, because the workflow checks out the repo and runs
|
||||||
what the git pre-commit hook runs, and it calls `script/check`;
|
nothing else, while `script/fmt-check` runs the formatter on the host: on a
|
||||||
`script/install-precommit` installs the git pre-commit hook (the `make hooks`
|
pristine checkout with nothing installed the run dies there, after the
|
||||||
target shims to it); and `script/projectname` (literally that filename) simply
|
containerised gates have passed. **The bootstrap alone is not enough**:
|
||||||
outputs the project's name. Scripts that need the name call
|
`script/bootstrap` installs node and yarn under nvm and leaves neither on the
|
||||||
`script/projectname` — e.g. `script/docker` assembles its image tag from it —
|
`PATH` of the shell that called it, so a bare `yarn` still exits 127. The host
|
||||||
so those scripts stay byte-identical across all repos. Repo-type-specific
|
entrypoints that need yarn — `script/fmt` and `script/fmt-check` — therefore
|
||||||
pre-commit extras (e.g. `go mod tidy` verification in Go repos) belong in
|
source nvm for the pinned node version before invoking it, exactly as
|
||||||
`script/precommit`, not in the hook itself. Model scripts are at
|
`script/bootstrap`'s own install step does. A runner carrying nothing but
|
||||||
|
docker and git then gets through `script/check`. Four further scripts are our
|
||||||
|
own extensions to the standard: `script/check` runs `script/test`,
|
||||||
|
`script/lint` and `script/fmt-check`; `script/precommit` is what the git
|
||||||
|
pre-commit hook runs, and it calls `script/check`; `script/install-precommit`
|
||||||
|
installs the git pre-commit hook (the `make hooks` target shims to it); and
|
||||||
|
`script/projectname` (literally that filename) simply outputs the project's
|
||||||
|
name. Scripts that need the name call `script/projectname` — e.g.
|
||||||
|
`script/docker` assembles its image tag from it — so those scripts stay
|
||||||
|
byte-identical across all repos. Repo-type-specific pre-commit extras (e.g.
|
||||||
|
`go mod tidy` verification in Go repos) belong in `script/precommit`, not in
|
||||||
|
the hook itself. Model scripts are at
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/script/<name>`. The README
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/script/<name>`. The README
|
||||||
must document the provided scripts in an **Entrypoints** section (see the
|
must document the provided scripts in an **Entrypoints** section (see the
|
||||||
README requirements below).
|
README requirements below).
|
||||||
@@ -89,87 +100,140 @@ style conventions are in separate documents:
|
|||||||
contributor should be able to understand the entire development workflow by
|
contributor should be able to understand the entire development workflow by
|
||||||
reading the Makefile.
|
reading the Makefile.
|
||||||
|
|
||||||
- Every repo should have a `Dockerfile`. All Dockerfiles must run `make check`
|
- Every repo should have a `Dockerfile`, and it carries the repo's gates: a
|
||||||
as a build step so the build fails if the branch is not green. For non-server
|
`lint` phase and a `test` phase, with the final stage depending on both so the
|
||||||
repos, the Dockerfile should bring up a development environment and run
|
image cannot be built unless they pass. For non-server repos the final stage
|
||||||
`make check`. For server repos, `make check` should run as an early build
|
brings up a development environment; for server repos it is the runtime image.
|
||||||
stage before the final image is assembled. Dockerfiles install development
|
Dockerfiles install development prerequisites by running `script/bootstrap`
|
||||||
prerequisites by running `script/bootstrap` rather than duplicating installs
|
rather than duplicating installs inline; COPY `script/` and the dependency
|
||||||
inline; COPY `script/` and the dependency manifests (`package.json` +
|
manifests (`package.json` + `yarn.lock`, `go.mod` + `go.sum`, etc.) before
|
||||||
`yarn.lock`, `go.mod` + `go.sum`, etc.) before running it so the bootstrap
|
running it.
|
||||||
layer stays cached until dependencies change.
|
|
||||||
|
|
||||||
- **Dockerfiles must use a separate lint stage for fail-fast feedback.** Go
|
- **Linting and testing run in Docker, as phases of the `Dockerfile`.** There is
|
||||||
repos use a multistage build where linting runs in an independent stage based
|
no separate lint file. `script/lint` and `script/test` each build one phase
|
||||||
on the `golangci/golangci-lint` image (pinned by hash). This stage runs
|
and nothing else:
|
||||||
`make fmt-check` and `make lint` before the full build begins. The build stage
|
|
||||||
then declares an explicit dependency on the lint stage via
|
|
||||||
`COPY --from=lint /src/go.sum /dev/null`, which forces BuildKit to complete
|
|
||||||
linting before proceeding to compilation and tests. This ensures lint failures
|
|
||||||
surface in seconds rather than minutes, without blocking on dependency
|
|
||||||
download or compilation in the build stage.
|
|
||||||
|
|
||||||
The standard pattern for a Go repo Dockerfile is:
|
```sh
|
||||||
|
docker build --no-cache --target lint -t "$(script/projectname)-lint" .
|
||||||
|
docker build --no-cache --target test -t "$(script/projectname)-test" .
|
||||||
|
```
|
||||||
|
|
||||||
|
**A stage that is not the last one in the file is built only when the final
|
||||||
|
stage's chain depends on it, or when `--target` names it.** That is why the
|
||||||
|
two gates are always invoked by name here, and why the final stage carries a
|
||||||
|
`COPY --from=` of a harmless file from each of them: without that edge a
|
||||||
|
plain `docker build .` builds the last stage alone and exits 0 having linted
|
||||||
|
and tested nothing.
|
||||||
|
|
||||||
|
**Every `docker build` in `script/` is tagged**, here and in
|
||||||
|
`script/cibuild` and `script/docker`. An untagged build leaves a dangling
|
||||||
|
image behind on every invocation, on every developer host and every CI
|
||||||
|
runner; a tagged one replaces the previous image.
|
||||||
|
|
||||||
|
Inside a phase the tool is invoked directly — `golangci-lint`, `go test`,
|
||||||
|
`eslint`, `prettier` — never through `make lint` or `script/test`, which are
|
||||||
|
themselves a `docker build` and would recurse into a daemon that does not
|
||||||
|
exist in a build step. Formatting is the exception and stays on the host:
|
||||||
|
`script/fmt` writes the working tree, and `script/fmt-check` is its
|
||||||
|
read-only twin.
|
||||||
|
|
||||||
|
**No lint verdict may come from a host invocation of the linter.** On a
|
||||||
|
shared host golangci-lint reads a result cache keyed on file content rather
|
||||||
|
than location, so a second checkout of the same content is served the first
|
||||||
|
one's findings, and a host-global lock in `$TMPDIR` makes concurrent runs
|
||||||
|
exit non-zero with `parallel golangci-lint is running` — a status a caller
|
||||||
|
cannot tell from real findings. Both have produced wrong verdicts in this
|
||||||
|
org, in both directions. A container has its own cache, its own `TMPDIR` and
|
||||||
|
a digest-pinned binary, so neither is reachable.
|
||||||
|
|
||||||
|
- **Any build that runs checks is built with `--no-cache`.** Docker invalidates
|
||||||
|
a `COPY` layer only when the copied content changes, so on an unchanged tree
|
||||||
|
the check `RUN` is served from cache, nothing executes, and the build still
|
||||||
|
exits 0. Every `docker build` in `script/` therefore passes `--no-cache`:
|
||||||
|
`script/lint`, `script/test`, `script/cibuild` and `script/docker` are the
|
||||||
|
four, and there is no fifth — `script/check` runs the two gate phases and
|
||||||
|
`script/fmt-check`, and builds no image of its own. A bare `docker build .` is
|
||||||
|
not evidence that anything ran: a sub-second build reporting success is a
|
||||||
|
cache hit, not a result. Never invalidate by pruning — `docker builder prune`
|
||||||
|
and friends destroy a build cache shared with every other build on the host.
|
||||||
|
|
||||||
|
- **The gate phases are separate stages, and the build stage depends on both.**
|
||||||
|
The lint phase is based on the `golangci/golangci-lint` image (pinned by
|
||||||
|
hash), so lint failures surface in seconds rather than after a full compile,
|
||||||
|
and the test phase is based on the Go image. The canonical Go repo
|
||||||
|
`Dockerfile`:
|
||||||
|
|
||||||
```dockerfile
|
```dockerfile
|
||||||
# Lint stage — fast feedback on formatting and lint issues
|
# Lint phase
|
||||||
# golangci/golangci-lint:v2.x.x, YYYY-MM-DD
|
# golangci/golangci-lint:v2.x.x, YYYY-MM-DD
|
||||||
FROM golangci/golangci-lint@sha256:... AS lint
|
FROM golangci/golangci-lint@sha256:... AS lint
|
||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN make fmt-check
|
RUN golangci-lint run --config .golangci.yml ./...
|
||||||
RUN make lint
|
|
||||||
|
|
||||||
# Build stage
|
# Test phase
|
||||||
# golang:1.x-alpine, YYYY-MM-DD
|
# golang:1.x-alpine, YYYY-MM-DD
|
||||||
|
FROM golang@sha256:... AS test
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
COPY . .
|
||||||
|
RUN go test -timeout 90s -race -cover ./... || \
|
||||||
|
{ echo "--- Rerunning with -v for details ---"; \
|
||||||
|
go test -timeout 90s -race -v ./...; exit 1; }
|
||||||
|
|
||||||
|
# Build stage. Nothing is wanted from either phase above; the copies
|
||||||
|
# are what make BuildKit build them first, so this stage cannot run
|
||||||
|
# unless lint and test passed.
|
||||||
|
# golang:1.x-alpine, YYYY-MM-DD
|
||||||
FROM golang@sha256:... AS builder
|
FROM golang@sha256:... AS builder
|
||||||
|
COPY --from=lint /src/go.sum /dev/null
|
||||||
|
COPY --from=test /src/go.sum /dev/null
|
||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
|
|
||||||
# Force BuildKit to run the lint stage before proceeding
|
|
||||||
COPY --from=lint /src/go.sum /dev/null
|
|
||||||
|
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN make test
|
|
||||||
|
|
||||||
ARG VERSION=dev
|
ARG VERSION=dev
|
||||||
RUN CGO_ENABLED=0 go build -trimpath \
|
RUN CGO_ENABLED=0 go build -trimpath \
|
||||||
-ldflags="-s -w -X main.Version=${VERSION}" \
|
-ldflags="-s -w -X main.Version=${VERSION}" \
|
||||||
-o /app ./cmd/app/
|
-o /app ./cmd/app/
|
||||||
|
|
||||||
# Runtime stage
|
# Runtime stage, and the last one
|
||||||
FROM alpine@sha256:...
|
FROM alpine@sha256:...
|
||||||
COPY --from=builder /app /usr/local/bin/app
|
COPY --from=builder /app /usr/local/bin/app
|
||||||
ENTRYPOINT ["app"]
|
ENTRYPOINT ["app"]
|
||||||
```
|
```
|
||||||
|
|
||||||
Key points:
|
Key points:
|
||||||
- The lint stage uses the `golangci/golangci-lint` image directly (it
|
- The lint phase uses the `golangci/golangci-lint` image directly (it has
|
||||||
includes both Go and the linter), so there is no need to install the
|
both Go and the linter), so nothing needs installing.
|
||||||
linter separately.
|
- `COPY --from=<phase> /src/go.sum /dev/null` is a no-op copy whose only
|
||||||
- `COPY --from=lint /src/go.sum /dev/null` is a no-op file copy that creates
|
purpose is the ordering edge. BuildKit runs stages in parallel by default,
|
||||||
a stage dependency. BuildKit runs stages in parallel by default; without
|
and a stage nothing depends on is not built at all, so without these two
|
||||||
this line, the build stage would not wait for lint to finish and a lint
|
lines a red gate would not fail the build.
|
||||||
failure might not fail the overall build.
|
- Keep the runtime stage last, and if you add a stage after it, give it the
|
||||||
|
same two copies. A plain `docker build .` builds the last stage's chain
|
||||||
|
and nothing else.
|
||||||
- If the project uses `//go:embed` directives that reference build artifacts
|
- If the project uses `//go:embed` directives that reference build artifacts
|
||||||
(e.g. a web frontend compiled in a separate stage), the lint stage must
|
(e.g. a web frontend compiled in a separate stage), the lint phase must
|
||||||
create placeholder files so the embed directives resolve. Example:
|
create placeholder files so the embed directives resolve. Example:
|
||||||
`RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css`.
|
`RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css`.
|
||||||
The lint stage should not depend on the actual build output — it exists to
|
|
||||||
fail fast.
|
|
||||||
- If the project requires CGO or system libraries for linting (e.g.
|
- If the project requires CGO or system libraries for linting (e.g.
|
||||||
`vips-dev`), install them in the lint stage with `apk add`.
|
`vips-dev`), install them in the lint phase with `apk add`.
|
||||||
- The build stage runs `make test` after compilation setup. Tests run in the
|
- `ARG VERSION=dev` is declared in the stage that compiles and supplied by
|
||||||
build stage, not the lint stage, because they may require compiled
|
`script/docker` and `script/cibuild`; no stage may call `git describe`.
|
||||||
artifacts or heavier dependencies.
|
|
||||||
|
|
||||||
- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that
|
- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that
|
||||||
runs `script/cibuild` (which runs `docker build .`) on push. Since the
|
runs `script/cibuild` on push, and checks out the repo as its only other step.
|
||||||
Dockerfile already runs `make check`, a successful build implies all checks
|
That script bootstraps, runs the gate phases, and then builds the image, so a
|
||||||
pass.
|
successful run means every check passed; a bare `docker build .` does not
|
||||||
|
carry the same guarantee, because its gate phases may come from the cache. The
|
||||||
|
image build is uncached and so runs the gate phases a second time. That is the
|
||||||
|
price of the rule above, and it is worth paying: the image that ships is built
|
||||||
|
from a run of its own gates rather than from a cache entry.
|
||||||
|
|
||||||
- Use platform-standard formatters: `black` for Python, `prettier` for
|
- Use platform-standard formatters: `black` for Python, `prettier` for
|
||||||
JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with
|
JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with
|
||||||
@@ -189,14 +253,21 @@ style conventions are in separate documents:
|
|||||||
module under test to verify it compiles/parses. There is no excuse for
|
module under test to verify it compiles/parses. There is no excuse for
|
||||||
`make test` to be a no-op.
|
`make test` to be a no-op.
|
||||||
|
|
||||||
- `make test` must complete in under 20 seconds. Add a 30-second timeout in the
|
- `make test` must complete in under 60 seconds. That is the hard cap, and a
|
||||||
Makefile.
|
suite that exceeds it fails. Under 20 seconds is the target. A suite between
|
||||||
|
20 and 60 seconds is still green, but the overage must be filed as an
|
||||||
|
improvement bug against that repo. Add a 90-second timeout to the test
|
||||||
|
invocation (`go test -timeout 90s`). The backstop deliberately sits above the
|
||||||
|
hard cap so that it catches a genuinely hung test rather than a merely slow
|
||||||
|
one.
|
||||||
|
|
||||||
- **`make test` should use the conditional verbose rerun pattern.** Run tests
|
- **The test command should use the conditional verbose rerun pattern.** Run
|
||||||
without `-v` (verbose) first. If tests fail, automatically rerun with `-v` to
|
tests without `-v` (verbose) first. If tests fail, automatically rerun with
|
||||||
show full output. This keeps CI logs and `docker build` output clean on
|
`-v` to show full output. This keeps CI logs and `docker build` output clean
|
||||||
success (just package/suite summaries) while providing full diagnostic detail
|
on success (just package/suite summaries) while providing full diagnostic
|
||||||
on failure (every test case, every assertion). The general shell pattern:
|
detail on failure (every test case, every assertion). The command lives in the
|
||||||
|
`test` phase of the `Dockerfile`, since `script/test` builds that phase; the
|
||||||
|
Makefile form below is the same pattern for any repo-local invocation:
|
||||||
|
|
||||||
```makefile
|
```makefile
|
||||||
test:
|
test:
|
||||||
@@ -209,11 +280,24 @@ style conventions are in separate documents:
|
|||||||
|
|
||||||
```makefile
|
```makefile
|
||||||
test:
|
test:
|
||||||
@go test -timeout 30s -race -cover ./... || \
|
@go test -count=1 -timeout 90s -race -cover ./... || \
|
||||||
{ echo "--- Rerunning with -v for details ---"; \
|
{ echo "--- Rerunning with -v for details ---"; \
|
||||||
go test -timeout 30s -race -v ./...; exit 1; }
|
go test -count=1 -timeout 90s -race -v ./...; exit 1; }
|
||||||
```
|
```
|
||||||
|
|
||||||
|
`-count=1` is required on both invocations: it defeats Go's test _result_
|
||||||
|
cache, so the target cannot report a pass it did not earn, and the rerun
|
||||||
|
reproduces a failure instead of replaying it. It leaves the build cache
|
||||||
|
alone, so it costs the runtime of the suite and no recompilation.
|
||||||
|
|
||||||
|
Note that this is a second, independent cache, stacked below the Docker
|
||||||
|
layer cache that [issue #26](https://git.eeqj.de/sneak/prompts/issues/26)
|
||||||
|
addresses. `CHECK_EPOCH` guarantees the `RUN make test` _step_ re-executes;
|
||||||
|
it does not guarantee `go test` inside that step does any work, because the
|
||||||
|
`GOCACHE` baked into earlier image layers survives into the re-executed
|
||||||
|
step. They are two separate defects requiring two separate fixes, and a fix
|
||||||
|
for one must not be recorded as covering the other.
|
||||||
|
|
||||||
Python example:
|
Python example:
|
||||||
|
|
||||||
```makefile
|
```makefile
|
||||||
@@ -239,10 +323,83 @@ style conventions are in separate documents:
|
|||||||
must be in `.gitignore`. No exceptions.
|
must be in `.gitignore`. No exceptions.
|
||||||
|
|
||||||
- `.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`, `*~`), language build artifacts, and `node_modules/`.
|
editor files (`.swp`, `*~`), in-repo agent scratch directories (`.claude/`),
|
||||||
Fetch the standard `.gitignore` from
|
language build artifacts, and `node_modules/`. Fetch the standard `.gitignore`
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when setting up
|
from `https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when
|
||||||
a new repo.
|
setting up a new repo. These patterns are written to `.gitignore`'s own
|
||||||
|
semantics, in which an unanchored pattern already matches at every depth; they
|
||||||
|
are not a `.dockerignore` and must not be transplanted into one unmodified.
|
||||||
|
|
||||||
|
- **`.dockerignore` does not use `.gitignore` semantics, and copying patterns
|
||||||
|
across unmodified leaves secrets in the build context.** Docker matches with
|
||||||
|
`moby/patternmatcher`: `filepath.Match` semantics plus a `**` extension, so
|
||||||
|
`*` does not cross `/` and a pattern without a leading `**/` is anchored at
|
||||||
|
the build-context root. A `.dockerignore` listing `.env`, `*.pem` and `*.key`
|
||||||
|
therefore excludes only the copies at the repository root, while `config/.env`
|
||||||
|
and `certs/server.key` still reach the context and can land in an image layer
|
||||||
|
— which is more dangerous than a short file with no secret patterns at all,
|
||||||
|
because it reads as solved and stops anyone looking. Give every
|
||||||
|
depth-independent pattern the `**/` prefix and leave only genuinely
|
||||||
|
root-anchored entries unprefixed: `.git`, and the repo's own host-built
|
||||||
|
binary, written `/myapp` and never `**/myapp`, which would also match
|
||||||
|
`cmd/myapp/` and delete the package directory from the context. Matching is
|
||||||
|
case-sensitive, and an ALL-CAPS twin per pattern still misses `Server.Key`, so
|
||||||
|
secret names use character ranges — `**/*.[kK][eE][yY]`, `**/*.[pP][eE][mM]`,
|
||||||
|
and likewise for `.envrc` and the extensionless SSH keys. Where such a pattern
|
||||||
|
also catches something the build needs, re-include it with a negation
|
||||||
|
(`!docs/example.env`); deleting the pattern reopens the exposure for every
|
||||||
|
other file it covers. Fetch the standard `.dockerignore` from
|
||||||
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.dockerignore` and extend
|
||||||
|
it with the repo's own artifacts.
|
||||||
|
|
||||||
|
- **In-repo agent scratch belongs in both files, written to each file's own
|
||||||
|
semantics.** `.claude/` holds one worktree per in-flight agent — an entire
|
||||||
|
additional checkout of the repo — so under `COPY . .` the build context
|
||||||
|
inflates by a multiple of the repo and another session's unreviewed work can
|
||||||
|
be copied into an image layer. In `.gitignore` the entry is `.claude/`,
|
||||||
|
unanchored. In `.dockerignore` it is `.claude`, anchored and with **no** `**/`
|
||||||
|
prefix, because the prefixed form would also delete any nested directory of
|
||||||
|
that name from the build. Anchoring carries a known gap that the canonical
|
||||||
|
`.dockerignore` states in its own comment, since consuming repos receive the
|
||||||
|
file and not the tracker: the directory is created in the agent's working
|
||||||
|
directory, so a repo running agents in subdirectories still ships
|
||||||
|
`services/api/.claude/` and must add its own anchored entry there.
|
||||||
|
|
||||||
|
- **Excluding `.git` means `git describe` cannot run inside any build stage, and
|
||||||
|
it fails quietly there.** In a build stage there is no repository, so
|
||||||
|
`git describe` writes nothing to stdout, `-X main.Version=` comes out empty,
|
||||||
|
the binary reports no version at all, and the build still exits 0. Compute the
|
||||||
|
version on the host and thread it in as a build arg. `script/docker` and
|
||||||
|
`script/cibuild` do this, byte-identically across repos:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Own line: a failing command substitution inside an argument does not
|
||||||
|
# trip `set -e`, so the inline form degrades to an empty constant.
|
||||||
|
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||||
|
[ -n "$version" ] || version="unknown"
|
||||||
|
docker build --no-cache \
|
||||||
|
--build-arg VERSION="$version" \
|
||||||
|
-t "$(script/projectname)" .
|
||||||
|
```
|
||||||
|
|
||||||
|
`--always` makes an untagged repo yield an abbreviated commit hash rather
|
||||||
|
than failing, and the `[ -n "$version" ]` line is the single place the
|
||||||
|
fallback is applied — a live check that fires on a build from an export with
|
||||||
|
no `.git` and on a repository with no commits yet. Do not fold it into the
|
||||||
|
substitution as `|| echo unknown`, which makes the guard unreachable. The
|
||||||
|
Dockerfile's side is `ARG VERSION=dev` in the stage that compiles, declared
|
||||||
|
there because `ARG` is stage-scoped; passing `VERSION` to a repo whose
|
||||||
|
Dockerfile declares no such `ARG` is ignored and costs nothing, which is why
|
||||||
|
the scripts stay byte-identical. One consequence for CI: the standard
|
||||||
|
checkout action clones shallow and fetches no tags, so a repo that embeds a
|
||||||
|
tag-derived version must set `fetch-depth: 0` on its checkout step.
|
||||||
|
|
||||||
|
- **Verify `.dockerignore` by enumerating the image, not by reading the
|
||||||
|
patterns.** Plant files at the root _and_ at least two directories deep, build
|
||||||
|
a probe image that does `COPY . .`, and list what actually landed
|
||||||
|
(`docker run --rm --entrypoint find IMAGE /app`). The `transferring context`
|
||||||
|
size is not a substitute: a nested secret is a few bytes, and BuildKit
|
||||||
|
transfers only the delta from the previous build.
|
||||||
|
|
||||||
- **No build artifacts in version control.** Code-derived data (compiled
|
- **No build artifacts in version control.** Code-derived data (compiled
|
||||||
bundles, minified output, generated assets) must never be committed to the
|
bundles, minified output, generated assets) must never be committed to the
|
||||||
@@ -258,9 +415,45 @@ style conventions are in separate documents:
|
|||||||
- Make all changes on a feature branch. You can do whatever you want on a
|
- Make all changes on a feature branch. You can do whatever you want on a
|
||||||
feature branch.
|
feature branch.
|
||||||
|
|
||||||
- `.golangci.yml` is standardized and must _NEVER_ be modified by an agent, only
|
- `.golangci.yml` is standardized. The vendored copy in a consuming repo must
|
||||||
manually by the user. Fetch from
|
_NEVER_ be modified by an agent: fetch it from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml`.
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml` and keep it
|
||||||
|
byte-identical, so that no repo can quietly loosen its own linting. Linter
|
||||||
|
configuration changes are made to the canonical copy in the `prompts` repo and
|
||||||
|
reach consuming repos by re-vendoring; an agent may open a PR against
|
||||||
|
canonical, which only the user merges. One list is exempt from byte-identity,
|
||||||
|
because it cannot be written once for every repo: the `deny` list of the
|
||||||
|
`test-support` depguard rule, where a repo names its own test-support packages
|
||||||
|
by full import path. A repo adds entries there and changes nothing else, and a
|
||||||
|
re-vendor carries its entries forward. The canonical golangci-lint version is
|
||||||
|
v2.12.2 (released 2026-05-06), pinned as the digest of the lint phase's base
|
||||||
|
image
|
||||||
|
(`golangci/golangci-lint@sha256:5cceeef04e53efe1470638d4b4b4f5ceefd574955ab3941b2d9a68a8c9ad5240`,
|
||||||
|
which reports `2.12.2 built with go1.26.2 from c0d3ddc9`). That digest is the
|
||||||
|
only pin, since no repo installs golangci-lint on the host: bumping the
|
||||||
|
version means changing it and nothing else.
|
||||||
|
|
||||||
|
- **`script/bootstrap` installs a pinned tool by comparing versions, never by
|
||||||
|
testing presence.** An `if ! command -v <tool>; then install; fi` guard tests
|
||||||
|
`PATH` only, so on an already-provisioned machine the pin is inert and a
|
||||||
|
version bump is a silent no-op — while the Dockerfile, installing into a clean
|
||||||
|
image, gets the pinned version, so a local `make check` and `make docker` can
|
||||||
|
disagree about what the tool even is. The canonical form:
|
||||||
|
- compares the installed version against the pin over the **whole** version
|
||||||
|
token; a parser that stops at the first `-` reports `2.12.2` for a host
|
||||||
|
running `2.12.2-rc1` and skips the install;
|
||||||
|
- treats absent, non-zero, empty or unrecognised `--version` output as a
|
||||||
|
mismatch, so the failure direction is a redundant install and never a
|
||||||
|
skipped one;
|
||||||
|
- after installing, re-resolves the binary the way callers do — `hash -r`,
|
||||||
|
then through `PATH`, not through the directory the installer wrote to —
|
||||||
|
and fails naming the resolved path, since an install that a shadowing
|
||||||
|
binary hides succeeds while changing nothing any caller sees;
|
||||||
|
- is actually called, and prints the version on both success paths: a
|
||||||
|
function defined and never invoked has the same exit status and the same
|
||||||
|
empty output as one that worked.
|
||||||
|
|
||||||
|
Keep it POSIX sh: no arrays, no `[[`, no `grep -P`.
|
||||||
|
|
||||||
- When pinning images or packages by hash, add a comment above the reference
|
- When pinning images or packages by hash, add a comment above the reference
|
||||||
with the version and date (YYYY-MM-DD).
|
with the version and date (YYYY-MM-DD).
|
||||||
@@ -379,7 +572,9 @@ style conventions are in separate documents:
|
|||||||
language-specific config). Everything else goes in a subdirectory. Canonical
|
language-specific config). Everything else goes in a subdirectory. Canonical
|
||||||
subdirectory names:
|
subdirectory names:
|
||||||
- `bin/` — executable scripts and tools
|
- `bin/` — executable scripts and tools
|
||||||
- `cmd/` — Go command entrypoints
|
- `cmd/` — Go command entrypoints; thin only: one `main.go` per binary whose
|
||||||
|
body is a single call into `internal/` or `pkg/`, no project logic in
|
||||||
|
`cmd/`
|
||||||
- `configs/` — configuration templates and examples
|
- `configs/` — configuration templates and examples
|
||||||
- `deploy/` — deployment manifests (k8s, compose, terraform)
|
- `deploy/` — deployment manifests (k8s, compose, terraform)
|
||||||
- `docs/` — documentation and markdown (README.md stays in root)
|
- `docs/` — documentation and markdown (README.md stays in root)
|
||||||
|
|||||||
@@ -14,17 +14,97 @@ pre-1.0
|
|||||||
|
|
||||||
# Next Step
|
# Next Step
|
||||||
|
|
||||||
Tag v1.0.0.
|
Store live photos in a form a photo viewer can open
|
||||||
|
(https://git.eeqj.de/sneak/quak/issues/107). This waits on sneak's choice
|
||||||
|
between keeping the ZIP and unpacking it into the image and the video.
|
||||||
|
|
||||||
|
Tagging and releases are decided by sneak alone, and happen only when he
|
||||||
|
declares one.
|
||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-09-23: Settled the package metadata (issue 6). quak is not published, so
|
||||||
|
`package.json` is marked `"private": true` and the `files` field is gone.
|
||||||
|
`engines.node` is `>=22`, the major version `script/bootstrap` and the
|
||||||
|
`Dockerfile` use. An `exports` map makes `.` and `./package.json` the only
|
||||||
|
importable paths; `runMetadataBackup`, the thumbnail helpers and their types
|
||||||
|
stay internal to the CLI.
|
||||||
|
|
||||||
|
- 2026-09-23: Brought the README and this file in line with the tree (issue
|
||||||
|
111). The layout lists `src/library/` and the other source files, the backup
|
||||||
|
layout names `failures.json` and the optional `thumbnails/`, "Opening a
|
||||||
|
library" says what happens when the first refresh fails, the Testing section
|
||||||
|
gives the 60-second hard cap and 20-second target for `make test` and names
|
||||||
|
the 90-second `timeout` in the `Dockerfile` as the backstop for a hung test,
|
||||||
|
and "Tag v1.0.0" is no longer listed as the next step.
|
||||||
|
|
||||||
|
- 2026-09-23: Tested `quak login` and `backup-metadata --exif` (issue 110).
|
||||||
|
`loginCommand` takes its login function and its prompts from `CliContext`, and
|
||||||
|
`bin/quak.ts` passes `Client.login` and the terminal prompts. Tests cover a
|
||||||
|
login from `QUAK_EMAIL` and `QUAK_PASSWORD` with no prompt, the TOTP prompt, a
|
||||||
|
failed login, and the saved session's modes, and show that `--exif` and
|
||||||
|
`--all` each turn on EXIF extraction and that it is off without them.
|
||||||
|
|
||||||
|
- 2026-09-23: `quak backup` writes each original once and no longer fills the
|
||||||
|
cache (issue 106). An original fetched for a backup is written by the download
|
||||||
|
writer straight into the backup's `originals/`, and the content cache records
|
||||||
|
it there instead of keeping its own copy; one the cache already held is still
|
||||||
|
copied. `quak backup` opens its library with the thumbnail and originals
|
||||||
|
precache off.
|
||||||
|
|
||||||
|
- 2026-09-23: `backup-metadata`, `helper list-missing-thumbnails` and
|
||||||
|
`helper fix-missing-thumbnails` refresh before they answer (issue 100). Each
|
||||||
|
awaits `lib.fresh()` before reading, so a file added since the cache was
|
||||||
|
written is included, and a failed refresh prints one line and exits 1 instead
|
||||||
|
of answering from a stale or empty cache. The README lists them among the
|
||||||
|
commands that refresh first.
|
||||||
|
|
||||||
|
- 2026-09-23: `quak backup` waits for the server refresh and fails when it fails
|
||||||
|
(issue 99). `lib.backup()` joins a refresh already running or starts one, as
|
||||||
|
`fresh()` does, and rejects before touching any file when it fails, leaving
|
||||||
|
`failures.json` as it was, so `quak backup` prints the error as one line and
|
||||||
|
exits 1 instead of backing up the previous run's file list, or nothing, and
|
||||||
|
exiting 0.
|
||||||
|
|
||||||
|
- 2026-09-23: CLI errors print a message instead of a stack trace (issue 102).
|
||||||
|
An error a command throws is printed as one `quak: MESSAGE` line on stderr and
|
||||||
|
the CLI exits 1 once output has drained. The wrapper that does this moved from
|
||||||
|
`bin/quak.ts` to `src/cli-run.ts`, and `bin/quak.ts` now awaits
|
||||||
|
`program.parseAsync()`.
|
||||||
|
|
||||||
- 2026-09-23: Opening a library no longer deletes another process's download in
|
- 2026-09-23: Opening a library no longer deletes another process's download in
|
||||||
progress (issue 105). The download writer's temp files are named
|
progress (issue 105). The download writer's temp files are named
|
||||||
`.quak-<pid>-<random>.tmp`, and `removeLeftoverTempFiles`, moved from the
|
`.quak-<pid>-<random>.tmp`, and `removeLeftoverTempFiles`, moved from the
|
||||||
backup into the download module, deletes a `.quak-*.tmp` file only when the
|
backup into the download module, deletes a `.quak-*.tmp` file only when the
|
||||||
process ID in its name is no longer running. The content cache calls it at
|
process ID in its name is no longer running. The content cache calls it at
|
||||||
`open()` for `originals/` and `thumbnails/`, the backup as before. Temp files
|
`open()` for `originals/` and `thumbnails/`, the backup as before.
|
||||||
written before this change carry no process ID and are no longer deleted.
|
|
||||||
|
- 2026-09-23: Re-vendored the lint and test setup from the template (issue 96).
|
||||||
|
Linting and testing are the `lint` and `test` phases of the `Dockerfile`;
|
||||||
|
`script/lint` and `script/test` each build one with `--no-cache`, and the last
|
||||||
|
stage compiles and depends on both, so `script/cibuild` is one build.
|
||||||
|
`Dockerfile.lint`, `CHECK_EPOCH`, `LINT_EPOCH` and the tests that checked them
|
||||||
|
are gone; `REPO_POLICIES.md` is re-copied.
|
||||||
|
|
||||||
|
- 2026-09-23: Stopped `helper fix-missing-thumbnails` retrying files the server
|
||||||
|
always refuses (issue 109). Both thumbnail helpers skip a file another account
|
||||||
|
owns without fetching it. The fixer skips a file whose recorded thumbnail size
|
||||||
|
is 0 or unknown before downloading it, and otherwise tries smaller encodings
|
||||||
|
(720 px quality 50 down to 160 px quality 20) until the encrypted thumbnail is
|
||||||
|
no larger than that size, skipping the file if none fits.
|
||||||
|
|
||||||
|
- 2026-09-23: Tested the live-photo hash check's error paths (issue 117). Tests
|
||||||
|
download a live photo whose ZIP names an unknown compression method, one whose
|
||||||
|
ZIP has no image entry and one with no video entry, and check that nothing is
|
||||||
|
stored and the error names the file ID; the unreadable one is not retried.
|
||||||
|
|
||||||
|
- 2026-09-23: `quak logout` ends the session on the server (issue 108). It calls
|
||||||
|
`POST /users/logout` through the new `Client.logoutOnServer()`, then deletes
|
||||||
|
`session.json` even when that call fails, says so and exits 1. It prints the
|
||||||
|
account's cache directory and says it still holds decrypted data. The default
|
||||||
|
cache path is now `defaultCacheDirectory()` in the library, shared with
|
||||||
|
`Library.open`.
|
||||||
|
|
||||||
- 2026-09-23: Fixed the backup's per-collection folders (issue 103). Two files
|
- 2026-09-23: Fixed the backup's per-collection folders (issue 103). Two files
|
||||||
in one collection with the same title, and two collections with the same name,
|
in one collection with the same title, and two collections with the same name,
|
||||||
each get their ID added to the name (`IMG_0001 (12345).JPG`, `Trip (10)/`), so
|
each get their ID added to the name (`IMG_0001 (12345).JPG`, `Trip (10)/`), so
|
||||||
@@ -32,6 +112,7 @@ Tag v1.0.0.
|
|||||||
`originals/` for files no longer in the collection, and the folders of deleted
|
`originals/` for files no longer in the collection, and the folders of deleted
|
||||||
or renamed collections, leaving anything else in `collections/` alone. The
|
or renamed collections, leaving anything else in `collections/` alone. The
|
||||||
README backup layout states the naming rule.
|
README backup layout states the naming rule.
|
||||||
|
|
||||||
- 2026-09-23: Checked downloaded originals against their recorded content hash
|
- 2026-09-23: Checked downloaded originals against their recorded content hash
|
||||||
(issue 68). `downloadFile`, which `quak get`, the content cache and backup all
|
(issue 68). `downloadFile`, which `quak get`, the content cache and backup all
|
||||||
use, hashes the decrypted bytes (unkeyed BLAKE2b-512, standard base64) and
|
use, hashes the decrypted bytes (unkeyed BLAKE2b-512, standard base64) and
|
||||||
@@ -40,12 +121,14 @@ Tag v1.0.0.
|
|||||||
hashed separately as `<imageHash>:<videoHash>`. `decryptFile` reads older
|
hashed separately as `<imageHash>:<videoHash>`. `decryptFile` reads older
|
||||||
clients' `imageHash` and `videoHash` fields for live photos. A file with no
|
clients' `imageHash` and `videoHash` fields for live photos. A file with no
|
||||||
recorded hash is stored unchecked.
|
recorded hash is stored unchecked.
|
||||||
|
|
||||||
- 2026-09-23: Kept one account's cache from mixing with another's (issue 104).
|
- 2026-09-23: Kept one account's cache from mixing with another's (issue 104).
|
||||||
When `metadata.json` in the cache directory was written for a different,
|
When `metadata.json` in the cache directory was written for a different,
|
||||||
non-zero user ID than the client's, `Library.open` deletes it and `mldata/`
|
non-zero user ID than the client's, `Library.open` deletes it and `mldata/`
|
||||||
and starts empty, so the first refresh enumerates from 0. This only happens
|
and starts empty, so the first refresh enumerates from 0. This only happens
|
||||||
with `--cache-dir` or an explicit `cacheDirectory`; the default path already
|
with `--cache-dir` or an explicit `cacheDirectory`; the default path already
|
||||||
includes the user ID. A test opens one account's cache as another account.
|
includes the user ID. A test opens one account's cache as another account.
|
||||||
|
|
||||||
- 2026-09-23: `backup-metadata` no longer stops on one failed ML data request
|
- 2026-09-23: `backup-metadata` no longer stops on one failed ML data request
|
||||||
(issue 101). Each request of up to 200 files is tried on its own; a failed one
|
(issue 101). Each request of up to 200 files is tried on its own; a failed one
|
||||||
is logged, its files are written with the reason in `mlDataError`, and the
|
is logged, its files are written with the reason in `mlDataError`, and the
|
||||||
|
|||||||
+10
-19
@@ -1,6 +1,7 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
|
|
||||||
import { stdout, stderr } from "node:process";
|
import { stdout, stderr } from "node:process";
|
||||||
|
import { input, password } from "@inquirer/prompts";
|
||||||
import { Command } from "commander";
|
import { Command } from "commander";
|
||||||
import envPaths from "env-paths";
|
import envPaths from "env-paths";
|
||||||
import { init } from "../src/crypto/index.js";
|
import { init } from "../src/crypto/index.js";
|
||||||
@@ -18,7 +19,9 @@ import {
|
|||||||
listMissingThumbnailsCommand,
|
listMissingThumbnailsCommand,
|
||||||
fixMissingThumbnailsCommand,
|
fixMissingThumbnailsCommand,
|
||||||
} from "../src/cli-commands.js";
|
} from "../src/cli-commands.js";
|
||||||
|
import { run as runCommand } from "../src/cli-run.js";
|
||||||
import { loadSession } from "../src/cli-session.js";
|
import { loadSession } from "../src/cli-session.js";
|
||||||
|
import { Client } from "../src/client.js";
|
||||||
import { VERSION } from "../src/index.js";
|
import { VERSION } from "../src/index.js";
|
||||||
|
|
||||||
const paths = envPaths("quak", { suffix: "" });
|
const paths = envPaths("quak", { suffix: "" });
|
||||||
@@ -41,25 +44,13 @@ const context = (): CliContext => ({
|
|||||||
sessionDir: paths.data,
|
sessionDir: paths.data,
|
||||||
cacheDir: program.opts<{ cacheDir?: string }>().cacheDir,
|
cacheDir: program.opts<{ cacheDir?: string }>().cacheDir,
|
||||||
loadSession,
|
loadSession,
|
||||||
|
login: (opts) => Client.login(opts),
|
||||||
|
prompt: (message) => input({ message }),
|
||||||
|
promptSecret: (message) => password({ message, mask: true }),
|
||||||
});
|
});
|
||||||
|
|
||||||
// Run a command and exit with its code once stdout/stderr have drained.
|
const run = (command: Promise<number>): Promise<void> =>
|
||||||
// Exiting before the drain can truncate piped output, and the library can keep
|
runCommand(command, stdout, stderr, (code) => process.exit(code));
|
||||||
// the event loop alive after a command returns, so a plain return could hang.
|
|
||||||
const run = async (command: Promise<number>): Promise<void> => {
|
|
||||||
process.exitCode = await command;
|
|
||||||
const pending = [stdout, stderr].filter((s) => s.writableLength > 0);
|
|
||||||
if (pending.length === 0) {
|
|
||||||
process.exit();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
let remaining = pending.length;
|
|
||||||
for (const s of pending) {
|
|
||||||
s.once("drain", () => {
|
|
||||||
if (--remaining === 0) process.exit();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
program
|
program
|
||||||
.command("login")
|
.command("login")
|
||||||
@@ -73,7 +64,7 @@ program
|
|||||||
|
|
||||||
program
|
program
|
||||||
.command("logout")
|
.command("logout")
|
||||||
.description("Delete the saved session")
|
.description("End the session on the server and delete the saved session")
|
||||||
.action(() => run(logoutCommand(context())));
|
.action(() => run(logoutCommand(context())));
|
||||||
|
|
||||||
program
|
program
|
||||||
@@ -169,4 +160,4 @@ helper
|
|||||||
);
|
);
|
||||||
|
|
||||||
await init();
|
await init();
|
||||||
program.parse();
|
await program.parseAsync();
|
||||||
|
|||||||
+11
-5
@@ -9,17 +9,23 @@
|
|||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://git.eeqj.de/sneak/quak.git"
|
"url": "https://git.eeqj.de/sneak/quak.git"
|
||||||
},
|
},
|
||||||
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=22"
|
||||||
|
},
|
||||||
"main": "./dist/src/index.js",
|
"main": "./dist/src/index.js",
|
||||||
"types": "./dist/src/index.d.ts",
|
"types": "./dist/src/index.d.ts",
|
||||||
|
"exports": {
|
||||||
|
".": {
|
||||||
|
"types": "./dist/src/index.d.ts",
|
||||||
|
"import": "./dist/src/index.js"
|
||||||
|
},
|
||||||
|
"./package.json": "./package.json"
|
||||||
|
},
|
||||||
"bin": {
|
"bin": {
|
||||||
"quak": "./dist/bin/quak.js"
|
"quak": "./dist/bin/quak.js"
|
||||||
},
|
},
|
||||||
"files": [
|
|
||||||
"dist/",
|
|
||||||
"README.md",
|
|
||||||
"LICENSE"
|
|
||||||
],
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "script/build",
|
"build": "script/build",
|
||||||
"quak": "node ./dist/bin/quak.js",
|
"quak": "node ./dist/bin/quak.js",
|
||||||
|
|||||||
+5
-13
@@ -1,19 +1,11 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/check: run all checks (test, lint). Our own extension to
|
# script/check: run all checks (test, lint). Our own extension to
|
||||||
# scripts-to-rule-them-all. Must not modify any files.
|
# scripts-to-rule-them-all. Both are Docker phases. Must not modify any
|
||||||
|
# files.
|
||||||
#
|
#
|
||||||
# The formatting check is part of lint, not a step of its own:
|
# script/fmt-check is not called here, unlike the template: the lint
|
||||||
# script/lint builds Dockerfile.lint, which runs eslint AND
|
# phase already runs `prettier --check .`, so calling it would run
|
||||||
# `prettier --check .` as build steps. Calling script/fmt-check here as
|
# prettier a second time over the same tree for the same verdict.
|
||||||
# well would run prettier a second time over the same tree for the same
|
|
||||||
# verdict — the weaker of the two, since the host toolchain is whatever
|
|
||||||
# the working tree happens to have installed while the container's is
|
|
||||||
# digest-pinned. script/fmt-check remains a standalone entrypoint for
|
|
||||||
# asking the formatting question by itself.
|
|
||||||
#
|
|
||||||
# script/lint builds Dockerfile.lint, so this script requires docker and
|
|
||||||
# must never be run from inside a container: that is why the Dockerfile
|
|
||||||
# image runs script/test and script/build rather than this.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
|||||||
+17
-13
@@ -1,15 +1,11 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/cibuild: run the CI build, which is both images in a defined order.
|
# script/cibuild: run the CI build. The image's last stage depends on the
|
||||||
#
|
# lint and test phases, so this one build runs eslint, prettier and the
|
||||||
# First script/lint, which builds Dockerfile.lint and is the one and only
|
# suite once each and then compiles. Unlike the template it does not run
|
||||||
# place linting happens — it goes first so a lint failure is reported before
|
# script/check first, which would run lint and the tests a second time.
|
||||||
# the slower suite runs. Then the Dockerfile image, which runs script/test
|
# --no-cache for the same reason as script/docker: the gate phases the
|
||||||
# and script/build. CHECK_EPOCH and LINT_EPOCH differ on every invocation, so
|
# final stage depends on are RUN steps, and a cached one is a check that
|
||||||
# neither the linters nor the suite can be served from Docker's cache: a
|
# did not run.
|
||||||
# green build here means the checks ran now, not that a previous run was
|
|
||||||
# remembered. The layers below the epochs (bootstrap, yarn install) are
|
|
||||||
# unaffected and stay cached. A build that omits the arguments fails by
|
|
||||||
# design.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
@@ -17,8 +13,16 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
"$SCRIPT_DIR/lint"
|
# Own line: a failing command substitution inside an argument does
|
||||||
docker build --build-arg CHECK_EPOCH="$(date +%s)" .
|
# not trip `set -e`, so the inline form degrades silently to an
|
||||||
|
# empty constant. VERSION is computed here because .dockerignore
|
||||||
|
# excludes .git, so `git describe` in a build stage yields an empty
|
||||||
|
# version without failing.
|
||||||
|
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||||
|
[ -n "$version" ] || version="unknown"
|
||||||
|
docker build --no-cache \
|
||||||
|
--build-arg VERSION="$version" \
|
||||||
|
-t "$("$SCRIPT_DIR/projectname")" .
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+11
-5
@@ -1,10 +1,8 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/docker: build the Docker image tagged with the project name.
|
# script/docker: build the Docker image tagged with the project name.
|
||||||
# Identical in all repos; the tag comes from script/projectname.
|
# Identical in all repos; the tag comes from script/projectname.
|
||||||
# CHECK_EPOCH is passed for the same reason script/cibuild passes it: the
|
# --no-cache because the gate phases the final stage depends on are RUN
|
||||||
# Dockerfile refuses to build without it, so that no path to an image can
|
# steps, and a cached one is a check that did not run.
|
||||||
# quietly serve the test and build layers from cache. This builds the test
|
|
||||||
# and build image only; linting is a separate image, built by script/lint.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
@@ -12,7 +10,15 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
docker build --build-arg CHECK_EPOCH="$(date +%s)" \
|
# Own line: a failing command substitution inside an argument does
|
||||||
|
# not trip `set -e`, so the inline form degrades silently to an
|
||||||
|
# empty constant. VERSION is computed here because .dockerignore
|
||||||
|
# excludes .git, so `git describe` in a build stage yields an empty
|
||||||
|
# version without failing.
|
||||||
|
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||||
|
[ -n "$version" ] || version="unknown"
|
||||||
|
docker build --no-cache \
|
||||||
|
--build-arg VERSION="$version" \
|
||||||
-t "$("$SCRIPT_DIR/projectname")" .
|
-t "$("$SCRIPT_DIR/projectname")" .
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+13
-14
@@ -1,24 +1,23 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/lint: run the linters. eslint and prettier are never run against
|
# script/lint: run the linter. Linting is a phase of the Dockerfile and
|
||||||
# the working tree from here: linting runs via docker only, one way,
|
# this builds that phase alone; the linter is never installed or run on
|
||||||
# everywhere — script/lint builds Dockerfile.lint, which COPYs the repo into
|
# a developer host, where a shared result cache and a host-global lock
|
||||||
# the pinned node image and runs the linters as build steps. That works even
|
# make its answer untrustworthy.
|
||||||
# when the docker daemon is remote and bind mounts are impossible.
|
|
||||||
#
|
#
|
||||||
# LINT_EPOCH is passed on every invocation because no lint cache is wanted:
|
# The phase is not the last stage in the file, so it is built only when
|
||||||
# on an unchanged tree Docker would otherwise serve the linter layers, having
|
# --target names it. --no-cache because a cached lint layer is a lint
|
||||||
# linted nothing, and still exit 0. Dockerfile.lint refuses to build without
|
# that did not run. The tag makes each build replace the previous image
|
||||||
# the argument, so no path to a lint result can quietly come from cache.
|
# instead of leaving a dangling one behind.
|
||||||
#
|
|
||||||
# Nothing that runs inside a container may call this script; see the header
|
|
||||||
# of Dockerfile.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
docker build --build-arg LINT_EPOCH="$(date +%s)" -f Dockerfile.lint .
|
docker build --no-cache \
|
||||||
|
--target lint \
|
||||||
|
-t "$("$SCRIPT_DIR/projectname")-lint" .
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+3
-11
@@ -4,17 +4,9 @@
|
|||||||
#
|
#
|
||||||
# Runs lint but deliberately NOT the tests, so the TDD red-phase commit
|
# Runs lint but deliberately NOT the tests, so the TDD red-phase commit
|
||||||
# (failing tests, no implementation yet) can land. CI runs
|
# (failing tests, no implementation yet) can land. CI runs
|
||||||
# script/cibuild, which builds both images and so catches any branch
|
# script/cibuild, whose image build includes the test phase, and so
|
||||||
# that ships red.
|
# catches any branch that ships red. The lint phase includes the
|
||||||
#
|
# prettier check, so a badly formatted tree still fails the commit.
|
||||||
# The formatting check is still enforced here, because script/lint is a
|
|
||||||
# build of Dockerfile.lint and that runs `prettier --check .` as a build
|
|
||||||
# step: a badly formatted tree fails this hook, and therefore the
|
|
||||||
# commit. Calling script/fmt-check as well would only run prettier a
|
|
||||||
# second time over the same tree for the same verdict.
|
|
||||||
#
|
|
||||||
# script/lint is a docker build (Dockerfile.lint); docker is required to
|
|
||||||
# commit, which is the point of linting one way, everywhere.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
|||||||
+10
-16
@@ -1,25 +1,19 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/test: run the test suite. Uses `timeout` (GNU coreutils) when
|
# script/test: run the test suite. Testing is a phase of the Dockerfile
|
||||||
# available so the run is hard-capped at 30s; on macOS without
|
# and this builds that phase alone, on the same terms as script/lint:
|
||||||
# coreutils the cap is skipped.
|
# --target because a phase that is not the last stage is built only when
|
||||||
|
# named, --no-cache because a cached test layer is a test that did not
|
||||||
|
# run, and a tag so each build replaces the previous image.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||||
rerun_verbose() {
|
|
||||||
echo "--- Rerunning with verbose for details ---"
|
|
||||||
yarn run vitest run --reporter=verbose
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
TIMEOUT="$(command -v timeout 2>/dev/null || command -v gtimeout 2>/dev/null || true)"
|
docker build --no-cache \
|
||||||
if [ -n "$TIMEOUT" ]; then
|
--target test \
|
||||||
"$TIMEOUT" 30s yarn run vitest run --reporter=dot || rerun_verbose
|
-t "$("$SCRIPT_DIR/projectname")-test" .
|
||||||
else
|
|
||||||
yarn run vitest run --reporter=dot || rerun_verbose
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+12
-7
@@ -1,9 +1,11 @@
|
|||||||
// The backup command, rebuilt on the library API (issue #51).
|
// The backup command, rebuilt on the library API (issue #51).
|
||||||
//
|
//
|
||||||
// `lib.backup()` refreshes the library, then, for every file in scope, gets its
|
// `lib.backup()` waits for a completed refresh of the library (a failed one
|
||||||
// original bytes onto disk under `downloadDirectory` and rebuilds the derived
|
// fails the backup before any file is touched), then, for every file in scope,
|
||||||
// views (per-file sidecars, per-collection symlink trees, per-collection JSON)
|
// gets its original bytes onto disk under `downloadDirectory` and rebuilds the
|
||||||
// from the model. The on-disk layout is the historical one, unchanged:
|
// derived views (per-file sidecars, per-collection symlink trees,
|
||||||
|
// per-collection JSON) from the model. The on-disk layout is the historical
|
||||||
|
// one, unchanged:
|
||||||
//
|
//
|
||||||
// <downloadDirectory>/
|
// <downloadDirectory>/
|
||||||
// originals/<fileID>.<ext> the decrypted bytes
|
// originals/<fileID>.<ext> the decrypted bytes
|
||||||
@@ -95,8 +97,9 @@ export interface BackupLibrary {
|
|||||||
listCollections(): Collection[];
|
listCollections(): Collection[];
|
||||||
listFiles(collectionID: number): EnteFile[];
|
listFiles(collectionID: number): EnteFile[];
|
||||||
// Get an original's bytes onto disk through the content cache/pools,
|
// Get an original's bytes onto disk through the content cache/pools,
|
||||||
// returning where they landed (the cache, or a prior backup).
|
// returning where they landed: `destination` when they were fetched now,
|
||||||
original(fileID: number): Promise<{ path: string }>;
|
// otherwise wherever they already were (the cache, or a prior backup).
|
||||||
|
original(fileID: number, destination: string): Promise<{ path: string }>;
|
||||||
thumbnail(fileID: number): Promise<{ path: string }>;
|
thumbnail(fileID: number): Promise<{ path: string }>;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -423,7 +426,9 @@ export const runBackup = async (
|
|||||||
}
|
}
|
||||||
try {
|
try {
|
||||||
log(`Fetching original ${file.metadata.title} (${fileID})...`);
|
log(`Fetching original ${file.metadata.title} (${fileID})...`);
|
||||||
const { path } = await lib.original(fileID);
|
// A fetched original is written straight to `dest`; only one
|
||||||
|
// that was already cached elsewhere is copied.
|
||||||
|
const { path } = await lib.original(fileID, dest);
|
||||||
await copyAtomic(path, dest);
|
await copyAtomic(path, dest);
|
||||||
downloaded++;
|
downloaded++;
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
|||||||
+72
-22
@@ -2,11 +2,10 @@
|
|||||||
//
|
//
|
||||||
// Each command takes its options and a `CliContext` and resolves to the exit
|
// Each command takes its options and a `CliContext` and resolves to the exit
|
||||||
// code; a thrown error is left to the caller. Nothing here calls
|
// code; a thrown error is left to the caller. Nothing here calls
|
||||||
// `process.exit`: `bin/quak.ts` wires these to the command line and exits with
|
// `process.exit`: `bin/quak.ts` wires these to the command line, and `run` in
|
||||||
// the returned code once output has drained. Output must stay byte-identical
|
// `cli-run.ts` prints a thrown error as one line and exits once output has
|
||||||
// (see `cli-output.ts`).
|
// drained. Output must stay byte-identical (see `cli-output.ts`).
|
||||||
|
|
||||||
import { input, password as passwordPrompt } from "@inquirer/prompts";
|
|
||||||
import {
|
import {
|
||||||
copyFileSync,
|
copyFileSync,
|
||||||
existsSync,
|
existsSync,
|
||||||
@@ -15,9 +14,17 @@ import {
|
|||||||
writeFileSync,
|
writeFileSync,
|
||||||
} from "node:fs";
|
} from "node:fs";
|
||||||
import { join } from "node:path";
|
import { join } from "node:path";
|
||||||
import { Client, type ClientSnapshot } from "./client.js";
|
import {
|
||||||
|
type Client,
|
||||||
|
type ClientSnapshot,
|
||||||
|
type LoginOptions,
|
||||||
|
} from "./client.js";
|
||||||
import { init } from "./crypto/index.js";
|
import { init } from "./crypto/index.js";
|
||||||
import { Library, type LibraryClient } from "./library/index.js";
|
import {
|
||||||
|
defaultCacheDirectory,
|
||||||
|
Library,
|
||||||
|
type LibraryClient,
|
||||||
|
} from "./library/index.js";
|
||||||
import {
|
import {
|
||||||
fileListRow,
|
fileListRow,
|
||||||
fileListLine,
|
fileListLine,
|
||||||
@@ -39,6 +46,12 @@ export interface CliContext {
|
|||||||
// Reads the session file into a client, or null when there is none. The
|
// Reads the session file into a client, or null when there is none. The
|
||||||
// CLI passes `loadSession` from `cli-session.ts`; tests pass a fake client.
|
// CLI passes `loadSession` from `cli-session.ts`; tests pass a fake client.
|
||||||
loadSession: (path: string) => Client | null;
|
loadSession: (path: string) => Client | null;
|
||||||
|
// Used by `login` only. The CLI passes `Client.login` and terminal
|
||||||
|
// prompts; tests pass fakes.
|
||||||
|
login: (opts: LoginOptions) => Promise<Client>;
|
||||||
|
prompt: (message: string) => Promise<string>;
|
||||||
|
// Like `prompt`, but the answer is masked as it is typed.
|
||||||
|
promptSecret: (message: string) => Promise<string>;
|
||||||
}
|
}
|
||||||
|
|
||||||
const sessionPath = (ctx: CliContext): string =>
|
const sessionPath = (ctx: CliContext): string =>
|
||||||
@@ -104,24 +117,19 @@ const openReadLibrary = (ctx: CliContext, client: Client): Promise<Library> =>
|
|||||||
precacheOriginals: false,
|
precacheOriginals: false,
|
||||||
});
|
});
|
||||||
|
|
||||||
const prompt = async (message: string): Promise<string> => input({ message });
|
|
||||||
|
|
||||||
const promptSecret = async (message: string): Promise<string> =>
|
|
||||||
passwordPrompt({ message, mask: true });
|
|
||||||
|
|
||||||
export const loginCommand = async (ctx: CliContext): Promise<number> => {
|
export const loginCommand = async (ctx: CliContext): Promise<number> => {
|
||||||
await init();
|
await init();
|
||||||
const email = process.env.QUAK_EMAIL ?? (await prompt("Email"));
|
const email = process.env.QUAK_EMAIL ?? (await ctx.prompt("Email"));
|
||||||
const password =
|
const password =
|
||||||
process.env.QUAK_PASSWORD ?? (await promptSecret("Password"));
|
process.env.QUAK_PASSWORD ?? (await ctx.promptSecret("Password"));
|
||||||
|
|
||||||
ctx.stderr.write("Authenticating...\n");
|
ctx.stderr.write("Authenticating...\n");
|
||||||
try {
|
try {
|
||||||
const client = await Client.login({
|
const client = await ctx.login({
|
||||||
email,
|
email,
|
||||||
password,
|
password,
|
||||||
totp: async () => prompt("TOTP code: "),
|
totp: async () => ctx.prompt("TOTP code: "),
|
||||||
emailOTP: async () => prompt("Email verification code: "),
|
emailOTP: async () => ctx.prompt("Email verification code: "),
|
||||||
});
|
});
|
||||||
|
|
||||||
saveSession(ctx.sessionDir, client.toJSON());
|
saveSession(ctx.sessionDir, client.toJSON());
|
||||||
@@ -146,14 +154,43 @@ export const whoamiCommand = async (ctx: CliContext): Promise<number> => {
|
|||||||
return 0;
|
return 0;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// Ends the session on the server, then deletes the session file even when that
|
||||||
|
// failed, and exits 1 if it did. The cache is left in place; the user is told
|
||||||
|
// where it is.
|
||||||
export const logoutCommand = async (ctx: CliContext): Promise<number> => {
|
export const logoutCommand = async (ctx: CliContext): Promise<number> => {
|
||||||
if (existsSync(sessionPath(ctx))) {
|
const path = sessionPath(ctx);
|
||||||
unlinkSync(sessionPath(ctx));
|
if (!existsSync(path)) {
|
||||||
ctx.stderr.write("Session deleted.\n");
|
|
||||||
} else {
|
|
||||||
ctx.stderr.write("No session found.\n");
|
ctx.stderr.write("No session found.\n");
|
||||||
}
|
|
||||||
return 0;
|
return 0;
|
||||||
|
}
|
||||||
|
await init();
|
||||||
|
let cacheDir = ctx.cacheDir;
|
||||||
|
let failure: string | undefined;
|
||||||
|
try {
|
||||||
|
const client = ctx.loadSession(path);
|
||||||
|
if (client) {
|
||||||
|
cacheDir ??= defaultCacheDirectory(client.whoami().userID);
|
||||||
|
await client.logoutOnServer();
|
||||||
|
client.logout();
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
failure = err instanceof Error ? err.message : String(err);
|
||||||
|
}
|
||||||
|
unlinkSync(path);
|
||||||
|
if (failure === undefined) {
|
||||||
|
ctx.stderr.write("Session ended on the server.\n");
|
||||||
|
} else {
|
||||||
|
ctx.stderr.write(
|
||||||
|
`Could not end the session on the server: ${failure}\n`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
ctx.stderr.write("Session deleted.\n");
|
||||||
|
if (cacheDir !== undefined) {
|
||||||
|
ctx.stderr.write(
|
||||||
|
`Cache directory ${cacheDir} still holds decrypted data; delete it to remove that data.\n`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return failure === undefined ? 0 : 1;
|
||||||
};
|
};
|
||||||
|
|
||||||
export const collectionsCommand = async (
|
export const collectionsCommand = async (
|
||||||
@@ -323,6 +360,9 @@ export const backupMetadataCommand = async (
|
|||||||
if (!client) return 1;
|
if (!client) return 1;
|
||||||
const lib = await openReadLibrary(ctx, client);
|
const lib = await openReadLibrary(ctx, client);
|
||||||
try {
|
try {
|
||||||
|
// Refresh first so the dump holds current account state, not what the
|
||||||
|
// cache last held; a failed refresh throws.
|
||||||
|
await lib.fresh();
|
||||||
const { failedMLBatches } = await runMetadataBackup(lib, client, dir, {
|
const { failedMLBatches } = await runMetadataBackup(lib, client, dir, {
|
||||||
exif: opts.exif || opts.all,
|
exif: opts.exif || opts.all,
|
||||||
onProgress: (msg) => ctx.stderr.write(msg + "\n"),
|
onProgress: (msg) => ctx.stderr.write(msg + "\n"),
|
||||||
@@ -343,10 +383,14 @@ export const backupCommand = async (
|
|||||||
if (!client) return 1;
|
if (!client) return 1;
|
||||||
|
|
||||||
ctx.stderr.write("Starting backup...\n");
|
ctx.stderr.write("Starting backup...\n");
|
||||||
|
// The precache is off: the backup fetches what it needs, and must not
|
||||||
|
// also fill the cache with every thumbnail and the recent originals.
|
||||||
const lib = await Library.open({
|
const lib = await Library.open({
|
||||||
client,
|
client,
|
||||||
downloadDirectory: dir,
|
downloadDirectory: dir,
|
||||||
cacheDirectory: ctx.cacheDir,
|
cacheDirectory: ctx.cacheDir,
|
||||||
|
precacheThumbnails: false,
|
||||||
|
precacheOriginals: false,
|
||||||
});
|
});
|
||||||
try {
|
try {
|
||||||
const result = await lib.backup({
|
const result = await lib.backup({
|
||||||
@@ -389,6 +433,9 @@ export const listMissingThumbnailsCommand = async (
|
|||||||
if (!client) return 1;
|
if (!client) return 1;
|
||||||
const lib = await openReadLibrary(ctx, client);
|
const lib = await openReadLibrary(ctx, client);
|
||||||
try {
|
try {
|
||||||
|
// Refresh first so files added since the cache was written are
|
||||||
|
// checked; a failed refresh throws.
|
||||||
|
await lib.fresh();
|
||||||
const missing = await listMissingThumbnails(lib, client, (msg) => {
|
const missing = await listMissingThumbnails(lib, client, (msg) => {
|
||||||
if (!opts.json) ctx.stderr.write(msg + "\n");
|
if (!opts.json) ctx.stderr.write(msg + "\n");
|
||||||
});
|
});
|
||||||
@@ -424,6 +471,9 @@ export const fixMissingThumbnailsCommand = async (
|
|||||||
if (!client) return 1;
|
if (!client) return 1;
|
||||||
const lib = await openReadLibrary(ctx, client);
|
const lib = await openReadLibrary(ctx, client);
|
||||||
try {
|
try {
|
||||||
|
// Refresh first so files added since the cache was written are found;
|
||||||
|
// a failed refresh throws.
|
||||||
|
await lib.fresh();
|
||||||
let fileIDs: number[];
|
let fileIDs: number[];
|
||||||
if (opts.file && opts.file.length > 0) {
|
if (opts.file && opts.file.length > 0) {
|
||||||
fileIDs = opts.file.map(Number).filter(Number.isFinite);
|
fileIDs = opts.file.map(Number).filter(Number.isFinite);
|
||||||
@@ -462,7 +512,7 @@ export const fixMissingThumbnailsCommand = async (
|
|||||||
ctx.stderr.write(` Skipped: ${skipped}\n`);
|
ctx.stderr.write(` Skipped: ${skipped}\n`);
|
||||||
ctx.stderr.write(` Failed: ${failed}\n`);
|
ctx.stderr.write(` Failed: ${failed}\n`);
|
||||||
if (skipped > 0) {
|
if (skipped > 0) {
|
||||||
ctx.stderr.write("\nSkipped (unsupported format):\n");
|
ctx.stderr.write("\nSkipped:\n");
|
||||||
for (const r of results.filter((r) => r.status === "skipped")) {
|
for (const r of results.filter((r) => r.status === "skipped")) {
|
||||||
ctx.stderr.write(
|
ctx.stderr.write(
|
||||||
` ${r.fileID}\t${r.title}\t${r.reason}\n`,
|
` ${r.fileID}\t${r.title}\t${r.reason}\n`,
|
||||||
|
|||||||
@@ -0,0 +1,36 @@
|
|||||||
|
// Runs one CLI command for `bin/quak.ts` and exits with its code.
|
||||||
|
|
||||||
|
import type { Writable } from "node:stream";
|
||||||
|
|
||||||
|
// Run a command and exit with its code once stdout/stderr have drained.
|
||||||
|
// Exiting before the drain can truncate piped output, and the library can keep
|
||||||
|
// the event loop alive after a command returns, so a plain return could hang.
|
||||||
|
// An error the command throws is printed as one `quak: MESSAGE` line, without
|
||||||
|
// the stack trace, and exits 1.
|
||||||
|
export const run = async (
|
||||||
|
command: Promise<number>,
|
||||||
|
stdout: Writable,
|
||||||
|
stderr: Writable,
|
||||||
|
exit: (code: number) => void,
|
||||||
|
): Promise<void> => {
|
||||||
|
let code: number;
|
||||||
|
try {
|
||||||
|
code = await command;
|
||||||
|
} catch (err) {
|
||||||
|
stderr.write(
|
||||||
|
`quak: ${err instanceof Error ? err.message : String(err)}\n`,
|
||||||
|
);
|
||||||
|
code = 1;
|
||||||
|
}
|
||||||
|
const pending = [stdout, stderr].filter((s) => s.writableLength > 0);
|
||||||
|
if (pending.length === 0) {
|
||||||
|
exit(code);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let remaining = pending.length;
|
||||||
|
for (const s of pending) {
|
||||||
|
s.once("drain", () => {
|
||||||
|
if (--remaining === 0) exit(code);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -217,6 +217,14 @@ export class Client {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Ends this client's session on the server (`POST /users/logout`), so the
|
||||||
|
// token stops working everywhere, including in any saved copy of it. This
|
||||||
|
// client is left as it was; call `logout()` to clear it.
|
||||||
|
async logoutOnServer(): Promise<void> {
|
||||||
|
this.assertLoggedIn();
|
||||||
|
await this.api.postJSON("/users/logout", {});
|
||||||
|
}
|
||||||
|
|
||||||
// Zeroes the key buffers in place, so any copy of the reference held
|
// Zeroes the key buffers in place, so any copy of the reference held
|
||||||
// elsewhere is wiped too. Every method checks `assertLoggedIn` before
|
// elsewhere is wiped too. Every method checks `assertLoggedIn` before
|
||||||
// touching the keys, so nothing decrypts with the zeroed keys.
|
// touching the keys, so nothing decrypts with the zeroed keys.
|
||||||
|
|||||||
+21
-3
@@ -321,6 +321,23 @@ export class ContentCache implements PhotoContent, ThumbnailsAPI {
|
|||||||
return this.get(fileID, "thumbnail", "on-demand", opts?.onProgress);
|
return this.get(fileID, "thumbnail", "on-demand", opts?.onProgress);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Get an original for a backup. One not present anywhere is written
|
||||||
|
// straight to `destination` and recorded there, so no second copy lands
|
||||||
|
// in the cache; one already present is returned where it is.
|
||||||
|
async backupOriginal(
|
||||||
|
fileID: number,
|
||||||
|
destination: string,
|
||||||
|
): Promise<ContentResult> {
|
||||||
|
const result = await this.acquire(
|
||||||
|
fileID,
|
||||||
|
"original",
|
||||||
|
"on-demand",
|
||||||
|
undefined,
|
||||||
|
{ destination },
|
||||||
|
);
|
||||||
|
return { path: result.path, bytes: result.bytes };
|
||||||
|
}
|
||||||
|
|
||||||
async ensure(args: EnsureOptions): Promise<EnsureResult[]> {
|
async ensure(args: EnsureOptions): Promise<EnsureResult[]> {
|
||||||
return this.ensureThumbnails(args);
|
return this.ensureThumbnails(args);
|
||||||
}
|
}
|
||||||
@@ -422,13 +439,14 @@ export class ContentCache implements PhotoContent, ThumbnailsAPI {
|
|||||||
|
|
||||||
// The core: return the cached path if present, else fetch through the pool,
|
// The core: return the cached path if present, else fetch through the pool,
|
||||||
// store, and return it. `cached` distinguishes a present hit (no network,
|
// store, and return it. `cached` distinguishes a present hit (no network,
|
||||||
// no download event) from a fresh fetch.
|
// no download event) from a fresh fetch. A fetched original is stored at
|
||||||
|
// `opts.destination` when given, instead of in `originalsDir`.
|
||||||
private async acquire(
|
private async acquire(
|
||||||
fileID: number,
|
fileID: number,
|
||||||
kind: Kind,
|
kind: Kind,
|
||||||
priority: Priority,
|
priority: Priority,
|
||||||
signal: AbortSignal | undefined,
|
signal: AbortSignal | undefined,
|
||||||
opts?: { onByte?: ProgressCallback },
|
opts?: { onByte?: ProgressCallback; destination?: string },
|
||||||
): Promise<{ path: string; bytes: number; cached: boolean }> {
|
): Promise<{ path: string; bytes: number; cached: boolean }> {
|
||||||
const file = this.getFile(fileID);
|
const file = this.getFile(fileID);
|
||||||
if (!file) throw new Error(`content cache: unknown file ${fileID}`);
|
if (!file) throw new Error(`content cache: unknown file ${fileID}`);
|
||||||
@@ -469,7 +487,7 @@ export class ContentCache implements PhotoContent, ThumbnailsAPI {
|
|||||||
kind === "original" ? this.originalsDir : this.thumbnailsDir;
|
kind === "original" ? this.originalsDir : this.thumbnailsDir;
|
||||||
const dest =
|
const dest =
|
||||||
kind === "original"
|
kind === "original"
|
||||||
? join(dir, originalName(file))
|
? (opts?.destination ?? join(dir, originalName(file)))
|
||||||
: join(dir, `${fileID}${THUMBNAIL_EXT}`);
|
: join(dir, `${fileID}${THUMBNAIL_EXT}`);
|
||||||
const pool =
|
const pool =
|
||||||
kind === "original" ? this.pools.content : this.pools.thumbnails;
|
kind === "original" ? this.pools.content : this.pools.thumbnails;
|
||||||
|
|||||||
+16
-9
@@ -98,6 +98,11 @@ export {
|
|||||||
|
|
||||||
export const DEFAULT_REFRESH_INTERVAL_SECONDS = 3;
|
export const DEFAULT_REFRESH_INTERVAL_SECONDS = 3;
|
||||||
|
|
||||||
|
// The account's cache directory when `cacheDirectory` is not given: the
|
||||||
|
// env-paths cache directory plus the user id, so each account has its own.
|
||||||
|
export const defaultCacheDirectory = (userID: number): string =>
|
||||||
|
join(envPaths("quak", { suffix: "" }).cache, String(userID));
|
||||||
|
|
||||||
// Project a metadata store into by-id records, filling each record's cache
|
// Project a metadata store into by-id records, filling each record's cache
|
||||||
// paths from the content cache when one is given. Shared by the live read
|
// paths from the content cache when one is given. Shared by the live read
|
||||||
// projection and the precache's initial seeding at open().
|
// projection and the precache's initial seeding at open().
|
||||||
@@ -344,8 +349,7 @@ export class Library {
|
|||||||
static async open(opts: LibraryOptions): Promise<Library> {
|
static async open(opts: LibraryOptions): Promise<Library> {
|
||||||
const { userID } = opts.client.whoami();
|
const { userID } = opts.client.whoami();
|
||||||
const cacheDirectory =
|
const cacheDirectory =
|
||||||
opts.cacheDirectory ??
|
opts.cacheDirectory ?? defaultCacheDirectory(userID);
|
||||||
join(envPaths("quak", { suffix: "" }).cache, String(userID));
|
|
||||||
const metadataPath = join(cacheDirectory, "metadata.json");
|
const metadataPath = join(cacheDirectory, "metadata.json");
|
||||||
let store = await MetadataStore.load(metadataPath);
|
let store = await MetadataStore.load(metadataPath);
|
||||||
// A cache directory given explicitly can hold another account's cache.
|
// A cache directory given explicitly can hold another account's cache.
|
||||||
@@ -534,11 +538,13 @@ export class Library {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Back up every in-scope file to `downloadDirectory` in the historical
|
// Back up every in-scope file to `downloadDirectory` in the historical
|
||||||
// on-disk layout, with a durable failure ledger (issue #51). Refreshes
|
// on-disk layout, with a durable failure ledger (issue #51). Waits for a
|
||||||
// first, fetches pending originals (and optional thumbnails) through the
|
// completed refresh first, as `fresh()` does, joining one already running,
|
||||||
// content cache and pools, then rebuilds the derived symlink/JSON views
|
// and rejects before touching any file when it fails. Then fetches pending
|
||||||
// from the model. Throws before any network work when no download directory
|
// originals (and optional thumbnails) through the content cache and pools,
|
||||||
// is available or no content cache backs the originals it must fetch.
|
// and rebuilds the derived symlink/JSON views from the model. Throws before
|
||||||
|
// any network work when no download directory is available or no content
|
||||||
|
// cache backs the originals it must fetch.
|
||||||
backup(opts?: BackupOptions): Promise<BackupResult> {
|
backup(opts?: BackupOptions): Promise<BackupResult> {
|
||||||
const downloadDirectory =
|
const downloadDirectory =
|
||||||
opts?.downloadDirectory ?? this.downloadDirectory;
|
opts?.downloadDirectory ?? this.downloadDirectory;
|
||||||
@@ -562,10 +568,11 @@ export class Library {
|
|||||||
const cache = this.cache;
|
const cache = this.cache;
|
||||||
return runBackup(
|
return runBackup(
|
||||||
{
|
{
|
||||||
refresh: () => this.runRefresh(),
|
refresh: () => this.refreshNow(),
|
||||||
listCollections: () => this.store.listCollections(),
|
listCollections: () => this.store.listCollections(),
|
||||||
listFiles: (id) => this.store.listFiles(id),
|
listFiles: (id) => this.store.listFiles(id),
|
||||||
original: (fileID) => cache!.original(fileID),
|
original: (fileID, destination) =>
|
||||||
|
cache!.backupOriginal(fileID, destination),
|
||||||
thumbnail: (fileID) => cache!.thumbnail(fileID),
|
thumbnail: (fileID) => cache!.thumbnail(fileID),
|
||||||
},
|
},
|
||||||
{ ...opts, downloadDirectory },
|
{ ...opts, downloadDirectory },
|
||||||
|
|||||||
@@ -140,8 +140,8 @@ const extractExif = async (
|
|||||||
// Dump every decrypted metadata layer the account holds into a directory tree
|
// Dump every decrypted metadata layer the account holds into a directory tree
|
||||||
// of plain JSON: account, per-collection, and per-file records including the
|
// of plain JSON: account, per-collection, and per-file records including the
|
||||||
// private and public magic metadata and (by default) the ML data. Collections
|
// private and public magic metadata and (by default) the ML data. Collections
|
||||||
// and files are enumerated from the library's cache rather than a fresh server
|
// and files are enumerated from the library's cache, which the caller refreshes
|
||||||
// scan. Returns how many ML data requests failed; their files are still
|
// first. Returns how many ML data requests failed; their files are still
|
||||||
// written, with `mlDataError` in place of `mlData`.
|
// written, with `mlDataError` in place of `mlData`.
|
||||||
export const runMetadataBackup = async (
|
export const runMetadataBackup = async (
|
||||||
lib: Library,
|
lib: Library,
|
||||||
|
|||||||
+88
-30
@@ -7,8 +7,21 @@ import { ApiError } from "./api/client.js";
|
|||||||
import { encryptBlob, toBase64 } from "./crypto/index.js";
|
import { encryptBlob, toBase64 } from "./crypto/index.js";
|
||||||
import type { EnteFile } from "./model/types.js";
|
import type { EnteFile } from "./model/types.js";
|
||||||
|
|
||||||
const THUMB_MAX_DIMENSION = 720;
|
// The server refuses a thumbnail larger than the one it already records for the
|
||||||
const THUMB_JPEG_QUALITY = 50;
|
// file (`thumbnail.size`, the encrypted size), so these encodings are tried
|
||||||
|
// from largest to smallest and the first that fits is uploaded.
|
||||||
|
const THUMB_ENCODINGS = [
|
||||||
|
{ maxDimension: 720, quality: 50 },
|
||||||
|
{ maxDimension: 720, quality: 30 },
|
||||||
|
{ maxDimension: 480, quality: 30 },
|
||||||
|
{ maxDimension: 320, quality: 20 },
|
||||||
|
{ maxDimension: 160, quality: 20 },
|
||||||
|
];
|
||||||
|
|
||||||
|
// The server accepts a new thumbnail only from the file's owner, so files other
|
||||||
|
// people own in albums shared with this account are never checked or repaired.
|
||||||
|
const NOT_OWNED_REASON =
|
||||||
|
"owned by another account (only the owner can replace its thumbnail)";
|
||||||
|
|
||||||
export interface MissingThumbnailInfo {
|
export interface MissingThumbnailInfo {
|
||||||
fileID: number;
|
fileID: number;
|
||||||
@@ -19,11 +32,12 @@ export interface MissingThumbnailInfo {
|
|||||||
|
|
||||||
// Three outcomes, not two. "fixed": a thumbnail was generated and uploaded.
|
// Three outcomes, not two. "fixed": a thumbnail was generated and uploaded.
|
||||||
// "failed": something went wrong (download, encode, upload) and the file still
|
// "failed": something went wrong (download, encode, upload) and the file still
|
||||||
// has no thumbnail. "skipped": the file is a format this helper cannot
|
// has no thumbnail. "skipped": the server would refuse any thumbnail for the
|
||||||
// regenerate — a video, or an image that is not a baseline JPEG. Skipped is a
|
// file or this helper cannot regenerate it — a file another account owns, a
|
||||||
// deliberate, expected outcome, not an error (issue #17): the repair path is
|
// recorded thumbnail size nothing fits within, a video, or an image that is
|
||||||
// JPEG-only because `jpeg-js` is, and a PNG or HEIC is left for a format-aware
|
// not a baseline JPEG. Skipped is a deliberate, expected outcome, not an error
|
||||||
// tool rather than reported as a failure.
|
// (issue #17): the repair path is JPEG-only because `jpeg-js` is, and a PNG or
|
||||||
|
// HEIC is left for a format-aware tool rather than reported as a failure.
|
||||||
export type ThumbnailFixStatus = "fixed" | "skipped" | "failed";
|
export type ThumbnailFixStatus = "fixed" | "skipped" | "failed";
|
||||||
|
|
||||||
export interface ThumbnailFixResult {
|
export interface ThumbnailFixResult {
|
||||||
@@ -45,6 +59,7 @@ export type ProgressCallback = (message: string) => void;
|
|||||||
// exists, so it is logged and the file is left unreported. That distinction is
|
// exists, so it is logged and the file is left unreported. That distinction is
|
||||||
// what stops `fix-missing-thumbnails` from regenerating and uploading over
|
// what stops `fix-missing-thumbnails` from regenerating and uploading over
|
||||||
// thumbnails that were fine all along while the CDN was briefly returning 500s.
|
// thumbnails that were fine all along while the CDN was briefly returning 500s.
|
||||||
|
// Files another account owns are logged as skipped and not checked.
|
||||||
export const listMissingThumbnails = async (
|
export const listMissingThumbnails = async (
|
||||||
lib: Library,
|
lib: Library,
|
||||||
client: Client,
|
client: Client,
|
||||||
@@ -52,6 +67,7 @@ export const listMissingThumbnails = async (
|
|||||||
): Promise<MissingThumbnailInfo[]> => {
|
): Promise<MissingThumbnailInfo[]> => {
|
||||||
const log = onProgress ?? (() => {});
|
const log = onProgress ?? (() => {});
|
||||||
const api = client.getApiClient();
|
const api = client.getApiClient();
|
||||||
|
const { userID } = client.whoami();
|
||||||
const missing: MissingThumbnailInfo[] = [];
|
const missing: MissingThumbnailInfo[] = [];
|
||||||
const seen = new Set<number>();
|
const seen = new Set<number>();
|
||||||
|
|
||||||
@@ -60,6 +76,13 @@ export const listMissingThumbnails = async (
|
|||||||
for (const photo of album.photos.list()) {
|
for (const photo of album.photos.list()) {
|
||||||
if (seen.has(photo.fileID)) continue;
|
if (seen.has(photo.fileID)) continue;
|
||||||
seen.add(photo.fileID);
|
seen.add(photo.fileID);
|
||||||
|
const file = lib.getFile(album.collectionID, photo.fileID);
|
||||||
|
if (file && file.ownerID !== userID) {
|
||||||
|
log(
|
||||||
|
`[${album.name}] Skipping ${photo.title}: ${NOT_OWNED_REASON}`,
|
||||||
|
);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
try {
|
try {
|
||||||
const stream = await api.getThumbnailStream(photo.fileID);
|
const stream = await api.getThumbnailStream(photo.fileID);
|
||||||
const reader = stream.getReader();
|
const reader = stream.getReader();
|
||||||
@@ -135,17 +158,13 @@ const resizeRGBA = (
|
|||||||
return dst;
|
return dst;
|
||||||
};
|
};
|
||||||
|
|
||||||
const generateThumbnail = (fileBytes: Uint8Array): Uint8Array => {
|
const generateThumbnail = (
|
||||||
const decoded = jpeg.decode(fileBytes, {
|
decoded: { data: Uint8Array; width: number; height: number },
|
||||||
useTArray: true,
|
maxDimension: number,
|
||||||
formatAsRGBA: true,
|
quality: number,
|
||||||
});
|
): Uint8Array => {
|
||||||
const { width: srcW, height: srcH } = decoded;
|
const { width: srcW, height: srcH } = decoded;
|
||||||
const scale = Math.min(
|
const scale = Math.min(maxDimension / srcW, maxDimension / srcH, 1);
|
||||||
THUMB_MAX_DIMENSION / srcW,
|
|
||||||
THUMB_MAX_DIMENSION / srcH,
|
|
||||||
1,
|
|
||||||
);
|
|
||||||
const dstW = Math.round(srcW * scale);
|
const dstW = Math.round(srcW * scale);
|
||||||
const dstH = Math.round(srcH * scale);
|
const dstH = Math.round(srcH * scale);
|
||||||
|
|
||||||
@@ -158,7 +177,7 @@ const generateThumbnail = (fileBytes: Uint8Array): Uint8Array => {
|
|||||||
|
|
||||||
const encoded = jpeg.encode(
|
const encoded = jpeg.encode(
|
||||||
{ data: pixels, width: dstW, height: dstH },
|
{ data: pixels, width: dstW, height: dstH },
|
||||||
THUMB_JPEG_QUALITY,
|
quality,
|
||||||
);
|
);
|
||||||
return new Uint8Array(encoded.data);
|
return new Uint8Array(encoded.data);
|
||||||
};
|
};
|
||||||
@@ -171,14 +190,35 @@ const generateThumbnail = (fileBytes: Uint8Array): Uint8Array => {
|
|||||||
const isJpeg = (bytes: Uint8Array): boolean =>
|
const isJpeg = (bytes: Uint8Array): boolean =>
|
||||||
bytes.length >= 2 && bytes[0] === 0xff && bytes[1] === 0xd8;
|
bytes.length >= 2 && bytes[0] === 0xff && bytes[1] === 0xd8;
|
||||||
|
|
||||||
// The reason a file cannot have a JPEG thumbnail regenerated for it from its
|
// The reason a file cannot have a JPEG thumbnail regenerated for it, known from
|
||||||
// metadata alone, before any bytes are fetched, or undefined when it might. A
|
// its record alone before any bytes are fetched, or undefined when it might. A
|
||||||
// non-image (video, live photo) is unsupported outright; a still image still
|
// still image still has to be checked against its actual bytes once
|
||||||
// has to be checked against its actual bytes once downloaded.
|
// downloaded.
|
||||||
const unsupportedByType = (file: EnteFile): string | undefined => {
|
const reasonToSkip = (file: EnteFile, userID: number): string | undefined => {
|
||||||
|
if (file.ownerID !== userID) {
|
||||||
|
return NOT_OWNED_REASON;
|
||||||
|
}
|
||||||
if (file.metadata.fileType !== "image") {
|
if (file.metadata.fileType !== "image") {
|
||||||
return `unsupported file type: ${file.metadata.fileType} (only JPEG images can be regenerated)`;
|
return `unsupported file type: ${file.metadata.fileType} (only JPEG images can be regenerated)`;
|
||||||
}
|
}
|
||||||
|
if (!file.thumbnail.size) {
|
||||||
|
return `recorded thumbnail size is ${file.thumbnail.size ?? "unknown"} (the server refuses a thumbnail larger than the one it records)`;
|
||||||
|
}
|
||||||
|
return undefined;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Encrypt the largest encoding of the decoded image whose ciphertext is no
|
||||||
|
// larger than `maxSize`, or return undefined when even the smallest is larger.
|
||||||
|
const encryptThumbnailWithin = (
|
||||||
|
decoded: { data: Uint8Array; width: number; height: number },
|
||||||
|
key: Uint8Array,
|
||||||
|
maxSize: number,
|
||||||
|
): { header: Uint8Array; ciphertext: Uint8Array } | undefined => {
|
||||||
|
for (const { maxDimension, quality } of THUMB_ENCODINGS) {
|
||||||
|
const thumbJpeg = generateThumbnail(decoded, maxDimension, quality);
|
||||||
|
const encrypted = encryptBlob(thumbJpeg, key);
|
||||||
|
if (encrypted.ciphertext.length <= maxSize) return encrypted;
|
||||||
|
}
|
||||||
return undefined;
|
return undefined;
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -197,6 +237,7 @@ export const fixMissingThumbnails = async (
|
|||||||
const log = onProgress ?? (() => {});
|
const log = onProgress ?? (() => {});
|
||||||
const results: ThumbnailFixResult[] = [];
|
const results: ThumbnailFixResult[] = [];
|
||||||
const api = client.getApiClient();
|
const api = client.getApiClient();
|
||||||
|
const { userID } = client.whoami();
|
||||||
|
|
||||||
// Resolve each requested fileID to its file record and owning album by
|
// Resolve each requested fileID to its file record and owning album by
|
||||||
// enumerating the library, each file taken from the first album that holds
|
// enumerating the library, each file taken from the first album that holds
|
||||||
@@ -237,18 +278,19 @@ export const fixMissingThumbnails = async (
|
|||||||
const { file, collectionName } = entry;
|
const { file, collectionName } = entry;
|
||||||
const title = file.metadata.title;
|
const title = file.metadata.title;
|
||||||
|
|
||||||
const typeReason = unsupportedByType(file);
|
const skipReason = reasonToSkip(file, userID);
|
||||||
if (typeReason) {
|
if (skipReason) {
|
||||||
log(`[${collectionName}] Skipping ${title}: ${typeReason}`);
|
log(`[${collectionName}] Skipping ${title}: ${skipReason}`);
|
||||||
results.push({
|
results.push({
|
||||||
fileID,
|
fileID,
|
||||||
title,
|
title,
|
||||||
collection: collectionName,
|
collection: collectionName,
|
||||||
status: "skipped",
|
status: "skipped",
|
||||||
reason: typeReason,
|
reason: skipReason,
|
||||||
});
|
});
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
const maxSize = file.thumbnail.size!;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const photo = lib.photos.byID({ fileID });
|
const photo = lib.photos.byID({ fileID });
|
||||||
@@ -277,12 +319,28 @@ export const fixMissingThumbnails = async (
|
|||||||
}
|
}
|
||||||
|
|
||||||
log(`[${collectionName}] Generating thumbnail for ${title}...`);
|
log(`[${collectionName}] Generating thumbnail for ${title}...`);
|
||||||
const thumbJpeg = generateThumbnail(fileBytes);
|
const decoded = jpeg.decode(fileBytes, {
|
||||||
|
useTArray: true,
|
||||||
|
formatAsRGBA: true,
|
||||||
|
});
|
||||||
|
const fitting = encryptThumbnailWithin(decoded, file.key, maxSize);
|
||||||
|
if (!fitting) {
|
||||||
|
const reason = `no thumbnail encoding fits the recorded thumbnail size of ${maxSize} bytes`;
|
||||||
|
log(`[${collectionName}] Skipping ${title}: ${reason}`);
|
||||||
|
results.push({
|
||||||
|
fileID,
|
||||||
|
title,
|
||||||
|
collection: collectionName,
|
||||||
|
status: "skipped",
|
||||||
|
reason,
|
||||||
|
});
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const { header, ciphertext } = fitting;
|
||||||
|
|
||||||
log(
|
log(
|
||||||
`[${collectionName}] Encrypting and uploading thumbnail (${thumbJpeg.length} bytes)...`,
|
`[${collectionName}] Uploading thumbnail (${ciphertext.length} bytes)...`,
|
||||||
);
|
);
|
||||||
const { header, ciphertext } = encryptBlob(thumbJpeg, file.key);
|
|
||||||
const md5 = createHash("md5").update(ciphertext).digest("base64");
|
const md5 = createHash("md5").update(ciphertext).digest("base64");
|
||||||
const { objectKey, url } = await api.getUploadURL(
|
const { objectKey, url } = await api.getUploadURL(
|
||||||
ciphertext.length,
|
ciphertext.length,
|
||||||
|
|||||||
+116
-1
@@ -562,11 +562,39 @@ describe("lib.backup", () => {
|
|||||||
lib.close();
|
lib.close();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("fsyncs a copied original before the rename and its directory after", async () => {
|
it("fetches each original once and writes it only into the backup", async () => {
|
||||||
|
// A backup of a 500 GB account must write 500 GB, not a copy in the
|
||||||
|
// cache as well: an original fetched for the backup goes straight
|
||||||
|
// into its originals/, and the cache records it there.
|
||||||
|
const source = stubSource();
|
||||||
|
const lib = await openLibrary(source);
|
||||||
|
const outDir = join(root, "backup");
|
||||||
|
|
||||||
|
const result = await lib.backup({ downloadDirectory: outDir });
|
||||||
|
|
||||||
|
expect(result.downloaded).toBe(3);
|
||||||
|
expect(source.originalCalls).toBe(3);
|
||||||
|
expect(readdirSync(join(root, "cache", "originals"))).toEqual([]);
|
||||||
|
const stored = readdirSync(join(outDir, "originals")).filter(
|
||||||
|
(name) => !name.endsWith(".json"),
|
||||||
|
);
|
||||||
|
expect(stored.sort()).toEqual(["100.jpg", "101.jpg", "200.png"]);
|
||||||
|
// The cache counts the backup's copy as present: reading the
|
||||||
|
// original afterwards fetches nothing and answers with that copy.
|
||||||
|
const read = await lib.photos.byID({ fileID: 100 })!.original();
|
||||||
|
expect(read.path).toBe(join(outDir, "originals", "100.jpg"));
|
||||||
|
expect(source.originalCalls).toBe(3);
|
||||||
|
await lib.close();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("fsyncs an original copied from the cache before the rename and its directory after", async () => {
|
||||||
const lib = await openLibrary(stubSource());
|
const lib = await openLibrary(stubSource());
|
||||||
const outDir = join(root, "backup");
|
const outDir = join(root, "backup");
|
||||||
const originals = join(outDir, "originals");
|
const originals = join(outDir, "originals");
|
||||||
const dest = join(originals, "100.jpg");
|
const dest = join(originals, "100.jpg");
|
||||||
|
// Only an original already in the cache is copied into the backup;
|
||||||
|
// one fetched for the backup is written there by the download writer.
|
||||||
|
await lib.photos.byID({ fileID: 100 })!.original();
|
||||||
fsEvents.length = 0;
|
fsEvents.length = 0;
|
||||||
|
|
||||||
await lib.backup({ downloadDirectory: outDir });
|
await lib.backup({ downloadDirectory: outDir });
|
||||||
@@ -625,6 +653,93 @@ describe("lib.backup", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Every refresh fails, as with an expired session or no network.
|
||||||
|
class FailingClient extends MockClient {
|
||||||
|
override async collectionsSince(): Promise<CollectionsPage> {
|
||||||
|
throw new Error("HTTP 401 from server");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Holds its refresh open until `release()` is called, then reports a third
|
||||||
|
// album, so a backup can be started while that refresh is still running.
|
||||||
|
class HeldClient extends MockClient {
|
||||||
|
release!: () => void;
|
||||||
|
private held = new Promise<void>((resolve) => {
|
||||||
|
this.release = resolve;
|
||||||
|
});
|
||||||
|
override async collectionsSince(): Promise<CollectionsPage> {
|
||||||
|
await this.held;
|
||||||
|
return {
|
||||||
|
collections: [collection(3, "Later")],
|
||||||
|
deleted: [],
|
||||||
|
cursor: 2,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
override async filesSince(args: {
|
||||||
|
collectionID: number;
|
||||||
|
}): Promise<FilesPage> {
|
||||||
|
if (args.collectionID !== 3) return super.filesSince(args);
|
||||||
|
return { files: [file(300, 3, "late.jpg")], deleted: [], cursor: 2 };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fill the library cache on disk, so the next open starts its refresh in the
|
||||||
|
// background instead of waiting for it.
|
||||||
|
const fillCache = async (): Promise<void> => {
|
||||||
|
const lib = await openLibrary(stubSource());
|
||||||
|
await lib.close();
|
||||||
|
};
|
||||||
|
|
||||||
|
describe("the refresh before a backup", () => {
|
||||||
|
it("waits for a refresh already running and backs up what it found", async () => {
|
||||||
|
await fillCache();
|
||||||
|
const client = new HeldClient();
|
||||||
|
const lib = await openLibrary(stubSource(), client);
|
||||||
|
const outDir = join(root, "backup");
|
||||||
|
|
||||||
|
const backup = lib.backup({ downloadDirectory: outDir });
|
||||||
|
client.release();
|
||||||
|
const result = await backup;
|
||||||
|
|
||||||
|
expect(result.totalFiles).toBe(4);
|
||||||
|
expect(existsSync(join(outDir, "originals", "300.jpg"))).toBe(true);
|
||||||
|
await lib.close();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("fails before any download when the refresh fails, leaving failures.json as it was", async () => {
|
||||||
|
await fillCache();
|
||||||
|
const outDir = join(root, "backup");
|
||||||
|
seedLedger(outDir, 100, "beach.jpg");
|
||||||
|
const ledgerPath = join(outDir, "failures.json");
|
||||||
|
const ledgerBefore = readFileSync(ledgerPath, "utf-8");
|
||||||
|
const source = stubSource();
|
||||||
|
const lib = await openLibrary(source, new FailingClient());
|
||||||
|
|
||||||
|
await expect(lib.backup({ downloadDirectory: outDir })).rejects.toThrow(
|
||||||
|
"HTTP 401 from server",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(source.originalCalls).toBe(0);
|
||||||
|
expect(readFileSync(ledgerPath, "utf-8")).toBe(ledgerBefore);
|
||||||
|
expect(existsSync(join(outDir, "originals"))).toBe(false);
|
||||||
|
await lib.close();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("fails when the refresh fails on an empty cache, instead of backing up nothing", async () => {
|
||||||
|
const source = stubSource();
|
||||||
|
const lib = await openLibrary(source, new FailingClient());
|
||||||
|
const outDir = join(root, "backup");
|
||||||
|
|
||||||
|
await expect(lib.backup({ downloadDirectory: outDir })).rejects.toThrow(
|
||||||
|
"HTTP 401 from server",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(source.originalCalls).toBe(0);
|
||||||
|
expect(existsSync(outDir)).toBe(false);
|
||||||
|
await lib.close();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
// The album folders under collections/, driven through `runBackup` with a
|
// The album folders under collections/, driven through `runBackup` with a
|
||||||
// stand-in library whose albums a test changes between runs.
|
// stand-in library whose albums a test changes between runs.
|
||||||
describe("backup album folders", () => {
|
describe("backup album folders", () => {
|
||||||
|
|||||||
+359
-24
@@ -13,6 +13,7 @@
|
|||||||
import {
|
import {
|
||||||
existsSync,
|
existsSync,
|
||||||
mkdtempSync,
|
mkdtempSync,
|
||||||
|
readdirSync,
|
||||||
readFileSync,
|
readFileSync,
|
||||||
rmSync,
|
rmSync,
|
||||||
statSync,
|
statSync,
|
||||||
@@ -20,11 +21,21 @@ import {
|
|||||||
} from "node:fs";
|
} from "node:fs";
|
||||||
import { join } from "node:path";
|
import { join } from "node:path";
|
||||||
import { tmpdir } from "node:os";
|
import { tmpdir } from "node:os";
|
||||||
import { describe, it, expect, beforeAll, beforeEach, afterEach } from "vitest";
|
import { PassThrough } from "node:stream";
|
||||||
|
import {
|
||||||
|
describe,
|
||||||
|
it,
|
||||||
|
expect,
|
||||||
|
vi,
|
||||||
|
beforeAll,
|
||||||
|
beforeEach,
|
||||||
|
afterEach,
|
||||||
|
} from "vitest";
|
||||||
|
|
||||||
import {
|
import {
|
||||||
type CliContext,
|
type CliContext,
|
||||||
saveSession,
|
saveSession,
|
||||||
|
loginCommand,
|
||||||
whoamiCommand,
|
whoamiCommand,
|
||||||
logoutCommand,
|
logoutCommand,
|
||||||
collectionsCommand,
|
collectionsCommand,
|
||||||
@@ -32,13 +43,17 @@ import {
|
|||||||
getCommand,
|
getCommand,
|
||||||
getThumbCommand,
|
getThumbCommand,
|
||||||
backupCommand,
|
backupCommand,
|
||||||
|
backupMetadataCommand,
|
||||||
listMissingThumbnailsCommand,
|
listMissingThumbnailsCommand,
|
||||||
|
fixMissingThumbnailsCommand,
|
||||||
} from "../../src/cli-commands.js";
|
} from "../../src/cli-commands.js";
|
||||||
|
import { run } from "../../src/cli-run.js";
|
||||||
import { loadSession } from "../../src/cli-session.js";
|
import { loadSession } from "../../src/cli-session.js";
|
||||||
import type { Client, ClientSnapshot } from "../../src/client.js";
|
import type { Client, ClientSnapshot, LoginOptions } from "../../src/client.js";
|
||||||
import type { ContentSource } from "../../src/library/content.js";
|
import type { ContentSource } from "../../src/library/content.js";
|
||||||
import type { Collection, EnteFile } from "../../src/model/types.js";
|
import type { Collection, EnteFile } from "../../src/model/types.js";
|
||||||
import { init } from "../../src/crypto/index.js";
|
import { init, toBase64 } from "../../src/crypto/index.js";
|
||||||
|
import { defaultCacheDirectory } from "../../src/library/index.js";
|
||||||
|
|
||||||
const USER_ID = 42;
|
const USER_ID = 42;
|
||||||
|
|
||||||
@@ -81,8 +96,26 @@ const FILES: Record<number, EnteFile[]> = {
|
|||||||
|
|
||||||
// An original is 7 bytes and a thumbnail 3. `failID` makes that file's
|
// An original is 7 bytes and a thumbnail 3. `failID` makes that file's
|
||||||
// original fail; `emptyThumbID` makes the server report that file's
|
// original fail; `emptyThumbID` makes the server report that file's
|
||||||
// thumbnail as empty.
|
// thumbnail as empty. `withNewFile` adds new.jpg (102) to Vacation, advancing
|
||||||
const fakeClient = (opts: { failID?: number; emptyThumbID?: number } = {}) => {
|
// the collection's updationTime as the server does, and `refreshError` makes
|
||||||
|
// listing collections fail with that message.
|
||||||
|
const fakeClient = (
|
||||||
|
opts: {
|
||||||
|
failID?: number;
|
||||||
|
emptyThumbID?: number;
|
||||||
|
withNewFile?: boolean;
|
||||||
|
refreshError?: string;
|
||||||
|
} = {},
|
||||||
|
) => {
|
||||||
|
const collections = opts.withNewFile
|
||||||
|
? [{ ...COLLECTIONS[0], updationTime: 2 }, COLLECTIONS[1]]
|
||||||
|
: COLLECTIONS;
|
||||||
|
const files = opts.withNewFile
|
||||||
|
? {
|
||||||
|
...FILES,
|
||||||
|
1: [...FILES[1], { ...file(102, 1, "new.jpg"), updationTime: 2 }],
|
||||||
|
}
|
||||||
|
: FILES;
|
||||||
const source: ContentSource = {
|
const source: ContentSource = {
|
||||||
original: async ({ file: f, destination }) => {
|
original: async ({ file: f, destination }) => {
|
||||||
if (f.id === opts.failID) throw new Error("HTTP 500 from server");
|
if (f.id === opts.failID) throw new Error("HTTP 500 from server");
|
||||||
@@ -96,18 +129,19 @@ const fakeClient = (opts: { failID?: number; emptyThumbID?: number } = {}) => {
|
|||||||
};
|
};
|
||||||
const fake = {
|
const fake = {
|
||||||
whoami: () => ({ email: "cli@example.com", userID: USER_ID }),
|
whoami: () => ({ email: "cli@example.com", userID: USER_ID }),
|
||||||
collectionsSince: async () => ({
|
collectionsSince: async () => {
|
||||||
collections: COLLECTIONS,
|
if (opts.refreshError) throw new Error(opts.refreshError);
|
||||||
deleted: [],
|
return { collections, deleted: [], cursor: 1 };
|
||||||
cursor: 1,
|
},
|
||||||
}),
|
|
||||||
filesSince: async (args: { collectionID: number }) => ({
|
filesSince: async (args: { collectionID: number }) => ({
|
||||||
files: FILES[args.collectionID] ?? [],
|
files: files[args.collectionID] ?? [],
|
||||||
deleted: [],
|
deleted: [],
|
||||||
cursor: 1,
|
cursor: 1,
|
||||||
}),
|
}),
|
||||||
contentSource: () => source,
|
contentSource: () => source,
|
||||||
getApiClient: () => ({
|
getApiClient: () => ({
|
||||||
|
// The ML data request of `backup-metadata`: no file has any.
|
||||||
|
postJSON: async () => ({ data: [] }),
|
||||||
getThumbnailStream: async (fileID: number) =>
|
getThumbnailStream: async (fileID: number) =>
|
||||||
new ReadableStream<Uint8Array>({
|
new ReadableStream<Uint8Array>({
|
||||||
start(controller) {
|
start(controller) {
|
||||||
@@ -141,6 +175,15 @@ const context = (client: Client | null = fakeClient()): CliContext => ({
|
|||||||
sessionDir: join(root, "session"),
|
sessionDir: join(root, "session"),
|
||||||
cacheDir: join(root, "cache"),
|
cacheDir: join(root, "cache"),
|
||||||
loadSession: () => client,
|
loadSession: () => client,
|
||||||
|
login: async () => {
|
||||||
|
throw new Error("login not expected");
|
||||||
|
},
|
||||||
|
prompt: async () => {
|
||||||
|
throw new Error("prompt not expected");
|
||||||
|
},
|
||||||
|
promptSecret: async () => {
|
||||||
|
throw new Error("prompt not expected");
|
||||||
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
beforeAll(async () => {
|
beforeAll(async () => {
|
||||||
@@ -176,19 +219,6 @@ describe("session file", () => {
|
|||||||
expect(JSON.parse(readFileSync(path, "utf-8"))).toEqual(snapshot);
|
expect(JSON.parse(readFileSync(path, "utf-8"))).toEqual(snapshot);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("is removed by logout", async () => {
|
|
||||||
const ctx = context();
|
|
||||||
saveSession(ctx.sessionDir, snapshot);
|
|
||||||
expect(await logoutCommand(ctx)).toBe(0);
|
|
||||||
expect(existsSync(join(ctx.sessionDir, "session.json"))).toBe(false);
|
|
||||||
expect(stderr.text).toBe("Session deleted.\n");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("logout without a session says so and exits 0", async () => {
|
|
||||||
expect(await logoutCommand(context())).toBe(0);
|
|
||||||
expect(stderr.text).toBe("No session found.\n");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("a missing session exits 1 with 'Not logged in'", async () => {
|
it("a missing session exits 1 with 'Not logged in'", async () => {
|
||||||
const ctx = { ...context(), loadSession };
|
const ctx = { ...context(), loadSession };
|
||||||
expect(await whoamiCommand(ctx)).toBe(1);
|
expect(await whoamiCommand(ctx)).toBe(1);
|
||||||
@@ -211,6 +241,184 @@ describe("session file", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// The login function is a fake that hands back a client whose snapshot is
|
||||||
|
// `snapshot`; each prompt is recorded and answered with "123456".
|
||||||
|
describe("login", () => {
|
||||||
|
const snapshot: ClientSnapshot = {
|
||||||
|
email: "cli@example.com",
|
||||||
|
userID: USER_ID,
|
||||||
|
token: "token",
|
||||||
|
masterKey: "a",
|
||||||
|
secretKey: "b",
|
||||||
|
publicKey: "c",
|
||||||
|
};
|
||||||
|
|
||||||
|
const loggedIn = {
|
||||||
|
whoami: () => ({ email: "cli@example.com", userID: USER_ID }),
|
||||||
|
toJSON: () => snapshot,
|
||||||
|
} as unknown as Client;
|
||||||
|
|
||||||
|
let prompts: string[];
|
||||||
|
|
||||||
|
const loginContext = (
|
||||||
|
login: (opts: LoginOptions) => Promise<Client>,
|
||||||
|
): CliContext => ({
|
||||||
|
...context(),
|
||||||
|
login,
|
||||||
|
prompt: async (message) => {
|
||||||
|
prompts.push(message);
|
||||||
|
return "123456";
|
||||||
|
},
|
||||||
|
promptSecret: async (message) => {
|
||||||
|
prompts.push(message);
|
||||||
|
return "123456";
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
prompts = [];
|
||||||
|
vi.stubEnv("QUAK_EMAIL", "cli@example.com");
|
||||||
|
vi.stubEnv("QUAK_PASSWORD", "hunter2");
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
vi.unstubAllEnvs();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("takes the email and password from the environment without a prompt", async () => {
|
||||||
|
const calls: LoginOptions[] = [];
|
||||||
|
const ctx = loginContext(async (opts) => {
|
||||||
|
calls.push(opts);
|
||||||
|
return loggedIn;
|
||||||
|
});
|
||||||
|
expect(await loginCommand(ctx)).toBe(0);
|
||||||
|
|
||||||
|
expect(prompts).toEqual([]);
|
||||||
|
expect(calls).toHaveLength(1);
|
||||||
|
expect(calls[0]!.email).toBe("cli@example.com");
|
||||||
|
expect(calls[0]!.password).toBe("hunter2");
|
||||||
|
const path = join(ctx.sessionDir, "session.json");
|
||||||
|
expect(stderr.text).toBe(
|
||||||
|
"Authenticating...\n" +
|
||||||
|
`Logged in as cli@example.com (user ${USER_ID})\n` +
|
||||||
|
`Session saved to ${path}\n`,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("saves the session with mode 0600 in a directory with mode 0700", async () => {
|
||||||
|
const ctx = loginContext(async () => loggedIn);
|
||||||
|
expect(await loginCommand(ctx)).toBe(0);
|
||||||
|
|
||||||
|
expect(statSync(ctx.sessionDir).mode & 0o777).toBe(0o700);
|
||||||
|
const path = join(ctx.sessionDir, "session.json");
|
||||||
|
expect(statSync(path).mode & 0o777).toBe(0o600);
|
||||||
|
expect(JSON.parse(readFileSync(path, "utf-8"))).toEqual(snapshot);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("asks for the TOTP code when the account needs one", async () => {
|
||||||
|
let code: string | undefined;
|
||||||
|
const ctx = loginContext(async (opts) => {
|
||||||
|
code = await opts.totp!();
|
||||||
|
return loggedIn;
|
||||||
|
});
|
||||||
|
expect(await loginCommand(ctx)).toBe(0);
|
||||||
|
|
||||||
|
expect(prompts).toEqual(["TOTP code: "]);
|
||||||
|
expect(code).toBe("123456");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("a failed login exits 1, says why and writes no session", async () => {
|
||||||
|
const ctx = loginContext(async () => {
|
||||||
|
throw new Error("HTTP 401 from server");
|
||||||
|
});
|
||||||
|
expect(await loginCommand(ctx)).toBe(1);
|
||||||
|
|
||||||
|
expect(stderr.text).toBe(
|
||||||
|
"Authenticating...\nLogin failed: HTTP 401 from server\n",
|
||||||
|
);
|
||||||
|
expect(existsSync(join(ctx.sessionDir, "session.json"))).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// These use a real client read from the session file, over a fake API that
|
||||||
|
// records each request and answers with `status`.
|
||||||
|
describe("logout", () => {
|
||||||
|
const snapshot: ClientSnapshot = {
|
||||||
|
email: "cli@example.com",
|
||||||
|
userID: USER_ID,
|
||||||
|
token: "saved-token",
|
||||||
|
masterKey: toBase64(new Uint8Array(32)),
|
||||||
|
secretKey: toBase64(new Uint8Array(32)),
|
||||||
|
publicKey: toBase64(new Uint8Array(32)),
|
||||||
|
};
|
||||||
|
|
||||||
|
const requests: Request[] = [];
|
||||||
|
|
||||||
|
const logoutContext = (status: number): CliContext => ({
|
||||||
|
...context(),
|
||||||
|
loadSession: (path) =>
|
||||||
|
loadSession(path, {
|
||||||
|
fetch: async (url, init) => {
|
||||||
|
requests.push(new Request(url, init));
|
||||||
|
return new Response(JSON.stringify({}), {
|
||||||
|
status,
|
||||||
|
headers: { "content-type": "application/json" },
|
||||||
|
});
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
requests.length = 0;
|
||||||
|
});
|
||||||
|
|
||||||
|
it("ends the session on the server, then deletes the file", async () => {
|
||||||
|
const ctx = logoutContext(200);
|
||||||
|
saveSession(ctx.sessionDir, snapshot);
|
||||||
|
expect(await logoutCommand(ctx)).toBe(0);
|
||||||
|
|
||||||
|
expect(requests).toHaveLength(1);
|
||||||
|
expect(requests[0]!.method).toBe("POST");
|
||||||
|
expect(new URL(requests[0]!.url).pathname).toBe("/users/logout");
|
||||||
|
expect(requests[0]!.headers.get("X-Auth-Token")).toBe("saved-token");
|
||||||
|
expect(existsSync(join(ctx.sessionDir, "session.json"))).toBe(false);
|
||||||
|
expect(stderr.text).toBe(
|
||||||
|
"Session ended on the server.\n" +
|
||||||
|
"Session deleted.\n" +
|
||||||
|
`Cache directory ${ctx.cacheDir} still holds decrypted data; delete it to remove that data.\n`,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("still deletes the file when the server call fails, and says so", async () => {
|
||||||
|
const ctx = logoutContext(500);
|
||||||
|
saveSession(ctx.sessionDir, snapshot);
|
||||||
|
expect(await logoutCommand(ctx)).toBe(1);
|
||||||
|
|
||||||
|
expect(requests).toHaveLength(1);
|
||||||
|
expect(existsSync(join(ctx.sessionDir, "session.json"))).toBe(false);
|
||||||
|
expect(stderr.text).toBe(
|
||||||
|
"Could not end the session on the server: HTTP 500\n" +
|
||||||
|
"Session deleted.\n" +
|
||||||
|
`Cache directory ${ctx.cacheDir} still holds decrypted data; delete it to remove that data.\n`,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("names the account's default cache directory without --cache-dir", async () => {
|
||||||
|
const ctx = { ...logoutContext(200), cacheDir: undefined };
|
||||||
|
saveSession(ctx.sessionDir, snapshot);
|
||||||
|
expect(await logoutCommand(ctx)).toBe(0);
|
||||||
|
expect(stderr.text).toContain(
|
||||||
|
`Cache directory ${defaultCacheDirectory(USER_ID)} still holds decrypted data`,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("without a session says so, calls nothing and exits 0", async () => {
|
||||||
|
expect(await logoutCommand(logoutContext(200))).toBe(0);
|
||||||
|
expect(requests).toHaveLength(0);
|
||||||
|
expect(stderr.text).toBe("No session found.\n");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe("whoami", () => {
|
describe("whoami", () => {
|
||||||
it("prints the account as one line of JSON", async () => {
|
it("prints the account as one line of JSON", async () => {
|
||||||
expect(await whoamiCommand(context())).toBe(0);
|
expect(await whoamiCommand(context())).toBe(0);
|
||||||
@@ -337,6 +545,16 @@ describe("backup", () => {
|
|||||||
expect(stdout.text).toBe("");
|
expect(stdout.text).toBe("");
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// The backup opens its library with the precache off: it fetches the
|
||||||
|
// originals it needs into the backup, and must not also fetch every
|
||||||
|
// thumbnail in the account, or keep originals, in the per-user cache.
|
||||||
|
it("leaves nothing in the cache's originals and thumbnails", async () => {
|
||||||
|
const dir = join(root, "backup");
|
||||||
|
expect(await backupCommand(context(), dir, {})).toBe(0);
|
||||||
|
expect(readdirSync(join(root, "cache", "thumbnails"))).toEqual([]);
|
||||||
|
expect(readdirSync(join(root, "cache", "originals"))).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
it("exits 1 and lists the file when one download fails", async () => {
|
it("exits 1 and lists the file when one download fails", async () => {
|
||||||
const ctx = context(fakeClient({ failID: 101 }));
|
const ctx = context(fakeClient({ failID: 101 }));
|
||||||
expect(await backupCommand(ctx, join(root, "backup"), {})).toBe(1);
|
expect(await backupCommand(ctx, join(root, "backup"), {})).toBe(1);
|
||||||
@@ -363,6 +581,34 @@ describe("backup", () => {
|
|||||||
expect(result.errors[0].fileID).toBe(101);
|
expect(result.errors[0].fileID).toBe(101);
|
||||||
expect(stderr.text).toBe("Starting backup...\n");
|
expect(stderr.text).toBe("Starting backup...\n");
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("exits 1 with the error on one line when the refresh fails", async () => {
|
||||||
|
const client = {
|
||||||
|
...fakeClient(),
|
||||||
|
collectionsSince: async () => {
|
||||||
|
throw new Error("HTTP 401 from server");
|
||||||
|
},
|
||||||
|
} as unknown as Client;
|
||||||
|
const dir = join(root, "backup");
|
||||||
|
// Through `run`, as `bin/quak.ts` does, which prints a thrown error.
|
||||||
|
const runStderr = new PassThrough();
|
||||||
|
let runText = "";
|
||||||
|
runStderr.on("data", (chunk: Buffer) => {
|
||||||
|
runText += chunk.toString();
|
||||||
|
});
|
||||||
|
const code = await new Promise<number>((resolve) => {
|
||||||
|
void run(
|
||||||
|
backupCommand(context(client), dir, {}),
|
||||||
|
new PassThrough(),
|
||||||
|
runStderr,
|
||||||
|
resolve,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
expect(code).toBe(1);
|
||||||
|
expect(runText).toBe("quak: HTTP 401 from server\n");
|
||||||
|
expect(stderr.text).toBe("Starting backup...\nRefreshing library...\n");
|
||||||
|
expect(existsSync(join(dir, "originals"))).toBe(false);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("helper list-missing-thumbnails", () => {
|
describe("helper list-missing-thumbnails", () => {
|
||||||
@@ -395,3 +641,92 @@ describe("helper list-missing-thumbnails", () => {
|
|||||||
expect(stderr.text).toBe("");
|
expect(stderr.text).toBe("");
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("backup-metadata --exif", () => {
|
||||||
|
// Runs the command and returns what it printed to stderr.
|
||||||
|
const backupMetadata = async (opts: { exif?: boolean; all?: boolean }) => {
|
||||||
|
expect(
|
||||||
|
await backupMetadataCommand(context(), join(root, "dump"), opts),
|
||||||
|
).toBe(0);
|
||||||
|
return stderr.text;
|
||||||
|
};
|
||||||
|
|
||||||
|
it("--exif extracts EXIF", async () => {
|
||||||
|
expect(await backupMetadata({ exif: true })).toContain(
|
||||||
|
"[beach.jpg] Extracting EXIF...\n",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("--all extracts EXIF", async () => {
|
||||||
|
expect(await backupMetadata({ all: true })).toContain(
|
||||||
|
"[beach.jpg] Extracting EXIF...\n",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("without either flag extracts no EXIF", async () => {
|
||||||
|
expect(await backupMetadata({})).not.toContain("Extracting EXIF");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// Each test first runs `collections` so the cache holds the account as it was,
|
||||||
|
// then changes the server under it.
|
||||||
|
describe("backup-metadata and the thumbnail helpers refresh first", () => {
|
||||||
|
beforeEach(async () => {
|
||||||
|
expect(await collectionsCommand(context(), {})).toBe(0);
|
||||||
|
stdout.text = "";
|
||||||
|
stderr.text = "";
|
||||||
|
});
|
||||||
|
|
||||||
|
it("backup-metadata writes a file added since the cache was written", async () => {
|
||||||
|
const ctx = context(fakeClient({ withNewFile: true }));
|
||||||
|
const dir = join(root, "dump");
|
||||||
|
expect(await backupMetadataCommand(ctx, dir, {})).toBe(0);
|
||||||
|
expect(
|
||||||
|
existsSync(join(dir, "collections", "1-Vacation", "102.json")),
|
||||||
|
).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("list-missing-thumbnails checks a file added since the cache was written", async () => {
|
||||||
|
const ctx = context(
|
||||||
|
fakeClient({ withNewFile: true, emptyThumbID: 102 }),
|
||||||
|
);
|
||||||
|
expect(await listMissingThumbnailsCommand(ctx, {})).toBe(0);
|
||||||
|
expect(stdout.text).toBe(
|
||||||
|
"102\tnew.jpg\tVacation\tempty thumbnail (0 bytes)\n",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("fix-missing-thumbnails finds a file added since the cache was written", async () => {
|
||||||
|
const ctx = context(fakeClient({ withNewFile: true }));
|
||||||
|
expect(
|
||||||
|
await fixMissingThumbnailsCommand(ctx, {
|
||||||
|
file: ["102"],
|
||||||
|
json: true,
|
||||||
|
}),
|
||||||
|
).toBe(0);
|
||||||
|
// Found, then skipped because the server records no thumbnail size
|
||||||
|
// for it; a file missing from the cache would fail as not found.
|
||||||
|
expect(JSON.parse(stdout.text)).toMatchObject([
|
||||||
|
{ fileID: 102, title: "new.jpg", status: "skipped" },
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
// `run` in `cli-run.ts` prints a thrown error as one line and exits 1.
|
||||||
|
it("all three throw when the refresh fails", async () => {
|
||||||
|
const ctx = context(
|
||||||
|
fakeClient({ refreshError: "HTTP 503 from server" }),
|
||||||
|
);
|
||||||
|
const dir = join(root, "dump");
|
||||||
|
await expect(backupMetadataCommand(ctx, dir, {})).rejects.toThrow(
|
||||||
|
"HTTP 503 from server",
|
||||||
|
);
|
||||||
|
expect(existsSync(dir)).toBe(false);
|
||||||
|
await expect(listMissingThumbnailsCommand(ctx, {})).rejects.toThrow(
|
||||||
|
"HTTP 503 from server",
|
||||||
|
);
|
||||||
|
await expect(
|
||||||
|
fixMissingThumbnailsCommand(ctx, { file: ["100"] }),
|
||||||
|
).rejects.toThrow("HTTP 503 from server");
|
||||||
|
expect(stdout.text).toBe("");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
@@ -0,0 +1,58 @@
|
|||||||
|
/**
|
||||||
|
* Tests for `run` in `src/cli-run.ts`, which every CLI command goes through.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { PassThrough } from "node:stream";
|
||||||
|
import { describe, it, expect } from "vitest";
|
||||||
|
|
||||||
|
import { run } from "../../src/cli-run.js";
|
||||||
|
|
||||||
|
// A stream whose written text is kept in `text`; writes finish at once, so
|
||||||
|
// nothing is left waiting to drain.
|
||||||
|
const collector = (): { stream: PassThrough; text: () => string } => {
|
||||||
|
const stream = new PassThrough();
|
||||||
|
const chunks: string[] = [];
|
||||||
|
stream.on("data", (chunk: Buffer) => chunks.push(chunk.toString()));
|
||||||
|
return { stream, text: () => chunks.join("") };
|
||||||
|
};
|
||||||
|
|
||||||
|
const runToExit = async (
|
||||||
|
command: Promise<number>,
|
||||||
|
): Promise<{ code: number; stdout: string; stderr: string }> => {
|
||||||
|
const stdout = collector();
|
||||||
|
const stderr = collector();
|
||||||
|
const code = await new Promise<number>((resolve) => {
|
||||||
|
void run(command, stdout.stream, stderr.stream, resolve);
|
||||||
|
});
|
||||||
|
return { code, stdout: stdout.text(), stderr: stderr.text() };
|
||||||
|
};
|
||||||
|
|
||||||
|
describe("run", () => {
|
||||||
|
it("exits with the code the command returns", async () => {
|
||||||
|
const result = await runToExit(Promise.resolve(3));
|
||||||
|
expect(result).toEqual({ code: 3, stdout: "", stderr: "" });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("prints a thrown error as one line without a stack trace and exits 1", async () => {
|
||||||
|
const failing = async (): Promise<number> => {
|
||||||
|
throw new Error(
|
||||||
|
"ENOTDIR: not a directory, mkdir '/dev/null/x/originals'",
|
||||||
|
);
|
||||||
|
};
|
||||||
|
const result = await runToExit(failing());
|
||||||
|
expect(result.code).toBe(1);
|
||||||
|
expect(result.stdout).toBe("");
|
||||||
|
expect(result.stderr).toBe(
|
||||||
|
"quak: ENOTDIR: not a directory, mkdir '/dev/null/x/originals'\n",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("prints a thrown value that is not an Error", async () => {
|
||||||
|
const result = await runToExit(Promise.reject("offline"));
|
||||||
|
expect(result).toEqual({
|
||||||
|
code: 1,
|
||||||
|
stdout: "",
|
||||||
|
stderr: "quak: offline\n",
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -29,10 +29,10 @@ describe("crypto.deriveKEK (Argon2id)", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Cheap parameters used so the test suite stays under the 30-second
|
* Cheap parameters used so the test suite stays under the 90-second
|
||||||
* budget. The real production parameters Ente uses are larger
|
* `timeout` in the `test` phase of the `Dockerfile`. The real production
|
||||||
* (memLimit up to 1 GiB, opsLimit 3-16). The algorithm is the same
|
* parameters Ente uses are larger (memLimit up to 1 GiB, opsLimit 3-16).
|
||||||
* regardless of parameters.
|
* The algorithm is the same regardless of parameters.
|
||||||
*/
|
*/
|
||||||
const TEST_OPS = 2;
|
const TEST_OPS = 2;
|
||||||
const TEST_MEM = 64 * 1024 * 1024; // 64 MiB
|
const TEST_MEM = 64 * 1024 * 1024; // 64 MiB
|
||||||
|
|||||||
@@ -248,7 +248,8 @@ afterAll(() => {
|
|||||||
* `sodium.randombytes_buf` goes through the wasm wrapper a byte at a time and
|
* `sodium.randombytes_buf` goes through the wasm wrapper a byte at a time and
|
||||||
* costs roughly 20 seconds for the 4 MiB chunk below — about two hundred
|
* costs roughly 20 seconds for the 4 MiB chunk below — about two hundred
|
||||||
* times what it costs to encrypt the same buffer, and on its own enough to
|
* times what it costs to encrypt the same buffer, and on its own enough to
|
||||||
* push `make test` past the 30-second cap in `script/test`. This loop fills
|
* push `make test` past the 90-second `timeout` in the `test` phase of the
|
||||||
|
* `Dockerfile`. This loop fills
|
||||||
* 4 MiB in a few milliseconds.
|
* 4 MiB in a few milliseconds.
|
||||||
*/
|
*/
|
||||||
const patternBytes = (length: number, seed: number): Uint8Array => {
|
const patternBytes = (length: number, seed: number): Uint8Array => {
|
||||||
@@ -1034,13 +1035,10 @@ describe.each(entryPoints)(
|
|||||||
expect(readdirSync(dir)).toEqual([]);
|
expect(readdirSync(dir)).toEqual([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Root ignores directory permissions, so this cannot fail as root
|
// Root ignores directory permissions, so this fails when run as root.
|
||||||
// (the Docker test image runs as root).
|
// The `test` phase of the `Dockerfile` runs as the `node` user.
|
||||||
it.skipIf(process.getuid?.() === 0)(
|
it("fails without creating anything when the destination directory is not writable", async () => {
|
||||||
"fails without creating anything when the destination directory is not writable",
|
const key = sodium.crypto_secretstream_xchacha20poly1305_keygen();
|
||||||
async () => {
|
|
||||||
const key =
|
|
||||||
sodium.crypto_secretstream_xchacha20poly1305_keygen();
|
|
||||||
const { header, ciphertext } = encryptFileBody(
|
const { header, ciphertext } = encryptFileBody(
|
||||||
patternBytes(64, 34),
|
patternBytes(64, 34),
|
||||||
key,
|
key,
|
||||||
@@ -1058,8 +1056,7 @@ describe.each(entryPoints)(
|
|||||||
}
|
}
|
||||||
|
|
||||||
expect(readdirSync(dir)).toEqual([]);
|
expect(readdirSync(dir)).toEqual([]);
|
||||||
},
|
});
|
||||||
);
|
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -1753,4 +1750,42 @@ describe("downloadFile content hash", () => {
|
|||||||
|
|
||||||
expect(readdirSync(t.dir)).toEqual([]);
|
expect(readdirSync(t.dir)).toEqual([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("rejects a live photo that is not a readable ZIP and does not retry", async () => {
|
||||||
|
// Bytes 8-9 of a ZIP entry's local header name its compression
|
||||||
|
// method; 99 is one no reader knows, so the entry cannot be read.
|
||||||
|
const zip = livePhotoZip.slice();
|
||||||
|
zip[8] = 99;
|
||||||
|
zip[9] = 0;
|
||||||
|
const t = setup(zip, { fileType: "livePhoto", hash: livePhotoHash });
|
||||||
|
|
||||||
|
await expect(t.run()).rejects.toThrow(
|
||||||
|
/file 999: live photo is not a readable ZIP/,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(readdirSync(t.dir)).toEqual([]);
|
||||||
|
expect(t.requests()).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects a live photo ZIP with no image entry", async () => {
|
||||||
|
const zip = zipSync({ "video.mov": patternBytes(900, 82) });
|
||||||
|
const t = setup(zip, { fileType: "livePhoto", hash: livePhotoHash });
|
||||||
|
|
||||||
|
await expect(t.run()).rejects.toThrow(
|
||||||
|
/file 999: live photo ZIP does not hold both an image and a video/,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(readdirSync(t.dir)).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects a live photo ZIP with no video entry", async () => {
|
||||||
|
const zip = zipSync({ "image.heic": patternBytes(500, 81) });
|
||||||
|
const t = setup(zip, { fileType: "livePhoto", hash: livePhotoHash });
|
||||||
|
|
||||||
|
await expect(t.run()).rejects.toThrow(
|
||||||
|
/file 999: live photo ZIP does not hold both an image and a video/,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(readdirSync(t.dir)).toEqual([]);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -2,13 +2,13 @@
|
|||||||
// failures are silent.
|
// failures are silent.
|
||||||
//
|
//
|
||||||
// Excluding too little: a worktree left under `.claude/` is copied into the
|
// 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
|
// image, vitest globs its `test/` tree as well as the real one, and the test
|
||||||
// containerised `make check` runs the whole suite twice over while reporting
|
// phase runs the whole suite twice over while reporting success. A compiled
|
||||||
// success. A compiled `bin/quak` is ~100 MB of context nobody needs.
|
// `bin/quak` is ~100 MB of context nobody needs.
|
||||||
//
|
//
|
||||||
// Excluding too much: Prettier 3 reads `.gitignore` as a default ignore file,
|
// Excluding too much: Prettier 3 reads `.gitignore` as a default ignore file,
|
||||||
// so dropping it from the context silently changes which files
|
// so dropping it from the context silently changes which files the lint
|
||||||
// `make fmt-check` looks at inside the image compared to the host.
|
// phase's prettier check looks at compared to `make fmt-check` on the host.
|
||||||
//
|
//
|
||||||
// Neither shows up as a build failure, so they are asserted here.
|
// Neither shows up as a build failure, so they are asserted here.
|
||||||
import { describe, expect, it } from "vitest";
|
import { describe, expect, it } from "vitest";
|
||||||
@@ -47,18 +47,13 @@ describe(".dockerignore", () => {
|
|||||||
expect(dockerignore).not.toContain(".gitignore");
|
expect(dockerignore).not.toContain(".gitignore");
|
||||||
});
|
});
|
||||||
|
|
||||||
// Both images are built from this same context, and the lint image runs
|
// BuildKit lets a `Dockerfile.dockerignore` shadow the root one; such a
|
||||||
// eslint and prettier across it. BuildKit lets a `<dockerfile>.dockerignore`
|
// file would silently give the build a different, unreviewed context —
|
||||||
// shadow the root one for a single build; such a file would silently give
|
// and eslint's flat config does not ignore dot-directories, so a stray
|
||||||
// the lint build a different, unreviewed context — and eslint's flat config
|
// `.claude/` worktree would be linted.
|
||||||
// does not ignore dot-directories, so a stray `.claude/` worktree would be
|
it("is not shadowed by a Dockerfile.dockerignore", () => {
|
||||||
// linted.
|
expect(existsSync(join(repoRoot, "Dockerfile.dockerignore"))).toBe(
|
||||||
it.each(["Dockerfile", "Dockerfile.lint"])(
|
|
||||||
"is not shadowed by a per-Dockerfile ignore file for %s",
|
|
||||||
(name) => {
|
|
||||||
expect(existsSync(join(repoRoot, `${name}.dockerignore`))).toBe(
|
|
||||||
false,
|
false,
|
||||||
);
|
);
|
||||||
},
|
});
|
||||||
);
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,9 +1,7 @@
|
|||||||
// The package manifest promises three files that only exist after a build:
|
// 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
|
// `main`, `types`, and the `quak` binary. Nothing in the test suite used to
|
||||||
// look at them, and `make check` runs the suite and the lint container but
|
// look at them, and `make check` runs the test and lint phases but never the
|
||||||
// never the build, so `tsconfig.json` and `package.json` were free to drift
|
// build, so `tsconfig.json` and `package.json` were free to drift apart. They
|
||||||
// apart. (The formatting check is part of the lint container, not a step of
|
|
||||||
// its own; `test/packaging/lint-once.test.ts` is what holds that shape.) They
|
|
||||||
// did: `rootDir` was `./src` while `include` also pulled in `bin/**/*`, which
|
// 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.
|
// is TS6059, and no build had succeeded for as long as that was true.
|
||||||
//
|
//
|
||||||
|
|||||||
@@ -1,184 +0,0 @@
|
|||||||
// Linting runs in Docker, one way, everywhere: `script/lint` builds
|
|
||||||
// `Dockerfile.lint`, which COPYs the repo into a digest-pinned image and runs
|
|
||||||
// eslint and prettier as build steps, so a successful build IS a clean lint.
|
|
||||||
//
|
|
||||||
// Three things can quietly undo that, and none of them shows up as a build
|
|
||||||
// failure, which is why they are asserted here:
|
|
||||||
//
|
|
||||||
// 1. Recursion. `script/check` calls `script/lint`, and `script/lint` is now a
|
|
||||||
// `docker build`. Anything that runs `make check` inside a container is
|
|
||||||
// therefore asking for Docker inside Docker, and CI breaks. The image built
|
|
||||||
// from `Dockerfile` runs the suite and the compile only; lint happens once,
|
|
||||||
// in `Dockerfile.lint`.
|
|
||||||
// 2. Cache. A lint build over an unchanged tree returns success in well under a
|
|
||||||
// second having linted nothing. The `LINT_EPOCH` guard is what forces the
|
|
||||||
// linter layers to execute, and it has to fail closed: an unset build
|
|
||||||
// argument is the empty string, which is a perfectly stable cache key, so an
|
|
||||||
// invocation that omits it must be rejected rather than served a cached
|
|
||||||
// green.
|
|
||||||
// 3. A host lint path surviving alongside the container one, which would let a
|
|
||||||
// lint result come from an unpinned local toolchain.
|
|
||||||
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 read = (name: string): string =>
|
|
||||||
readFileSync(join(repoRoot, name), "utf-8");
|
|
||||||
|
|
||||||
// The executable lines of a shell script or Dockerfile: comments carry the
|
|
||||||
// reasoning and frequently name the very commands these tests forbid, so they
|
|
||||||
// would otherwise trigger every assertion below.
|
|
||||||
const instructions = (name: string): string[] =>
|
|
||||||
read(name)
|
|
||||||
.split("\n")
|
|
||||||
.map((line) => line.trim())
|
|
||||||
.filter((line) => line !== "" && !line.startsWith("#"));
|
|
||||||
|
|
||||||
const lintScript = instructions("script/lint");
|
|
||||||
const dockerfileLint = instructions("Dockerfile.lint");
|
|
||||||
const dockerfile = instructions("Dockerfile");
|
|
||||||
const cibuild = instructions("script/cibuild");
|
|
||||||
|
|
||||||
const has = (lines: string[], pattern: RegExp): boolean =>
|
|
||||||
lines.some((line) => pattern.test(line));
|
|
||||||
|
|
||||||
describe("script/lint", () => {
|
|
||||||
it("lints by building Dockerfile.lint", () => {
|
|
||||||
expect(has(lintScript, /docker build .*-f Dockerfile\.lint/)).toBe(
|
|
||||||
true,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The whole point of the ruling: no invocation of a linter against the
|
|
||||||
// working tree survives, so a lint verdict can only come from the pinned
|
|
||||||
// image.
|
|
||||||
it("runs no linter on the host", () => {
|
|
||||||
expect(has(lintScript, /eslint|prettier/)).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Without a fresh epoch the build is served from cache in under a second,
|
|
||||||
// having linted nothing, and still exits 0.
|
|
||||||
it("passes a fresh LINT_EPOCH on every run", () => {
|
|
||||||
expect(
|
|
||||||
has(lintScript, /--build-arg LINT_EPOCH="\$\(date \+%s\)"/),
|
|
||||||
).toBe(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("Dockerfile.lint", () => {
|
|
||||||
// Tag references are server-mutable, so they are remote code execution.
|
|
||||||
it("pins its base image by digest", () => {
|
|
||||||
expect(has(dockerfileLint, /^FROM \S+@sha256:[0-9a-f]{64}/)).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("runs eslint as a build step", () => {
|
|
||||||
expect(has(dockerfileLint, /^RUN .*eslint \./)).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("runs prettier as a build step", () => {
|
|
||||||
expect(has(dockerfileLint, /^RUN .*prettier --check \./)).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
// An unset ARG is the empty string, and an empty string is a perfectly
|
|
||||||
// stable cache key. Rejecting it is what stops a bare
|
|
||||||
// `docker build -f Dockerfile.lint .` from reporting a green it did not
|
|
||||||
// earn.
|
|
||||||
it("refuses to build without LINT_EPOCH", () => {
|
|
||||||
expect(has(dockerfileLint, /^ARG LINT_EPOCH$/)).toBe(true);
|
|
||||||
expect(
|
|
||||||
has(dockerfileLint, /^RUN \[ -n "\$LINT_EPOCH" \] \|\| exit 1$/),
|
|
||||||
).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The guard only forces execution of the layers below it, so both linters
|
|
||||||
// have to sit after it. Layer order is the mechanism, not a style choice.
|
|
||||||
it("puts both linters below the epoch guard", () => {
|
|
||||||
const guard = dockerfileLint.findIndex((line) =>
|
|
||||||
/^RUN \[ -n "\$LINT_EPOCH" \]/.test(line),
|
|
||||||
);
|
|
||||||
const linters = dockerfileLint
|
|
||||||
.map((line, index) => ({ line, index }))
|
|
||||||
.filter(({ line }) => /^RUN .*(eslint|prettier)/.test(line));
|
|
||||||
|
|
||||||
expect(linters.length).toBeGreaterThan(0);
|
|
||||||
for (const { line, index } of linters) {
|
|
||||||
expect(
|
|
||||||
index,
|
|
||||||
`${line} must run below the LINT_EPOCH guard`,
|
|
||||||
).toBeGreaterThan(guard);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Dependency installation is the slow layer and has nothing to do with the
|
|
||||||
// sources, so it caches separately: manifests first, sources afterwards.
|
|
||||||
it("copies the manifests before the sources", () => {
|
|
||||||
const manifests = dockerfileLint.findIndex((line) =>
|
|
||||||
/^COPY package\.json yarn\.lock/.test(line),
|
|
||||||
);
|
|
||||||
const sources = dockerfileLint.findIndex((line) =>
|
|
||||||
/^COPY \. \.$/.test(line),
|
|
||||||
);
|
|
||||||
|
|
||||||
expect(manifests).toBeGreaterThanOrEqual(0);
|
|
||||||
expect(sources).toBeGreaterThan(manifests);
|
|
||||||
});
|
|
||||||
|
|
||||||
// script/lint is a docker build; a lint step that shelled out to it would
|
|
||||||
// recurse.
|
|
||||||
it("does not call script/lint or make lint", () => {
|
|
||||||
expect(has(dockerfileLint, /make lint|script\/lint/)).toBe(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("Dockerfile", () => {
|
|
||||||
// `make check` runs script/lint, which is a docker build, so an image that
|
|
||||||
// ran it would need a Docker daemon inside the container.
|
|
||||||
it("does not run make check, make lint or script/lint", () => {
|
|
||||||
expect(
|
|
||||||
has(dockerfile, /make check|make lint|script\/(check|lint)/),
|
|
||||||
).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The replaced lint stage took a `COPY --from=lint` dependency to order
|
|
||||||
// itself before the check stage. Dockerfile.lint is that stage now, and
|
|
||||||
// two definitions of how to lint is one too many.
|
|
||||||
it("has no lint stage", () => {
|
|
||||||
expect(has(dockerfile, /AS lint\b|--from=lint\b/)).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("still runs the suite and the build under the epoch guard", () => {
|
|
||||||
expect(has(dockerfile, /^RUN make test$/)).toBe(true);
|
|
||||||
expect(has(dockerfile, /^RUN make build$/)).toBe(true);
|
|
||||||
expect(
|
|
||||||
has(dockerfile, /^RUN \[ -n "\$CHECK_EPOCH" \] \|\| exit 1$/),
|
|
||||||
).toBe(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("script/cibuild", () => {
|
|
||||||
// CI has to get both verdicts. Lint goes first so the fast failure is
|
|
||||||
// reported before the suite runs.
|
|
||||||
it("builds the lint image before the test and build image", () => {
|
|
||||||
const lint = cibuild.findIndex((line) => /\/lint"/.test(line));
|
|
||||||
const check = cibuild.findIndex((line) =>
|
|
||||||
/docker build .*CHECK_EPOCH/.test(line),
|
|
||||||
);
|
|
||||||
|
|
||||||
expect(lint).toBeGreaterThanOrEqual(0);
|
|
||||||
expect(check).toBeGreaterThan(lint);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("package.json", () => {
|
|
||||||
// `yarn lint` was a second, unpinned way to get a lint verdict, from
|
|
||||||
// whatever eslint the working tree happened to have installed.
|
|
||||||
it("exposes no host lint script", () => {
|
|
||||||
const pkg = JSON.parse(read("package.json")) as {
|
|
||||||
scripts: Record<string, string>;
|
|
||||||
};
|
|
||||||
expect(pkg.scripts.lint).toBeUndefined();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,503 +0,0 @@
|
|||||||
// `make check` used to run `prettier --check .` twice: once inside the lint
|
|
||||||
// container (`script/lint` builds `Dockerfile.lint`, which runs eslint and
|
|
||||||
// prettier as build steps) and once again on the host, because `script/check`
|
|
||||||
// also called `script/fmt-check`. Two passes, one verdict, and the host one is
|
|
||||||
// the weaker of the two — its prettier is whatever the working tree happens to
|
|
||||||
// have installed, while the container's is digest-pinned and installed under
|
|
||||||
// `--frozen-lockfile`.
|
|
||||||
//
|
|
||||||
// The fix was to delete the host call from `script/check` and `script/precommit`.
|
|
||||||
// Nothing about that fix is self-enforcing: anyone can wire `script/fmt-check`
|
|
||||||
// back in, or add a prettier step to a Dockerfile, and every build stays green
|
|
||||||
// while quietly doing the work twice again. So the count is asserted here
|
|
||||||
// rather than promised in a comment.
|
|
||||||
//
|
|
||||||
// The assertion is a static walk of the invocation graph, not a string match
|
|
||||||
// against one file. Starting from an entrypoint, it follows every edge the repo
|
|
||||||
// actually uses to reach another command — `run:` steps in the CI workflow,
|
|
||||||
// `"$SCRIPT_DIR/<name>"` and `script/<name>` into other scripts, `make <target>`
|
|
||||||
// through the Makefile shims, `yarn run <name>` through the `package.json`
|
|
||||||
// scripts, and `docker build -f <file>` into that Dockerfile's `RUN` steps — and
|
|
||||||
// counts the prettier invocations it finds. A prettier call added anywhere in
|
|
||||||
// that graph is therefore caught, wherever it is added.
|
|
||||||
//
|
|
||||||
// Two entrypoints are walked, because they cover different graphs: `make check`
|
|
||||||
// is what a developer runs, and `.gitea/workflows/check.yml` is what CI runs.
|
|
||||||
// The CI walk starts at the workflow file rather than at a hand-picked script,
|
|
||||||
// so "the path CI executes" is read out of the repo instead of assumed; it
|
|
||||||
// reaches `script/cibuild`, and through it the `Dockerfile` image that `make
|
|
||||||
// check` never touches. Walking only `make check` is how a duplicate prettier
|
|
||||||
// pass in `Dockerfile` stayed invisible.
|
|
||||||
//
|
|
||||||
// Undercounting is the failure mode that would make this test worthless. Three
|
|
||||||
// things guard against it: the walk is asserted to have reached the nodes that
|
|
||||||
// matter, an unresolvable or empty node is a thrown error rather than a quiet
|
|
||||||
// zero, and prettier is counted per occurrence rather than per line, so two
|
|
||||||
// invocations chained with `&&` cannot read as one.
|
|
||||||
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 read = (name: string): string =>
|
|
||||||
readFileSync(join(repoRoot, name), "utf-8");
|
|
||||||
|
|
||||||
// A backslash at end of line continues the command; the resolver has to see the
|
|
||||||
// whole invocation, since the interesting flags (`-f Dockerfile.lint`) can sit
|
|
||||||
// on the continuation.
|
|
||||||
const joinContinuations = (text: string): string[] => {
|
|
||||||
const joined: string[] = [];
|
|
||||||
for (const raw of text.split("\n")) {
|
|
||||||
const line = raw.trim();
|
|
||||||
const previous = joined[joined.length - 1];
|
|
||||||
if (previous !== undefined && previous.endsWith("\\")) {
|
|
||||||
joined[joined.length - 1] =
|
|
||||||
`${previous.slice(0, -1).trim()} ${line}`;
|
|
||||||
} else {
|
|
||||||
joined.push(line);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return joined;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Comments are stripped everywhere. The headers of these scripts explain the
|
|
||||||
// duplication this test exists to prevent, and therefore name `prettier` and
|
|
||||||
// `script/fmt-check` repeatedly; counting them would make the test assert the
|
|
||||||
// prose instead of the behaviour.
|
|
||||||
const executable = (text: string): string[] =>
|
|
||||||
joinContinuations(text).filter(
|
|
||||||
(line) => line !== "" && !line.startsWith("#"),
|
|
||||||
);
|
|
||||||
|
|
||||||
// Every occurrence, not "does this line mention prettier": a line that reads
|
|
||||||
// `yarn run prettier --check . && yarn run prettier --check src` is two passes
|
|
||||||
// over the same tree, which is exactly the bug this file exists to catch, and
|
|
||||||
// counting it as one would hide it. `.prettierrc` and `.prettierignore` are not
|
|
||||||
// invocations and do not match, because `\b` requires a non-word character
|
|
||||||
// after the name.
|
|
||||||
const countPrettier = (line: string): number =>
|
|
||||||
(line.match(/\bprettier\b/g) ?? []).length;
|
|
||||||
|
|
||||||
// Makefile targets are thin shims (`check:` / tab / `@script/check`), so a
|
|
||||||
// `make <target>` edge has to resolve through them to keep "per `make check`"
|
|
||||||
// meaning what it says. Recipe lines are the tab-indented ones.
|
|
||||||
const makeRecipes = (): Map<string, string[]> => {
|
|
||||||
const recipes = new Map<string, string[]>();
|
|
||||||
let current: string | null = null;
|
|
||||||
for (const raw of read("Makefile").split("\n")) {
|
|
||||||
if (raw.startsWith("\t")) {
|
|
||||||
if (current !== null) {
|
|
||||||
recipes.get(current)?.push(raw.trim().replace(/^[@-]+/, ""));
|
|
||||||
}
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
const target = /^([a-z][a-z-]*)\s*:(?!=)/.exec(raw);
|
|
||||||
current = target === null ? null : target[1];
|
|
||||||
if (current !== null && !recipes.has(current)) {
|
|
||||||
recipes.set(current, []);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return recipes;
|
|
||||||
};
|
|
||||||
|
|
||||||
const recipes = makeRecipes();
|
|
||||||
|
|
||||||
const packageScripts = (): Record<string, string> => {
|
|
||||||
const pkg = JSON.parse(read("package.json")) as {
|
|
||||||
scripts?: Record<string, string>;
|
|
||||||
};
|
|
||||||
return pkg.scripts ?? {};
|
|
||||||
};
|
|
||||||
|
|
||||||
const scripts = packageScripts();
|
|
||||||
|
|
||||||
// Node keys: `script/<name>`, `docker:<Dockerfile>`, `make:<target>`,
|
|
||||||
// `yarn:<package.json script>`, `workflow:<CI workflow file>`.
|
|
||||||
const resolve = (node: string): string[] => {
|
|
||||||
if (node.startsWith("script/")) return executable(read(node));
|
|
||||||
if (node.startsWith("docker:")) {
|
|
||||||
return executable(read(node.slice("docker:".length)))
|
|
||||||
.filter((line) => line.startsWith("RUN "))
|
|
||||||
.map((line) => line.slice("RUN ".length));
|
|
||||||
}
|
|
||||||
// The `run:` steps of a workflow, in file order. `uses:` steps are actions,
|
|
||||||
// not commands, and have no edges into this repo's graph. A `run: |` block
|
|
||||||
// would resolve to the bare `|`, which reaches nothing and therefore fails
|
|
||||||
// the count rather than passing quietly.
|
|
||||||
if (node.startsWith("workflow:")) {
|
|
||||||
return executable(read(node.slice("workflow:".length)))
|
|
||||||
.filter((line) => /^-?\s*run:\s*\S/.test(line))
|
|
||||||
.map((line) => line.replace(/^-?\s*run:\s*/, ""));
|
|
||||||
}
|
|
||||||
if (node.startsWith("make:")) {
|
|
||||||
const target = node.slice("make:".length);
|
|
||||||
const recipe = recipes.get(target);
|
|
||||||
// A renamed or deleted target must be a loud failure: silently walking
|
|
||||||
// an empty recipe would report zero prettier invocations, which reads
|
|
||||||
// like the tidiest possible result.
|
|
||||||
if (recipe === undefined) {
|
|
||||||
throw new Error(`no such Makefile target: ${target}`);
|
|
||||||
}
|
|
||||||
return recipe;
|
|
||||||
}
|
|
||||||
if (node.startsWith("yarn:")) {
|
|
||||||
const name = node.slice("yarn:".length);
|
|
||||||
const script = scripts[name];
|
|
||||||
if (script === undefined) {
|
|
||||||
throw new Error(`no such package.json script: ${name}`);
|
|
||||||
}
|
|
||||||
return [script];
|
|
||||||
}
|
|
||||||
throw new Error(`unresolvable node: ${node}`);
|
|
||||||
};
|
|
||||||
|
|
||||||
// Same reasoning as the missing-target error, applied to every node kind: a
|
|
||||||
// node that resolves to no commands contributes zero prettier invocations and
|
|
||||||
// zero edges, which is indistinguishable from a clean result. Fail instead.
|
|
||||||
const commandsOf = (node: string): string[] => {
|
|
||||||
const commands = resolve(node);
|
|
||||||
if (commands.length === 0) {
|
|
||||||
throw new Error(`node resolved to no commands: ${node}`);
|
|
||||||
}
|
|
||||||
return commands;
|
|
||||||
};
|
|
||||||
|
|
||||||
const edgesOf = (line: string): string[] => {
|
|
||||||
const edges: string[] = [];
|
|
||||||
|
|
||||||
// `"$SCRIPT_DIR/lint"`, `"$ROOT/script/lint"` and a bare `script/lint` are
|
|
||||||
// all the same edge.
|
|
||||||
for (const match of line.matchAll(
|
|
||||||
/(?:\$SCRIPT_DIR|\$\{SCRIPT_DIR\}|script)\/([a-z][a-z-]*)/g,
|
|
||||||
)) {
|
|
||||||
edges.push(`script/${match[1]}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Only real targets: `pkg_install gnumake make make make` in
|
|
||||||
// script/bootstrap is a package name, not an invocation of this Makefile.
|
|
||||||
for (const match of line.matchAll(/\bmake\s+([a-z][a-z-]*)/g)) {
|
|
||||||
if (recipes.has(match[1] ?? "")) edges.push(`make:${match[1]}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Same rule for yarn: `yarn run prettier` is the linter itself (counted,
|
|
||||||
// not followed), `yarn run fmt-check` would be a package.json script that
|
|
||||||
// runs it indirectly.
|
|
||||||
for (const match of line.matchAll(/\byarn(?:\s+run)?\s+([a-z][a-z-]*)/g)) {
|
|
||||||
if ((match[1] ?? "") in scripts) edges.push(`yarn:${match[1]}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
// The container lint pass lives behind a `docker build`; without following
|
|
||||||
// it the count would miss the one invocation that is supposed to survive.
|
|
||||||
if (/\bdocker\s+build\b/.test(line)) {
|
|
||||||
const file = /\s-f\s+(\S+)/.exec(line);
|
|
||||||
edges.push(`docker:${file === null ? "Dockerfile" : file[1]}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return edges;
|
|
||||||
};
|
|
||||||
|
|
||||||
interface Walk {
|
|
||||||
prettier: number;
|
|
||||||
reached: Set<string>;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Repeated invocations must count repeatedly — running the same script twice is
|
|
||||||
// exactly the bug — so nodes are not deduplicated. The path stack is only there
|
|
||||||
// to turn a cycle into a loud failure instead of a hang.
|
|
||||||
//
|
|
||||||
// Counting and edge-following both happen for every line: a line that invokes
|
|
||||||
// prettier can also invoke something else, and skipping the edges of counted
|
|
||||||
// lines silently truncated the graph.
|
|
||||||
const walk = (node: string, path: string[] = [], into?: Walk): Walk => {
|
|
||||||
const result = into ?? { prettier: 0, reached: new Set<string>() };
|
|
||||||
if (path.includes(node)) {
|
|
||||||
throw new Error(`invocation cycle: ${[...path, node].join(" -> ")}`);
|
|
||||||
}
|
|
||||||
result.reached.add(node);
|
|
||||||
|
|
||||||
for (const line of commandsOf(node)) {
|
|
||||||
result.prettier += countPrettier(line);
|
|
||||||
for (const edge of edgesOf(line)) {
|
|
||||||
walk(edge, [...path, node], result);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
};
|
|
||||||
|
|
||||||
describe("prettier runs exactly once per make check", () => {
|
|
||||||
const check = walk("make:check");
|
|
||||||
|
|
||||||
// The headline assertion, and the one the issue is about.
|
|
||||||
it("invokes prettier once for the whole of make check", () => {
|
|
||||||
expect(check.prettier).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Guards against the count being 1 (or 0) because the walk never got
|
|
||||||
// anywhere. `make check` has to reach the suite, the lint script, and the
|
|
||||||
// Dockerfile whose build IS the lint verdict.
|
|
||||||
it.each(["script/check", "script/test", "script/lint", "Dockerfile.lint"])(
|
|
||||||
"reaches %s while counting",
|
|
||||||
(node) => {
|
|
||||||
const key = node.startsWith("script/") ? node : `docker:${node}`;
|
|
||||||
expect([...check.reached]).toContain(key);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
// The one that survives is the container's, not the host's: that is the
|
|
||||||
// authoritative verdict, since a successful Dockerfile.lint build is what
|
|
||||||
// CI treats as proof of a clean tree.
|
|
||||||
it("keeps the surviving invocation inside the lint container", () => {
|
|
||||||
expect(walk("docker:Dockerfile.lint").prettier).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("does not reach the host formatting check from make check", () => {
|
|
||||||
expect([...check.reached]).not.toContain("script/fmt-check");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("prettier runs exactly once per CI build", () => {
|
|
||||||
// Rooted at the workflow file, so this is the graph CI executes rather than
|
|
||||||
// the graph someone believed CI executes. `make check` cannot stand in for
|
|
||||||
// it: CI runs script/cibuild, which builds Dockerfile as well as
|
|
||||||
// Dockerfile.lint, and nothing under `make check` ever reads Dockerfile.
|
|
||||||
const ci = walk("workflow:.gitea/workflows/check.yml");
|
|
||||||
|
|
||||||
it("invokes prettier once for the whole CI build", () => {
|
|
||||||
expect(ci.prettier).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
// script/cibuild is here because the workflow is asserted to run it;
|
|
||||||
// Dockerfile is here because it is the half of the CI graph that the
|
|
||||||
// `make check` walk cannot see.
|
|
||||||
it.each([
|
|
||||||
"script/cibuild",
|
|
||||||
"script/lint",
|
|
||||||
"docker:Dockerfile.lint",
|
|
||||||
"docker:Dockerfile",
|
|
||||||
])("reaches %s while counting", (node) => {
|
|
||||||
expect([...ci.reached]).toContain(node);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The test and build image must not lint: linting is Dockerfile.lint's job,
|
|
||||||
// and a prettier step added here would be a second pass over the same tree
|
|
||||||
// for the same verdict — on the one path where it matters most.
|
|
||||||
it("keeps prettier out of the test and build image", () => {
|
|
||||||
expect(walk("docker:Dockerfile").prettier).toBe(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("the standalone entrypoints still do what their names say", () => {
|
|
||||||
// REPO_POLICIES.md requires both `make lint` and `make fmt-check` to exist
|
|
||||||
// and mean something. Dropping fmt-check from script/check must not turn it
|
|
||||||
// into a target nobody can use, and must not leave `make check` passing
|
|
||||||
// because both halves became no-ops.
|
|
||||||
it("still checks formatting under make fmt-check", () => {
|
|
||||||
expect(walk("make:fmt-check").prettier).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("still checks formatting under make lint", () => {
|
|
||||||
expect(walk("make:lint").prettier).toBe(1);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("script/precommit", () => {
|
|
||||||
// Same duplication as script/check, same fix. The hook still catches a
|
|
||||||
// badly formatted tree before the commit lands, because script/lint is the
|
|
||||||
// container prettier run — that is the whole reason the host call could go.
|
|
||||||
it("checks formatting exactly once", () => {
|
|
||||||
expect(walk("script/precommit").prettier).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("gets that check from the lint container", () => {
|
|
||||||
expect([...walk("script/precommit").reached]).toContain(
|
|
||||||
"docker:Dockerfile.lint",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// script/bootstrap installs the dependencies, and it has two install sites: one
|
|
||||||
// for the case where yarn has to be reached through nvm, and one for the case
|
|
||||||
// where yarn is already on PATH. A substring check against the whole file
|
|
||||||
// cannot tell them apart, so it reports the first and says nothing about the
|
|
||||||
// second — which is the one the containers take, because the pinned node image
|
|
||||||
// ships yarn. Both are resolved separately here.
|
|
||||||
const installBranches = (): { withoutYarn: string[]; withYarn: string[] } => {
|
|
||||||
const lines = executable(read("script/bootstrap"));
|
|
||||||
const open = lines.findIndex((line) =>
|
|
||||||
/^install_js_deps\s*\(\)/.test(line),
|
|
||||||
);
|
|
||||||
if (open === -1) {
|
|
||||||
throw new Error("script/bootstrap: no install_js_deps function");
|
|
||||||
}
|
|
||||||
const close = lines.indexOf("}", open);
|
|
||||||
const body = lines.slice(open + 1, close === -1 ? undefined : close);
|
|
||||||
const guard = body.findIndex((line) =>
|
|
||||||
/^if\b.*\bmissing yarn\b/.test(line),
|
|
||||||
);
|
|
||||||
const otherwise = body.indexOf("else", guard);
|
|
||||||
const end = body.indexOf("fi", otherwise);
|
|
||||||
if (guard === -1 || otherwise === -1 || end === -1) {
|
|
||||||
throw new Error(
|
|
||||||
"script/bootstrap: install_js_deps is not the expected " +
|
|
||||||
"if missing yarn / else / fi shape",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
withoutYarn: body.slice(guard + 1, otherwise),
|
|
||||||
withYarn: body.slice(otherwise + 1, end),
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
// Every `yarn install` in the given lines, with its flags, so an unpinned
|
|
||||||
// install cannot hide next to a pinned one.
|
|
||||||
const yarnInstalls = (lines: string[]): string[] =>
|
|
||||||
lines.flatMap((line) =>
|
|
||||||
[...line.matchAll(/\byarn install\b[^"'&|;]*/g)].map((match) =>
|
|
||||||
match[0].trim(),
|
|
||||||
),
|
|
||||||
);
|
|
||||||
|
|
||||||
describe("host and container prettier cannot disagree", () => {
|
|
||||||
// With the host pass gone from `make check`, `make fmt-check` is the only
|
|
||||||
// host-side formatting check left, and the container is the gate. The two
|
|
||||||
// must keep producing the same verdict on the same tree, or a developer
|
|
||||||
// running `make fmt-check` gets a green that CI then rejects.
|
|
||||||
//
|
|
||||||
// Three things make them agree, and all three are load-bearing:
|
|
||||||
it("pins the same prettier for both", () => {
|
|
||||||
const pkg = JSON.parse(read("package.json")) as {
|
|
||||||
devDependencies: Record<string, string>;
|
|
||||||
};
|
|
||||||
// An exact version, not a range: `^3.8.1` would let the container and
|
|
||||||
// the host resolve different builds with different formatting.
|
|
||||||
expect(pkg.devDependencies.prettier).toMatch(/^\d+\.\d+\.\d+$/);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("installs from the lockfile on the branch the container takes", () => {
|
|
||||||
// Both images are FROM a node image, which ships yarn, so `missing
|
|
||||||
// yarn` is false and this is the branch that runs in the container.
|
|
||||||
const installs = yarnInstalls(installBranches().withYarn);
|
|
||||||
expect(installs).not.toHaveLength(0);
|
|
||||||
for (const install of installs) {
|
|
||||||
expect(install).toContain("--frozen-lockfile");
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
it("installs from the lockfile on the nvm branch too", () => {
|
|
||||||
// Not the container's branch, but it is the one a developer without
|
|
||||||
// yarn on PATH gets, and their prettier has to match the container's.
|
|
||||||
const installs = yarnInstalls(installBranches().withoutYarn);
|
|
||||||
expect(installs).not.toHaveLength(0);
|
|
||||||
for (const install of installs) {
|
|
||||||
expect(install).toContain("--frozen-lockfile");
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
it("runs script/bootstrap inside the lint container", () => {
|
|
||||||
// Without this the lockfile assertions above would be about a script
|
|
||||||
// the container never executes.
|
|
||||||
expect([...walk("docker:Dockerfile.lint").reached]).toContain(
|
|
||||||
"script/bootstrap",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("keeps .gitignore in the build context", () => {
|
|
||||||
// Prettier 3 reads .gitignore as a default ignore file, so excluding it
|
|
||||||
// from the context would change which files the container checks.
|
|
||||||
const dockerignore = read(".dockerignore")
|
|
||||||
.split("\n")
|
|
||||||
.map((line) => line.trim());
|
|
||||||
expect(dockerignore).not.toContain(".gitignore");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("the walk cannot pass vacuously", () => {
|
|
||||||
// An earlier draft of this file computed a Makefile target as
|
|
||||||
// `node.slice("make:")` — a string where a number belongs, which coerces to
|
|
||||||
// NaN and made every target resolve to nothing. The count went to zero and
|
|
||||||
// an assertion of "not twice" would have been satisfied by a walk that had
|
|
||||||
// read nothing at all. Every way of reaching nothing is therefore an
|
|
||||||
// error here, and the ways are tested rather than assumed.
|
|
||||||
it("reports zero for a subgraph that does not run prettier", () => {
|
|
||||||
expect(walk("make:clean").prettier).toBe(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("refuses a Makefile target that does not exist", () => {
|
|
||||||
expect(() => walk("make:no-such-target")).toThrow(
|
|
||||||
/no such Makefile target/,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("refuses a package.json script that does not exist", () => {
|
|
||||||
expect(() => walk("yarn:no-such-script")).toThrow(
|
|
||||||
/no such package.json script/,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("refuses a script that does not exist", () => {
|
|
||||||
expect(() => walk("script/no-such-script")).toThrow(/ENOENT/);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("refuses a node that resolves to no commands", () => {
|
|
||||||
// .dockerignore has no RUN steps, standing in for a Dockerfile whose
|
|
||||||
// steps a restructure moved somewhere the resolver cannot see.
|
|
||||||
expect(() => walk("docker:.dockerignore")).toThrow(
|
|
||||||
/resolved to no commands/,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("refuses a node kind it does not understand", () => {
|
|
||||||
expect(() => walk("nonsense")).toThrow(/unresolvable node/);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("refuses to walk in circles", () => {
|
|
||||||
expect(() => walk("make:check", ["script/check"])).toThrow(
|
|
||||||
/invocation cycle/,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("the resolver reads what the shell would run", () => {
|
|
||||||
// Counting per line is how `yarn run prettier --check . && yarn run
|
|
||||||
// prettier --check src` read as a single invocation.
|
|
||||||
it("counts every prettier invocation on a line", () => {
|
|
||||||
expect(
|
|
||||||
countPrettier(
|
|
||||||
"yarn run prettier --check . && yarn run prettier --check src",
|
|
||||||
),
|
|
||||||
).toBe(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("does not count the config files as invocations", () => {
|
|
||||||
expect(countPrettier("COPY .prettierrc .prettierignore ./")).toBe(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The counting `continue` also dropped every edge that shared a line with a
|
|
||||||
// prettier call, so a whole subtree could be hidden behind one `&&`.
|
|
||||||
it("still follows the edges of a line that invokes prettier", () => {
|
|
||||||
expect(
|
|
||||||
edgesOf('yarn run prettier --check . && "$SCRIPT_DIR/lint"'),
|
|
||||||
).toContain("script/lint");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("resolves every spelling of a script call to one node", () => {
|
|
||||||
expect(
|
|
||||||
edgesOf('"$SCRIPT_DIR/lint" "${SCRIPT_DIR}/test" script/fmt'),
|
|
||||||
).toEqual(["script/lint", "script/test", "script/fmt"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("follows a bare docker build to Dockerfile and -f to its file", () => {
|
|
||||||
expect(edgesOf("docker build .")).toContain("docker:Dockerfile");
|
|
||||||
expect(edgesOf("docker build -f Dockerfile.lint .")).toContain(
|
|
||||||
"docker:Dockerfile.lint",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("reads the run steps of the CI workflow and not its uses steps", () => {
|
|
||||||
expect(commandsOf("workflow:.gitea/workflows/check.yml")).toEqual([
|
|
||||||
"script/cibuild",
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -215,6 +215,9 @@ const buildThumbMock = async (opts?: {
|
|||||||
thumbnail: {
|
thumbnail: {
|
||||||
decryptionHeader: toBase64(sodium.randombytes_buf(24)),
|
decryptionHeader: toBase64(sodium.randombytes_buf(24)),
|
||||||
},
|
},
|
||||||
|
// The encrypted size of the thumbnail the server records; large
|
||||||
|
// enough here that the default encoding fits.
|
||||||
|
info: { thumbSize: 1_000_000 },
|
||||||
updationTime: TEST_TIME,
|
updationTime: TEST_TIME,
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
@@ -446,6 +449,32 @@ const openLib = (client: Client): Promise<Library> =>
|
|||||||
precacheOriginals: false,
|
precacheOriginals: false,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
/** The mock's raw record for one file, for a test to change before login. */
|
||||||
|
const rawFile = (m: ThumbMockState, fileID: number): Record<string, unknown> =>
|
||||||
|
m.filesByCollection[1]!.find((f) => f.id === fileID)!;
|
||||||
|
|
||||||
|
/** Replace the original the mock serves for one file. */
|
||||||
|
const replaceOriginal = (
|
||||||
|
m: ThumbMockState,
|
||||||
|
fileID: number,
|
||||||
|
body: Uint8Array,
|
||||||
|
): void => {
|
||||||
|
const push = sodium.crypto_secretstream_xchacha20poly1305_init_push(
|
||||||
|
m.fileKeys[fileID]!,
|
||||||
|
);
|
||||||
|
m.fileCiphertexts[fileID] =
|
||||||
|
sodium.crypto_secretstream_xchacha20poly1305_push(
|
||||||
|
push.state,
|
||||||
|
body,
|
||||||
|
null,
|
||||||
|
sodium.crypto_secretstream_xchacha20poly1305_TAG_FINAL,
|
||||||
|
);
|
||||||
|
rawFile(m, fileID).file = { decryptionHeader: toBase64(push.header) };
|
||||||
|
};
|
||||||
|
|
||||||
|
const isOriginalDownload = (url: string): boolean =>
|
||||||
|
url.includes("files.ente.io") || url.includes("/files/download/");
|
||||||
|
|
||||||
const login = (fetch: typeof globalThis.fetch, retry?: RetryOptions) =>
|
const login = (fetch: typeof globalThis.fetch, retry?: RetryOptions) =>
|
||||||
Client.login({
|
Client.login({
|
||||||
email: TEST_EMAIL,
|
email: TEST_EMAIL,
|
||||||
@@ -581,6 +610,33 @@ describe("listMissingThumbnails", () => {
|
|||||||
// Should still be 2, not 4 (each file checked only once)
|
// Should still be 2, not 4 (each file checked only once)
|
||||||
expect(missing.length).toBe(2);
|
expect(missing.length).toBe(2);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("skips a file another account owns without fetching its thumbnail", async () => {
|
||||||
|
const otherMock = await buildThumbMock();
|
||||||
|
rawFile(otherMock, 102).ownerID = 7;
|
||||||
|
const logs: string[] = [];
|
||||||
|
const counted = countingFetch(
|
||||||
|
buildThumbFetch(otherMock),
|
||||||
|
(url) => url.includes("thumbnails.ente.io") && url.includes("102"),
|
||||||
|
);
|
||||||
|
const client = await login(counted.fetch);
|
||||||
|
const lib = await openLib(client);
|
||||||
|
|
||||||
|
const missing = await listMissingThumbnails(lib, client, (msg) =>
|
||||||
|
logs.push(msg),
|
||||||
|
);
|
||||||
|
lib.close();
|
||||||
|
|
||||||
|
expect(missing.map((m) => m.fileID)).toEqual([101]);
|
||||||
|
expect(counted.matched()).toBe(0);
|
||||||
|
expect(
|
||||||
|
logs.some(
|
||||||
|
(l) =>
|
||||||
|
l.includes("Skipping file-102.jpg") &&
|
||||||
|
l.includes("another account"),
|
||||||
|
),
|
||||||
|
).toBe(true);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("fixMissingThumbnails", () => {
|
describe("fixMissingThumbnails", () => {
|
||||||
@@ -688,6 +744,93 @@ describe("fixMissingThumbnails", () => {
|
|||||||
expect(fixMock.uploadedThumbnails.length).toBe(1);
|
expect(fixMock.uploadedThumbnails.length).toBe(1);
|
||||||
expect(fixMock.uploadedThumbnails[0]!.fileID).toBe(101);
|
expect(fixMock.uploadedThumbnails[0]!.fileID).toBe(101);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("skips a file another account owns without downloading it", async () => {
|
||||||
|
// The server accepts a thumbnail only from the file's owner.
|
||||||
|
const fixMock = await buildThumbMock();
|
||||||
|
rawFile(fixMock, 101).ownerID = 7;
|
||||||
|
const counted = countingFetch(
|
||||||
|
buildThumbFetch(fixMock),
|
||||||
|
isOriginalDownload,
|
||||||
|
);
|
||||||
|
const client = await login(counted.fetch);
|
||||||
|
const lib = await openLib(client);
|
||||||
|
|
||||||
|
const results = await fixMissingThumbnails(lib, client, [101]);
|
||||||
|
lib.close();
|
||||||
|
|
||||||
|
expect(results[0]!.status).toBe("skipped");
|
||||||
|
expect(results[0]!.reason).toContain("another account");
|
||||||
|
expect(counted.matched()).toBe(0);
|
||||||
|
expect(fixMock.uploadedThumbnails.length).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("skips a file whose recorded thumbnail size is 0 without downloading it", async () => {
|
||||||
|
// The server refuses a thumbnail larger than the one it records, and
|
||||||
|
// no thumbnail is 0 bytes.
|
||||||
|
const fixMock = await buildThumbMock();
|
||||||
|
rawFile(fixMock, 101).info = { thumbSize: 0 };
|
||||||
|
const counted = countingFetch(
|
||||||
|
buildThumbFetch(fixMock),
|
||||||
|
isOriginalDownload,
|
||||||
|
);
|
||||||
|
const client = await login(counted.fetch);
|
||||||
|
const lib = await openLib(client);
|
||||||
|
|
||||||
|
const results = await fixMissingThumbnails(lib, client, [101]);
|
||||||
|
lib.close();
|
||||||
|
|
||||||
|
expect(results[0]!.status).toBe("skipped");
|
||||||
|
expect(results[0]!.reason).toContain("recorded thumbnail size is 0");
|
||||||
|
expect(counted.matched()).toBe(0);
|
||||||
|
expect(fixMock.uploadedThumbnails.length).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("re-encodes smaller until the thumbnail fits the recorded size", async () => {
|
||||||
|
// A noisy 400x300 JPEG, which the default encoding (quality 50, not
|
||||||
|
// resized because it is under 720 px) cannot compress below the size
|
||||||
|
// recorded here: one byte less than that encoding's ciphertext.
|
||||||
|
const fixMock = await buildThumbMock();
|
||||||
|
const w = 400;
|
||||||
|
const h = 300;
|
||||||
|
const noisy = new Uint8Array(
|
||||||
|
jpegJs.encode(
|
||||||
|
{
|
||||||
|
data: sodium.randombytes_buf(w * h * 4),
|
||||||
|
width: w,
|
||||||
|
height: h,
|
||||||
|
},
|
||||||
|
90,
|
||||||
|
).data,
|
||||||
|
);
|
||||||
|
replaceOriginal(fixMock, 101, noisy);
|
||||||
|
const decoded = jpegJs.decode(noisy, {
|
||||||
|
useTArray: true,
|
||||||
|
formatAsRGBA: true,
|
||||||
|
});
|
||||||
|
const defaultSize =
|
||||||
|
jpegJs.encode(decoded, 50).data.length +
|
||||||
|
sodium.crypto_secretstream_xchacha20poly1305_ABYTES;
|
||||||
|
const recordedSize = defaultSize - 1;
|
||||||
|
rawFile(fixMock, 101).info = { thumbSize: recordedSize };
|
||||||
|
|
||||||
|
const client = await login(buildThumbFetch(fixMock));
|
||||||
|
const lib = await openLib(client);
|
||||||
|
|
||||||
|
const results = await fixMissingThumbnails(lib, client, [101]);
|
||||||
|
lib.close();
|
||||||
|
|
||||||
|
expect(results[0]!.status).toBe("fixed");
|
||||||
|
const upload = fixMock.uploadedThumbnails[0]!;
|
||||||
|
expect(upload.ciphertext.length).toBeLessThanOrEqual(recordedSize);
|
||||||
|
const decrypted = decryptBlob(
|
||||||
|
upload.ciphertext,
|
||||||
|
fromBase64(upload.decryptionHeader),
|
||||||
|
fixMock.fileKeys[101]!,
|
||||||
|
);
|
||||||
|
expect(decrypted[0]).toBe(0xff);
|
||||||
|
expect(decrypted[1]).toBe(0xd8);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("Client.getApiClient", () => {
|
describe("Client.getApiClient", () => {
|
||||||
|
|||||||
Reference in New Issue
Block a user