ISD-2819 restart synapse and MAS if MAS config has changed (#779)

Author: Thanhphan1147

src/pebble.py

@@ -219,6 +219,28 @@ def _get_synapse_config(container: ops.model.Container) -> dict:
         raise PebbleServiceError(str(exc)) from exc
 
 
+def _get_mas_config(container: ops.model.Container) -> dict:
+    """Get the current MAS configuration.
+
+    Args:
+        container: Synapse container.
+
+    Returns:
+        dict: MAS configuration.
+
+    Raises:
+        PebbleServiceError: if something goes wrong while interacting with Pebble.
+    """
+    try:
+        config = container.pull(MAS_CONFIGURATION_PATH).read()
+        return yaml.safe_load(config)
+    except ops.pebble.PathError as exc:
+        # If the MAS config has not been created, we return an empty dict to trigger a replan
+        if exc.kind == "not-found":
+            return {}
+        raise PebbleServiceError(str(exc)) from exc
+
+
 def _push_synapse_config(
     container: ops.model.Container,
     current_synapse_config: dict,
@@ -317,7 +339,16 @@ def reconcile(  # noqa: C901
         PebbleServiceError: if something goes wrong while interacting with Pebble.
     """
     try:
-        restart_mas(container, rendered_mas_configuration, charm_state)
+
+        existing_mas_config = _get_mas_config(container=container)
+        mas_config_has_changed = DeepDiff(
+            existing_mas_config,
+            yaml.safe_load(rendered_mas_configuration),
+            ignore_order=True,
+            ignore_string_case=True,
+        )
+        if mas_config_has_changed:
+            restart_mas(container, rendered_mas_configuration, charm_state)
 
         if _environment_has_changed(container=container, charm_state=charm_state, is_main=is_main):
             # Configurations set via environment variables:
@@ -402,7 +433,7 @@ def reconcile(  # noqa: C901
             ignore_string_case=True,
         )
 
-        if config_has_changed:
+        if config_has_changed or mas_config_has_changed:
             logging.info("Configuration has changed, Synapse will be restarted.")
             logging.debug("The change is: %s", config_has_changed)
             # Push worker configuration

tests/unit/conftest.py

@@ -17,7 +17,7 @@
 from ops.testing import Harness
 
 import synapse
-from auth.mas import MAS_EXECUTABLE_PATH
+from auth.mas import MAS_CONFIGURATION_PATH, MAS_EXECUTABLE_PATH
 from charm import SynapseCharm
 from s3_parameters import S3Parameters
 
@@ -139,6 +139,13 @@ def harness_fixture(request, monkeypatch) -> typing.Generator[Harness, None, Non
     harness.set_can_connect(synapse.SYNAPSE_CONTAINER_NAME, True)
     synapse_container.make_dir("/data", make_parents=True)
     synapse_container.push(f"/data/{TEST_SERVER_NAME}.signing.key", "123")
+    synapse_container.make_dir("/mas", make_parents=True)
+    synapse_container.push(
+        MAS_CONFIGURATION_PATH,
+        yaml.safe_dump(
+            {"http": {"listeners": [{"name": "web", "binds": [{"address": "[::]:8081"}]}]}}
+        ),
+    )
     # unused-variable disabled to pass constants values to inner function
     command_path = synapse.SYNAPSE_COMMAND_PATH
     command_migrate_config = synapse.COMMAND_MIGRATE_CONFIG