mirror of
https://github.com/penpot/penpot.git
synced 2026-11-16 15:11:17 +00:00
* ✨ Reference the file data storage object with a foreign key The file data pointer lived in `file_data.metadata.storage-ref-id`, a JSON key. The storage GC parsed it to find live references, and nothing stopped it from physically deleting an object a live row still pointed at: a failure in that scan lost the blob. Migration 0159 moves the pointer to a nullable `storage_object_id` column on `file_data`, backfills it from the metadata key, removes the key from the rows it backfills, indexes the column and rebuilds the foreign key to `storage_object(id)` as `NO ACTION DEFERRABLE INITIALLY IMMEDIATE`. `INITIALLY IMMEDIATE` is deliberate: the GC catches the violation inside the chunk transaction, while a deferred check would fire at commit, outside it, and the sweep would never move past the blocked chunk. The column is the only source of truth. The `storage-ref-id` entry is gone from the file metadata schema, and the single point that serializes the metadata drops it, so no write can resurrect it. `upsert!` does not query the row: the pointer of the row being replaced travels in its params, and the object is touched before the row is written. Fragments and snapshots pass nil because a modified pointer always gets a new id; the offload passes its own row; `insert-file!` drops it, since an INSERT never replaces a persisted object. `update-file!` takes the file map read from the database plus the fields to change and merges them, so the pointer comes from the read map and no caller can lose it by building a partial map. A map without `:data` raises `:missing-file-data`: it is not `assert`, which is compiled out in the deployed binary. The params cannot override the pointer or retarget the write with `:id`/`:file-id`. `bfc/file->response` strips the pointer from every response (`get-file`, `create-file`, `duplicate-file`, the view-only bundle, the team access request, the comments read, the library summary, the snapshot read and the debug download). A `file-data` object is authentication-only, so a leaked id would let any logged-in profile fetch the blob from `/assets/by-id`. `get-file-fragment` resolves through the file data backend, so a fragment on cold storage no longer hands nil to `blob/decode`, and answers only the keys of its result schema. The storage GC reference scan, the restore union and `objects-gc` read the column. The offload reads `SELECT fd.*`, so its rows go through a `decode-row` that decodes jsonb metadata and drops a JSON null, which the row schema rejected; a row without a readable object raises `:missing-storage-object` with the file and row ids. A chunk blocked by the foreign key (SQLState 23503) is a real anomaly, since the reference scan should have frozen the object: it stays an error with its own hint and the chunk is retried on the next run until the reference is fixed. The release is a coordinated restart, not a rolling deploy, and not rollback-safe for the rows it writes: the previous code writes and scans the metadata pointer, so a key it writes misses the backfill and removing it loses the reference. `operations/2.20.0-file-data-storage-object-id.md` builds the column, the index and the foreign key online and runs the backfill with every instance stopped, then marks the step as applied; a fresh or small instance does the whole job in the migration. The runbook keeps the validation scan out of the stopped window and adds a lock timeout and retry to the online statements. Tests cover the foreign key shape, the backfill and its corrupt and orphan guards, the rebuild of a missing index and of a wrong, non-deferrable or deferred constraint, the deletion refused by a live reference, the metadata cleanup, the offload row normalizations, the touched objects of the unshare and the restore, the response stripping on every call site and the chunk blocked by the foreign key. The backend memories and the developer guide document the pointer, the GC behavior and the two migration paths. Closes #12768 AI-assisted-by: deepseek-v4.1-flash AI-assisted-by: inkling-2-small-free * 🐛 Hold the file row lock across the migration write `get-file` applies the pending migrations in memory and, when it finds any, persists the result. That write read the row without a lock and `update-file!` is an unconditional UPDATE, so a save that committed in between was overwritten: the saved content, `revn` and `modified-at` went back, the next save from that client failed with `:revn-conflict` and the object the save left became an orphan the storage GC cannot revisit once it is frozen. The read now runs in a transaction of its own (`get-file` calls `get-file*` inside `db/tx-run!` and accepts a cfg map only), so the `file` row lock covers the re-check and the write. `get-file*` reads the row once (`sql:get-file` plus `resolve-applied-migrations`) and completes it with `attach-file-data`; only when a migration is pending it reads the file again under `FOR UPDATE`, re-checks `need-migration?` on that fresh map and persists it (`migrate-file`). The common case stays at one row read and one migrations resolution, the migration case keeps a single decoded copy in the heap, and a row that changed in between is not overwritten. A migration found on the unlocked read is applied in memory only, for the next read to persist. `migrate-file` returns the reattached map when it persists, with the `:storage-object-id` of the row the write left, and the realized map when it does not; `:realize?` is what returns the read fully plain. `fdata/upsert!` answers `{:written ... :storage-object-id ...}` instead of a boolean, `update-file!` propagates it and the migrating read puts it back in the map it returns, so a caller that persists again touches the current object instead of the replaced one. `insert-file!` keeps nil: an INSERT never replaces a persisted object. The write also compares the stored pointer with the caller's value (`IS NOT DISTINCT FROM`) and raises `:stale-file-data-pointer` when it affects no row. Every writer holds the `file` row lock, so a pointer that no longer matches is a protocol violation, not a race to retry. The expected pointer is a separate argument because the storage branch replaces `:storage-object-id` before the upsert, and the check lives in `upsert-in-database`: the `legacy-db` branches do not use that SQL and their count can legitimately be zero. The save, snapshot and restore-backup reads take `FOR UPDATE` instead of `FOR SHARE`: they inherit the lock, and the migration branch asks for the exclusive one in the same transaction, so a shared lock that upgrades deadlocks two concurrent readers. A data read rejects `:lock-for-share?` for the same reason; only row-only reads accept it. `sql:get-file-without-data` is a plain select now, not a CTE, which makes locking legal without loading the data. Realization has a single owner: `attach-file-data` only resolves and decodes, and `get-file*` realizes once per path. The applied migrations no longer travel in the `get-file-with-summary` response, cache hit and cache miss alike. `embed-assets` reads each library without `:realize?`, so its `:components` is an unloaded pointer map; `absorb-assets` walks it with `vals`, `PointerMap.seq` calls `load!` and that raised with no loader bound, so every export with `:merge-libraries` of a library with components failed. The absorb runs under the library's own loader now. The in-place binfile import (`import-file-and-overwrite*`, `::overwrite`, `::bfc/file-id`) had no product caller and cannot carry the previous `storage_object_id`, so overwriting a storage-backed row would leave its object unreclaimed. `import-files!` rejects a cfg with `::bfc/file-id` (`:not-supported`) and the helpers only that path used go with it (`invalidate-thumbnails`, `*reference-file*`, the `::overwrite` id branch of `index-object` and of `save-file!`, the `on-conflict-do-nothing?` flag of the media insert). Tests: a new `file-migration-read-test` pins the single read, the locked re-read, the concurrent save interleaving, the double migration and the read-only path; the upsert tests cover the return shape and the stale pointer; the SQL recorder they share lives in `backend-tests.helpers`, and the save, snapshot, restore and summary sequences follow the new reads. The backend memories document the read contract and the pointer. AI-assisted-by: deepseek-v4.1-flash * 🐛 Harden the get-file guard and skip its read-only transaction The cfg guard of `get-file` was an `assert`, which `app.config` elides when `:backend-asserts` is off, so a deployed binary accepted a bare pool or connection while the docstring promised it raises. It throws `IllegalArgumentException` now, the class the option guards of the same namespace already use, and the existing test expects it instead of `AssertionError`. A read with `:read-only?` applies the pending migrations in memory and writes nothing, so the transaction the migration write needs only costs two round trips there. `get-file` runs it with `db/run!` instead: with a cfg that carries a connection it still joins the caller's transaction, and only the reads that would have opened their own skip it. A lock option needs a read-write transaction from the caller, because PostgreSQL rejects row locks in a read-only one; the docstring states that. Tests: the guard test expects the new class; a cfg marked `::db/read-only` reads a pending migration without persisting it (the config flag that fills that key is legacy, but the key is set by hand); and a read-only read is pinned as not opening a transaction while the same call without the option does. The backend memory documents the split and the guard. AI-assisted-by: deepseek-v4.1-flash
66 lines
2.9 KiB
SQL
66 lines
2.9 KiB
SQL
-- Turn the file data storage pointer into a column with a foreign key.
|
|
--
|
|
-- Until now the pointer lived in `file_data.metadata->>'storage-ref-id'`.
|
|
-- The storage GC parsed the JSON, and nothing stopped it from deleting the
|
|
-- blob of a live row. With the column and the foreign key the database
|
|
-- refuses that delete.
|
|
--
|
|
-- With the storage backend the release is a coordinated restart: the column is
|
|
-- the only source of truth, and the previous code cannot read the rows this
|
|
-- release writes. With the default `db` backend the new code writes the same
|
|
-- `file_data.data` column the previous code reads, so a rolling deploy is
|
|
-- safe.
|
|
--
|
|
-- This migration runs on a fresh database and on small instances. A large
|
|
-- instance builds the column and the index out of band, runs this same
|
|
-- backfill and foreign key with the instances stopped, and marks this step as
|
|
-- applied; the end state is identical. See
|
|
-- `operations/2.20.0-file-data-storage-object-id.md`.
|
|
--
|
|
-- `DEFERRABLE` follows the schema convention (all foreign keys of the project
|
|
-- are deferrable, so `th/database-reset` can delete table by table with
|
|
-- `SET CONSTRAINTS ALL DEFERRED`). It is `INITIALLY IMMEDIATE`, not
|
|
-- `DEFERRED`: the storage GC catches the violation inside the chunk
|
|
-- transaction and retries the chunk, and a deferred check would fire at
|
|
-- commit, outside that transaction, so the GC would never move past it.
|
|
|
|
ALTER TABLE file_data
|
|
ADD COLUMN IF NOT EXISTS storage_object_id uuid;
|
|
|
|
-- The CTE is MATERIALIZED so the uuid cast only sees rows that passed the
|
|
-- regex. A plain subquery can be inlined, and a corrupt value would reach the
|
|
-- cast and abort the migration.
|
|
WITH candidates AS MATERIALIZED (
|
|
SELECT file_id,
|
|
id,
|
|
(metadata->>'storage-ref-id')::uuid AS soid
|
|
FROM file_data
|
|
WHERE backend = 'storage'
|
|
AND storage_object_id IS NULL
|
|
AND (metadata->>'storage-ref-id') ~*
|
|
'^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$'
|
|
)
|
|
UPDATE file_data AS fd
|
|
SET storage_object_id = c.soid,
|
|
metadata = fd.metadata - 'storage-ref-id'
|
|
FROM candidates AS c
|
|
WHERE fd.file_id = c.file_id
|
|
AND fd.id = c.id
|
|
AND EXISTS (SELECT 1 FROM storage_object AS so WHERE so.id = c.soid);
|
|
|
|
-- The deletion check of the foreign key looks a row up by this column for
|
|
-- every deleted object; without the index it scans all partitions.
|
|
CREATE INDEX IF NOT EXISTS file_data__storage_object_id__idx
|
|
ON file_data (storage_object_id);
|
|
|
|
-- Rebuild the constraint so the definition is always the one above. This is
|
|
-- also how a constraint created by hand with the wrong shape (CASCADE, not
|
|
-- deferrable, or `INITIALLY DEFERRED`) gets repaired.
|
|
ALTER TABLE file_data
|
|
DROP CONSTRAINT IF EXISTS file_data_storage_object_id_fkey;
|
|
|
|
ALTER TABLE file_data
|
|
ADD CONSTRAINT file_data_storage_object_id_fkey
|
|
FOREIGN KEY (storage_object_id) REFERENCES storage_object(id)
|
|
ON DELETE NO ACTION DEFERRABLE INITIALLY IMMEDIATE;
|