From 32a604d7c16b28dad552c8c87be710bdc9e37d92 Mon Sep 17 00:00:00 2001
From: teutat3s <10206665+teutat3s@users.noreply.github.com>
Date: Sun, 17 Jul 2022 16:06:57 +0200
Subject: [PATCH] Implement feedback from PR #1931

---
 docs/configuring-well-known.md                | 26 +++++++------------
 roles/matrix-base/defaults/main.yml           | 11 ++++----
 roles/matrix-base/tasks/setup_well_known.yml  |  1 +
 .../static-files/well-known/matrix-support.j2 |  4 +--
 .../tasks/setup_well_known.yml                |  1 +
 5 files changed, 19 insertions(+), 24 deletions(-)

diff --git a/docs/configuring-well-known.md b/docs/configuring-well-known.md
index 35b969319..d52bef73f 100644
--- a/docs/configuring-well-known.md
+++ b/docs/configuring-well-known.md
@@ -47,23 +47,15 @@ The two playbook variables that you could look for, if you're interested in bein
 Example snippet for `vars.yml`:
 ```
 # Homeserver admin contacts as per MSC 1929 https://github.com/matrix-org/matrix-spec-proposals/pull/1929
-matrix_homeserver_admin_contacts: |
-  [
-    {
-      "matrix_id": "@admin1:domain.tld",
-      "email_address": "admin@domain.tld",
-      "role": "admin"
-    },
-    {
-      "matrix_id": "@admin2:domain.tld",
-      "email_address": "admin@domain.tld",
-      "role": "admin"
-    },
-    {
-      "email_address": "security@domain.tld",
-      "role": "security"
-    }
-  ]
+matrix_homeserver_admin_contacts:
+  - matrix_id: @admin1:domain.tld
+    email_address: admin@domain.tld
+    role: admin
+  - matrix_id: @admin2:domain.tld
+    email_address: admin@domain.tld
+    role: admin
+  - email_address: security@domain.tld
+    role: security
 
 matrix_homeserver_support_url: "https://example.domain.tld/support"
 ```
diff --git a/roles/matrix-base/defaults/main.yml b/roles/matrix-base/defaults/main.yml
index 244b4916f..b8bea562a 100644
--- a/roles/matrix-base/defaults/main.yml
+++ b/roles/matrix-base/defaults/main.yml
@@ -14,12 +14,13 @@ matrix_admin: ''
 
 # Homeserver admin contacts and support page as per MSC 1929
 # See: https://github.com/matrix-org/matrix-spec-proposals/pull/1929
-#
 # Users in form:
-# [
-#   { "matrix_id": "@admin:domain.tld", "email_address": "admin@domain.tld", "role": "admin" },
-#   { "email_address": "security@domain.tld", "role": "security" }
-# ]
+# matrix_homeserver_admin_contacts:
+#   - matrix_id: @admin:domain.tld
+#     email_address: admin@domain.tld
+#     role: admin
+#   - email_address: security@domain.tld
+#     role: security
 matrix_homeserver_admin_contacts: []
 # Url string like https://domain.tld/support.html
 matrix_homeserver_support_url: ''
diff --git a/roles/matrix-base/tasks/setup_well_known.yml b/roles/matrix-base/tasks/setup_well_known.yml
index 44ef3d28a..8faf100c0 100644
--- a/roles/matrix-base/tasks/setup_well_known.yml
+++ b/roles/matrix-base/tasks/setup_well_known.yml
@@ -43,3 +43,4 @@
     mode: 0644
     owner: "{{ matrix_user_username }}"
     group: "{{ matrix_user_groupname }}"
+  when: matrix_homeserver_admin_contacts|length > 0
diff --git a/roles/matrix-base/templates/static-files/well-known/matrix-support.j2 b/roles/matrix-base/templates/static-files/well-known/matrix-support.j2
index b22c40aaf..18a5403c9 100644
--- a/roles/matrix-base/templates/static-files/well-known/matrix-support.j2
+++ b/roles/matrix-base/templates/static-files/well-known/matrix-support.j2
@@ -1,7 +1,7 @@
 #jinja2: lstrip_blocks: "True"
 {
-	{% if matrix_homeserver_admin_contacts %}
-    "admins": {{ matrix_homeserver_admin_contacts }}
+	{% if matrix_homeserver_admin_contacts|length > 0 %}
+    "admins": {{ matrix_homeserver_admin_contacts|to_json }}
 	{% endif %}
 	{% if matrix_homeserver_support_url %},
     "support_page": "{{ matrix_homeserver_support_url }}"
diff --git a/roles/matrix-nginx-proxy/tasks/setup_well_known.yml b/roles/matrix-nginx-proxy/tasks/setup_well_known.yml
index 48727725a..b0df3fad7 100644
--- a/roles/matrix-nginx-proxy/tasks/setup_well_known.yml
+++ b/roles/matrix-nginx-proxy/tasks/setup_well_known.yml
@@ -31,3 +31,4 @@
     mode: 0644
     owner: "{{ matrix_user_username }}"
     group: "{{ matrix_user_groupname }}"
+  when: matrix_homeserver_admin_contacts|length > 0