zammad/spec/jobs/trigger_webhook_job/custom_payload_spec.rb

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

require 'rails_helper'

RSpec.describe TriggerWebhookJob::CustomPayload do

  # rubocop:disable Lint/InterpolationCheck
  describe '.generate' do
    subject(:generate) { described_class.generate(record, { ticket:, article:, notification:, config: }) }

    let(:ticket)  { create(:ticket) }
    let(:article) { create(:ticket_article, body: "Text with\nnew line.") }
    let(:event) do
      {
        type:      'info',
        execution: 'trigger',
        changes:   { 'state' => %w[open closed] },
        user_id:   1,
      }
    end
    let(:notification) { TriggerWebhookJob::CustomPayload::Track::Notification.generate({ ticket:, article: }, { event: }) }
    let(:config)       { TriggerWebhookJob::CustomPayload::Track::Config.generate({ ticket:, article: }, {}) }

    context 'when the payload is empty' do
      let(:record)    { {}.to_json }
      let(:json_data) { {} }

      it 'returns an empty JSON object' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder is empty' do
      let(:record) { { 'ticket' => '#{}' }.to_json }
      let(:json_data) { { 'ticket' => '#{}' } }

      it 'returns the placeholder' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder is invalid' do
      let(:record) { { 'ticket' => '#{ticket.title', 'article' => '#{article.id article.note}' }.to_json }
      let(:json_data) { { 'ticket' => '#{ticket.title', 'article' => '#{article.id article.note}' } }

      it 'returns the placeholder' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder base object ticket or article is missing' do
      let(:record) { { 'ticket' => '#{.title}' }.to_json }
      let(:json_data) { { 'ticket' => '#{no object provided}' } }

      it 'returns the placeholder reporting "no object provided"' do
        expect(generate).to eq(json_data)
      end

    end

    context 'when the placeholder base object is other than ticket or article' do
      let(:record) { { 'user' => '#{user}' }.to_json }
      let(:json_data) { { 'user' => '#{user / no such object}' } }

      it 'returns the placehodler reporting "no such object"' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder contains only base object ticket or article' do
      let(:record) { { 'ticket' => '#{ticket}', 'Article' => '#{article}' }.to_json }
      let(:json_data) { { 'ticket' => '#{ticket / missing method}', 'Article' => '#{article / missing method}' } }

      it 'returns the placeholder reporting "missing method"' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder contains denied method' do
      let(:record) { { 'ticket' => '#{ticket.articles}' }.to_json }
      let(:json_data) { { 'ticket' => '#{ticket.articles / no such method}' } }

      it 'returns the placeholder reporting "no such method"' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder contains denied attribute' do
      let(:record) { { 'ticket.owner' => '#{ticket.owner.password}' }.to_json }
      let(:json_data) { { 'ticket.owner' => '#{ticket.owner.password / no such method}' } }

      it 'returns the placeholder reporting "no such method"' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder contains danger method' do
      let(:record) { { 'ticket.owner' => '#{ticket.destroy!}' }.to_json }
      let(:json_data) { { 'ticket.owner' => '#{ticket.destroy! / no such method}' } }

      it 'returns the placeholder reporting "no such method"' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder ends with complex object' do
      let(:record) { { 'ticket' => '#{ticket.group}' }.to_json }
      let(:json_data) { { 'ticket' => '#{ticket.group / no such method}' } }

      it 'returns the placeholder reporting "no such method"' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder contains valid object and invalid method' do
      let(:record) { { 'ticket' => '#{ticket.1_article}' }.to_json }
      let(:json_data) { { 'ticket' => '#{ticket.1_article / no such method}' } }

      it 'returns the placeholder reporting "no such method"' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder contains valid object and method' do
      let(:record) { { 'ticket.id' => '#{ticket.id}' }.to_json }
      let(:json_data) { { 'ticket.id' => ticket.id } }

      it 'returns the determined value' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder contains valid object and method, but the value is nil' do
      let(:record) do
        {
          'ticket.organization.name' => '#{ticket.organization.name}',
          'ticket.title'             => '#{ticket.title}'
        }.to_json
      end
      let(:json_data) do
        {
          'ticket.organization.name' => '',
          'ticket.title'             => ticket.title
        }
      end

      it 'returns an empty string' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder contains multiple valid object and method' do
      let(:record) do
        {
          'ticket'  => { 'owner' => '#{ticket.owner.fullname}' },
          'article' => { 'created_at' => '#{article.created_at}' }
        }.to_json
      end
      let(:json_data) do
        {
          'ticket'  => { 'owner' => ticket.owner.fullname.to_s },
          'article' => { 'created_at' => article.created_at.to_s }
        }
      end

      it 'returns the determined value' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the placeholder contains multiple attributes' do
      let(:record) do
        {
          'my_field'  => 'Test #{ticket.id} // #{ticket.group.name} Test',
          'my_field2' => '#{ticket.id} // #{ticket.group.name} Test',
          'my_field3' => '#{ticket.id}',
          'my_field4' => '#{ticket.group.name}',
        }.to_json
      end
      let(:json_data) do
        {
          'my_field'  => "Test #{ticket.id} // #{ticket.group.name} Test",
          'my_field2' => "#{ticket.id} // #{ticket.group.name} Test",
          'my_field3' => ticket.id,
          'my_field4' => ticket.group.name.to_s,
        }
      end

      it 'returns the placeholder reporting "no such method"' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the payload contains a complex structure' do
      let(:record) do
        {
          'current_user' => '#{current_user.fullname}',
          'fqdn'         => '#{config.fqdn}',
          'ticket'       => {
            'id'      => '#{ticket.id}',
            'owner'   => '#{ticket.owner.fullname}',
            'group'   => '#{ticket.group.name}',
            'article' => {
              'id'          => '#{article.id}',
              'created_at'  => '#{article.created_at}',
              'subject'     => '#{article.subject}',
              'body'        => '#{article.body}',
              'attachments' => '#{article.attachments}',
              'internal'    => '#{article.internal}',
            }
          }
        }.to_json
      end
      let(:json_data) do
        {
          'current_user' => '#{current_user / no such object}',
          'fqdn'         => Setting.get('fqdn'),
          'ticket'       => {
            'id'      => ticket.id,
            'owner'   => ticket.owner.fullname.to_s,
            'group'   => ticket.group.name.to_s,
            'article' => {
              'id'          => article.id,
              'created_at'  => article.created_at.to_s,
              'subject'     => article.subject.to_s,
              'body'        => article.body.to_s,
              'attachments' => '#{article.attachments / no such method}',
              'internal'    => article.internal
            }
          }
        }
      end

      it 'returns a valid JSON payload' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when the replacement value contains double quotes' do
      let(:ticket)    { create(:ticket, title: 'Test "Title"') }
      let(:record)    { { 'ticket.title' => '#{ticket.title}' }.to_json }
      let(:json_data) { { 'ticket.title' => 'Test "Title"' } }

      it 'returns the determined value' do
        expect(generate).to eq(json_data)
      end
    end

    context 'when object attributes are used in the placeholder', db_strategy: :reset do
      let(:ticket) { create(:ticket, object_manager_attribute_name => object_manager_attribute_value) }

      before do
        create_object_manager_attribute
        ObjectManager::Attribute.migration_execute
      end

      shared_examples 'check different usage' do
        context 'when used in string context' do
          let(:record) do
            {
              "ticket.#{object_manager_attribute_name}" => "Test \#{ticket.#{object_manager_attribute_name}}"
            }.to_json
          end
          let(:json_data) do
            {
              "ticket.#{object_manager_attribute_name}" => "Test #{object_manager_attribute_value}"
            }
          end

          it 'returns the determined value' do
            expect(generate).to eq(json_data)
          end
        end

        context 'when used in direct context' do
          let(:record) do
            {
              "ticket.#{object_manager_attribute_name}" => "\#{ticket.#{object_manager_attribute_name}}"
            }.to_json
          end
          let(:json_data) do
            {
              "ticket.#{object_manager_attribute_name}" => object_manager_attribute_value
            }
          end

          it 'returns the determined value' do
            expect(generate).to eq(json_data)
          end
        end
      end

      context 'when multiselect is used inside the ticket' do
        let(:object_manager_attribute_name)  { 'multiselect_keys_001' }
        let(:object_manager_attribute_value) { %w[key_1 key_3] }
        let(:create_object_manager_attribute) do
          create(:object_manager_attribute_multiselect, name: object_manager_attribute_name)
        end

        include_examples 'check different usage'
      end

      context 'when external data source is used inside the ticket', db_adapter: :postgresql do
        let(:object_manager_attribute_name)  { 'autocompletion_ajax_external_data_source' }
        let(:object_manager_attribute_value) do
          {
            'value' => 123,
            'label' => 'Example',
          }
        end
        let(:create_object_manager_attribute) do
          create(:object_manager_attribute_autocompletion_ajax_external_data_source, name: object_manager_attribute_name)
        end

        include_examples 'check different usage'
      end
    end

    describe "when the placeholder contains object 'notification'" do
      let(:record) do
        {
          'subject' => '#{notification.subject}',
          'message' => '#{notification.message}',
          'changes' => '#{notification.changes}',
          'body'    => '#{notification.body}',
          'link'    => '#{notification.link}',
        }.to_json
      end

      context "when the event is of the type 'create'" do
        let(:event) do
          {
            type:      'create',
            execution: 'trigger',
            user_id:   1,
          }
        end

        it 'returns a valid json with a notification factory generated information"', :aggregate_failures do
          expect(generate['subject']).to eq(ticket.title)
          expect(generate['body']).to eq(article.body_as_text)
          expect(generate['link']).to match(%r{http.*#ticket/zoom/#{ticket.id}$})
          expect(generate['message']).to include('Created by')
          expect(generate['changes']).to include('State: new')
        end
      end

      context "when the event is of the type 'update'" do
        let(:event) do
          {
            type:      'update',
            execution: 'trigger',
            changes:   { 'state' => %w[open closed] },
            user_id:   1,
          }
        end

        it 'returns a valid json with a notification factory generated information"', :aggregate_failures do
          expect(generate['subject']).to eq(ticket.title)
          expect(generate['body']).to eq(article.body_as_text)
          expect(generate['link']).to match(%r{http.*#ticket/zoom/#{ticket.id}$})
          expect(generate['message']).to include('Updated by')
          expect(generate['changes']).to include('state: open -> closed')
        end

        context 'without changes' do
          let(:event) do
            {
              type:      'update',
              execution: 'trigger',
              user_id:   1,
            }
          end

          it 'returns a valid json with a notification factory generated information"', :aggregate_failures do
            expect(generate['subject']).to eq(ticket.title)
            expect(generate['body']).to eq(article.body_as_text)
            expect(generate['link']).to match(%r{http.*#ticket/zoom/#{ticket.id}$})
            expect(generate['message']).to include('Updated by')
          end
        end
      end

      context "when the event is of the type 'info'" do
        let(:event) do
          {
            type:      'info',
            execution: 'trigger',
            changes:   { 'state' => %w[open closed] },
            user_id:   1,
          }
        end

        it 'returns a valid json with a notification factory generated information"', :aggregate_failures do
          expect(generate['subject']).to eq(ticket.title)
          expect(generate['body']).to eq(article.body_as_text)
          expect(generate['link']).to match(%r{http.*#ticket/zoom/#{ticket.id}$})
          expect(generate['message']).to include('Last updated at')
        end
      end

      context "when the event is of the type 'escalation'" do
        let(:event) do
          {
            type:      'escalation',
            execution: 'trigger',
            user_id:   1,
          }
        end

        it 'returns a valid json with a notification factory generated information"', :aggregate_failures do
          expect(generate['subject']).to eq(ticket.title)
          expect(generate['body']).to eq(article.body_as_text)
          expect(generate['link']).to match(%r{http.*#ticket/zoom/#{ticket.id}$})
          expect(generate['message']).to include('Escalated at')
          expect(generate['changes']).to include('has been escalated since')
        end
      end

      context "when the event is of the type 'escalation warning'" do
        let(:event) do
          {
            type:      'escalation_warning',
            execution: 'trigger',
            user_id:   1,
          }
        end

        it 'returns a valid json with a notification factory generated information"', :aggregate_failures do
          expect(generate['subject']).to eq(ticket.title)
          expect(generate['body']).to eq(article.body_as_text)
          expect(generate['link']).to match(%r{http.*#ticket/zoom/#{ticket.id}$})
          expect(generate['message']).to include('Will escalate at')
          expect(generate['changes']).to include('will escalate at')
        end
      end

      context "when the event is of the type 'reminder reached'" do
        let(:event) do
          {
            type:      'reminder_reached',
            execution: 'trigger',
            user_id:   1,
          }
        end

        it 'returns a valid json with a notification factory generated information"', :aggregate_failures do
          expect(generate['subject']).to eq(ticket.title)
          expect(generate['body']).to eq(article.body_as_text)
          expect(generate['link']).to match(%r{http.*#ticket/zoom/#{ticket.id}$})
          expect(generate['message']).to include('Reminder reached!')
          expect(generate['changes']).to include('reminder reached for')
        end
      end

      context "when the event is triggered by a 'job'" do
        let(:event) do
          {
            type:      '',
            execution: 'job',
            changes:   { 'state' => %w[open closed] },
            user_id:   1,
          }
        end

        let(:article) { nil }

        it 'returns a valid json with a notification factory generated information"', :aggregate_failures do
          expect(generate['subject']).to eq(ticket.title)
          expect(generate['body']).to be_empty
          expect(generate['link']).to match(%r{http.*#ticket/zoom/#{ticket.id}$})
          expect(generate['message']).to include('Last updated at')
        end
      end
    end

    describe 'when the payload is a pre-defined webhook' do
      subject(:generate) { described_class.generate(record, { ticket:, article:, notification:, webhook: struct_webhook }) }

      let(:webhook)        { create(:mattermost_webhook) }
      let(:struct_webhook) { TriggerWebhookJob::CustomPayload::Track::PreDefinedWebhook.generate({ ticket:, article: }, { event:, webhook: }) }
      let(:record)         { TriggerWebhookJob::CustomPayload::Track::PreDefinedWebhook.payload('Mattermost') }

      it 'returns a valid json with webhook information"', :aggregate_failures do
        info = webhook.preferences[:pre_defined_webhook]

        expect(generate[:channel]).to eq(info[:channel])
        expect(generate[:icon_url]).to eq(info[:icon_url])
      end

      context 'when event has no changes' do
        let(:event) do
          {
            type:      'info',
            execution: 'trigger',
            changes:   { 'state' => %w[open closed] },
            user_id:   1,
          }
        end

        it "returns a valid json with webhook information without 'attachments'", :aggregate_failures do
          info = webhook.preferences[:pre_defined_webhook]

          expect(generate[:channel]).to eq(info[:channel])
          expect(generate[:icon_url]).to eq(info[:icon_url])
          expect(generate).to not_include(:attachments)
        end
      end

      context 'when pre-defined webhook has no additional values' do
        let(:webhook)        { create(:slack_webhook) }
        let(:record)         { TriggerWebhookJob::CustomPayload::Track::PreDefinedWebhook.payload('Slack') }

        it 'returns a valid json with webhook information"', :aggregate_failures do
          expect(generate['text']).to eq("# #{ticket.title}")
        end
      end
    end
  end
  # rubocop:enable Lint/InterpolationCheck

  describe '.replacements' do
    subject(:replacements) { described_class.replacements(pre_defined_webhook_type: 'Mattermost') }

    it 'returns a hash with the replacement variables', :aggregate_failures do
      expect(replacements).to be_a(Hash)
      expect(replacements.keys).to include(:article, :ticket, :notification, :webhook)
    end
  end
end