discourse/spec/lib/site_setting_extension_spec.rb

# frozen_string_literal: true

RSpec.describe SiteSettingExtension do
  # We disable message bus here to avoid a large amount
  # of unneeded messaging, tests are careful to call refresh
  # when they need to.
  #
  # DistributedCache used by locale handler can under certain
  # cases take a tiny bit to stabilize.
  #
  # TODO: refactor SiteSettingExtension not to rely on statics in
  # DefaultsProvider
  #
  before { MessageBus.off }

  after { MessageBus.on }

  describe "#types" do
    context "when verifying enum sequence" do
      before { @types = SiteSetting.types }

      it "'string' should be at 1st position" do
        expect(@types[:string]).to eq(1)
      end

      it "'value_list' should be at 12th position" do
        expect(@types[:value_list]).to eq(12)
      end
    end
  end

  let :provider_local do
    SiteSettings::LocalProcessProvider.new
  end

  let :settings do
    new_settings(provider_local)
  end

  let :settings2 do
    new_settings(provider_local)
  end

  it "Does not leak state cause changes are not linked" do
    t1 =
      Thread.new do
        5.times do
          settings = new_settings(SiteSettings::LocalProcessProvider.new)
          settings.setting(:title, "test")
          settings.title = "title1"
          expect(settings.title).to eq "title1"
        end
      end

    t2 =
      Thread.new do
        5.times do
          settings = new_settings(SiteSettings::LocalProcessProvider.new)
          settings.setting(:title, "test")
          settings.title = "title2"
          expect(settings.title).to eq "title2"
        end
      end

    t1.join
    t2.join
  end

  describe "refresh!" do
    it "will reset to default if provider vanishes" do
      settings.setting(:hello, 1)
      settings.hello = 100
      expect(settings.hello).to eq(100)

      settings.provider.clear
      settings.refresh!

      expect(settings.hello).to eq(1)
    end

    it "will set to new value if provider changes" do
      settings.setting(:hello, 1)
      settings.hello = 100
      expect(settings.hello).to eq(100)

      settings.provider.save(:hello, 99, SiteSetting.types[:integer])
      settings.refresh!

      expect(settings.hello).to eq(99)
    end

    it "publishes changes cross sites" do
      settings.setting(:hello, 1)
      settings2.setting(:hello, 1)

      settings.hello = 100

      settings2.refresh!
      expect(settings2.hello).to eq(100)

      settings.hello = 99

      settings2.refresh!
      expect(settings2.hello).to eq(99)
    end

    it "does not override types in the type supervisor" do
      settings.setting(:foo, "bar")
      settings.provider.save(:foo, "bar", SiteSetting.types[:enum])
      settings.refresh!
      expect(settings.foo).to eq("bar")

      settings.foo = "baz"
      expect(settings.foo).to eq("baz")
    end

    it "clears the cache for site setting uploads" do
      settings.setting(:upload_type, "", type: :upload)
      upload = Fabricate(:upload)
      settings.upload_type = upload

      expect(settings.upload_type).to eq(upload)
      expect(settings.send(:uploads)[:upload_type]).to eq(upload)

      upload2 = Fabricate(:upload)
      settings.provider.save(:upload_type, upload2.id, SiteSetting.types[:upload])

      expect do settings.refresh! end.to change { settings.send(:uploads)[:upload_type] }.from(
        upload,
      ).to(nil)

      expect(settings.upload_type).to eq(upload2)
    end

    it "refreshes the client_settings_json cache" do
      upload = Fabricate(:upload)
      settings.setting(:upload_type, upload.id.to_s, type: :upload, client: true)
      settings.setting(:string_type, "haha", client: true)
      settings.refresh!

      expect(settings.client_settings_json).to eq(
        %Q|{"default_locale":"#{SiteSetting.default_locale}","upload_type":"#{upload.url}","string_type":"haha"}|,
      )

      upload.update!(url: "a_new_url")
      settings.string_type = "changed"
      settings.refresh!

      expect(settings.client_settings_json).to eq(
        %Q|{"default_locale":"#{SiteSetting.default_locale}","upload_type":"a_new_url","string_type":"changed"}|,
      )
    end
  end

  describe "DiscourseEvent" do
    before do
      settings.setting(:test_setting, 1)
      settings.refresh!
    end

    it "triggers events correctly" do
      settings.setting(:test_setting, 1)
      settings.refresh!

      override_events = DiscourseEvent.track_events { settings.test_setting = 2 }
      no_change_events = DiscourseEvent.track_events { settings.test_setting = 2 }
      default_events = DiscourseEvent.track_events { settings.test_setting = 1 }

      expect(override_events.map { |e| e[:event_name] }).to contain_exactly(:site_setting_changed)
      expect(no_change_events.map { |e| e[:event_name] }).to be_empty
      expect(default_events.map { |e| e[:event_name] }).to contain_exactly(:site_setting_changed)

      changed_event_1 = override_events.find { |e| e[:event_name] == :site_setting_changed }
      changed_event_2 = default_events.find { |e| e[:event_name] == :site_setting_changed }

      expect(changed_event_1[:params]).to eq([:test_setting, 1, 2])
      expect(changed_event_2[:params]).to eq([:test_setting, 2, 1])
    end
  end

  describe "DiscourseEvent for login_required changed to true" do
    before do
      SiteSetting.login_required = false
      SiteSetting.bootstrap_mode_min_users = 50
      SiteSetting.bootstrap_mode_enabled = true
    end

    it "lowers bootstrap mode min users for private sites" do
      SiteSetting.login_required = true

      expect(SiteSetting.bootstrap_mode_min_users).to eq(10)
    end
  end

  describe "DiscourseEvent for login_required changed to false" do
    before do
      SiteSetting.login_required = true
      SiteSetting.bootstrap_mode_min_users = 50
      SiteSetting.bootstrap_mode_enabled = true
    end

    it "resets bootstrap mode min users for public sites" do
      SiteSetting.login_required = false

      expect(SiteSetting.bootstrap_mode_min_users).to eq(50)
    end
  end

  describe "int setting" do
    before do
      settings.setting(:test_setting, 77)
      settings.refresh!
    end

    it "should have a key in all_settings" do
      expect(settings.all_settings.detect { |s| s[:setting] == :test_setting }).to be_present
    end

    it "should have the correct desc" do
      I18n.backend.store_translations(
        :en,
        site_settings: {
          test_setting: "test description <a href='%{base_path}/admin'>/admin</a>",
        },
      )
      expect(settings.description(:test_setting)).to eq(
        "test description <a href='/admin'>/admin</a>",
      )

      Discourse.stubs(:base_path).returns("/forum")
      expect(settings.description(:test_setting)).to eq(
        "test description <a href='/forum/admin'>/admin</a>",
      )
    end

    it "should have the correct default" do
      expect(settings.test_setting).to eq(77)
    end

    context "when overidden" do
      after :each do
        settings.remove_override!(:test_setting)
      end

      it "should have the correct override" do
        settings.test_setting = 100
        expect(settings.test_setting).to eq(100)
      end

      it "should coerce correct string to int" do
        settings.test_setting = "101"
        expect(settings.test_setting).to eq(101)
      end

      it "should coerce incorrect string to 0" do
        settings.test_setting = "pie"
        expect(settings.test_setting).to eq(0)
      end

      it "should not set default when reset" do
        settings.test_setting = 100
        settings.setting(:test_setting, 77)
        settings.refresh!
        expect(settings.test_setting).not_to eq(77)
      end

      it "can be overridden with set" do
        settings.set("test_setting", 12)
        expect(settings.test_setting).to eq(12)
      end

      it "should publish changes to clients" do
        settings.setting("test_setting", 100)
        settings.setting("test_setting", nil, client: true)

        message = MessageBus.track_publish("/client_settings") { settings.test_setting = 88 }.first

        expect(message).to be_present
      end
    end
  end

  describe "remove_override" do
    fab!(:upload)

    before do
      settings.setting(:test_override, "test")
      settings.setting(:image_list_test, "", type: :uploaded_image_list)
      settings.refresh!
    end
    it "correctly nukes overrides" do
      settings.test_override = "bla"
      settings.remove_override!(:test_override)
      expect(settings.test_override).to eq("test")
    end

    it "correctly nukes overrides for image list type setting" do
      settings.image_list_test = "#{upload.id}"
      settings.remove_override!(:image_list_test)
      expect(settings.image_list_test).to be_empty
    end
  end

  describe "string setting" do
    before do
      settings.setting(:test_str, "str")
      settings.refresh!
    end

    it "should have the correct default" do
      expect(settings.test_str).to eq("str")
    end

    context "when overridden" do
      after :each do
        settings.remove_override!(:test_str)
      end

      it "should coerce int to string" do
        settings.test_str = 100
        expect(settings.test_str).to eq("100")
      end

      it "can be overridden with set" do
        settings.set("test_str", "hi")
        expect(settings.test_str).to eq("hi")
      end
    end
  end

  describe "string setting with regex" do
    it "Supports custom validation errors" do
      settings.setting(:test_str, "bob", regex: "hi", regex_error: "oops")
      settings.refresh!

      begin
        settings.test_str = "a"
      rescue Discourse::InvalidParameters => e
        message = e.message
      end

      expect(message).to match(/oops/)
    end
  end

  describe "bool setting" do
    before do
      settings.setting(:test_hello?, false)
      settings.refresh!
    end

    it "should have the correct default" do
      expect(settings.test_hello?).to eq(false)
    end

    context "when overridden" do
      after { settings.remove_override!(:test_hello?) }

      it "should have the correct override" do
        settings.test_hello = true
        expect(settings.test_hello?).to eq(true)
      end

      it "should coerce true strings to true" do
        settings.test_hello = "true"
        expect(settings.test_hello?).to be(true)
      end

      it "should coerce all other strings to false" do
        settings.test_hello = "f"
        expect(settings.test_hello?).to be(false)
      end

      it "should not set default when reset" do
        settings.test_hello = true
        settings.setting(:test_hello?, false)
        settings.refresh!
        expect(settings.test_hello?).not_to eq(false)
      end

      it "can be overridden with set" do
        settings.set("test_hello", true)
        expect(settings.test_hello?).to eq(true)
      end
    end
  end

  describe "int enum" do
    class TestIntEnumClass
      def self.valid_value?(v)
        true
      end
      def self.values
        [1, 2, 3]
      end
    end

    it "should coerce correctly" do
      settings.setting(:test_int_enum, 1, enum: TestIntEnumClass)
      settings.test_int_enum = "2"
      settings.refresh!
      expect(settings.defaults[:test_int_enum]).to eq(1)
      expect(settings.test_int_enum).to eq(2)
    end
  end

  describe "enum setting" do
    class TestEnumClass
      def self.valid_value?(v)
        self.values.include?(v)
      end
      def self.values
        ["en"]
      end
      def self.translate_names?
        false
      end
    end

    let :test_enum_class do
      TestEnumClass
    end

    before do
      settings.setting(:test_enum, "en", enum: test_enum_class)
      settings.refresh!
    end

    it "should have the correct default" do
      expect(settings.test_enum).to eq("en")
    end

    it "should not hose all_settings" do
      expect(settings.all_settings.detect { |s| s[:setting] == :test_enum }).to be_present
    end

    it "should report error when being set other values" do
      expect { settings.test_enum = "not_in_enum" }.to raise_error(Discourse::InvalidParameters)
    end

    context "when overridden" do
      after :each do
        settings.remove_override!(:validated_setting)
      end

      it "stores valid values" do
        test_enum_class.expects(:valid_value?).with("fr").returns(true)
        settings.test_enum = "fr"
        expect(settings.test_enum).to eq("fr")
      end

      it "rejects invalid values" do
        test_enum_class.expects(:valid_value?).with("gg").returns(false)
        expect { settings.test_enum = "gg" }.to raise_error(Discourse::InvalidParameters)
      end
    end
  end

  describe "a setting with a category" do
    before do
      settings.setting(:test_setting, 88, category: :tests)
      settings.refresh!
    end

    it "should return the category in all_settings" do
      expect(settings.all_settings.find { |s| s[:setting] == :test_setting }[:category]).to eq(
        :tests,
      )
    end

    context "when overidden" do
      after :each do
        settings.remove_override!(:test_setting)
      end

      it "should have the correct override" do
        settings.test_setting = 101
        expect(settings.test_setting).to eq(101)
      end

      it "should still have the correct category" do
        settings.test_setting = 102
        expect(settings.all_settings.find { |s| s[:setting] == :test_setting }[:category]).to eq(
          :tests,
        )
      end
    end
  end

  describe "setting with a validator" do
    before do
      settings.setting(:validated_setting, "info@example.com", type: "email")
      settings.refresh!
    end

    after :each do
      settings.remove_override!(:validated_setting)
    end

    it "stores valid values" do
      EmailSettingValidator.any_instance.expects(:valid_value?).returns(true)
      settings.validated_setting = "success@example.com"
      expect(settings.validated_setting).to eq("success@example.com")
    end

    it "rejects invalid values" do
      expect {
        EmailSettingValidator.any_instance.expects(:valid_value?).returns(false)
        settings.validated_setting = "nope"
      }.to raise_error(Discourse::InvalidParameters)
      expect(settings.validated_setting).to eq("info@example.com")
    end

    it "allows blank values" do
      settings.validated_setting = ""
      expect(settings.validated_setting).to eq("")
    end
  end

  describe "set for an invalid setting name" do
    it "raises an error" do
      settings.setting(:test_setting, 77)
      settings.refresh!
      expect { settings.set("provider", "haxxed") }.to raise_error(Discourse::InvalidParameters)
    end
  end

  describe ".get" do
    before do
      settings.setting(:title, "Discourse v1")
      settings.refresh!
    end

    it "works correctly" do
      expect { settings.get("frogs_in_africa") }.to raise_error(Discourse::InvalidParameters)

      expect(settings.get(:title)).to eq("Discourse v1")
      expect(settings.get("title")).to eq("Discourse v1")
    end
  end

  describe ".set_and_log" do
    before do
      settings.setting(:s3_secret_access_key, "old_secret_key", secret: true)
      settings.setting(:title, "Discourse v1")
      settings.refresh!
    end

    it "raises an error when set for an invalid setting name" do
      expect { settings.set_and_log("provider", "haxxed") }.to raise_error(
        Discourse::InvalidParameters,
      )
    end

    it "scrubs secret setting values from logs" do
      settings.set_and_log("s3_secret_access_key", "new_secret_key")
      expect(UserHistory.last.previous_value).to eq("[FILTERED]")
      expect(UserHistory.last.new_value).to eq("[FILTERED]")
    end

    it "works" do
      settings.set_and_log("title", "Discourse v2")
      expect(settings.title).to eq("Discourse v2")
      expect(UserHistory.last.previous_value).to eq("Discourse v1")
      expect(UserHistory.last.new_value).to eq("Discourse v2")
    end
  end

  describe "filter domain name" do
    before do
      settings.setting(:allowed_spam_host_domains, "www.example.com")
      settings.refresh!
    end

    it "filters domain" do
      settings.set("allowed_spam_host_domains", "http://www.discourse.org/")
      expect(settings.allowed_spam_host_domains).to eq("www.discourse.org")
    end

    it "returns invalid domain as is, without throwing exception" do
      settings.set("allowed_spam_host_domains", "test!url")
      expect(settings.allowed_spam_host_domains).to eq("test!url")
    end
  end

  describe "hidden" do
    before do
      settings.setting(:superman_identity, "Clark Kent", hidden: true)
      settings.refresh!
    end

    it "is in the `hidden_settings` collection" do
      expect(settings.hidden_settings.include?(:superman_identity)).to eq(true)
    end

    it "can be retrieved" do
      expect(settings.superman_identity).to eq("Clark Kent")
    end

    it "is not present in all_settings by default" do
      expect(settings.all_settings.find { |s| s[:setting] == :superman_identity }).to be_blank
    end

    it "is present in all_settings when we ask for hidden" do
      expect(
        settings.all_settings(include_hidden: true).find { |s| s[:setting] == :superman_identity },
      ).to be_present
    end
  end

  describe "global override" do
    context "with default_locale" do
      it "supports adding a default locale via a global" do
        global_setting :default_locale, "zh_CN"
        settings.default_locale = "en"
        expect(settings.default_locale).to eq("zh_CN")
      end
    end

    context "without global setting" do
      before do
        settings.setting(:trout_api_key, "evil")
        settings.refresh!
      end

      it "should not add the key to the shadowed_settings collection" do
        expect(settings.shadowed_settings.include?(:trout_api_key)).to eq(false)
      end

      it "can return the default value" do
        expect(settings.trout_api_key).to eq("evil")
      end

      it "can overwrite the default" do
        settings.trout_api_key = "tophat"
        settings.refresh!
        expect(settings.trout_api_key).to eq("tophat")
      end
    end

    context "with blank global setting" do
      before do
        GlobalSetting.stubs(:nada).returns("")
        settings.setting(:nada, "nothing")
        settings.refresh!
      end

      it "should return default cause nothing is set" do
        expect(settings.nada).to eq("nothing")
      end
    end

    context "with a false override" do
      before do
        GlobalSetting.stubs(:bool).returns(false)
        settings.setting(:bool, true)
        settings.refresh!
      end

      it "should return default cause nothing is set" do
        expect(settings.bool).to eq(false)
      end

      it "should not trigger any message bus work if you try to set it" do
        m =
          MessageBus.track_publish("/site_settings") do
            settings.bool = true
            expect(settings.bool).to eq(false)
          end
        expect(m.length).to eq(0)
      end
    end

    context "with global setting" do
      before do
        GlobalSetting.stubs(:trout_api_key).returns("purringcat")
        settings.setting(:trout_api_key, "evil")
        settings.refresh!
      end

      it "should return the global setting instead of default" do
        expect(settings.trout_api_key).to eq("purringcat")
      end

      it "should return the global setting after a refresh" do
        settings.refresh!
        expect(settings.trout_api_key).to eq("purringcat")
      end

      it "should add the key to the hidden_settings collection" do
        expect(settings.hidden_settings.include?(:trout_api_key)).to eq(true)

        ["", nil].each_with_index do |setting, index|
          GlobalSetting.stubs(:"trout_api_key_#{index}").returns(setting)
          settings.setting(:"trout_api_key_#{index}", "evil")
          settings.refresh!
          expect(settings.hidden_settings.include?(:"trout_api_key_#{index}")).to eq(false)
        end
      end

      it "should add the key to the shadowed_settings collection" do
        expect(settings.shadowed_settings.include?(:trout_api_key)).to eq(true)
      end
    end
  end

  describe "secret" do
    before do
      settings.setting(:superman_identity, "Clark Kent", secret: true)
      settings.refresh!
    end

    it "is in the `secret_settings` collection" do
      expect(settings.secret_settings.include?(:superman_identity)).to eq(true)
    end

    it "can be retrieved" do
      expect(settings.superman_identity).to eq("Clark Kent")
    end

    it "is present in all_settings by default" do
      secret_setting = settings.all_settings.find { |s| s[:setting] == :superman_identity }
      expect(secret_setting).to be_present
      expect(secret_setting[:secret]).to eq(true)
    end
  end

  describe "locale default overrides are respected" do
    before do
      settings.setting(:test_override, "default", locale_default: { zh_CN: "cn" })
      settings.refresh!
    end

    after { settings.remove_override!(:test_override) }

    it "ensures the default cache expired after overriding the default_locale" do
      expect(settings.test_override).to eq("default")
      settings.default_locale = "zh_CN"
      expect(settings.test_override).to eq("cn")
    end

    it "returns the saved setting even locale default exists" do
      expect(settings.test_override).to eq("default")
      settings.default_locale = "zh_CN"
      settings.test_override = "saved"
      expect(settings.test_override).to eq("saved")
    end
  end

  describe ".requires_refresh?" do
    it "always refresh default_locale always require refresh" do
      expect(settings.requires_refresh?(:default_locale)).to be_truthy
    end
  end

  describe ".default_locale" do
    it "is always loaded" do
      expect(settings.default_locale).to eq("en")
    end
  end

  describe ".default_locale=" do
    it "can be changed" do
      settings.default_locale = "zh_CN"
      expect(settings.default_locale).to eq "zh_CN"
    end

    it "refresh!" do
      settings.expects(:refresh!)
      settings.default_locale = "zh_CN"
    end

    it "expires the cache" do
      settings.default_locale = "zh_CN"
      expect(Discourse.cache.exist?(SiteSettingExtension.client_settings_cache_key)).to be_falsey
    end

    it "refreshes the client" do
      Discourse.expects(:request_refresh!)
      settings.default_locale = "zh_CN"
    end
  end

  describe "get_hostname" do
    it "properly extracts the hostname" do
      # consider testing this through a public interface, this tests implementation details
      expect(settings.send(:get_hostname, "discourse.org")).to eq("discourse.org")
      expect(settings.send(:get_hostname, "@discourse.org")).to eq("discourse.org")
      expect(settings.send(:get_hostname, "https://discourse.org")).to eq("discourse.org")
    end
  end

  describe ".all_settings" do
    describe "uploads settings" do
      it "should return the right values" do
        negative_upload_id = [(Upload.minimum(:id) || 0) - 1, -10].min
        system_upload = Fabricate(:upload, id: negative_upload_id)
        settings.setting(:logo, system_upload.id, type: :upload)
        settings.refresh!
        setting = settings.all_settings.last

        expect(setting[:value]).to eq(system_upload.url)
        expect(setting[:default]).to eq(system_upload.url)

        upload = Fabricate(:upload)
        settings.logo = upload
        settings.refresh!
        setting = settings.all_settings.last

        expect(setting[:value]).to eq(upload.url)
        expect(setting[:default]).to eq(system_upload.url)
      end
    end
  end

  describe ".client_settings_json_uncached" do
    it "should return the right json value" do
      upload = Fabricate(:upload)
      settings.setting(:upload_type, upload.id.to_s, type: :upload, client: true)
      settings.setting(:string_type, "haha", client: true)
      settings.refresh!

      expect(settings.client_settings_json_uncached).to eq(
        %Q|{"default_locale":"#{SiteSetting.default_locale}","upload_type":"#{upload.url}","string_type":"haha"}|,
      )
    end

    it "settings with html type are not sanitized" do
      settings.setting(:with_html, "<script></script>rest", type: :html, client: true)

      client_settings = JSON.parse settings.client_settings_json_uncached

      expect(client_settings["with_html"]).to eq("<script></script>rest")
    end
  end

  describe ".setup_methods" do
    describe "for uploads site settings" do
      fab!(:upload)
      fab!(:upload2) { Fabricate(:upload) }

      it "should return the upload record" do
        settings.setting(:some_upload, upload.id.to_s, type: :upload)

        expect(settings.some_upload).to eq(upload)

        # Ensure that we cache the upload record
        expect(settings.some_upload.object_id).to eq(settings.some_upload.object_id)

        settings.some_upload = upload2

        expect(settings.some_upload).to eq(upload2)
      end
    end
  end

  describe "_map extension for list settings" do
    it "handles splitting group_list settings" do
      SiteSetting.personal_message_enabled_groups = "1|2"
      expect(SiteSetting.personal_message_enabled_groups_map).to eq([1, 2])
    end

    it "handles splitting compact list settings" do
      SiteSetting.markdown_linkify_tlds = "com|net"
      expect(SiteSetting.markdown_linkify_tlds_map).to eq(%w[com net])
    end

    it "handles splitting simple list settings" do
      SiteSetting.ga_universal_auto_link_domains = "test.com|xy.com"
      expect(SiteSetting.ga_universal_auto_link_domains_map).to eq(%w[test.com xy.com])
    end

    it "handles splitting list settings with no type" do
      SiteSetting.post_menu = "read|like"
      expect(SiteSetting.post_menu_map).to eq(%w[read like])
    end

    it "does not handle splitting secret list settings" do
      SiteSetting.discourse_connect_provider_secrets = "test|secret1\ntest2|secret2"
      expect(SiteSetting.respond_to?(:discourse_connect_provider_secrets_map)).to eq(false)
    end

    it "handles null values for settings" do
      SiteSetting.ga_universal_auto_link_domains = nil
      SiteSetting.pm_tags_allowed_for_groups = nil
      SiteSetting.exclude_rel_nofollow_domains = nil

      expect(SiteSetting.ga_universal_auto_link_domains_map).to eq([])
      expect(SiteSetting.pm_tags_allowed_for_groups_map).to eq([])
      expect(SiteSetting.exclude_rel_nofollow_domains_map).to eq([])
    end
  end
end