Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

generate-fixtures: configurable asset store (local folder or Flysystem) with a content-hash manifest and pruning

Fechada
  • Algo errado?
#462 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Um pull request relacionado já foi integrado.

  • #466 de @silverbackdan — integrado

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
10/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
docker, php, symfony
Domínio
backend

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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/src is copied into the php image.
  • Excluded from the image: .dockerignore breaks 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-fixtures writes the files to the configured store and writes the manifest. doctrine:fixtures:load resolves 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 (store from 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-assets deletes 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.

Linguagem predominante
PHP
Estrelas
32
Forks
8
Merge médio
58min
PRs com merge (30d)
147

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de components-web-app/api-components-bundle

Todas as issues de components-web-app/api-components-bundle

Issues semelhantes

Mais issues de PHP

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.