Add comments about #strip_markup usage

3f784bff · Markus Koller · Andy Soiron · 55a4cc5a · 3f784bff
Commit 3f784bff authored Jan 18, 2022 by Markus Koller Committed by Andy Soiron Jan 21, 2022
Show whitespace changes
Inline Side-by-side

Showing with 5 additions and 0 deletions

app/models/integrations/chat_message/base_message.rb app/models/integrations/chat_message/base_message.rb +5 -0

No files found.
--- a/app/models/integrations/chat_message/base_message.rb
+++ b/app/models/integrations/chat_message/base_message.rb
@@ -47,16 +47,21 @@ module Integrations
        format(message)
      end

+      # NOTE: Make sure to call `#strip_markup` on any untrusted user input that's added to the
+      # `title`, `subtitle`, `text`, `fallback`, or `author_name` fields.
      def attachments
        raise NotImplementedError
      end

+      # NOTE: Make sure to call `#strip_markup` on any untrusted user input that's added to the
+      # `title`, `subtitle`, `text`, `fallback`, or `author_name` fields.
      def activity
        raise NotImplementedError
      end

      private

+      # NOTE: Make sure to call `#strip_markup` on any untrusted user input that's added to the string.
      def message
        raise NotImplementedError
      end