From affb99003c688d059297ba1d1ce959066ac3c598 Mon Sep 17 00:00:00 2001
From: Slavi Pantaleev <slavi@devture.com>
Date: Tue, 21 May 2019 12:09:38 +0900
Subject: [PATCH] Improve Synapse variable naming consistency

---
 CHANGELOG.md                                             | 9 +++++++++
 roles/matrix-synapse/defaults/main.yml                   | 6 +++---
 roles/matrix-synapse/tasks/validate_config.yml           | 3 +++
 .../matrix-synapse/templates/synapse/homeserver.yaml.j2  | 6 +++---
 4 files changed, 18 insertions(+), 6 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 096810a7..6ab43b91 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -20,6 +20,15 @@ Each bridge now lives in its own separate role (`roles/matrix-bridge-*`).
 These bridge roles are independent of the `matrix-synapse` role, so it should be possible to use them with a Synapse instance installed another way (not through the playbook).
 
 
+## Renaming inconsistently-named Synapse variables
+
+For better consistency, the following variables have been renamed:
+
+- `matrix_enable_room_list_search` was renamed to `matrix_synapse_enable_room_list_search`
+- `matrix_alias_creation_rules` was renamed to `matrix_synapse_alias_creation_rules`
+- `matrix_nginx_proxy_matrix_room_list_publication_rulesdata_path` was renamed to `matrix_synapse_room_list_publication_rules`
+
+
 # 2019-05-09
 
 Besides a myriad of bug fixes and minor improvements, here are the more notable (bigger) features we can announce today.
diff --git a/roles/matrix-synapse/defaults/main.yml b/roles/matrix-synapse/defaults/main.yml
index 92772155..e450d617 100644
--- a/roles/matrix-synapse/defaults/main.yml
+++ b/roles/matrix-synapse/defaults/main.yml
@@ -239,17 +239,17 @@ matrix_s3_media_store_region: "eu-central-1"
 matrix_synapse_self_check_validate_certificates: true
 
 # Controls whether searching the public room list is enabled.
-matrix_enable_room_list_search: true
+matrix_synapse_enable_room_list_search: true
 
 # Controls who's allowed to create aliases on this server.
-matrix_alias_creation_rules:
+matrix_synapse_alias_creation_rules:
   - user_id: "*"
     alias: "*"
     room_id: "*"
     action: allow
 
 # Controls who can publish and which rooms can be published in the public room list.
-matrix_room_list_publication_rules:
+matrix_synapse_room_list_publication_rules:
   - user_id: "*"
     alias: "*"
     room_id: "*"
diff --git a/roles/matrix-synapse/tasks/validate_config.yml b/roles/matrix-synapse/tasks/validate_config.yml
index b02abd29..cdc649cc 100644
--- a/roles/matrix-synapse/tasks/validate_config.yml
+++ b/roles/matrix-synapse/tasks/validate_config.yml
@@ -17,3 +17,6 @@
   with_items:
     - {'old': 'matrix_synapse_container_expose_api_port', 'new': 'matrix_synapse_container_expose_client_api_port'}
     - {'old': 'matrix_synapse_no_tls', 'new': '<removed>'}
+    - {'old': 'matrix_enable_room_list_search', 'new': 'matrix_synapse_enable_room_list_search'}
+    - {'old': 'matrix_alias_creation_rules', 'new': 'matrix_synapse_alias_creation_rules'}
+    - {'old': 'matrix_room_list_publication_rules', 'new': 'matrix_synapse_room_list_publication_rules'}
diff --git a/roles/matrix-synapse/templates/synapse/homeserver.yaml.j2 b/roles/matrix-synapse/templates/synapse/homeserver.yaml.j2
index 1c889671..ce2f1677 100644
--- a/roles/matrix-synapse/templates/synapse/homeserver.yaml.j2
+++ b/roles/matrix-synapse/templates/synapse/homeserver.yaml.j2
@@ -1179,7 +1179,7 @@ push:
 #
 #enable_room_list_search: false
 
-enable_room_list_search: {{ matrix_enable_room_list_search|to_json }}
+enable_room_list_search: {{ matrix_synapse_enable_room_list_search|to_json }}
 
 # The `alias_creation` option controls who's allowed to create aliases
 # on this server.
@@ -1209,7 +1209,7 @@ enable_room_list_search: {{ matrix_enable_room_list_search|to_json }}
 #    room_id: "*"
 #    action: allow
 
-alias_creation_rules: {{ matrix_alias_creation_rules|to_json }}
+alias_creation_rules: {{ matrix_synapse_alias_creation_rules|to_json }}
 
 # The `room_list_publication_rules` option controls who can publish and
 # which rooms can be published in the public room list.
@@ -1240,4 +1240,4 @@ alias_creation_rules: {{ matrix_alias_creation_rules|to_json }}
 #    room_id: "*"
 #    action: allow
 
-room_list_publication_rules: {{ matrix_room_list_publication_rules|to_json }}
+room_list_publication_rules: {{ matrix_synapse_room_list_publication_rules|to_json }}