generate-fixtures: configurable asset store (local folder or Flysystem) with a content-hash manifest and pruning
I maintainer di solito rispondono entro 1 giorno
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 10/100
Direzione di ricerca
Start with the generator behind generate-fixtures and the scaffold that loads files with new File(__DIR__ . '/assets/<name>'), then the bundle config under silverback_api_components.fixtures.assets. Pull request #466 is already open against this issue, so check its state before starting. Done means a settled design for the manifest, the store abstraction, and pruning, which needs maintainer agreement first.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
generate-fixtures writes every stored file next to the scaffold (assets/), and the scaffold loads each one with new File(__DIR__ . '/assets/<name>'). For a real site that becomes a lot of binary in the repo.
Cymru Kitchens is the example: 710 images, 275 MB.
- Committed: it more than doubles the git history permanently, and
api/srcis copied into the php image. - Excluded from the image:
.dockerignorebreaks a fixture load in a pod. - Git LFS: works, but it is a git-host choice the bundle shouldn't depend on.
The memory side of loading real-size snapshots is #460.
Proposal
1. The scaffold refers to files by content
- The generator writes a manifest alongside the class, with one entry per file: sha256, size, mime type, original name, and the uploadable field it came from.
- The class refers to a file by its hash, never a path.
- Files are stored under content-hash names. An unchanged image keeps its name across regenerations, so diffs only show real changes, and a file used twice is stored once.
2. The location is bundle config, read by both generate and load
silverback_api_components:
fixtures:
assets:
store: local # local | flysystem
path: '%kernel.project_dir%/fixtures/assets' # local
adapter: gcloud # flysystem: one of the app's adapters
prefix: fixtures/ # flysystem
generate-fixtureswrites the files to the configured store and writes the manifest.doctrine:fixtures:loadresolves each hash through the same store.- The class doesn't say where files live, so the same scaffold can load from a local folder for a developer and from a bucket in CI or a review app (
storefrom an env var). - Command options override the config for one-off runs (
--assets-store,--assets-dir). - Generating needs write access to the store, and loading needs read access. A Flysystem store reuses the app's existing adapters.
- Default: a folder next to the scaffold, as today. Small sites and existing scaffolds keep working, and small sites can still just commit their assets.
3. Pruning follows the manifest
- Local folder: generating rewrites the manifest and deletes any file in the folder it no longer references, so the folder always matches the class.
- Flysystem: a command such as
fixtures:prune-assetsdeletes objects under the prefix that no kept manifest references. "Kept" means the current manifest plus any listed (or recent) ones, so a branch still on an older snapshot can load. Hash names make this safe: an object is either referenced or it isn't. - Pruning git history is out of scope. Using a Flysystem store keeps large files out of history in the first place.
4. Optional size cap for development (--max-dimension)
- Downscale images on export, e.g. to 2400 px, the widest variant, so nothing visible changes. This would cut a site like CK's assets a lot.
- Off by default, because the default should stay byte-identical to production. The fixed-point check (generate, load, generate again: byte-identical) holds with it off.
Use on Cymru Kitchens
A Flysystem store pointed at a fixtures/ prefix in the existing media bucket, the manifest in git, and nothing large in the repo or the image. CK's snapshot is generated and verified, and it's waiting on this and #460.
- Lingua principale
- PHP
- Stelle
- 32
- Fork
- 8
- Merge medio
- 40m
- PR unite (30g)
- 133
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di components-web-app/api-components-bundle
-
Codecov project status fails before the Behat coverage upload landsForse già presa @silverbackdan l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 20/100
components-web-app/api-components-bundle#472 ·
I maintainer di solito rispondono entro 1 giorno
-
Fixture builder: accept a PageBuilder or PageDataBuilder as the target of linkRoute(), linkIri() and redirect(to:)Forse già presa @silverbackdan l’ha presa oggi. Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 15/100
components-web-app/api-components-bundle#471 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
components-web-app/api-components-bundle#469 ·
I maintainer di solito rispondono entro 1 giorno
-
Component groups: a maximum number of components (e.g. exactly one CTA)Forse già presa @silverbackdan l’ha presa oggi. Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 20/100
components-web-app/api-components-bundle#464 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
generate-fixtures drops a redirect on a route that also has a pageForse già presa @silverbackdan l’ha presa oggi. Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
components-web-app/api-components-bundle#461 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di components-web-app/api-components-bundle
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
omegaup/omegaup#10353 · 1 commento ·
I maintainer di solito rispondono entro 5 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
Featured image not passed to checks in the Tasks column or publish blocksForse già presa @roborourke l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
humanmade/publication-checklist#100 ·
I maintainer di solito rispondono entro 1 giorno
-
bug customer-reported
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
MagnaCapax/PMSS#1072 ·
I maintainer di solito rispondono entro 5 giorni