feat: enroll signalgo to nginx proxy

roles/custom/matrix-bridge-mautrix-signalgo/tasks/inject_into_nginx_proxy.yml

@@ -0,0 +1,35 @@
+---
+
+- name: Fail if matrix-nginx-proxy role already executed
+  ansible.builtin.fail:
+    msg: >-
+      Trying to append mautrix-signalgo-metrics's reverse-proxying configuration to matrix-nginx-proxy,
+      but it's pointless since the matrix-nginx-proxy role had already executed.
+      To fix this, please change the order of roles in your playbook,
+      so that the matrix-nginx-proxy role would run after the matrix-bridge-mautrix-signalgo role.
+  when: matrix_nginx_proxy_role_executed | default(False) | bool
+
+- when: matrix_mautrix_signalgo_metrics_proxying_enabled | bool
+  block:
+    - name: Generate mautrix-signalgo metrics proxying configuration for matrix-nginx-proxy (matrix.DOMAIN/metrics/mautrix-signalgo)
+      ansible.builtin.set_fact:
+        matrix_mautrix_signalgo_nginx_metrics_configuration_block: |
+          location /metrics/mautrix-signalgo {
+            {% if matrix_nginx_proxy_enabled | default(False) %}
+              {# Use the embedded DNS resolver in Docker containers to discover the service #}
+              resolver 127.0.0.11 valid=5s;
+              set $backend "matrix-mautrix-signalgo:8001";
+              proxy_pass http://$backend/metrics;
+            {% else %}
+              return 404 "matrix-nginx-proxy is disabled and no host port was bound to the container, so metrics are unavailable";
+            {% endif %}
+          }
+
+    - name: Register mautrix-signalgo metrics proxying configuration with matrix-nginx-proxy (matrix.DOMAIN/metrics/mautrix-signalgo)
+      ansible.builtin.set_fact:
+        matrix_nginx_proxy_proxy_matrix_metrics_additional_system_location_configuration_blocks: |
+          {{
+            matrix_nginx_proxy_proxy_matrix_metrics_additional_system_location_configuration_blocks | default([])
+            +
+            [matrix_mautrix_signalgo_nginx_metrics_configuration_block]
+          }}

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

@@ -1,5 +1,14 @@
 ---
 
+- tags:
+    - setup-all
+    - setup-nginx-proxy
+    - install-all
+    - install-nginx-proxy
+  block:
+    - when: matrix_mautrix_signalgo_enabled | bool and matrix_mautrix_signalgo_metrics_enabled | bool
+      ansible.builtin.include_tasks: "{{ role_path }}/tasks/inject_into_nginx_proxy.yml"
+
 - tags:
     - setup-all
     - setup-mautrix-signalgo

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

@@ -77,6 +77,39 @@
       pull: true
   when: "matrix_mautrix_signalgo_container_image_self_build | bool"
 
+- name: Check if an old database file exists
+  ansible.builtin.stat:
+    path: "{{ matrix_mautrix_signalgo_base_path }}/mautrix-signalgo.db"
+  register: matrix_mautrix_signalgo_stat_database
+
+- name: Check if an old matrix state file exists
+  ansible.builtin.stat:
+    path: "{{ matrix_mautrix_signalgo_base_path }}/mx-state.json"
+  register: matrix_mautrix_signalgo_stat_mx_state
+
+- name: (Data relocation) Ensure matrix-mautrix-signalgo.service is stopped
+  ansible.builtin.service:
+    name: matrix-mautrix-signalgo
+    state: stopped
+    enabled: false
+    daemon_reload: true
+  failed_when: false
+  when: "matrix_mautrix_signalgo_stat_database.stat.exists"
+
+- name: (Data relocation) Move mautrix-signalgo database file to ./data directory
+  ansible.builtin.command:
+    cmd: "mv {{ matrix_mautrix_signalgo_base_path }}/mautrix-signalgo.db {{ matrix_mautrix_signalgo_data_path }}/mautrix-signalgo.db"
+    creates: "{{ matrix_mautrix_signalgo_data_path }}/mautrix-signalgo.db"
+    removes: "{{ matrix_mautrix_signalgo_base_path }}/mautrix-signalgo.db"
+  when: "matrix_mautrix_signalgo_stat_database.stat.exists"
+
+- name: (Data relocation) Move mautrix-signalgo mx-state file to ./data directory
+  ansible.builtin.command:
+    cmd: "mv {{ matrix_mautrix_signalgo_base_path }}/mx-state.json {{ matrix_mautrix_signalgo_data_path }}/mx-state.json"
+    creates: "{{ matrix_mautrix_signalgo_data_path }}/mx-state.json"
+    removes: "{{ matrix_mautrix_signalgo_base_path }}/mx-state.json"
+  when: "matrix_mautrix_signalgo_stat_mx_state.stat.exists"
+
 - name: Ensure mautrix-signalgo config.yaml installed
   ansible.builtin.copy:
     content: "{{ matrix_mautrix_signalgo_configuration | to_nice_yaml(indent=2, width=999999) }}"
@@ -98,7 +131,6 @@
     src: "{{ role_path }}/templates/systemd/matrix-mautrix-signalgo.service.j2"
     dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-mautrix-signalgo.service"
     mode: 0644
-  register: matrix_mautrix_signalgo_systemd_service_result
 
 - name: Ensure matrix-mautrix-signalgo.service restarted, if necessary
   ansible.builtin.service:

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

@@ -1,11 +1,20 @@
 ---
 
-- name: Fail if required mautrix-signalgo settings not defined
+- name: Fail if required mautrix-whatsapp settings not defined
   ansible.builtin.fail:
     msg: >-
       You need to define a required configuration setting (`{{ item.name }}`).
   when: "item.when | bool and vars[item.name] == ''"
   with_items:
-    - {'name': 'matrix_mautrix_signalgo_appservice_token', when: true}
-    - {'name': 'matrix_mautrix_signalgo_homeserver_token', when: true}
-    - {'name': 'matrix_mautrix_signalgo_database_hostname', when: "{{ matrix_mautrix_signalgo_database_engine == 'postgres' }}"}
+    - {'name': 'matrix_mautrix_whatsapp_appservice_token', when: true}
+    - {'name': 'matrix_mautrix_whatsapp_homeserver_token', when: true}
+    - {'name': 'matrix_mautrix_whatsapp_database_hostname', when: "{{ matrix_mautrix_whatsapp_database_engine == 'postgres' }}"}
+
+- name: (Deprecation) Catch and report renamed 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_mautrix_whatsapp_log_level', 'new': 'matrix_mautrix_whatsapp_logging_level'}