Skip to content

A platform for community discussion. Free, open, simple.

UX: Do not log error for empty `.discourse-compatibility` file (#41804)

David Taylor858581dce918
diff --git a/lib/version_compatibility.rb b/lib/version_compatibility.rb
index 9b3a78d87b5..eb0a1558cf5 100644
--- a/lib/version_compatibility.rb
+++ b/lib/version_compatibility.rb
@@ -29,6 +29,8 @@ module Discourse
rescue Psych::SyntaxError, Psych::DisallowedClass
end
+ return if version_list.blank?
+
raise InvalidVersionListError unless version_list.is_a?(Hash)
version_list =
diff --git a/spec/lib/version_compatibility_spec.rb b/spec/lib/version_compatibility_spec.rb
index c6e42955cc8..2fce90d6247 100644
--- a/spec/lib/version_compatibility_spec.rb
+++ b/spec/lib/version_compatibility_spec.rb
@@ -76,6 +76,14 @@ RSpec.describe Discourse do
expect(Discourse.find_compatible_resource("")).to be_nil
end
+ it "returns nil when blank" do
+ expect(Discourse.find_compatible_resource(" \n \n")).to be_nil
+ end
+
+ it "returns nil when the file contains only comments" do
+ expect(Discourse.find_compatible_resource("# just a comment\n# another line\n")).to be_nil
+ end
+
it "raises an error on invalid input" do
expect { Discourse.find_compatible_resource("1.0.0.beta1 12f82d5") }.to raise_error(
Discourse::InvalidVersionListError,
@@ -213,6 +221,23 @@ RSpec.describe Discourse do
end
end
+ context "with an empty .discourse-compatibility file" do
+ let!(:git_directory) do
+ path = setup_git_repo(".discourse-compatibility" => "# only a comment\n")
+ setup_remote_upstream(path)
+ path
+ end
+
+ after { FileUtils.remove_entry(git_directory) }
+
+ it "returns nil without logging an error" do
+ output =
+ capture_stderr { expect(Discourse.find_compatible_git_resource(git_directory)).to be_nil }
+
+ expect(output).to be_blank
+ end
+ end
+
context "with a large .discourse-compatibility file" do
let!(:git_directory) do
path = setup_git_repo(".discourse-compatibility" => "<= 9999.0: fallback-ref")