danger 8.4.5 → 8.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55ca17556aed4215f86219bcdca5271049b481a1bd349e35211b4f9e509c2b15
-  data.tar.gz: b2b1fb228f4325ce12ac2ff9c7a753d1b056966f0e8078bdce392a4fb9334b32
+  metadata.gz: c8d6272f0ed9095d67e585d262669d8d11705a8a5cce460c02122a9b826d5cd7
+  data.tar.gz: 42699026115d900c5e32f057e206697472be7ba80d6d1686e7eb07d5262100c6
 SHA512:
-  metadata.gz: f2769209f205e40a84f24426e4ce93b3681cbe8f4d57970114b0238d0a3f4c5bb8ff75bbd69936635abb7a8c64f933aaf1e18c4c2a0355ef18630d8365b99c60
-  data.tar.gz: c260a71c30a49e4b6fad9975986324f795fc07750edd082e0e364f6c4975fc69e68619d7bd083bb48dac24f514f14a102d7cb7b95509de1c1b664608fbc63421
+  metadata.gz: 3981a24f19fb7b63737b80435d8d2685fa187630aeb82edb28042c8d0db74f23412e588daf16732f045563cc52f9d85432682c76fe1913c4cde57d671b99cb8b
+  data.tar.gz: 4b7f3f4fb90975da2faa9cbdff6e5cb95e27ea06447fa95a749df6df77bec14de7c47c6e52fc2d98949e160cb4dd12a96d9babefec2798be8cdcd1cde77f0ebd

data/lib/danger/comment_generators/vsts_inline.md.erb

@@ -0,0 +1,17 @@
+<%- @tables.each do |table| -%>
+  <%- if table[:content].any? || table[:resolved].any? -%>
+| | |
+|---|---|
+    <%- table[:content].each do |violation| -%>
+| <%= @emoji_mapper.map(table[:emoji]) %> | <%= "~~" if table[:resolved] %><%= violation.message %><%= "~~" if table[:resolved] %> |
+    <%- end -%>
+
+  <%- end -%>
+<%- end -%>
+
+<%- @markdowns.each do |current| -%>
+<%= current %>
+<%# the previous line has to be aligned far to the left, otherwise markdown can break easily %>
+<%- end -%>
+
+Generated by :no_entry_sign: [Danger](https://danger.systems/ "generated_by_<%= @danger_id %>")

data/lib/danger/helpers/comments_helper.rb

@@ -24,7 +24,8 @@ module Danger
       # @param [Bool] Should hide any generated link created
       #
       # @return [String] The Markdown compatible link
-      def markdown_link_to_message(message, _)
+      def markdown_link_to_message(message, hide_link)
+        return "" if hide_link
         "#{message.file}#L#{message.line}"
       end
 
@@ -147,7 +148,7 @@ module Danger
 
       def generate_description(warnings: nil, errors: nil, template: "github")
         emoji_mapper = EmojiMapper.new(template)
-        if errors.empty? && warnings.empty?
+        if (errors.nil? || errors.empty?) && (warnings.nil? || warnings.empty?)
           return ENV['DANGER_SUCCESS_MESSAGE'] || "All green. #{random_compliment}"
         else
           message = "#{emoji_mapper.map('warning')} "

data/lib/danger/request_sources/vsts.rb

@@ -43,6 +43,10 @@ module Danger
         @scm ||= GitRepo.new
       end
 
+      def client
+        @api
+      end
+
       def host
         @host ||= @api.host
       end
@@ -76,15 +80,36 @@ module Danger
           return
         end
 
-        comment = generate_description(warnings: warnings, errors: errors)
+        regular_violations = regular_violations_group(
+          warnings: warnings,
+          errors: errors,
+          messages: messages,
+          markdowns: markdowns
+        )
+
+        inline_violations = inline_violations_group(
+          warnings: warnings,
+          errors: errors,
+          messages: messages,
+          markdowns: markdowns
+        )
+
+        rest_inline_violations = submit_inline_comments!(**{
+          danger_id: danger_id,
+          previous_violations: {}
+        }.merge(inline_violations))
+
+        main_violations = merge_violations(
+          regular_violations, rest_inline_violations
+        )
+
+        comment = generate_description(warnings: main_violations[:warnings], errors: main_violations[:errors])
         comment += "\n\n"
-        comment += generate_comment(warnings: warnings,
-                                     errors: errors,
-                                   messages: messages,
-                                  markdowns: markdowns,
-                        previous_violations: {},
-                                  danger_id: danger_id,
-                                   template: "vsts")
+        comment += generate_comment(**{
+          previous_violations: {},
+          danger_id: danger_id,
+          template: "vsts"
+        }.merge(main_violations))
         if new_comment || remove_previous_comments
           post_new_comment(comment)
         else
@@ -105,6 +130,8 @@ module Danger
           comment_content = comment[:content].nil? ? "" : comment[:content]
           # Skip the comment if it wasn't posted by danger
           next unless comment_content.include?("generated_by_#{danger_id}")
+          # Skip the comment if it's an inline comment
+          next unless c[:threadContext].nil?
           # Updated the danger posted comment
           @api.update_comment(thread_id, comment_id, new_comment)
           comment_updated = true
@@ -112,6 +139,142 @@ module Danger
         # If no comment was updated, post a new one
         post_new_comment(new_comment) unless comment_updated
       end
+
+      def submit_inline_comments!(warnings: [], errors: [], messages: [], markdowns: [], previous_violations: [], danger_id: "danger")
+        # Avoid doing any fetchs if there's no inline comments
+        return {} if (warnings + errors + messages + markdowns).select(&:inline?).empty?
+
+        pr_threads = @api.fetch_last_comments
+        danger_threads = pr_threads.select do |thread|
+          comment = thread[:comments].first
+          comment_content = comment[:content].nil? ? "" : comment[:content]
+
+          next comment_content.include?("generated_by_#{danger_id}")
+        end
+        non_danger_threads = pr_threads - danger_threads
+
+        warnings = submit_inline_comments_for_kind!(:warning, warnings, danger_threads, previous_violations["warning"], danger_id: danger_id)
+        errors = submit_inline_comments_for_kind!(:error, errors, danger_threads, previous_violations["error"], danger_id: danger_id)
+        messages = submit_inline_comments_for_kind!(:message, messages, danger_threads, previous_violations["message"], danger_id: danger_id)
+        markdowns = submit_inline_comments_for_kind!(:markdown, markdowns, danger_threads, [], danger_id: danger_id)
+
+        # submit removes from the array all comments that are still in force
+        # so we strike out all remaining ones
+        danger_threads.each do |thread|
+          violation = violations_from_table(thread[:comments].first[:content]).first
+          if !violation.nil? && violation.sticky
+            body = generate_inline_comment_body("white_check_mark", violation, danger_id: danger_id, resolved: true, template: "github")
+            @api.update_comment(thread[:id], thread[:comments].first[:id], body)
+          end
+        end
+
+        {
+          warnings: warnings,
+          errors: errors,
+          messages: messages,
+          markdowns: markdowns
+        }
+      end
+
+      def messages_are_equivalent(m1, m2)
+        blob_regexp = %r{blob/[0-9a-z]+/}
+        m1.file == m2.file && m1.line == m2.line &&
+          m1.message.sub(blob_regexp, "") == m2.message.sub(blob_regexp, "")
+      end
+
+      def submit_inline_comments_for_kind!(kind, messages, danger_threads, previous_violations, danger_id: "danger")
+        previous_violations ||= []
+        is_markdown_content = kind == :markdown
+        emoji = { warning: "warning", error: "no_entry_sign", message: "book" }[kind]
+
+        messages.reject do |m|
+          next false unless m.file && m.line
+
+          # Once we know we're gonna submit it, we format it
+          if is_markdown_content
+            body = generate_inline_markdown_body(m, danger_id: danger_id, template: "vsts")
+          else
+            # Hide the inline link behind a span
+            m.message.gsub!("\n", "<br />")
+            m = process_markdown(m, true)
+            body = generate_inline_comment_body(emoji, m, danger_id: danger_id, template: "vsts")
+            # A comment might be in previous_violations because only now it's part of the unified diff
+            # We remove from the array since it won't have a place in the table anymore
+            previous_violations.reject! { |v| messages_are_equivalent(v, m) }
+          end
+
+          matching_threads = danger_threads.select do |comment_data|
+            if comment_data.key?(:threadContext) && !comment_data[:threadContext].nil? &&
+              comment_data[:threadContext][:filePath] == m.file &&
+              comment_data[:threadContext].key?(:rightFileStart) &&
+              comment_data[:threadContext][:rightFileStart][:line] == m.line
+              # Parse it to avoid problems with strikethrough
+              violation = violations_from_table(comment_data[:comments].first[:content]).first
+              if violation
+                messages_are_equivalent(violation, m)
+              else
+                blob_regexp = %r{blob/[0-9a-z]+/}
+                comment_data[:comments].first[:content].sub(blob_regexp, "") == body.sub(blob_regexp, "")
+              end
+            else
+              false
+            end
+          end
+
+          if matching_threads.empty?
+            @api.post_inline_comment(body, m.file, m.line)
+
+            # Not reject because this comment has not completed
+            next false
+          else
+            # Remove the surviving comment so we don't strike it out
+            danger_threads.reject! { |c| matching_threads.include? c }
+
+            # Update the comment to remove the strikethrough if present
+            thread = matching_threads.first
+            @api.update_comment(thread[:id], thread[:comments].first[:id], body)
+          end
+
+          # Remove this element from the array
+          next true
+        end
+      end
+
+      private
+
+      def regular_violations_group(warnings: [], errors: [], messages: [], markdowns: [])
+        {
+          warnings: warnings.reject(&:inline?),
+          errors: errors.reject(&:inline?),
+          messages: messages.reject(&:inline?),
+          markdowns: markdowns.reject(&:inline?)
+        }
+      end
+
+      def inline_violations_group(warnings: [], errors: [], messages: [], markdowns: [])
+        cmp = proc do |a, b|
+          next -1 unless a.file && a.line
+          next 1 unless b.file && b.line
+
+          next a.line <=> b.line if a.file == b.file
+          next a.file <=> b.file
+        end
+
+        # Sort to group inline comments by file
+        {
+          warnings: warnings.select(&:inline?).sort(&cmp),
+          errors: errors.select(&:inline?).sort(&cmp),
+          messages: messages.select(&:inline?).sort(&cmp),
+          markdowns: markdowns.select(&:inline?).sort(&cmp)
+        }
+      end
+
+      def merge_violations(*violation_groups)
+        violation_groups.inject({}) do |accumulator, group|
+          accumulator.merge(group) { |_, old, fresh| old + fresh }
+        end
+      end
+
     end
   end
 end

data/lib/danger/request_sources/vsts_api.rb

@@ -76,6 +76,38 @@ module Danger
         post(uri, body)
       end
 
+      def post_inline_comment(text, file, line)
+        uri = URI("#{pr_api_endpoint}/threads?api-version=#{@api_version}")
+        body = {
+          "comments" => [
+            {
+              "parentCommentId" => 0,
+              "content" => text,
+              "commentType" => 1
+            }
+          ],
+          "properties" => {
+            "Microsoft.TeamFoundation.Discussion.SupportsMarkdown" => {
+              "type" => "System.Int32",
+              "value" => 1
+            }
+          },
+          "status" => 1,
+          "threadContext" => {
+            "filePath" => file,
+            "rightFileEnd" => {
+              "line" => line + 1,
+              "offset" => 1
+            },
+            "rightFileStart" => {
+              "line" => line,
+              "offset" => 1
+            }
+          }
+        }.to_json
+        post(uri, body)
+      end
+
       def update_comment(thread, id, new_comment)
         uri = URI("#{pr_api_endpoint}/threads/#{thread}/comments/#{id}?api-version=#{@api_version}")
         body = {

data/lib/danger/version.rb

@@ -1,4 +1,4 @@
 module Danger
-  VERSION = "8.4.5".freeze
+  VERSION = "8.5.0".freeze
   DESCRIPTION = "Like Unit Tests, but for your Team Culture.".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger
 version: !ruby/object:Gem::Version
-  version: 8.4.5
+  version: 8.5.0
 platform: ruby
 authors:
 - Orta Therox
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: claide
@@ -271,6 +271,7 @@ files:
 - lib/danger/comment_generators/gitlab.md.erb
 - lib/danger/comment_generators/gitlab_inline.md.erb
 - lib/danger/comment_generators/vsts.md.erb
+- lib/danger/comment_generators/vsts_inline.md.erb
 - lib/danger/core_ext/file_list.rb
 - lib/danger/core_ext/string.rb
 - lib/danger/danger_core/dangerfile.rb