Rename matrix_mautrix_wsproxy_* variables to matrix_bridge_mautrix_wsproxy_*

Part of adopting a uniform naming policy for bridge variables,
where the variable prefix matches the role directory name.

The companion appservice variables defined by this role are folded
under the role prefix as well: matrix_mautrix_androidsms_* becomes
matrix_bridge_mautrix_wsproxy_androidsms_* and matrix_mautrix_imessage_*
becomes matrix_bridge_mautrix_wsproxy_imessage_*.

matrix_mautrix_signal_wsproxy_syncproxy_connection_string becomes
matrix_bridge_mautrix_wsproxy_syncproxy_connection_string, aligning it
with the sibling matrix_bridge_mautrix_wsproxy_syncproxy_* variables.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

roles/custom/matrix-bridge-mautrix-wsproxy/tasks/main.yml

@@ -11,15 +11,15 @@
     - install-all
     - install-mautrix-wsproxy
   block:
-    - when: matrix_mautrix_wsproxy_enabled | bool
+    - when: matrix_bridge_mautrix_wsproxy_enabled | bool
       ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml"
 
-    - when: matrix_mautrix_wsproxy_enabled | bool
+    - when: matrix_bridge_mautrix_wsproxy_enabled | bool
       ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml"
 
 - tags:
     - setup-all
     - setup-mautrix-wsproxy
   block:
-    - when: not matrix_mautrix_wsproxy_enabled | bool
+    - when: not matrix_bridge_mautrix_wsproxy_enabled | bool
       ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"

roles/custom/matrix-bridge-mautrix-wsproxy/tasks/setup_install.yml

@@ -16,10 +16,10 @@
   when: "matrix_synapse_role_executed|default(False)"
 
 - ansible.builtin.set_fact:
-    matrix_mautrix_wsproxy_migration_requires_restart: false
+    matrix_bridge_mautrix_wsproxy_migration_requires_restart: false
 
 - ansible.builtin.set_fact:
-    matrix_mautrix_wsproxy_syncproxy_migration_requires_restart: false
+    matrix_bridge_mautrix_wsproxy_syncproxy_migration_requires_restart: false
 
 - name: Ensure Mautrix wsproxy paths exist
   ansible.builtin.file:
@@ -29,39 +29,39 @@
     owner: "{{ matrix_user_name }}"
     group: "{{ matrix_group_name }}"
   with_items:
-    - path: "{{ matrix_mautrix_wsproxy_base_path }}"
+    - path: "{{ matrix_bridge_mautrix_wsproxy_base_path }}"
       when: true
   when: item.when | bool
 
 - name: Ensure Mautrix wsproxy support files installed
   ansible.builtin.template:
     src: "{{ role_path }}/templates/{{ item }}.j2"
-    dest: "{{ matrix_mautrix_wsproxy_base_path }}/{{ item }}"
+    dest: "{{ matrix_bridge_mautrix_wsproxy_base_path }}/{{ item }}"
     mode: '0640'
     owner: "{{ matrix_user_name }}"
     group: "{{ matrix_group_name }}"
   with_items:
     - syncproxy-env
     - wsproxy-labels
-  register: matrix_mautrix_wsproxy_support_files_result
+  register: matrix_bridge_mautrix_wsproxy_support_files_result
 
 - name: Ensure Mautrix wsproxy image is pulled
   community.docker.docker_image_pull:
-    name: "{{ matrix_mautrix_wsproxy_container_image }}"
+    name: "{{ matrix_bridge_mautrix_wsproxy_container_image }}"
     pull: always
-  register: matrix_mautrix_wsproxy_container_image_pull_result
+  register: matrix_bridge_mautrix_wsproxy_container_image_pull_result
   retries: "{{ devture_playbook_help_container_retries_count }}"
   delay: "{{ devture_playbook_help_container_retries_delay }}"
-  until: matrix_mautrix_wsproxy_container_image_pull_result is not failed
+  until: matrix_bridge_mautrix_wsproxy_container_image_pull_result is not failed
 
 - name: Ensure Mautrix syncproxy image is pulled
   community.docker.docker_image_pull:
-    name: "{{ matrix_mautrix_wsproxy_syncproxy_container_image }}"
+    name: "{{ matrix_bridge_mautrix_wsproxy_syncproxy_container_image }}"
     pull: always
-  register: matrix_mautrix_wsproxy_syncproxy_container_image_pull_result
+  register: matrix_bridge_mautrix_wsproxy_syncproxy_container_image_pull_result
   retries: "{{ devture_playbook_help_container_retries_count }}"
   delay: "{{ devture_playbook_help_container_retries_delay }}"
-  until: matrix_mautrix_wsproxy_syncproxy_container_image_pull_result is not failed
+  until: matrix_bridge_mautrix_wsproxy_syncproxy_container_image_pull_result is not failed
 
 - name: Ensure Mautrix wsproxy paths exists
   ansible.builtin.file:
@@ -71,46 +71,46 @@
     owner: "{{ matrix_user_name }}"
     group: "{{ matrix_group_name }}"
   with_items:
-    - "{{ matrix_mautrix_wsproxy_base_path }}"
-    - "{{ matrix_mautrix_wsproxy_config_path }}"
+    - "{{ matrix_bridge_mautrix_wsproxy_base_path }}"
+    - "{{ matrix_bridge_mautrix_wsproxy_config_path }}"
 
 - name: Check if an old Matrix state file exists
   ansible.builtin.stat:
-    path: "{{ matrix_mautrix_wsproxy_base_path }}/mx-state.json"
-  register: matrix_mautrix_wsproxy_stat_mx_state
+    path: "{{ matrix_bridge_mautrix_wsproxy_base_path }}/mx-state.json"
+  register: matrix_bridge_mautrix_wsproxy_stat_mx_state
 
 - name: Ensure mautrix-wsproxy config.yaml installed
   ansible.builtin.copy:
-    content: "{{ matrix_mautrix_wsproxy_configuration | to_nice_yaml }}"
-    dest: "{{ matrix_mautrix_wsproxy_config_path }}/config.yaml"
+    content: "{{ matrix_bridge_mautrix_wsproxy_configuration | to_nice_yaml }}"
+    dest: "{{ matrix_bridge_mautrix_wsproxy_config_path }}/config.yaml"
     mode: '0644'
     owner: "{{ matrix_user_name }}"
     group: "{{ matrix_group_name }}"
-  register: matrix_mautrix_wsproxy_config_result
+  register: matrix_bridge_mautrix_wsproxy_config_result
 
 - name: Ensure mautrix-androidsms registration.yaml installed
   ansible.builtin.copy:
-    content: "{{ matrix_mautrix_androidsms_registration | to_nice_yaml }}"
-    dest: "{{ matrix_mautrix_wsproxy_config_path }}/androidsms-registration.yaml"
+    content: "{{ matrix_bridge_mautrix_wsproxy_androidsms_registration | to_nice_yaml }}"
+    dest: "{{ matrix_bridge_mautrix_wsproxy_config_path }}/androidsms-registration.yaml"
     mode: '0644'
     owner: "{{ matrix_user_name }}"
     group: "{{ matrix_group_name }}"
-  register: matrix_mautrix_wsproxy_registration_androidsms_result
+  register: matrix_bridge_mautrix_wsproxy_registration_androidsms_result
 
 - name: Ensure mautrix-imessage registration.yaml installed
   ansible.builtin.copy:
-    content: "{{ matrix_mautrix_imessage_registration | to_nice_yaml }}"
-    dest: "{{ matrix_mautrix_wsproxy_config_path }}/imessage-registration.yaml"
+    content: "{{ matrix_bridge_mautrix_wsproxy_imessage_registration | to_nice_yaml }}"
+    dest: "{{ matrix_bridge_mautrix_wsproxy_config_path }}/imessage-registration.yaml"
     mode: '0644'
     owner: "{{ matrix_user_name }}"
     group: "{{ matrix_group_name }}"
-  register: matrix_mautrix_wsproxy_registration_imessage_result
+  register: matrix_bridge_mautrix_wsproxy_registration_imessage_result
 
 - name: Ensure mautrix-wsproxy container network is created
-  when: matrix_mautrix_wsproxy_container_network != 'host'
+  when: matrix_bridge_mautrix_wsproxy_container_network != 'host'
   community.general.docker_network:
     enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
-    name: "{{ matrix_mautrix_wsproxy_container_network }}"
+    name: "{{ matrix_bridge_mautrix_wsproxy_container_network }}"
     driver: bridge
     driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"
 
@@ -119,55 +119,55 @@
     src: "{{ role_path }}/templates/systemd/matrix-mautrix-wsproxy.service.j2"
     dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-mautrix-wsproxy.service"
     mode: '0644'
-  register: matrix_mautrix_wsproxy_systemd_service_result
+  register: matrix_bridge_mautrix_wsproxy_systemd_service_result
 
 - name: Determine whether Mautrix wsproxy needs a restart
   ansible.builtin.set_fact:
-    matrix_mautrix_wsproxy_restart_necessary: >-
+    matrix_bridge_mautrix_wsproxy_restart_necessary: >-
       {{
-        matrix_mautrix_wsproxy_migration_requires_restart | default(false)
-        or matrix_mautrix_wsproxy_support_files_result.changed | default(false)
-        or matrix_mautrix_wsproxy_config_result.changed | default(false)
-        or matrix_mautrix_wsproxy_registration_androidsms_result.changed | default(false)
-        or matrix_mautrix_wsproxy_registration_imessage_result.changed | default(false)
-        or matrix_mautrix_wsproxy_systemd_service_result.changed | default(false)
-        or matrix_mautrix_wsproxy_container_image_pull_result.changed | default(false)
+        matrix_bridge_mautrix_wsproxy_migration_requires_restart | default(false)
+        or matrix_bridge_mautrix_wsproxy_support_files_result.changed | default(false)
+        or matrix_bridge_mautrix_wsproxy_config_result.changed | default(false)
+        or matrix_bridge_mautrix_wsproxy_registration_androidsms_result.changed | default(false)
+        or matrix_bridge_mautrix_wsproxy_registration_imessage_result.changed | default(false)
+        or matrix_bridge_mautrix_wsproxy_systemd_service_result.changed | default(false)
+        or matrix_bridge_mautrix_wsproxy_container_image_pull_result.changed | default(false)
       }}
 
 - name: Ensure systemd reloaded after matrix-mautrix-wsproxy.service installation
   ansible.builtin.service:
     daemon_reload: true
-  when: "matrix_mautrix_wsproxy_systemd_service_result.changed"
+  when: "matrix_bridge_mautrix_wsproxy_systemd_service_result.changed"
 
 - name: Ensure matrix-mautrix-wsproxy.service restarted, if necessary
   ansible.builtin.service:
     name: "matrix-mautrix-wsproxy.service"
     state: restarted
-  when: "matrix_mautrix_wsproxy_migration_requires_restart|bool"
+  when: "matrix_bridge_mautrix_wsproxy_migration_requires_restart|bool"
 
 - name: Ensure matrix-mautrix-wsproxy-syncproxy.service installed
   ansible.builtin.template:
     src: "{{ role_path }}/templates/systemd/matrix-mautrix-wsproxy-syncproxy.service.j2"
     dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-mautrix-wsproxy-syncproxy.service"
     mode: '0644'
-  register: matrix_mautrix_wsproxy_syncproxy_systemd_service_result
+  register: matrix_bridge_mautrix_wsproxy_syncproxy_systemd_service_result
 
 - name: Determine whether Mautrix wsproxy syncproxy needs a restart
   ansible.builtin.set_fact:
-    matrix_mautrix_wsproxy_syncproxy_restart_necessary: >-
+    matrix_bridge_mautrix_wsproxy_syncproxy_restart_necessary: >-
       {{
-        matrix_mautrix_wsproxy_syncproxy_migration_requires_restart | default(false)
-        or matrix_mautrix_wsproxy_syncproxy_systemd_service_result.changed | default(false)
-        or matrix_mautrix_wsproxy_syncproxy_container_image_pull_result.changed | default(false)
+        matrix_bridge_mautrix_wsproxy_syncproxy_migration_requires_restart | default(false)
+        or matrix_bridge_mautrix_wsproxy_syncproxy_systemd_service_result.changed | default(false)
+        or matrix_bridge_mautrix_wsproxy_syncproxy_container_image_pull_result.changed | default(false)
       }}
 
 - name: Ensure systemd reloaded after matrix-mautrix-wsproxy-syncproxy.service installation
   ansible.builtin.service:
     daemon_reload: true
-  when: "matrix_mautrix_wsproxy_syncproxy_systemd_service_result.changed"
+  when: "matrix_bridge_mautrix_wsproxy_syncproxy_systemd_service_result.changed"
 
 - name: Ensure matrix-mautrix-wsproxy-syncproxy.service restarted, if necessary
   ansible.builtin.service:
     name: "matrix-mautrix-wsproxy-syncproxy.service"
     state: restarted
-  when: "matrix_mautrix_wsproxy_syncproxy_migration_requires_restart|bool"
+  when: "matrix_bridge_mautrix_wsproxy_syncproxy_migration_requires_restart|bool"

roles/custom/matrix-bridge-mautrix-wsproxy/tasks/setup_uninstall.yml

@@ -7,45 +7,45 @@
 - name: Check existence of matrix-mautrix-wsproxy service
   ansible.builtin.stat:
     path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-mautrix-wsproxy.service"
-  register: matrix_mautrix_wsproxy_service_stat
+  register: matrix_bridge_mautrix_wsproxy_service_stat
 
 - name: Ensure matrix-mautrix-wsproxy is stopped
   ansible.builtin.service:
     name: matrix-mautrix-wsproxy
     state: stopped
     daemon_reload: true
-  when: "matrix_mautrix_wsproxy_service_stat.stat.exists"
+  when: "matrix_bridge_mautrix_wsproxy_service_stat.stat.exists"
 
 - name: Ensure matrix-mautrix-wsproxy.service doesn't exist
   ansible.builtin.file:
     path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-mautrix-wsproxy.service"
     state: absent
-  when: "matrix_mautrix_wsproxy_service_stat.stat.exists"
+  when: "matrix_bridge_mautrix_wsproxy_service_stat.stat.exists"
 
 - name: Ensure systemd reloaded after matrix-mautrix-wsproxy.service removal
   ansible.builtin.service:
     daemon_reload: true
-  when: "matrix_mautrix_wsproxy_service_stat.stat.exists"
+  when: "matrix_bridge_mautrix_wsproxy_service_stat.stat.exists"
 
 - name: Check existence of matrix-mautrix-wsproxy-syncproxy service
   ansible.builtin.stat:
     path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-mautrix-wsproxy-syncproxy.service"
-  register: matrix_mautrix_wsproxy_syncproxy_service_stat
+  register: matrix_bridge_mautrix_wsproxy_syncproxy_service_stat
 
 - name: Ensure matrix-mautrix-wsproxy-syncproxy is stopped
   ansible.builtin.service:
     name: matrix-mautrix-wsproxy-syncproxy
     state: stopped
     daemon_reload: true
-  when: "matrix_mautrix_wsproxy_syncproxy_service_stat.stat.exists"
+  when: "matrix_bridge_mautrix_wsproxy_syncproxy_service_stat.stat.exists"
 
 - name: Ensure matrix-mautrix-wsproxy-syncproxy.service doesn't exist
   ansible.builtin.file:
     path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-mautrix-wsproxy-syncproxy.service"
     state: absent
-  when: "matrix_mautrix_wsproxy_syncproxy_service_stat.stat.exists"
+  when: "matrix_bridge_mautrix_wsproxy_syncproxy_service_stat.stat.exists"
 
 - name: Ensure systemd reloaded after matrix-mautrix-wsproxy-syncproxy.service removal
   ansible.builtin.service:
     daemon_reload: true
-  when: "matrix_mautrix_wsproxy_syncproxy_service_stat.stat.exists"
+  when: "matrix_bridge_mautrix_wsproxy_syncproxy_service_stat.stat.exists"

roles/custom/matrix-bridge-mautrix-wsproxy/tasks/validate_config.yml

@@ -12,15 +12,15 @@
       Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml).
   when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"
   with_items:
-    - {'old': 'matrix_mautrix_wsproxy_docker_image', 'new': 'matrix_mautrix_wsproxy_container_image'}
-    - {'old': 'matrix_mautrix_wsproxy_docker_image_force_pull', 'new': 'matrix_mautrix_wsproxy_container_image_force_pull'}
-    - {'old': 'matrix_mautrix_wsproxy_docker_image_registry_prefix', 'new': 'matrix_mautrix_wsproxy_container_image_registry_prefix'}
-    - {'old': 'matrix_mautrix_wsproxy_docker_image_registry_prefix_upstream', 'new': 'matrix_mautrix_wsproxy_container_image_registry_prefix_upstream'}
-    - {'old': 'matrix_mautrix_wsproxy_docker_image_registry_prefix_upstream_default', 'new': 'matrix_mautrix_wsproxy_container_image_registry_prefix_upstream_default'}
-    - {'old': 'matrix_mautrix_wsproxy_syncproxy_docker_image', 'new': 'matrix_mautrix_wsproxy_syncproxy_container_image'}
-    - {'old': 'matrix_mautrix_wsproxy_syncproxy_docker_image_force_pull', 'new': 'matrix_mautrix_wsproxy_syncproxy_container_image_force_pull'}
-    - {'old': 'matrix_mautrix_wsproxy_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}
-    - {'old': 'matrix_mautrix_wsproxy_syncproxy_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}
+    - {'old': 'matrix_bridge_mautrix_wsproxy_docker_image', 'new': 'matrix_bridge_mautrix_wsproxy_container_image'}
+    - {'old': 'matrix_bridge_mautrix_wsproxy_docker_image_force_pull', 'new': 'matrix_bridge_mautrix_wsproxy_container_image_force_pull'}
+    - {'old': 'matrix_bridge_mautrix_wsproxy_docker_image_registry_prefix', 'new': 'matrix_bridge_mautrix_wsproxy_container_image_registry_prefix'}
+    - {'old': 'matrix_bridge_mautrix_wsproxy_docker_image_registry_prefix_upstream', 'new': 'matrix_bridge_mautrix_wsproxy_container_image_registry_prefix_upstream'}
+    - {'old': 'matrix_bridge_mautrix_wsproxy_docker_image_registry_prefix_upstream_default', 'new': 'matrix_bridge_mautrix_wsproxy_container_image_registry_prefix_upstream_default'}
+    - {'old': 'matrix_bridge_mautrix_wsproxy_syncproxy_docker_image', 'new': 'matrix_bridge_mautrix_wsproxy_syncproxy_container_image'}
+    - {'old': 'matrix_bridge_mautrix_wsproxy_syncproxy_docker_image_force_pull', 'new': 'matrix_bridge_mautrix_wsproxy_syncproxy_container_image_force_pull'}
+    - {'old': 'matrix_bridge_mautrix_wsproxy_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}
+    - {'old': 'matrix_bridge_mautrix_wsproxy_syncproxy_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}
 
 
 - name: Fail if required settings not defined
@@ -29,12 +29,12 @@
       You need to define a required configuration setting (`{{ item }}`).
   when: "lookup('vars', item, default='') == ''"
   with_items:
-    - "matrix_mautrix_androidsms_appservice_token"
-    - "matrix_mautrix_androidsms_homeserver_token"
-    - "matrix_mautrix_imessage_appservice_token"
-    - "matrix_mautrix_imessage_homeserver_token"
-    - "matrix_mautrix_wsproxy_homeserver_address"
-    - "matrix_mautrix_wsproxy_syncproxy_shared_secret"
-    - "matrix_mautrix_wsproxy_syncproxy_homeserver_url"
-    - "matrix_mautrix_wsproxy_syncproxy_database_hostname"
-    - "matrix_mautrix_wsproxy_syncproxy_database_password"
+    - "matrix_bridge_mautrix_wsproxy_androidsms_appservice_token"
+    - "matrix_bridge_mautrix_wsproxy_androidsms_homeserver_token"
+    - "matrix_bridge_mautrix_wsproxy_imessage_appservice_token"
+    - "matrix_bridge_mautrix_wsproxy_imessage_homeserver_token"
+    - "matrix_bridge_mautrix_wsproxy_homeserver_address"
+    - "matrix_bridge_mautrix_wsproxy_syncproxy_shared_secret"
+    - "matrix_bridge_mautrix_wsproxy_syncproxy_homeserver_url"
+    - "matrix_bridge_mautrix_wsproxy_syncproxy_database_hostname"
+    - "matrix_bridge_mautrix_wsproxy_syncproxy_database_password"