Skip to content

armgit / zulip

Public Imported from GitHub
0

Zulip server and web application. Open-source team chat that helps teams stay productive and focused.

checks: Add check for JITSI_SERVER_URL being valid URL.

Lauryn Menard8e8ccc0f81d2
diff --git a/zerver/apps.py b/zerver/apps.py
index 80874a45dac..2ae54bec7ab 100644
--- a/zerver/apps.py
+++ b/zerver/apps.py
@@ -13,6 +13,7 @@ from typing_extensions import override
from zerver.checks import (
check_auth_settings,
check_external_host_setting,
+ check_jitsi_server_url,
check_required_settings,
check_uploads_settings,
)
@@ -60,6 +61,7 @@ class ZerverConfig(AppConfig):
register(check_external_host_setting)
register(check_auth_settings)
register(check_uploads_settings)
+ register(check_jitsi_server_url)
if settings.SENTRY_DSN: # nocoverage
from zproject.config import get_config
diff --git a/zerver/checks.py b/zerver/checks.py
index f069460a713..4c13cc4f308 100644
--- a/zerver/checks.py
+++ b/zerver/checks.py
@@ -6,6 +6,8 @@ from typing import Any
from django.apps.config import AppConfig
from django.conf import settings
from django.core import checks
+from django.core.exceptions import ValidationError
+from django.core.validators import URLValidator
def get_settings_error_message_strings(setting_name: str) -> tuple[str, str]:
@@ -209,3 +211,36 @@ def check_uploads_settings(
)
]
return []
+
+
+def check_jitsi_server_url(
+ app_configs: Sequence[AppConfig] | None,
+ databases: Sequence[str] | None,
+ **kwargs: Any,
+) -> Iterable[checks.CheckMessage]:
+ # As of Zulip 12.0, the web app will not load if a server-level
+ # Jitsi Meet integration has been configured that is not a URL.
+ # A None value is the valid way to disable the integration. By
+ # default, the integration uses the SaaS https://meet.jit.si
+ # server.
+ jitsi_server_url = settings.JITSI_SERVER_URL
+ if jitsi_server_url is None or jitsi_server_url == "https://meet.jit.si":
+ return []
+
+ assert isinstance(jitsi_server_url, str)
+ validate = URLValidator()
+ try:
+ validate(jitsi_server_url)
+ return []
+ except ValidationError:
+ settings_location, setting_display_name = get_settings_error_message_strings(
+ "JITSI_SERVER_URL"
+ )
+ message = f"{setting_display_name} in {settings_location} is not a URL"
+ return [
+ checks.Error(
+ message,
+ obj="settings.JITSI_SERVER_URL",
+ id="zulip.E007",
+ )
+ ]
diff --git a/zerver/tests/test_checks.py b/zerver/tests/test_checks.py
index 4e5035111df..a7416530bfb 100644
--- a/zerver/tests/test_checks.py
+++ b/zerver/tests/test_checks.py
@@ -245,3 +245,28 @@ class TestChecks(ZulipTestCase):
def test_checks_uploads_local_dir_valid(self) -> None:
self.assert_check_with_error(None)
+
+ @override_settings(RUNNING_IN_DOCKER=False)
+ def test_check_jitsi_server_url(self) -> None:
+ self.assert_check_with_error(
+ "(zulip.E007) JITSI_SERVER_URL in /etc/zulip/settings.py is not a URL",
+ JITSI_SERVER_URL="example.jitsi.com",
+ )
+
+ @override_settings(RUNNING_IN_DOCKER=True)
+ def test_check_jitsi_server_url_in_docker(self) -> None:
+ self.assert_check_with_error(
+ "(zulip.E007) SETTING_JITSI_SERVER_URL in your Docker environment configuration is not a URL",
+ JITSI_SERVER_URL="jitsi[etc]",
+ )
+
+ @override_settings(RUNNING_IN_DOCKER=True, RUNNING_IN_HELM=True)
+ def test_check_jitsi_server_url_in_helm(self) -> None:
+ self.assert_check_with_error(
+ "(zulip.E007) zulip.environment.SETTING_JITSI_SERVER_URL in your Helm values is not a URL",
+ JITSI_SERVER_URL="example.com/jitsi",
+ )
+
+ @override_settings(JITSI_SERVER_URL="https://example.com/jitsi")
+ def test_check_jitsi_server_url_valid(self) -> None:
+ self.assert_check_with_error(None)