Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor app config flow (incl. dealing with flask env deprecation) #969

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Refactor app config flow (incl. dealing with flask env deprecation) #969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
406d91c
refactor: move comments and variable setting
Feb 1, 2024
722e6c7
fix: try adding the test db uri to the DocumentationConfig
Flix6x Feb 1, 2024
25f4747
style: clarify use of dummy config setting
Flix6x Feb 1, 2024
161751a
fix: parseable dummy config setting
Flix6x Feb 1, 2024
ec58e43
Merge branch 'main' into refactor/flask-env-deprecation
nhoening Mar 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions flexmeasures/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
from flask_sslify import SSLify
from flask_json import FlaskJSON
from flask_cors import CORS
from flexmeasures.utils.config_utils import use_documentation_config, use_testing_config

from redis import Redis
from rq import Queue
Expand All @@ -37,7 +38,6 @@ def create( # noqa C901
Also, a list of plugins can be set. Usually this works as a config setting, but this is useful for automated testing.
"""

from flexmeasures.utils import config_defaults
from flexmeasures.utils.config_utils import read_config, configure_logging
from flexmeasures.utils.app_utils import set_secret_key, init_sentry
from flexmeasures.utils.error_utils import add_basic_error_handlers
Expand All @@ -46,20 +46,29 @@ def create( # noqa C901

configure_logging() # do this first, see https://flask.palletsprojects.com/en/2.0.x/logging
# we're loading dotenv files manually & early (can do Flask.run(load_dotenv=False)),
# as we need to know the ENV now (for it to be recognised by Flask()).
# as we need to know the ENV now (for it to be recognized by Flask()).
load_dotenv()

# Below sets app.config["ENV"] = os.environ.get("FLASK_ENV") or "production"
app = Flask("flexmeasures")

if env is not None: # overwrite
app.config["FLEXMEASURES_ENV"] = env
if app.config.get("FLEXMEASURES_ENV") == "testing":
app.testing = True
if app.config.get("FLEXMEASURES_ENV") == "development":
app.debug = config_defaults.DevelopmentConfig.DEBUG
# Overwrite the setting of app.config["ENV"] to "production" instead the "FLASK_ENV" environment variable.
# Otherwise, the in the future deprecated "FLASK_ENV" can create issues.
if os.environ.get("FLASK_ENV"):
app.config["ENV"] = "production"

if env == "documentation":
use_documentation_config(app, path_to_config=path_to_config)
elif env == "testing":
use_testing_config(app)
from fakeredis import FakeStrictRedis

# App configuration
redis_conn = FakeStrictRedis(
host="redis", port="1234"
) # dummy connection details
else:
read_config(app, custom_path_to_config=path_to_config, env=env)

read_config(app, custom_path_to_config=path_to_config)
if plugins:
app.config["FLEXMEASURES_PLUGINS"] += plugins
add_basic_error_handlers(app)
Expand All @@ -74,13 +83,7 @@ def create( # noqa C901
CORS(app)

# configure Redis (for redis queue)
if app.testing:
from fakeredis import FakeStrictRedis

redis_conn = FakeStrictRedis(
host="redis", port="1234"
) # dummy connection details
else:
if not app.testing:
redis_conn = Redis(
app.config["FLEXMEASURES_REDIS_URL"],
port=app.config["FLEXMEASURES_REDIS_PORT"],
Expand Down
93 changes: 56 additions & 37 deletions flexmeasures/utils/config_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,7 @@ def configure_logging():

def check_app_env(env: str | None):
if env not in (
"documentation",
"development",
"testing",
"staging",
"production",
):
Copy link
Contributor

Choose a reason for hiding this comment

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

The following print statement would need to be updated correspondingly, I suppose:

        print(
            f'Flexmeasures environment needs to be either "documentation", "development", "testing", "staging" or "production". It currently is "{env}".'
        )

Expand All @@ -69,20 +67,46 @@ def check_app_env(env: str | None):
sys.exit(2)


def read_config(app: Flask, custom_path_to_config: str | None):
def use_documentation_config(app: Flask, path_to_config: str | None = None):
"""Use the default documentation config"""
app.config["ENV"] = "documentation"
app.config["FLEXMEASURES_ENV"] = "documentation"
app.config.from_object(
"flexmeasures.utils.config_defaults.%sConfig" % camelize("documentation")
)
read_custom_config(app, path_to_config)


def use_testing_config(app: Flask):
"""Use default the testing config"""
app.config["ENV"] = "testing"
app.config["FLEXMEASURES_ENV"] = "testing"
app.testing = True
app.config.from_object(
"flexmeasures.utils.config_defaults.%sConfig" % camelize("testing")
)
custom_test_db_uri = os.getenv("SQLALCHEMY_TEST_DATABASE_URI", None)
if custom_test_db_uri:
app.config["SQLALCHEMY_DATABASE_URI"] = custom_test_db_uri


def read_config(
app: Flask,
custom_path_to_config: str | None,
env: str = DefaultConfig.FLEXMEASURES_ENV_DEFAULT,
):
"""Read configuration from various expected sources, complain if not setup correctly."""

flexmeasures_env = DefaultConfig.FLEXMEASURES_ENV_DEFAULT
if app.testing:
flexmeasures_env = "testing"
elif os.getenv("FLEXMEASURES_ENV", None):
if os.getenv("FLEXMEASURES_ENV", None):
flexmeasures_env = os.getenv("FLEXMEASURES_ENV", None)
elif os.getenv("FLASK_ENV", None):
flexmeasures_env = os.getenv("FLASK_ENV", None)
app.logger.warning(
"'FLASK_ENV' is deprecated and replaced by FLEXMEASURES_ENV"
" Change FLASK_ENV to FLEXMEASURES_ENV in the environment variables",
)
else:
flexmeasures_env = env

check_app_env(flexmeasures_env)

Expand All @@ -93,39 +117,30 @@ def read_config(app: Flask, custom_path_to_config: str | None):

# Now, potentially overwrite those from config file or environment variables

# These two locations are possible (besides the custom path)
path_to_config_home = str(Path.home().joinpath(".flexmeasures.cfg"))
path_to_config_instance = os.path.join(app.instance_path, "flexmeasures.cfg")

# Custom config: do not use any when testing (that should run completely on defaults)
if not app.testing:
used_path_to_config = read_custom_config(
app, custom_path_to_config, path_to_config_home, path_to_config_instance
)
read_env_vars(app)
else: # one exception: the ability to set where the test database is
custom_test_db_uri = os.getenv("SQLALCHEMY_TEST_DATABASE_URI", None)
if custom_test_db_uri:
app.config["SQLALCHEMY_DATABASE_URI"] = custom_test_db_uri

used_path_to_config = read_custom_config(app, custom_path_to_config)
read_env_vars(app)

# Check for missing values.
# Documentation runs fine without them.
if not app.testing and flexmeasures_env != "documentation":
if not are_required_settings_complete(app):
if not os.path.exists(used_path_to_config):
print(
f"You can provide these settings ― as environment variables or in your config file (e.g. {path_to_config_home} or {path_to_config_instance})."
)
else:
print(
f"Please provide these settings ― as environment variables or in your config file ({used_path_to_config})."
)
sys.exit(2)
missing_fields, config_warnings = get_config_warnings(app)
if len(config_warnings) > 0:
for warning in config_warnings:
print(f"Warning: {warning}")
print(f"You might consider setting {', '.join(missing_fields)}.")
path_to_config_home = str(Path.home().joinpath(".flexmeasures.cfg"))
path_to_config_instance = os.path.join(app.instance_path, "flexmeasures.cfg")
if not are_required_settings_complete(app):
if not os.path.exists(used_path_to_config):
print(
f"You can provide these settings ― as environment variables or in your config file (e.g. {path_to_config_home} or {path_to_config_instance})."
)
else:
print(
f"Please provide these settings ― as environment variables or in your config file ({used_path_to_config})."
)
sys.exit(2)
missing_fields, config_warnings = get_config_warnings(app)
if len(config_warnings) > 0:
for warning in config_warnings:
print(f"Warning: {warning}")
print(f"You might consider setting {', '.join(missing_fields)}.")

# Set the desired logging level on the root logger (controlling extension logging level)
# and this app's logger.
Expand All @@ -137,7 +152,8 @@ def read_config(app: Flask, custom_path_to_config: str | None):


def read_custom_config(
app: Flask, suggested_path_to_config, path_to_config_home, path_to_config_instance
app: Flask,
suggested_path_to_config,
) -> str:
"""
Read in a custom config file and env vars.
Expand All @@ -147,6 +163,9 @@ def read_custom_config(

Return the path to the config file.
"""
# These two locations are possible (besides the custom path)
path_to_config_home = str(Path.home().joinpath(".flexmeasures.cfg"))
path_to_config_instance = os.path.join(app.instance_path, "flexmeasures.cfg")
if suggested_path_to_config is not None and not os.path.exists(
suggested_path_to_config
):
Expand Down
Loading