lookit / lookit/lookit-api

Improve error message when user uploaded file is too large

Open
#1,235 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
12
Forks
21
Avg merge
5d 19h
Merged PRs (30d)
5

Description

Description

When a researcher is trying to create/edit a study and the study image size is too large, they get an error when trying to submit the form: 413 Request Entity Too Large. This comes from size limits in the nginx config. Ideally we would catch this error earlier and give users a more informative message.

How to reproduce

  • Go to a study create or edit page
  • Set the study image to an image file that is too large (> 10 MB?)
  • Try to submit the form.

Expected behavior

Ideally we should catch this error earlier and give users a more informative error message, e.g. "Image file size is too large. Please limit the file to 10 MB or less". This could either happen at the point of selecting a file or when the submit button is clicked but before the request is sent.
In addition to improving error messages, we could put any file size limits in the help text for the file upload form element.

Screenshots

Screenshot 2023-06-06 at 11 52 22 AM

Additional context

We may want to look through the site to find any other instances where users can upload arbitrary files, e.g. lab page images.

Note that we do mention file size limits in the documentation for the study image here: https://lookit.readthedocs.io/en/develop/researchers-set-study-fields.html#study-image but it might be possible to improve the docs for other similar instances.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the oversized study-image upload on the study create and edit pages, then review the nginx size limit and the file-upload form. Check the existing study-image documentation for the stated limit and look for other arbitrary file-upload forms such as lab page images. Done means users receive an informative size-limit message before or during submission and the relevant help text is accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
nginx
Domain
documentation, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.