Store each thumbnail as a single 400×225 PNG and stop using thumbnail_encoding
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Refactorización
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- javascript, python
Línea de trabajo
Start with the named cropper at ContentNodeThumbnail.vue:467, publish logic at utils/publish.py:596-636, upload logic at utils/nodes.py:103, and the three thumbnail display components. Trace how thumbnail files and crop encodings flow through upload, migration, display, and publish; then define tests around the listed image sizes, transparent letterboxing, repeat command runs, and both ricecooker version paths. Done means the acceptance criteria pass and no code outside the model field and migrations reads or writes thumbnail_encoding.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Overview
contentnode.thumbnail_encoding holds about 355 GB of base64 thumbnails in TOAST. 98.7% of them are a plain resize of the node's thumbnail File. About 98K are user crops, and only 107 nodes have been re-cropped in a later session since November 2022. Each thumbnail should instead be stored once, as a 400×225 PNG File with transparent letterboxing, and thumbnail_encoding should no longer be used.
Complexity: High
Target branch: hotfixes
Context
-
In a 0.1% production sample of 7,644 nodes with an encoding: 98.7% are
{"points": [], "zoom": 0}with a resize of the node's thumbnailFile, 1.2% are Croppa crops, and 0.04% are crops from the olderpoints/zoomcropper. -
Change history since November 2022. A re-crop is two crop changes on the same node with different crop settings and no thumbnail upload in between:
Measure Count Updates that set a thumbnail encoding 44,033 (42,628 with crop settings) Nodes cropped by a user 39,271 Thumbnail uploads attached to those nodes 39,178 Nodes re-cropped without a new upload 707 (1.8%) …re-cropped in a later session 107 (0.27%) -
About 0.1% of nodes with an encoding have no thumbnail
File, so theirbase64is the only copy. -
Thumbnail
Files: 10,853,488 rows referencing 289,745 distinct images, 56.9 GB in storage. -
thumbnail_encodingis written by:- the cropper:
ContentNodeThumbnail.vue:467 - ricecooker uploads:
utils/nodes.py:103 - publish:
utils/publish.py:596-636builds a resized copy from it, or regenerates and saves it when empty, then exports the copy as a new unattachedFile.
- the cropper:
-
Display reads
encoding.base64before theFileURL:Thumbnail.vue:156,StudioThumbnail.vue:106,ImageOnlyThumbnail.vue:117.
The Change
- Every thumbnail
Fileshould be a 400×225 PNG: the image scaled down to fit, or left at its own size if smaller, and centered on a transparent background. - Thumbnails added in the editor should be converted in the browser before upload. A user's crop is what gets uploaded, and the original image is not kept.
- A management command, run from
make deploy-migrate(per Makefile:32-40), should:- convert each distinct thumbnail image once, and update every
Filerow that references it in place, keeping itsid; - for nodes with a user crop, or whose
base64is the only copy, convert thatbase64into the node's thumbnailFile.
- convert each distinct thumbnail image once, and update every
- Publish should export the node's thumbnail
Filewithout processing the image, except for channels whosericecooker_versionis below 0.9.0, whose thumbnails publish should still convert. - No code should read or write
thumbnail_encoding. Display should use the thumbnailFile's URL.
Out of Scope
- Dropping the
thumbnail_encodingcolumn, which will be a follow-up issue. - Channel thumbnails (
Channel.thumbnail_encoding). - Converting thumbnails in ricecooker.
- Deleting the original thumbnail images from storage (56.9 GB, about $18 a year).
Acceptance Criteria
General
- Adding a thumbnail in the editor, with or without a crop, uploads only a 400×225 PNG with transparent letterboxing, and it becomes the node's thumbnail
File - After the command runs on
hotfixes, every thumbnailFilereferences a 400×225 PNG and keeps itsid - For a sample of nodes with a user crop, the converted thumbnail shows the same crop as the previous
base64 - Every node whose
base64was the only copy has a thumbnailFileafter the command - Publishing a channel with no
ricecooker_version, or 0.9.0 or later, creates no new thumbnailFilerows - Publishing a channel with
ricecooker_versionbelow 0.9.0 exports 400×225 PNG thumbnails - Apart from the model field and migrations, no code reads or writes
thumbnail_encoding
Testing
- Unit tests cover converting landscape, portrait, and smaller-than-400×225 images, and check that the letterbox is transparent
- Running the command again after it completes changes nothing
AI usage
Drafted with Claude Code, which measured thumbnail encodings, thumbnail File counts and re-crop history on production through read-only queries in the disposable debugging job, and traced the code paths that read and write thumbnail_encoding. I chose the design (one stored 400×225 thumbnail, no originals kept), the letterboxing, the ricecooker cutoff, and the scope.
- Lenguaje dominante
- Python
- Estrellas
- 212
- Forks
- 314
- Merge medio
- 3 d 12 h
- PR fusionados (30 d)
- 51
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de learningequality/studio
-
Set unpublishable: true on PublishedChange by construction to simplify handleMaxRevs predicateAbiertoDEV: frontend P3 - low
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
learningequality/studio#5868 ·
Los mantenedores suelen responder en 1 día
-
TAG: tech update / debt
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
learningequality/studio#2245 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
learningequality/studio#6359 ·
Los mantenedores suelen responder en 1 día
-
Remove slideshow supportAbiertoDEV: backend
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
learningequality/studio#6353 · 2 reacciones ·
Los mantenedores suelen responder en 1 día
-
DEV: backend
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
learningequality/studio#6352 ·
Los mantenedores suelen responder en 1 día
Todos los issues de learningequality/studio
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
pytest-dev/pytest-html#1085 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 90/100
pollen-robotics/reachy_mini#1527 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 66/100
Los mantenedores suelen responder en 2 días
-
Variadic arguments that aren't objects are passed as objects (stringWithFormat_ with %d / %f)Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
A seed and its negative give the same run, so realizations of a negative seed repeat each otherAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
Los mantenedores suelen responder en 1 día