Add the custom_webhook integration by armiiller · Pull Request #145 · PagerTree/pager_tree-integrations

armiiller · 2025-12-04T02:28:44Z

No description provided.

Copilot

Pull request overview

This PR adds a new custom_webhook integration (v3) that allows users to define custom YAML-based webhook transformation rules. The integration sends webhook data to an external service that processes it according to user-defined rules and returns structured alert data. This enables flexible webhook handling for third-party services not directly supported by PagerTree.

Key Changes

Added CustomWebhook::V3 integration model with YAML rule configuration support
Implemented HTTP-based communication with external webhook processing service
Added comprehensive test suite with VCR cassettes for various action types (create, acknowledge, resolve, ignore)

Reviewed changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
`app/models/pager_tree/integrations/custom_webhook/v3.rb`	Core integration model with HTTParty-based external service communication, YAML configuration handling, and alert processing logic
`app/views/pager_tree/integrations/custom_webhook/v3/_form_options.html.erb`	Form view with YAML code editor for custom webhook rule configuration
`app/views/pager_tree/integrations/custom_webhook/v3/_show_options.html.erb`	Empty show view (no display options needed)
`test/models/pager_tree/integrations/custom_webhook/v3_test.rb`	Test suite covering sanity checks, action routing, thirdparty_id extraction, and alert creation
`test/fixtures/pager_tree/integrations/integrations.yml`	Test fixture for custom_webhook_v3 integration
`test/vcr_cassettes/custom_webhook_v3_adapter_*.yml`	VCR cassettes for HTTP interactions with webhook processing service
`test/support/vcr.rb`	VCR configuration to filter sensitive service URL
`lib/pager_tree/integrations.rb`	Global configuration for custom webhook service URL
`config/locales/en.yml`	Localization strings for form labels and hints
`.github/workflows/ci.yml`	CI environment variable for webhook service URL

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-04T02:35:00Z

config/locales/en.yml

        option_thread_same_alert: "Thread Same Alert"
      "pager_tree/integrations/channel/microsoft_teams/v3":
        option_time_zone: "Display Time Zone"
+      "pager_tree/integration/custom_webhook/v3":


The path should be "pager_tree/integrations/custom_webhook/v3" (with 's' in "integrations") to match the module namespace and be consistent with all other integration paths in this file (e.g., lines 193-198, 201-203).

Suggested change

"pager_tree/integration/custom_webhook/v3":

"pager_tree/integrations/custom_webhook/v3":

Copilot · 2025-12-04T02:35:00Z

test/fixtures/pager_tree/integrations/integrations.yml


+custom_webhook_v3:
+  type: "PagerTree::Integrations::CustomWebhook::V3"
+  # optionss: no_options


There's a typo: optionss: should be options: (single 's'). This should follow the same pattern as other fixtures in this file.

Suggested change

# optionss: no_options

# options: no_options

Copilot · 2025-12-04T02:35:01Z

app/models/pager_tree/integrations/custom_webhook/v3.rb

+    end
+
+    def _additional_datums
+      custom_response_result.dig("additional_data") || []


The _additional_datums method should map the response data to AdditionalDatum objects instead of returning raw hashes. Following the pattern used in other integrations (e.g., Cloudflare::V3), it should be:

def _additional_datums data = custom_response_result.dig("additional_data") || [] data.map { |datum| AdditionalDatum.new(datum) } end

This ensures the data is properly validated and conforms to the expected AdditionalDatum interface.

Suggested change

custom_response_result.dig("additional_data") || []

data = custom_response_result.dig("additional_data") || []

data.map { |datum| AdditionalDatum.new(datum) }

Copilot · 2025-12-04T02:35:01Z

test/models/pager_tree/integrations/custom_webhook/v3_test.rb

+        @integration.adapter_incoming_deferred_request.body = @acknowledge_request
+        assert_equal :acknowledge, @integration.adapter_action
+      end
+    end


[nitpick] Missing blank line between test methods. For consistency with the rest of the file (see lines 97-99, 105-107, 127-129), there should be a blank line before the test "adapter_action_resolve" method definition.

Suggested change

end

end

Copilot · 2025-12-04T02:35:01Z

test/models/pager_tree/integrations/custom_webhook/v3_test.rb

+        @integration.adapter_incoming_deferred_request.body = @resolve_request
+        assert_equal :resolve, @integration.adapter_action
+      end
+    end


[nitpick] Missing blank line between test methods. For consistency with the rest of the file (see lines 97-99, 105-107, 127-129), there should be a blank line before the test "adapter_action_other" method definition.

Suggested change

end

end

Copilot

Pull request overview

Copilot reviewed 29 out of 30 changed files in this pull request and generated 5 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-05T17:06:02Z

app/models/pager_tree/integrations/custom_webhook/v3.rb

+        Rails.logger.error("Custom Webhook Service error: #{e.message}")
+        adapter_source_log&.sublog("Custom Webhook Service error: #{e.message}")
+        adapter_source_log&.save
+        raise "Custom Webhook Service error #{e.message}"


Missing colon after "error" in the error message string. Should be "Custom Webhook Service error: #{e.message}" for consistency with other error messages in this file.

Suggested change

raise "Custom Webhook Service error #{e.message}"

raise "Custom Webhook Service error: #{e.message}"

Copilot · 2025-12-05T17:06:03Z

app/models/pager_tree/integrations/custom_webhook/v3.rb

+
+        body_hash = {
+          log: log_hash,
+          config: JSON.parse(PagerTree::Integrations::FormatConverters::YamlJsonConverter.convert_to_json(option_custom_definition))


Inefficient double-conversion. The code converts YAML to JSON string using convert_to_json, then immediately parses it back with JSON.parse. This creates unnecessary overhead. Consider having YamlJsonConverter provide a method that returns the parsed data structure directly, or use convert_to_json(option_custom_definition, pretty: false) and skip the JSON.parse to directly use the JSON string if that's the desired format.

Copilot · 2025-12-05T17:06:03Z

lib/pager_tree/integrations/format_converters/yaml_json_converter.rb

+# lib/pager_tree/integrations/format_converters/yaml_json_converter.rb
+require "yaml"
+require "json"
+
+module PagerTree
+  module Integrations
+    module FormatConverters
+      class YamlJsonConverter
+        class InvalidFormatError < StandardError; end
+
+        class << self
+          def convert_to_json(str, pretty: true)
+            format = detect_format(str)
+
+            case format
+            when :json
+              data = JSON.parse(str)
+              pretty ? JSON.pretty_generate(data) : data.to_json
+            when :yaml
+              data = YAML.safe_load(str)
+              pretty ? JSON.pretty_generate(data) : data.to_json
+            else
+              raise InvalidFormatError, "Input is neither valid JSON nor YAML"
+            end
+          end
+
+          def convert_to_yaml(str)
+            format = detect_format(str)
+
+            case format
+            when :json
+              data = JSON.parse(str)
+              data.to_yaml
+            when :yaml
+              data = YAML.safe_load(str)
+              data.to_yaml
+            else
+              raise InvalidFormatError, "Input is neither valid JSON nor YAML"
+            end
+          end
+
+          def detect_format(str)
+            return :json if json?(str)
+            return :yaml if yaml?(str)
+            :unknown
+          end
+
+          private
+
+          def json?(str)
+            JSON.parse(str)
+            true
+          rescue JSON::ParserError
+            false
+          end
+
+          def yaml?(str)
+            YAML.safe_load(str)
+            true
+          rescue Psych::SyntaxError
+            false
+          end
+        end
+      end
+    end
+  end
+end


The YamlJsonConverter utility class lacks test coverage. This new utility should have comprehensive tests covering format detection, conversion between YAML and JSON, error handling for invalid inputs, and edge cases. Consider adding a test file at test/lib/pager_tree/integrations/format_converters/yaml_json_converter_test.rb.

Copilot · 2025-12-05T17:06:03Z

test/fixtures/pager_tree/integrations/integrations.yml


+custom_webhook_v3:
+  type: "PagerTree::Integrations::CustomWebhook::V3"
+  # optionss: no_options


Typo in YAML comment - "optionss" should be "options" (extra 's').

Suggested change

# optionss: no_options

# options: no_options

Copilot · 2025-12-05T17:06:04Z

lib/pager_tree/integrations/format_converters/yaml_json_converter.rb

+              data = YAML.safe_load(str)
+              pretty ? JSON.pretty_generate(data) : data.to_json
+            else
+              raise InvalidFormatError, "Input is neither valid JSON nor YAML"
+            end
+          end
+
+          def convert_to_yaml(str)
+            format = detect_format(str)
+
+            case format
+            when :json
+              data = JSON.parse(str)
+              data.to_yaml
+            when :yaml
+              data = YAML.safe_load(str)
+              data.to_yaml
+            else
+              raise InvalidFormatError, "Input is neither valid JSON nor YAML"
+            end
+          end
+
+          def detect_format(str)
+            return :json if json?(str)
+            return :yaml if yaml?(str)
+            :unknown
+          end
+
+          private
+
+          def json?(str)
+            JSON.parse(str)
+            true
+          rescue JSON::ParserError
+            false
+          end
+
+          def yaml?(str)
+            YAML.safe_load(str)


Using YAML.safe_load without specifying permitted classes could be a security risk if the YAML contains complex objects. Consider using YAML.safe_load(str, permitted_classes: [], permitted_symbols: [], aliases: false) to be more explicit about what's allowed.

Copilot

Pull request overview

Copilot reviewed 31 out of 32 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-05T23:17:55Z

app/models/pager_tree/integrations/custom_webhook/v3.rb

+        Rails.logger.error("Custom Webhook Service error: #{e.message}")
+        adapter_source_log&.sublog("Custom Webhook Service error: #{e.message}")
+        adapter_source_log&.save
+        raise "Custom Webhook Service error #{e.message}"


Inconsistent error message format. The error message at line 124 is missing a colon after "error" (should be "Custom Webhook Service error: #{e.message}"). For consistency with the error message at line 105 and standard error message formatting, add a colon between "error" and the interpolated message.

Suggested change

raise "Custom Webhook Service error #{e.message}"

raise "Custom Webhook Service error: #{e.message}"

Copilot · 2025-12-05T23:17:56Z

lib/pager_tree/integrations/format_converters/yaml_json_converter.rb

+# lib/pager_tree/integrations/format_converters/yaml_json_converter.rb
+require "yaml"
+require "json"
+
+module PagerTree
+  module Integrations
+    module FormatConverters
+      class YamlJsonConverter
+        class InvalidFormatError < StandardError; end
+
+        class << self
+          def convert_to_json(str, pretty: true)
+            format = detect_format(str)
+
+            case format
+            when :json
+              data = JSON.parse(str)
+              pretty ? JSON.pretty_generate(data) : data.to_json
+            when :yaml
+              data = YAML.safe_load(str)
+              pretty ? JSON.pretty_generate(data) : data.to_json
+            else
+              raise InvalidFormatError, "Input is neither valid JSON nor YAML"
+            end
+          end
+
+          def convert_to_yaml(str)
+            format = detect_format(str)
+
+            case format
+            when :json
+              data = JSON.parse(str)
+              data.to_yaml
+            when :yaml
+              data = YAML.safe_load(str)
+              data.to_yaml
+            else
+              raise InvalidFormatError, "Input is neither valid JSON nor YAML"
+            end
+          end
+
+          def detect_format(str)
+            return :json if json?(str)
+            return :yaml if yaml?(str)
+            :unknown
+          end
+
+          private
+
+          def json?(str)
+            JSON.parse(str)
+            true
+          rescue JSON::ParserError
+            false
+          end
+
+          def yaml?(str)
+            YAML.safe_load(str)
+            true
+          rescue Psych::SyntaxError
+            false
+          end
+        end
+      end
+    end
+  end
+end


The new YamlJsonConverter utility class lacks test coverage. This class handles conversion of YAML/JSON input that could come from users, and includes error handling for invalid formats. Add unit tests to verify:

Successful conversion from YAML to JSON (pretty and compact)

Successful conversion from JSON to YAML

Error handling for invalid YAML input

Error handling for invalid JSON input

Format detection logic

Edge cases (empty strings, malformed input, etc.)

This is especially important since the converter handles user-provided configuration data.

armiiller added 2 commits December 3, 2025 19:26

Adding the custom_webhook integration

c7a9d92

standardrb

9a66ce0

armiiller requested a review from Copilot December 4, 2025 02:28

Copilot started reviewing on behalf of armiiller December 4, 2025 02:29 View session

Copilot finished reviewing on behalf of armiiller December 4, 2025 02:34

Copilot AI reviewed Dec 4, 2025

View reviewed changes

armiiller added 2 commits December 5, 2025 07:54

Add the yaml json converter utility

79b6828

Adding examples and a working anyhook

43909d9

armiiller requested a review from Copilot December 5, 2025 17:01

Copilot started reviewing on behalf of armiiller December 5, 2025 17:02 View session

Copilot finished reviewing on behalf of armiiller December 5, 2025 17:04

Copilot AI reviewed Dec 5, 2025

View reviewed changes

armiiller added 5 commits December 5, 2025 10:09

Add the adapter_source log attribute

46ad980

Add better sublogging

2bd893b

Adds the cloudwatch example

23d381d

Updating some of the locals (per copilot request)

2d80679

Updating the examples to be more accurate

e41d103

armiiller requested a review from Copilot December 5, 2025 23:13

Copilot started reviewing on behalf of armiiller December 5, 2025 23:13 View session

Copilot AI reviewed Dec 5, 2025

View reviewed changes

armiiller added 3 commits December 8, 2025 10:05

Add the suggestion from Copilot

591f5f7

Add test coverage for the JSON YAML converter

a3b6c03

Update link

40519b3

armiiller merged commit 0ae5bc8 into main Dec 8, 2025
2 checks passed

	"pager_tree/integration/custom_webhook/v3":
	"pager_tree/integrations/custom_webhook/v3":

	custom_response_result.dig("additional_data") \|\| []
	data = custom_response_result.dig("additional_data") \|\| []
	data.map { \|datum\| AdditionalDatum.new(datum) }

	raise "Custom Webhook Service error #{e.message}"
	raise "Custom Webhook Service error: #{e.message}"

Uh oh!

Conversation

armiiller commented Dec 4, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant