Add Django database migrations to Dockerfile entrypoint

AetherUnbound commented 1 year ago

Fixes

Fixes #1048 by @AetherUnbound

Description

This PR adds the Django database migration to the Dockerfile entrypoint so it occurs automatically on startup. This can be disabled by setting DJANGO_MIGRATE_DB_ON_STARTUP=False.

Note We'll want to add the disable flag to the current EC2-based deployment setup, since all of the instances in the auto-scaling group start at the same time which we want to avoid (see https://github.com/WordPress/openverse-infrastructure/issues/176).

Testing Instructions

Run just build && just up && just logs web and check that the "Running database migrations..." line does not show up in the logs.
Comment out the DJANGO_MIGRATE_DB_ON_STARTUP line in api/env.docker then run just up && just logs web and check that the "Running database migrations..." line does show up in the logs.
(Optional) Run just dj migrate api 0050 to roll back a migration. Then run just down && just up && just logs web and check that the migration is run automatically.

Checklist

[x] My pull request has a descriptive title (not a vague title like Update index.md).
[x] My pull request targets the default branch of the repository (main) or a parent feature branch.
[x] My commit messages follow [best practices][best_practices].
[x] 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).
[x] I tried running the project locally and verified that there are no visible errors.

[best_practices]: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines

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. ```

github-actions[bot] commented 1 year ago

API Developer Docs Preview: Ready

https://wordpress.github.io/openverse-api/_preview/1049

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

AetherUnbound commented 1 year ago

My only concern about enabling this now is that we could see some undesired behavior if all 5 instances within the autoscaling group run the migration at the same time (this was a piece I mentioned in the original discussion too). I'm not aware of a way to have the ASG start up one instance at a time and verify that it's healthy, but I haven't looked in depth at how that could work. So in order to prevent concurrent migrations, I thought it best to disable this for the time being.

sarayourfriend commented 1 year ago

Oh, I see. I misremembered what you'd described the ASG deployment process was and thought that the ASG did deploy one at a time, but of course it does not :+1: This makes sense to me then.

WordPress / openverse-api