From 21a67b0d7414e7002bcaac79f507aaf4dd4bc512 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Goinvic?= Date: Tue, 28 Jan 2025 11:09:13 +0100 Subject: [PATCH] Add support for .well-known/matrix/support in Well Known Delegation - Add new support configuration to well-known delegation - Modify schema to accommodate support configuration - Update templates to include support file - Update tests to verify support configuration handling --- .../configs/well-known/partial-haproxy.cfg.tpl | 6 ++++++ charts/matrix-stack/source/wellKnownDelegation.json | 5 ++++- charts/matrix-stack/source/wellKnownDelegation.yaml.j2 | 1 + charts/matrix-stack/templates/well-known/_helpers.tpl | 9 +++++++++ .../matrix-stack/templates/well-known/configmap.yaml | 2 ++ charts/matrix-stack/values.schema.json | 5 ++++- charts/matrix-stack/values.yaml | 1 + newsfragments/133.added.md | 1 + tests/integration/test_well_known_delegation.py | 5 +++++ tests/manifests/test_well_known_delegation.py | 10 ++++++++++ 10 files changed, 43 insertions(+), 2 deletions(-) create mode 100644 newsfragments/133.added.md diff --git a/charts/matrix-stack/configs/well-known/partial-haproxy.cfg.tpl b/charts/matrix-stack/configs/well-known/partial-haproxy.cfg.tpl index d2e6cf74..9d378b96 100644 --- a/charts/matrix-stack/configs/well-known/partial-haproxy.cfg.tpl +++ b/charts/matrix-stack/configs/well-known/partial-haproxy.cfg.tpl @@ -10,8 +10,13 @@ SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial frontend well-known-in bind *:8010 + # same as http log, with %Th (handshake time) + log-format "%ci:%cp [%tr] %ft %b/%s %Th/%TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs %{+Q}r" + + acl well-known path /.well-known/matrix/server acl well-known path /.well-known/matrix/client + acl well-known path /.well-known/matrix/support acl well-known path /.well-known/element/element.json use_backend well-known-static if well-known @@ -31,6 +36,7 @@ backend well-known-static http-request return status 200 content-type "application/json" file "/well-known/server" if { path /.well-known/matrix/server } http-request return status 200 content-type "application/json" file "/well-known/client" if { path /.well-known/matrix/client } + http-request return status 200 content-type "application/json" file "/well-known/support" if { path /.well-known/matrix/support } http-request return status 200 content-type "application/json" file "/well-known/element.json" if { path /.well-known/element/element.json } {{- end -}} diff --git a/charts/matrix-stack/source/wellKnownDelegation.json b/charts/matrix-stack/source/wellKnownDelegation.json index 208b1df6..c645b862 100644 --- a/charts/matrix-stack/source/wellKnownDelegation.json +++ b/charts/matrix-stack/source/wellKnownDelegation.json @@ -18,10 +18,13 @@ "client": { "type": "string" }, + "element": { + "type": "string" + }, "server": { "type": "string" }, - "element": { + "support": { "type": "string" } } diff --git a/charts/matrix-stack/source/wellKnownDelegation.yaml.j2 b/charts/matrix-stack/source/wellKnownDelegation.yaml.j2 index 90e2606f..3b9fec9d 100644 --- a/charts/matrix-stack/source/wellKnownDelegation.yaml.j2 +++ b/charts/matrix-stack/source/wellKnownDelegation.yaml.j2 @@ -16,3 +16,4 @@ additional: client: "{}" server: "{}" element: "{}" + support: "{}" diff --git a/charts/matrix-stack/templates/well-known/_helpers.tpl b/charts/matrix-stack/templates/well-known/_helpers.tpl index a0a1c9af..4949e7c6 100644 --- a/charts/matrix-stack/templates/well-known/_helpers.tpl +++ b/charts/matrix-stack/templates/well-known/_helpers.tpl @@ -66,3 +66,12 @@ k8s.element.io/target-instance: {{ $root.Release.Name }}-haproxy {{- tpl (toPrettyJson (merge $config $additional)) $root -}} {{- end -}} {{- end }} + +{{- define "element-io.well-known-delegation.support" }} +{{- $root := .root -}} +{{- with required "element-io.well-known-delegation.support missing context" .context -}} +{{- $config := dict -}} +{{- $additional := .additional.support | fromJson -}} +{{- tpl (toPrettyJson (merge $config $additional)) $root -}} +{{- end -}} +{{- end }} diff --git a/charts/matrix-stack/templates/well-known/configmap.yaml b/charts/matrix-stack/templates/well-known/configmap.yaml index 5f68a13c..7b674b53 100644 --- a/charts/matrix-stack/templates/well-known/configmap.yaml +++ b/charts/matrix-stack/templates/well-known/configmap.yaml @@ -18,6 +18,8 @@ data: {{ (tpl (include "element-io.well-known-delegation.client" (dict "root" $ "context" .)) $) | nindent 4 }} server: | {{ (tpl (include "element-io.well-known-delegation.server" (dict "root" $ "context" .)) $) | nindent 4 }} + support: | + {{ (tpl (include "element-io.well-known-delegation.support" (dict "root" $ "context" .)) $) | nindent 4 }} element.json: | {{ (tpl (include "element-io.well-known-delegation.element" (dict "root" $ "context" .)) $) | nindent 4 }} {{- end -}} diff --git a/charts/matrix-stack/values.schema.json b/charts/matrix-stack/values.schema.json index c4970b0e..8321a7f4 100644 --- a/charts/matrix-stack/values.schema.json +++ b/charts/matrix-stack/values.schema.json @@ -3761,10 +3761,13 @@ "client": { "type": "string" }, + "element": { + "type": "string" + }, "server": { "type": "string" }, - "element": { + "support": { "type": "string" } }, diff --git a/charts/matrix-stack/values.yaml b/charts/matrix-stack/values.yaml index 99cf58dc..f05107ca 100644 --- a/charts/matrix-stack/values.yaml +++ b/charts/matrix-stack/values.yaml @@ -1047,3 +1047,4 @@ wellKnownDelegation: client: "{}" server: "{}" element: "{}" + support: "{}" diff --git a/newsfragments/133.added.md b/newsfragments/133.added.md new file mode 100644 index 00000000..48153201 --- /dev/null +++ b/newsfragments/133.added.md @@ -0,0 +1 @@ +Add support for .well-known/matrix/support in Well Known Delegation. diff --git a/tests/integration/test_well_known_delegation.py b/tests/integration/test_well_known_delegation.py index 796bf8f4..d6188134 100644 --- a/tests/integration/test_well_known_delegation.py +++ b/tests/integration/test_well_known_delegation.py @@ -29,6 +29,11 @@ async def test_well_known_files_can_be_accessed( else: assert json_content == {} + json_content = await aiottp_get_json( + f"https://{generated_data.server_name}/.well-known/matrix/support", ssl_context + ) + assert json_content == {} + json_content = await aiottp_get_json( f"https://{generated_data.server_name}/.well-known/element/element.json", ssl_context ) diff --git a/tests/manifests/test_well_known_delegation.py b/tests/manifests/test_well_known_delegation.py index 139b75f3..7f97e937 100644 --- a/tests/manifests/test_well_known_delegation.py +++ b/tests/manifests/test_well_known_delegation.py @@ -13,9 +13,11 @@ async def test_only_additional_if_all_disabled_in_well_known(values, make_templa client_config = {"testclientkey": {"testsubket": "testvalue"}} server_config = {"testserverkey": {"testsubket": "testvalue"}} element_config = {"testelementkey": {"testsubket": "testvalue"}} + support_config = {"testsupportkey": {"testsubket": "testvalue"}} values["wellKnownDelegation"].setdefault("additional", {})["client"] = json.dumps(client_config) values["wellKnownDelegation"].setdefault("additional", {})["server"] = json.dumps(server_config) values["wellKnownDelegation"].setdefault("additional", {})["element"] = json.dumps(element_config) + values["wellKnownDelegation"].setdefault("additional", {})["support"] = json.dumps(support_config) for template in await make_templates(values): if template["kind"] == "ConfigMap" and template["metadata"]["name"] == "pytest-well-known-haproxy": client_from_json = json.loads(template["data"]["client"]) @@ -27,6 +29,9 @@ async def test_only_additional_if_all_disabled_in_well_known(values, make_templa element_from_json = json.loads(template["data"]["element.json"]) assert element_from_json == element_config + support_config_from_json = json.loads(template["data"]["support"]) + assert support_config == support_config_from_json + break else: raise AssertionError("Unable to find WellKnownDelegationConfigMap") @@ -38,9 +43,11 @@ async def test_synapse_injected_in_server_and_client_well_known(values, make_tem client_config = {"testclientkey": {"testsubket": "testvalue"}} server_config = {"testserverkey": {"testsubket": "testvalue"}} element_config = {"testelementkey": {"testsubket": "testvalue"}} + support_config = {"testsupportkey": {"testsubket": "testvalue"}} values["wellKnownDelegation"].setdefault("additional", {})["client"] = json.dumps(client_config) values["wellKnownDelegation"].setdefault("additional", {})["server"] = json.dumps(server_config) values["wellKnownDelegation"].setdefault("additional", {})["element"] = json.dumps(element_config) + values["wellKnownDelegation"].setdefault("additional", {})["support"] = json.dumps(support_config) synapse_federation = {"m.server": "synapse.ess.localhost:443"} synapse_base_url = {"m.homeserver": {"base_url": "https://synapse.ess.localhost"}} @@ -55,6 +62,9 @@ async def test_synapse_injected_in_server_and_client_well_known(values, make_tem element_from_json = json.loads(template["data"]["element.json"]) assert element_from_json == element_config + support_from_json = json.loads(template["data"]["support"]) + assert support_from_json == support_config + break else: raise AssertionError("Unable to find WellKnownDelegationConfigMap")