Removing Support file specific error handling

Author: thavaahariharangit

updater/lib/dependabot/dependency_change_builder.rb

@@ -25,8 +25,6 @@ module Dependabot
   class DependencyChangeBuilder
     extend T::Sig
 
-    SUPPORT_FILE_WARNING_NAME_LIMIT = 10
-
     sig do
       params(
         job: Dependabot::Job,
@@ -69,17 +67,14 @@ def initialize(job:, dependency_files:, updated_dependencies:, change_source:, n
       @updated_dependencies = updated_dependencies
       @change_source = change_source
       @notices = notices
-      @support_files_only_diagnostics = T.let(nil, T.nilable(String))
     end
 
     sig { returns(Dependabot::DependencyChange) }
     def run
       updated_files = generate_dependency_files
 
       unless updated_files.any?
-        error_message = "FileUpdater failed to update any files for: #{dependency_info_for_error}"
-        error_message += "; #{support_files_only_diagnostics}" if support_files_only_diagnostics
-        raise DependabotError, error_message
+        raise DependabotError, "FileUpdater failed to update any files for: #{dependency_info_for_error}"
       end
 
       # Remove any unchanged dependencies from the updated list
@@ -120,9 +115,6 @@ def run
     sig { returns(T::Array[Dependabot::Notice]) }
     attr_reader :notices
 
-    sig { returns(T.nilable(String)) }
-    attr_reader :support_files_only_diagnostics
-
     sig { returns(T.nilable(String)) }
     def source_dependency_name
       return nil unless change_source.is_a? Dependabot::Dependency
@@ -167,44 +159,9 @@ def generate_dependency_files
       @notices.concat(updater_notices)
 
       updated_files = all_files.reject(&:support_file?)
-      add_support_files_only_diagnostics(all_files: all_files, updated_files: updated_files)
-
       updated_files
     end
 
-    sig do
-      params(
-        all_files: T::Array[Dependabot::DependencyFile],
-        updated_files: T::Array[Dependabot::DependencyFile]
-      ).void
-    end
-    def add_support_files_only_diagnostics(all_files:, updated_files:)
-      return unless all_files.any? && updated_files.empty?
-
-      support_file_names = naturally_sorted_names(all_files.select(&:support_file?).map(&:name).uniq)
-      listed_support_file_names = support_file_names.first(SUPPORT_FILE_WARNING_NAME_LIMIT)
-      omitted_support_file_count = support_file_names.length - listed_support_file_names.length
-      support_file_list = listed_support_file_names.join(", ")
-      support_file_list += " (and #{omitted_support_file_count} more)" if omitted_support_file_count.positive?
-
-      diagnostics = "FileUpdater returned only support files: #{support_file_list}"
-      @support_files_only_diagnostics = diagnostics
-      Dependabot.logger.warn("#{diagnostics} for: #{dependency_info_for_error}")
-    end
-
-    sig { params(names: T::Array[String]).returns(T::Array[String]) }
-    def naturally_sorted_names(names)
-      names.sort_by { |name| natural_sort_segments(name) }
-    end
-
-    sig { params(name: String).returns(T::Array[[Integer, T.any(Integer, String)]]) }
-    def natural_sort_segments(name)
-      segments = T.cast(name.scan(/\d+|\D+/), T::Array[String])
-      segments.map do |segment|
-        segment.match?(/\A\d+\z/) ? [0, segment.to_i] : [1, segment.downcase]
-      end
-    end
-
     sig { returns(String) }
     def dependency_names_for_error
       format_names(updated_dependencies.map(&:name))

updater/spec/dependabot/dependency_change_builder_spec.rb

@@ -125,17 +125,6 @@ def dependency_group_source
       Dependabot::DependencyGroup.new(name: "dummy-pkg-*", rules: { patterns: ["dummy-pkg-*"] })
     end
 
-    def build_support_files(names)
-      names.map do |name|
-        Dependabot::DependencyFile.new(
-          name: name,
-          content: "content",
-          directory: "/",
-          support_file: true
-        )
-      end
-    end
-
     context "when the source is a lead dependency" do
       let(:change_source) { lead_dependency_change_source }
 
@@ -252,31 +241,19 @@ def build_support_files(names)
         stub_file_updater(updated_dependency_files: updated_support_files, notices: updater_notices)
       end
 
-      it "warns with excluded support file names" do
-        expect(Dependabot.logger)
-          .to receive(:warn)
-          .with(satisfy { |message|
-            message.include?("FileUpdater returned only support files") &&
-              message.include?("for: #{single_dependency_info}") &&
-              message.include?("sub_dep") &&
-              message.include?("sub_dep.lock") &&
-              !message.include?("(and")
-          })
-
+      it "raises a generic no-files error" do
         expect { create_change }
           .to raise_error(
             Dependabot::DependabotError,
-            "FileUpdater failed to update any files for: dummy-pkg-b (1.1.0 → 1.2.0); " \
-            "FileUpdater returned only support files: sub_dep, sub_dep.lock"
+            "FileUpdater failed to update any files for: dummy-pkg-b (1.1.0 → 1.2.0)"
           )
       end
 
       it "collects notices before raising" do
         expect { create_change }
           .to raise_error(
             Dependabot::DependabotError,
-            "FileUpdater failed to update any files for: dummy-pkg-b (1.1.0 → 1.2.0); " \
-            "FileUpdater returned only support files: sub_dep, sub_dep.lock"
+            "FileUpdater failed to update any files for: dummy-pkg-b (1.1.0 → 1.2.0)"
           )
 
         expect(notices).to eq(updater_notices)
@@ -298,79 +275,11 @@ def build_support_files(names)
         stub_file_updater(updated_dependency_files: support_files)
       end
 
-      it "raises a diagnostics error with sorted and unique dependency names" do
-        expect { create_change }
-          .to raise_error(
-            Dependabot::DependabotError,
-            "FileUpdater failed to update any files for: dummy-pkg-a, dummy-pkg-b; " \
-            "FileUpdater returned only support files: sub_dep, sub_dep.lock"
-          )
-      end
-    end
-
-    context "when support file names exceed warning limit" do
-      let(:change_source) { lead_dependency_change_source }
-      let(:support_files) do
-        file_names = Array.new(described_class::SUPPORT_FILE_WARNING_NAME_LIMIT + 1) do |index|
-          "support_#{index}.txt"
-        end
-        build_support_files(file_names)
-      end
-
-      before do
-        stub_file_updater(updated_dependency_files: support_files)
-      end
-
-      it "adds omitted count to diagnostics" do
-        expected_support_files = Array.new(described_class::SUPPORT_FILE_WARNING_NAME_LIMIT) do |index|
-          "support_#{index}.txt"
-        end.join(", ")
-
+      it "raises a no-files error listing sorted and unique dependency names" do
         expect { create_change }
           .to raise_error(
             Dependabot::DependabotError,
-            "FileUpdater failed to update any files for: dummy-pkg-b (1.1.0 → 1.2.0); " \
-            "FileUpdater returned only support files: #{expected_support_files} (and 1 more)"
-          )
-      end
-    end
-
-    context "when support file names include multi-digit suffixes" do
-      let(:change_source) { lead_dependency_change_source }
-      let(:support_files) do
-        build_support_files([10, 2, 1].map { |index| "support_#{index}.txt" })
-      end
-
-      before do
-        stub_file_updater(updated_dependency_files: support_files)
-      end
-
-      it "orders support file names naturally in diagnostics" do
-        expect { create_change }
-          .to raise_error(
-            Dependabot::DependabotError,
-            "FileUpdater failed to update any files for: dummy-pkg-b (1.1.0 → 1.2.0); " \
-            "FileUpdater returned only support files: support_1.txt, support_2.txt, support_10.txt"
-          )
-      end
-    end
-
-    context "when support file names differ in casing" do
-      let(:change_source) { lead_dependency_change_source }
-      let(:support_files) do
-        build_support_files(["Support_2.txt", "support_10.txt", "support_1.txt"])
-      end
-
-      before do
-        stub_file_updater(updated_dependency_files: support_files)
-      end
-
-      it "orders support file names naturally regardless of case" do
-        expect { create_change }
-          .to raise_error(
-            Dependabot::DependabotError,
-            "FileUpdater failed to update any files for: dummy-pkg-b (1.1.0 → 1.2.0); " \
-            "FileUpdater returned only support files: support_1.txt, Support_2.txt, support_10.txt"
+            "FileUpdater failed to update any files for: dummy-pkg-a, dummy-pkg-b"
           )
       end
     end