Skip to content

Feat: improve notifications code #1493

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

Merged
merged 1 commit into from
Sep 16, 2025
Merged

Feat: improve notifications code #1493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions .env.backend.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,7 @@ DASH_DB_HOST=dashboard_db
DASH_DB_PORT=${DASH_DB_PORT:-5432}

USE_DASHBOARD_DB=${USE_DASHBOARD_DB:-False}

## Variables used for the notifications command. Check docs/notifications.md
# EMAIL_HOST_USER="youruser@host" # (optional)
# EMAIL_HOST_PASSWORD="yourpassword"
16 changes: 8 additions & 8 deletions backend/kernelCI/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,14 +174,14 @@ def get_json_env_var(name, default):
]

# Email settings for SMTP backend
EMAIL_BACKEND = get_json_env_var(
EMAIL_BACKEND = os.environ.get(
"EMAIL_BACKEND", "django.core.mail.backends.smtp.EmailBackend"
)
EMAIL_HOST = get_json_env_var("EMAIL_HOST", "smtp.gmail.com")
EMAIL_PORT = get_json_env_var("EMAIL_PORT", 587)
EMAIL_USE_TLS = get_json_env_var("EMAIL_USE_TLS", True)
EMAIL_HOST_USER = get_json_env_var("EMAIL_HOST_USER", "[email protected]")
EMAIL_HOST_PASSWORD = get_json_env_var("EMAIL_HOST_PASSWORD", "")
EMAIL_HOST = os.environ.get("EMAIL_HOST", "smtp.gmail.com")
EMAIL_PORT = os.environ.get("EMAIL_PORT", 587)
EMAIL_USE_TLS = os.environ.get("EMAIL_USE_TLS", True)
EMAIL_HOST_USER = os.environ.get("EMAIL_HOST_USER", "[email protected]")
EMAIL_HOST_PASSWORD = os.environ.get("EMAIL_HOST_PASSWORD", "")

# Database
# https://docs.djangoproject.com/en/5.0/ref/settings/#databases
Expand All @@ -202,7 +202,7 @@ def get_json_env_var(name, default):
"PASSWORD": "kernelci-db-password",
"HOST": "127.0.0.1",
"OPTIONS": {
"connect_timeout": 5,
"connect_timeout": 16,
Copy link
Collaborator

Choose a reason for hiding this comment

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

why 16?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

its the DB_DEFAULT_TIMEOUT on entrypoint.sh

},
},
)
Expand All @@ -215,7 +215,7 @@ def get_json_env_var(name, default):
"HOST": os.environ.get("DASH_DB_HOST", "127.0.0.1"),
"PORT": os.environ.get("DASH_DB_PORT", 5434),
"OPTIONS": {
"connect_timeout": 5,
"connect_timeout": 16,
},
}

Expand Down
13 changes: 0 additions & 13 deletions backend/kernelCI_app/helpers/system.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,9 @@

from kernelCI_app.constants.general import PRODUCTION_HOST


# TODO: combine with the function below once it is verified
# that this way of identifying the production instance works
def is_production_instance():
if not hasattr(settings, "CORS_ALLOWED_ORIGINS"):
return False
if PRODUCTION_HOST in settings.CORS_ALLOWED_ORIGINS:
return True
return False


type PossibleHosts = Literal["production", "staging"]


# TODO: verify if this is the correct way to identify
# the production instance
def get_running_instance() -> PossibleHosts | None:
if (
hasattr(settings, "CORS_ALLOWED_ORIGINS")
Expand Down
9 changes: 5 additions & 4 deletions backend/kernelCI_app/management/commands/notifications.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from django.core.management.base import BaseCommand

from kernelCI_app.helpers.logger import log_message
from kernelCI_app.helpers.system import is_production_instance
from kernelCI_app.helpers.system import get_running_instance

from kernelCI_app.helpers.email import (
smtp_setup_connection,
Expand Down Expand Up @@ -199,7 +199,8 @@ def exclude_already_found_and_store(issues: list[dict]) -> list[dict]:


def look_for_new_issues(*, service, signup_folder, email_args):
if is_production_instance():
if get_running_instance() == "staging":
print("This command only runs on production or dev environments.")
return

issues = kcidb_new_issues()
Expand Down Expand Up @@ -499,7 +500,6 @@ def discard_sent_reports(


# TODO: lower the complexity of this function, we are at the limit
# flake8: noqa: C901
def run_checkout_summary(
*,
service,
Expand All @@ -508,7 +508,8 @@ def run_checkout_summary(
email_args,
skip_sent_reports: bool = True,
):
if is_production_instance():
if get_running_instance() == "staging":
print("This command only runs on production or dev environments.")
return

tree_key_set, tree_prop_map = process_submissions_files(
Expand Down