Remove welcome_user_id from Element and Schildichat

Ref: - matrix-org/matrix-react-sdk#12153 - element-hq/element-web#26885 Technically, it may still work for Schildichat, because it's stuck in the past. It will catch up soon anyway.
Chasethechicken · Jul 6, 2024 · 2aa7516 · 2aa7516
1 parent fd288ce
commit 2aa7516
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 8 deletions.
diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers
@@ -3901,8 +3901,6 @@ matrix_client_element_enable_presence_by_hs_url: |
     else {matrix_client_element_default_hs_url: false}
   }}
 
-matrix_client_element_welcome_user_id: ~
-
 matrix_client_element_jitsi_preferred_domain: "{{ matrix_server_fqn_jitsi if jitsi_enabled else '' }}"
 
 ######################################################################
@@ -4014,8 +4012,6 @@ matrix_client_schildichat_enable_presence_by_hs_url: |
     else {matrix_client_schildichat_default_hs_url: false}
   }}
 
-matrix_client_schildichat_welcome_user_id: ~
-
 matrix_client_schildichat_jitsi_preferred_domain: "{{ matrix_server_fqn_jitsi if jitsi_enabled else '' }}"
 
 ######################################################################

diff --git a/roles/custom/matrix-client-element/defaults/main.yml b/roles/custom/matrix-client-element/defaults/main.yml
@@ -151,7 +151,6 @@ matrix_client_element_bug_report_endpoint_url: "https://element.io/bugreports/su
 matrix_client_element_show_lab_settings: true  # noqa var-naming
 # Element public room directory server(s)
 matrix_client_element_room_directory_servers: ['matrix.org']
-matrix_client_element_welcome_user_id: ~
 # Branding of Element
 matrix_client_element_brand: "Element"
 

diff --git a/roles/custom/matrix-client-element/tasks/validate_config.yml b/roles/custom/matrix-client-element/tasks/validate_config.yml
@@ -43,6 +43,7 @@
     - {'old': 'matrix_client_element_branding_authHeaderLogoUrl', 'new': 'matrix_client_element_branding_auth_header_logo_url'}
     - {'old': 'matrix_client_element_branding_welcomeBackgroundUrl', 'new': 'matrix_client_element_branding_welcome_background_url'}
     - {'old': 'matrix_client_element_jitsi_preferredDomain', 'new': 'matrix_client_element_jitsi_preferred_domain'}
+    - {'old': 'matrix_client_element_welcome_user_id', 'new': '<removed>'}
 
 - when: matrix_client_element_container_labels_traefik_enabled | bool
   block:

diff --git a/roles/custom/matrix-client-element/templates/config.json.j2 b/roles/custom/matrix-client-element/templates/config.json.j2
@@ -26,7 +26,6 @@
 	"room_directory": {
 		"servers": {{ matrix_client_element_room_directory_servers | to_json }}
 	},
-	"welcome_user_id": {{ matrix_client_element_welcome_user_id | to_json }},
 	{% if matrix_client_element_enable_presence_by_hs_url is not none %}
 		"enable_presence_by_hs_url": {{ matrix_client_element_enable_presence_by_hs_url | to_json }},
 	{% endif %}

diff --git a/roles/custom/matrix-client-schildichat/defaults/main.yml b/roles/custom/matrix-client-schildichat/defaults/main.yml
@@ -145,7 +145,6 @@ matrix_client_schildichat_bug_report_endpoint_url: "https://element.io/bugreport
 matrix_client_schildichat_show_lab_settings: true  # noqa var-naming
 # schildichat public room directory server(s)
 matrix_client_schildichat_room_directory_servers: ['matrix.org']
-matrix_client_schildichat_welcome_user_id: ~
 # Branding of schildichat
 matrix_client_schildichat_brand: "schildichat"
 

diff --git a/roles/custom/matrix-client-schildichat/tasks/validate_config.yml b/roles/custom/matrix-client-schildichat/tasks/validate_config.yml
@@ -1,5 +1,14 @@
 ---
 
+- name: (Deprecation) Catch and report renamed Schildichat settings
+  ansible.builtin.fail:
+    msg: >-
+      Your configuration contains a variable, which now has a different name.
+      Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).
+  when: "item.old in vars"
+  with_items:
+    - {'old': 'matrix_client_schildichat_welcome_user_id', 'new': '<removed>'}
+
 - name: Fail if required schildichat settings not defined
   ansible.builtin.fail:
     msg: >

diff --git a/roles/custom/matrix-client-schildichat/templates/config.json.j2 b/roles/custom/matrix-client-schildichat/templates/config.json.j2
@@ -26,7 +26,6 @@
 	"room_directory": {
 		"servers": {{ matrix_client_schildichat_room_directory_servers | to_json }}
 	},
-	"welcome_user_id": {{ matrix_client_schildichat_welcome_user_id | to_json }},
 	{% if matrix_client_schildichat_enable_presence_by_hs_url is not none %}
 		"enable_presence_by_hs_url": {{ matrix_client_schildichat_enable_presence_by_hs_url | to_json }},
 	{% endif %}