Switch local API dev server to use gunicorn instead of django runserver

[ashiramin]

Fixes

Fixes #2814 by @sarayourfriend

Description

• Swapped out manage.py runserver for gunicorn --reload in docker-compose

Testing Instructions

Update api/.env to have ENVIRONMENT=local or recreate api/.env (rm api/.env && cp api/env.template api/.env). Then run just dc stop web && just dc stop nginx && just build web && just api/up and confirm the API responds and static files work (visit /admin and confirm the page has styles). Confirm the Nginx image still has static files by visiting the Nginx service locally at http://0.0.0.0:50270/admin. This proves the static files are still correctly copied over from the Django image.

Checklist

• My pull request has a descriptive title (not a vague title likeUpdate index.md).
• My pull request targets the default branch of the repository (main) or a parent feature branch.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.
• I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[ashiramin]

@sarayourfriend Kept it in draft state for now. Are there any other changes I need to make?

[sarayourfriend]

I think this looks good to me. I haven't tested it locally yet, but will do so today. I think we could leave out the --bind parameter, I expected that to be handled by the gunicorn.conf, but I could be wrong.

[sarayourfriend]

Okay, everything looks good, just three things, only one of which is significant:

1. We can remove the --bind option, it is indeed covered by gunicorn.conf.py
2. We should consider adding -w 1 so that we only run a single worker locally. There's no benefit to running 4 and it just makes the logs more confusing to follow.
3. Static files are not working because there are additional changes to make it work. The changes required are:

• Update the default ENVIRONMENT variable to local in api/env.docker:

  openverse/api/env.docker

  Line 8 in 980ef96

  ENVIRONMENT=local

• Update the static file settings: https://github.com/WordPress/openverse/blob/980ef96e0e16fc758f78be9f2aadf595f75948f6/api/conf/settings/static.py
• Remove STATIC_ROOT declaration in api/Dockerfile when it runs python manage.py collectstatic (not strictly necessary but helps clean things up a bit).

[ashiramin]

@sarayourfriend Made the changes you requested and was able to test that static files are not 404ing locally

[sarayourfriend]

LGTM, thanks for the contribution @ashiramin. I've gone ahead and added testing instructions but in the future please add them once a PR is marked ready for review. It makes it much easier for maintainers to review PRs 🙏

[ashiramin]

@sarayourfriend Thank you for doing this and for reminding me about testing instructions. I'll do this next time :)

[openverse-bot]

Based on the high urgency of this PR, the following reviewers are being gently reminded to review this PR:

@dhruvkb
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend¹ days, this PR was ready for review 2 day(s) ago. PRs labelled with high urgency are expected to be reviewed within 2 weekday(s)².

@ashiramin, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

1. Specifically, Saturday and Sunday. ↩

2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the operation that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range. ↩

[dhruvkb]

LGTM, sorry I took so long to review it!