zammad/spec/graphql/gql/subscriptions/app_maintenance_spec.rb

# Copyright (C) 2012-2024 Zammad Foundation, https://zammad-foundation.org/

require 'rails_helper'

RSpec.describe Gql::Subscriptions::AppMaintenance, type: :graphql do

  let(:subscription) do
    <<~QUERY
      subscription appMaintenance {
        appMaintenance {
          type
        }
      }
    QUERY
  end
  let(:mock_channel)  { build_mock_channel }
  let(:expected_type) { 'app_version' }
  let(:expected_msg) do
    {
      result: {
        'data' => {
          'appMaintenance' => {
            'type' => expected_type
          }
        }
      },
      more:   true,
    }
  end

  shared_examples 'app maintenance subscription' do
    it 'correct app maintenance update/change event' do
      expect(mock_channel.mock_broadcasted_messages).to eq([expected_msg])
    end
  end

  context 'when app maintenance update/change events (trigger actions in the frontend) are triggered' do
    context 'when browser reload is triggered' do
      before do
        gql.execute(subscription, context: { channel: mock_channel })
        AppVersion.trigger_browser_reload(app_version_set)
      end

      context 'when app version event is triggered' do
        let(:app_version_set) { AppVersion::MSG_APP_VERSION }

        include_examples 'app maintenance subscription'
      end

      context 'when restart auto event is triggered' do
        let(:app_version_set) { AppVersion::MSG_RESTART_AUTO }
        let(:expected_type)   { 'restart_auto' }

        include_examples 'app maintenance subscription'
      end

      context 'when restart manual event is triggered' do
        let(:app_version_set) { AppVersion::MSG_RESTART_MANUAL }
        let(:expected_type)   { 'restart_manual' }

        include_examples 'app maintenance subscription'
      end

      context 'when config change event is triggered' do
        let(:app_version_set) { AppVersion::MSG_CONFIG_CHANGED }
        let(:expected_type)   { 'config_changed' }

        include_examples 'app maintenance subscription'
      end
    end

    context 'when system restart is triggered' do
      before do
        Setting.set('auto_shutdown', auto_shutdown_enabled)
        gql.execute(subscription, context: { channel: mock_channel })
        AppVersion.trigger_restart
      end

      context 'when auto restart is enabled' do
        let(:auto_shutdown_enabled) { true }
        let(:expected_type) { 'restart_auto' }

        include_examples 'app maintenance subscription'
      end

      context 'when auto restart is disabled' do
        let(:auto_shutdown_enabled) { false }
        let(:expected_type) { 'restart_manual' }

        include_examples 'app maintenance subscription'
      end
    end
  end
end