Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Use the existing and configured env indicator #476

Merged
merged 1 commit into from
Jan 20, 2022

Conversation

sarayourfriend
Copy link
Contributor

Fixes

Fixes #475 by @sarayourfriend

Description

Replace PYTHON_ENV with the already used ENVIRONMENT.

Testing Instructions

Checkout the branch and update your local instance (just recreate && just init should do it but will wipe local data) and verify the API runs.

Unit tests should also pass of course.

Checklist

  • My pull request has a descriptive title (not a vague title like Update 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.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • [N/A] I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

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.

@sarayourfriend sarayourfriend added 🟧 priority: high Stalls work on the project or its dependents 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository labels Jan 20, 2022
@sarayourfriend sarayourfriend requested a review from a team as a code owner January 20, 2022 12:14
@@ -39,7 +39,7 @@
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = config("DJANGO_DEBUG_ENABLED", default=False, cast=bool)

PYTHON_ENV = config("PYTHON_ENV", default="production")
ENVIRONMENT = config("ENVIRONMENT", default="local")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did it change to "local"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the default that is used by the ingestion_server when it accesses this same variable:

environment = config("ENVIRONMENT", default="local")

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should keep "production" and change to "staging" or the corresponding string in the staging server. "local" doesn't seem very useful as everything is local to its own machine.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea I agree that naming convention isn't too useful! 😅 I think dev or staging makes sense. A lot of the environment checks in the ingestion server are checking explicitly if in prod (environment == "prod") so it hasn't mattered much what not prod is.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree local is ambiguous.

In my mind (and indeed I've seen this in practice) dev is local development, staging is the pre-production deployment, prod is production, and test is when tests are running regardless of environment. Also variations on those strings exist. Node (and most JavaScript projects like React and Vue) uses the full development and production specifically for example, so I like the consistency of using that for the less-opinionated Python environment.

Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! We can follow up with a future PR to change "local" to something clearer 🙂

@@ -39,7 +39,7 @@
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = config("DJANGO_DEBUG_ENABLED", default=False, cast=bool)

PYTHON_ENV = config("PYTHON_ENV", default="production")
ENVIRONMENT = config("ENVIRONMENT", default="local")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea I agree that naming convention isn't too useful! 😅 I think dev or staging makes sense. A lot of the environment checks in the ingestion server are checking explicitly if in prod (environment == "prod") so it hasn't mattered much what not prod is.

@sarayourfriend sarayourfriend merged commit ab26c74 into main Jan 20, 2022
@sarayourfriend sarayourfriend deleted the fix/use-existing-environment-indicator branch January 20, 2022 18:04
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace PYTHON_ENV with ENVIRONMENT
3 participants