matrix-docker-ansible-deploy/roles/matrix-postgres/tasks/run_synapse_janitor.yml

---

# Pre-checks

- name: Fail if Postgres not enabled
  fail:
    msg: "Postgres via the matrix-postgres role is not enabled (`matrix_postgres_enabled`). Cannot run synapse-janitor."
  when: "not matrix_postgres_enabled|bool"

- name: Fail if not aware of the risks
  fail:
    msg: >-
      Using Synapse Janitor is considered dangerous and may break your database.
      See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/465.
      If you'd like to run it anyway, add `--extra-vars='i_know_synapse_janitor_is_dangerous=1'` to your command.
  when: "i_know_synapse_janitor_is_dangerous|default('') == ''"

# Defaults

- name: Set postgres_start_wait_time, if not provided
  set_fact:
    postgres_start_wait_time: 15
  when: "postgres_start_wait_time|default('') == ''"

- name: Set postgres_synapse_janitor_wait_time, if not provided
  set_fact:
    postgres_synapse_janitor_wait_time: "{{ 7 * 86400 }}"
  when: "postgres_synapse_janitor_wait_time|default('') == ''"

- name: Set postgres_synapse_janitor_tool_path, if not provided
  set_fact:
    postgres_synapse_janitor_tool_path: "{{ matrix_postgres_base_path }}/synapse_janitor.sql"
  when: "postgres_synapse_janitor_tool_path|default('') == ''"


# Actual janitor work

- name: Download synapse-janitor tool
  get_url:
    url: "{{ matrix_postgres_tool_synapse_janitor }}"
    dest: "{{ postgres_synapse_janitor_tool_path }}"
    force: true
    mode: 0550
    owner: "{{ matrix_user_username }}"
    group: "{{ matrix_user_username }}"

- name: Ensure matrix-postgres is started
  service:
    name: matrix-postgres
    state: started
    daemon_reload: yes

- name: Wait a bit, so that Postgres can start
  wait_for:
    timeout: "{{ postgres_start_wait_time }}"
  delegate_to: 127.0.0.1
  become: false

- import_tasks: tasks/util/detect_existing_postgres_version.yml

- name: Abort, if no existing Postgres version detected
  fail:
    msg: "Could not find existing Postgres installation"
  when: "not matrix_postgres_detected_existing|bool"

- name: Generate Postgres database synapse-janitor command
  set_fact:
    matrix_postgres_synapse_janitor_command: >-
      /usr/bin/docker run --rm --name matrix-postgres-synapse-janitor
      --user={{ matrix_user_uid }}:{{ matrix_user_gid }}
      --cap-drop=ALL
      --network={{ matrix_docker_network }}
      --env-file={{ matrix_postgres_base_path }}/env-postgres-psql
      --mount type=bind,src={{ postgres_synapse_janitor_tool_path }},dst=/synapse_janitor.sql,ro=true
      {{ matrix_postgres_docker_image_latest }}
      psql -v ON_ERROR_STOP=1 -h matrix-postgres {{ matrix_synapse_database_database }} -f /synapse_janitor.sql

- name: Note about Postgres purging alternative
  debug:
    msg: >-
      Running synapse-janitor with the following Postgres command: `{{ matrix_postgres_synapse_janitor_command }}`.
      If this crashes, you can stop all processes (`systemctl stop matrix-*`),
      start Postgres only (`systemctl start matrix-postgres`)
      and manually run the above command directly on the server.

- name: Populate service facts
  service_facts:

- set_fact:
    matrix_postgres_synapse_was_running: "{{ ansible_facts.services['matrix-synapse.service']|default(none) is not none and ansible_facts.services['matrix-synapse.service'].state == 'running' }}"

- name: Ensure matrix-synapse is stopped
  service:
    name: matrix-synapse
    state: stopped
    daemon_reload: yes

- name: Run synapse-janitor
  command: "{{ matrix_postgres_synapse_janitor_command }}"
  async: "{{ postgres_synapse_janitor_wait_time }}"
  poll: 10
  register: matrix_postgres_synapse_janitor_result

# Intentionally show the results
- debug: var="matrix_postgres_synapse_janitor_result"

- name: Ensure matrix-synapse is started, if it previously was
  service:
    name: matrix-synapse
    state: started
    daemon_reload: yes
  when: "matrix_postgres_synapse_was_running|bool"

- name: Delete synapse-janitor tool
  file:
    path: "{{ postgres_synapse_janitor_tool_path }}"
    state: absent