super_settings 2.5.0 → 2.6.1

data/lib/super_settings/local_cache.rb

@@ -12,10 +12,6 @@ module SuperSettings
     NOT_DEFINED = Object.new.freeze
     private_constant :NOT_DEFINED
 
-    # @private
-    DRIFT_FACTOR = 10
-    private_constant :DRIFT_FACTOR
-
     # Number of seconds that the cache will be considered fresh. The database will only be
     # checked for changed settings at most this often.
     attr_reader :refresh_interval
@@ -47,13 +43,15 @@ module SuperSettings
           value = NOT_DEFINED
         else
           setting = Setting.find_by_key(key)
-          value = (setting ? setting.value : NOT_DEFINED)
+          value = (setting ? setting.value.freeze : NOT_DEFINED)
           # Guard against caching too many cache missees; at some point it's better to slam
           # the database rather than run out of memory.
           if setting || @cache.size < 100_000
             @lock.synchronize do
-              # For case where one thread could be iterating over the cache while it's updated causing an error
-              @cache = @cache.merge(key => value).freeze
+              # Don't overwrite an entry added by a concurrent refresh; it is at least as
+              # fresh as the value read here. A new hash is set so that one thread can
+              # iterate over the cache while it's updated without causing an error.
+              @cache = @cache.merge(key => value).freeze unless @cache.include?(key)
             end
           end
         end
@@ -91,8 +89,7 @@ module SuperSettings
     def to_h
       ensure_cache_up_to_date!
       hash = {}
-      @cache.each do |key, data|
-        value, _ = data
+      @cache.each do |key, value|
         hash[key] = value unless value == NOT_DEFINED
       end
       hash
@@ -150,8 +147,6 @@ module SuperSettings
         return if @refreshing
 
         @next_check_at = Time.now + @refresh_interval
-        return if @cache.empty?
-
         @refreshing = true
       end
 
@@ -199,7 +194,7 @@ module SuperSettings
       return if Coerce.blank?(setting.key)
 
       @lock.synchronize do
-        @cache = @cache.merge(setting.key => setting.value)
+        @cache = @cache.merge(setting.key => setting.value.freeze).freeze
       end
     end
 
@@ -220,7 +215,7 @@ module SuperSettings
       changed_settings = {}
       start_time = Time.now
       Setting.updated_since(last_refresh_time - 1).each do |setting|
-        value = (setting.deleted? ? NOT_DEFINED : setting.value)
+        value = (setting.deleted? ? NOT_DEFINED : setting.value.freeze)
         changed_settings[setting.key] = value
       end
       set_cache_values(start_time) { @cache.merge(changed_settings) }
@@ -249,13 +244,5 @@ module SuperSettings
         @cache = block.call.freeze
       end
     end
-
-    # Recursively freeze a hash.
-    def deep_freeze_hash(hash)
-      hash.each_value do |value|
-        deep_freeze_hash(value) if value.is_a?(Hash)
-      end
-      hash.freeze
-    end
   end
 end

data/lib/super_settings/mini_i18n.rb

@@ -78,21 +78,21 @@ module SuperSettings
       # Load every JSON file from the locales directory, keyed by filename
       # stem (e.g. "en").
       def load_all_locales
-        if development_mode?
-          @mutex.synchronize { @cache = {} }
-        end
-
-        return @cache unless @cache.empty?
+        return @cache unless @cache.empty? || development_mode?
 
         @mutex.synchronize do
-          return @cache unless @cache.empty?
+          return @cache unless @cache.empty? || development_mode?
 
+          # Build into a new hash so that other threads never see a partially
+          # loaded cache.
+          cache = {}
           Dir.glob(File.join(locales_dir, "*.json")).each do |path|
             code = File.basename(path, ".json").downcase
-            @cache[code] = JSON.parse(File.read(path))
+            cache[code] = JSON.parse(File.read(path))
           rescue JSON::ParserError
             # Skip malformed locale files
           end
+          @cache = cache
         end
 
         @cache
@@ -103,7 +103,8 @@ module SuperSettings
       end
 
       def development_mode?
-        ENV.fetch("RACK_ENV", ENV.fetch("RAILS_ENV", "development")) == "development"
+        env = ENV["RAILS_ENV"] || ENV["RACK_ENV"] || ENV["APP_ENV"] || "development"
+        env == "development"
       end
     end
   end

data/lib/super_settings/rack_application.rb

@@ -52,8 +52,10 @@ module SuperSettings
     def call(env)
       if @path_prefix.empty? || "#{env["SCRIPT_NAME"]}#{env["PATH_INFO"]}".start_with?(@path_prefix)
         handle_request(env)
-      else
+      elsif @app
         @app.call(env)
+      else
+        [404, {"content-type" => "text/plain"}, ["Not found"]]
       end
     end
 
@@ -104,9 +106,9 @@ module SuperSettings
     # Subclasses can override this method to return the path to an ERB file to use as the layout
     # for the HTML application. The layout can use any of the methods defined in SuperSettings::Application::Helper.
     #
-    # @return [String]
+    # @return [String, Symbol]
     def layout
-      "layout.html.erb"
+      :default
     end
 
     # Subclasses can override this method to add custom HTML to the <head> element in the HTML application.
@@ -129,7 +131,16 @@ module SuperSettings
 
     def handle_request(env)
       request = Rack::Request.new(env)
-      path = request.path[@path_prefix.length, request.path.length]
+      script_name = env["SCRIPT_NAME"].to_s
+      full_path = "#{script_name}#{env["PATH_INFO"]}"
+      path = if !@path_prefix.empty? && full_path.start_with?(@path_prefix)
+        full_path[@path_prefix.length, full_path.length]
+      elsif @path_prefix.empty? && !script_name.empty?
+        # The application is mounted at SCRIPT_NAME, which the router has already consumed.
+        env["PATH_INFO"].to_s
+      else
+        full_path
+      end
       if request.get?
         if (path == "/" || path == "") && web_ui_enabled?
           return handle_root_request(request)
@@ -186,13 +197,21 @@ module SuperSettings
         if lang && SuperSettings::MiniI18n.available_locales.include?(lang)
           headers["set-cookie"] = "super_settings_locale=#{lang}; path=/; SameSite=Lax"
         end
-        [200, headers, [Application.new(layout: :default, add_to_head: add_to_head(request), color_scheme: SuperSettings.configuration.controller.color_scheme, read_only: read_only, locale: locale).render]]
+        application = Application.new(
+          layout: layout,
+          add_to_head: add_to_head(request),
+          color_scheme: SuperSettings.configuration.controller.color_scheme,
+          dark_mode_selector: SuperSettings.configuration.controller.resolved_dark_mode_selector,
+          read_only: read_only,
+          locale: locale
+        )
+        [200, headers, [application.render]]
       end
 
-      if [401, 403].include?(response.first)
-        if SuperSettings.authentication_url
-          response = [302, {"location" => SuperSettings.authentication_url}, []]
-        end
+      # Only unauthenticated requests are redirected to the login page. An authenticated
+      # user who is denied access would just be bounced back here in a redirect loop.
+      if response.first == 401 && SuperSettings.authentication_url
+        response = [302, {"location" => SuperSettings.authentication_url}, []]
       end
 
       response
@@ -217,7 +236,11 @@ module SuperSettings
 
     def handle_update_request(request)
       check_authorization(request, write_required: true) do |user|
-        result = SuperSettings::RestAPI.update(post_params(request)["settings"], changed_by(user))
+        params = post_params(request)
+        settings = params["settings"] if params
+        next json_response(400, error: "Invalid request") unless valid_settings_params?(settings)
+
+        result = SuperSettings::RestAPI.update(settings, changed_by(user))
         if result[:success]
           json_response(200, result)
         else
@@ -245,7 +268,12 @@ module SuperSettings
 
     def handle_updated_since_request(request)
       check_authorization(request) do |user|
-        json_response(200, RestAPI.updated_since(request.params["time"]))
+        result = RestAPI.updated_since(request.params["time"])
+        if result
+          json_response(200, result)
+        else
+          json_response(400, error: "Invalid time parameter")
+        end
       end
     end
 
@@ -315,12 +343,24 @@ module SuperSettings
       nil
     end
 
+    # Returns the request parameters merged with any JSON request body. Returns nil
+    # if the request body is not valid JSON.
     def post_params(request)
       if request.content_type.to_s.match?(/\Aapplication\/json/i) && request.body
-        request.params.merge(JSON.parse(request.body.read))
+        body = JSON.parse(request.body.read)
+        return nil unless body.is_a?(Hash)
+
+        request.params.merge(body)
       else
         request.params
       end
+    rescue JSON::ParserError
+      nil
+    end
+
+    # The settings parameter in an update request must be an array of hashes.
+    def valid_settings_params?(settings)
+      settings.is_a?(Array) && settings.all? { |setting| setting.is_a?(Hash) }
     end
   end
 end

data/lib/super_settings/rest_api.rb

@@ -163,7 +163,7 @@ module SuperSettings
         end
 
         payload[:histories] = histories.collect do |history|
-          history_values = {value: history.value, changed_by: history.changed_by_display, created_at: history.created_at.utc.iso8601(6)}
+          history_values = {value: history.value, changed_by: history.changed_by_display, created_at: history.created_at&.utc&.iso8601(6)}
           history_values[:deleted] = true if history.deleted?
           history_values
         end
@@ -209,9 +209,15 @@ module SuperSettings
       #     ...
       #   ]
       #
-      # @return [Hash] hash with settings array
+      # @return [Hash, nil] hash with settings array or nil if the time is missing or unparseable
       def updated_since(time)
-        time = Coerce.time(time)
+        time = begin
+          Coerce.time(time)
+        rescue ArgumentError
+          nil
+        end
+        return nil if time.nil?
+
         settings = Setting.updated_since(time).reject(&:deleted?)
         {settings: settings.collect(&:as_json)}
       end

data/lib/super_settings/setting.rb

@@ -30,6 +30,10 @@ module SuperSettings
     class InvalidRecordError < StandardError
     end
 
+    # Exception raised if the storage engine could not persist valid changes.
+    class PersistenceError < StandardError
+    end
+
     include Attributes
 
     # The changed_by attribute is used to temporarily store an identifier for the user
@@ -164,12 +168,23 @@ module SuperSettings
       def bulk_update(params, changed_by = nil)
         all_valid, settings = update_settings(params, changed_by)
         if all_valid
-          storage.with_connection do
-            transaction do |_changes|
-              settings.each do |setting|
-                setting.save!
+          begin
+            storage.with_connection do
+              transaction do |_changes|
+                settings.each do |setting|
+                  setting.save!
+                end
               end
             end
+          rescue InvalidRecordError, PersistenceError => e
+            # Validation failures detected by save! are already recorded on the setting that
+            # failed. A storage level failure isn't attributable to any single setting, so
+            # record it on all of them; otherwise callers would get a failure with no
+            # explanation of what went wrong.
+            if settings.none? { |setting| setting.errors.any? }
+              settings.each { |setting| setting.send(:add_base_error, e.message) }
+            end
+            return [false, settings]
           end
           clear_last_updated_cache
         end
@@ -214,7 +229,7 @@ module SuperSettings
         Thread.current[:super_settings_transaction] = changes
 
         begin
-          @storage.transaction(&block)
+          storage.transaction(&block)
 
           clear_last_updated_cache
 
@@ -382,7 +397,7 @@ module SuperSettings
     # @param val [String]
     def description=(val)
       val = val&.to_s
-      val = nil if val&.empty?
+      val = nil if val && val.empty?
       will_change!(:description, val) unless description == val
       @record.description = val
     end
@@ -484,12 +499,12 @@ module SuperSettings
         raise InvalidRecordError.new(errors.values.join("; "))
       end
 
+      return if @changes.empty?
+
       timestamp = Time.now
       self.created_at ||= timestamp
       self.updated_at = timestamp if updated_at.nil? || !changed?(:updated_at)
 
-      return if @changes.empty?
-
       self.class.storage.with_connection do
         self.class.transaction do
           record_value_change
@@ -664,7 +679,7 @@ module SuperSettings
 
     def raw_value=(val)
       val = val&.to_s
-      val = nil if val&.empty?
+      val = nil if val && val.empty?
       will_change!(:raw_value, val) unless raw_value == val
       @raw_value = val
       @record.raw_value = val
@@ -706,6 +721,17 @@ module SuperSettings
       attribute_errors << "#{attribute.tr("_", " ")} #{message}"
     end
 
+    # Record an error that applies to the record as a whole rather than to one attribute.
+    # The message is used verbatim since there is no attribute name to prefix it with.
+    def add_base_error(message)
+      base_errors = @errors["base"]
+      unless base_errors
+        base_errors = []
+        @errors["base"] = base_errors
+      end
+      base_errors << message
+    end
+
     def call_after_save_callbacks
       self.class.after_save_blocks.each do |block|
         block.call(self)

data/lib/super_settings/storage/active_record_storage.rb

@@ -103,22 +103,37 @@ module SuperSettings
       def save!
         # Check if another record with the same key exists. If it does, then we need to update
         # that record instead and delete the current one.
-        duplicate = @model.class.find_by(key: @model.key)
-        if duplicate.nil? || duplicate == @model
-          @model.save!
-        else
-          duplicate.raw_value = @model.raw_value
-          duplicate.value_type = @model.value_type
-          duplicate.description = @model.description
-          duplicate.deleted = @model.deleted
-
-          @model.transaction do
-            if @model.persisted?
-              @model.reload.update!(deleted: true)
+        attempts = 0
+        begin
+          # Each attempt runs in a savepoint so a duplicate key failure can be rolled back
+          # and retried; otherwise the surrounding transaction would be left in an aborted
+          # state on PostgreSQL.
+          @model.class.transaction(requires_new: true) do
+            duplicate = @model.class.find_by(key: @model.key)
+            if duplicate.nil? || duplicate == @model
+              @model.save!
+            else
+              duplicate.raw_value = @model.raw_value
+              duplicate.value_type = @model.value_type
+              duplicate.description = @model.description
+              duplicate.deleted = @model.deleted
+
+              if @model.persisted?
+                begin
+                  @model.reload.update!(deleted: true)
+                rescue ActiveRecord::RecordNotFound
+                end
+              end
+              duplicate.save!
+              @model = duplicate
             end
-            duplicate.save!
           end
-          @model = duplicate
+        rescue ActiveRecord::RecordNotUnique
+          # A record with the same key was inserted concurrently; retry so it is
+          # found as a duplicate and merged.
+          attempts += 1
+          retry if attempts <= 1
+          raise
         end
       end
 

data/lib/super_settings/storage/json_storage.rb

@@ -11,6 +11,11 @@ module SuperSettings
     # This class can be used as the base for any storage class where the settings are all stored
     # together in a single JSON payload.
     #
+    # Writes are serialized within a process, but there is no coordination between processes.
+    # If multiple processes write settings at the same time, the last write wins and can
+    # overwrite changes made by another process. Storage backends based on this class are best
+    # suited for setups where settings are updated from a single process at a time.
+    #
     # Subclasses must implement the following methods:
     # - self.all
     # - self.last_updated_at
@@ -18,6 +23,12 @@ module SuperSettings
     class JSONStorage < StorageAttributes
       include Transaction
 
+      # Mutex used to serialize the read-modify-write cycle in save_all within a process.
+      # Note that this cannot protect against concurrent writes from multiple processes;
+      # in that situation the last writer wins and can overwrite another process's changes.
+      SAVE_MUTEX = Mutex.new
+      private_constant :SAVE_MUTEX
+
       class HistoryStorage < HistoryAttributes
         class << self
           def create!(attributes)
@@ -65,50 +76,52 @@ module SuperSettings
         end
 
         def save_all(changes)
-          existing = {}
-          parse_settings(settings_json_payload).each do |setting|
-            existing[setting.key] = setting
-          end
+          SAVE_MUTEX.synchronize do
+            existing = {}
+            parse_settings(settings_json_payload).each do |setting|
+              existing[setting.key] = setting
+            end
 
-          history_items = []
-          changes.each do |record|
-            if record.is_a?(HistoryStorage)
-              history_items << record
-            else
-              existing[record.key] = record
+            history_items = []
+            changes.each do |record|
+              if record.is_a?(HistoryStorage)
+                history_items << record
+              else
+                existing[record.key] = record
+              end
             end
-          end
 
-          settings = existing.values.sort_by(&:key)
+            settings = existing.values.sort_by(&:key)
 
-          changed_histories = {}
-          history_items.each do |history_item|
-            setting = existing[history_item.key]
-            next unless setting
+            changed_histories = {}
+            history_items.each do |history_item|
+              setting = existing[history_item.key]
+              next unless setting
 
-            history = changed_histories[history_item.key]
-            unless history
-              history = setting.history.dup
-              changed_histories[history_item.key] = history
+              history = changed_histories[history_item.key]
+              unless history
+                history = setting.history.dup
+                changed_histories[history_item.key] = history
+              end
+              history.unshift(history_item)
             end
-            history.unshift(history_item)
-          end
 
-          settings_json = JSON.dump(settings.collect(&:as_json))
-          save_settings_json(settings_json)
-
-          changed_histories.each do |setting_key, setting_history|
-            ordered_history = setting_history.sort_by { |history_item| history_item.created_at }.reverse
-            payload = ordered_history.collect do |history_item|
-              {
-                value: history_item.value,
-                changed_by: history_item.changed_by,
-                created_at: history_item.created_at.iso8601(6),
-                deleted: history_item.deleted?
-              }
+            settings_json = JSON.dump(settings.collect(&:as_json))
+            save_settings_json(settings_json)
+
+            changed_histories.each do |setting_key, setting_history|
+              ordered_history = setting_history.sort_by { |history_item| history_item.created_at }.reverse
+              payload = ordered_history.collect do |history_item|
+                {
+                  value: history_item.value,
+                  changed_by: history_item.changed_by,
+                  created_at: history_item.created_at.iso8601(6),
+                  deleted: history_item.deleted?
+                }
+              end
+              history_json = JSON.dump(payload)
+              save_history_json(setting_key, history_json)
             end
-            history_json = JSON.dump(payload)
-            save_history_json(setting_key, history_json)
           end
         end
 

data/lib/super_settings/storage/mongodb_storage.rb

@@ -65,9 +65,12 @@ module SuperSettings
           if @mongodb.nil? || @url_hash != @url.hash
             @mutex.synchronize do
               unless @url_hash == @url.hash
+                client = Mongo::Client.new(@url)
+                create_indexes!(client)
+                # Only record the URL hash after the client is set up so that a
+                # failure here will be retried on the next call.
+                @mongodb = client
                 @url_hash = @url.hash
-                @mongodb = Mongo::Client.new(@url)
-                create_indexes!(@mongodb)
               end
             end
           end
@@ -100,8 +103,12 @@ module SuperSettings
             key: key,
             deleted: false
           }
-          record = settings_collection.find(query).projection(history: 0).first
-          new(record) if record
+          attributes = settings_collection.find(query).projection(history: 0).first
+          if attributes
+            record = new(attributes)
+            record.persisted = true
+            record
+          end
         end
 
         def last_updated_at

data/lib/super_settings/storage/redis_storage.rb

@@ -123,7 +123,7 @@ module SuperSettings
         end
 
         def last_updated_at
-          result = with_redis { |redis| redis.zrevrange(UPDATED_KEY, 0, 1, withscores: true).first }
+          result = with_redis { |redis| redis.zrevrange(UPDATED_KEY, 0, 0, withscores: true).first }
           return nil unless result
 
           time_at_microseconds(result[1])

data/lib/super_settings/storage/s3_storage.rb

@@ -69,6 +69,9 @@ module SuperSettings
         end
       end
 
+      BUCKET_MUTEX = Mutex.new
+      private_constant :BUCKET_MUTEX
+
       @bucket = nil
       @bucket_hash = nil
 
@@ -115,20 +118,32 @@ module SuperSettings
         private
 
         def s3_bucket
-          if configuration.hash != @bucket_hash
-            @bucket_hash = configuration.hash
+          # The mutex ensures the bucket and the configuration hash it was built from are
+          # always published together. The bucket and the hash are derived from a single
+          # read of the configuration attributes so that a concurrent configuration change
+          # cannot cache a bucket built from mixed values under the settled configuration
+          # hash; a torn read produces a hash that will not match the settled configuration,
+          # so the bucket gets rebuilt on the next call.
+          BUCKET_MUTEX.synchronize do
+            config = configuration
             options = {
-              endpoint: configuration.endpoint,
-              access_key_id: configuration.access_key_id,
-              secret_access_key: configuration.secret_access_key,
-              region: configuration.region
+              endpoint: config.endpoint,
+              access_key_id: config.access_key_id,
+              secret_access_key: config.secret_access_key,
+              region: config.region
             }
-            options[:force_path_style] = true if configuration.endpoint
-            options.compact!
+            bucket_name = config.bucket
+            config_hash = [options, bucket_name, config.path].hash
+
+            if config_hash != @bucket_hash
+              options[:force_path_style] = true if options[:endpoint]
+              options.compact!
 
-            @bucket = Aws::S3::Resource.new(options).bucket(configuration.bucket)
+              @bucket = Aws::S3::Resource.new(options).bucket(bucket_name)
+              @bucket_hash = config_hash
+            end
+            @bucket
           end
-          @bucket
         end
 
         def s3_object(filename)

data/lib/super_settings/storage/test_storage.rb

@@ -107,6 +107,7 @@ module SuperSettings
           self.class.settings.delete(@original_key)
         end
         self.class.settings[key] = attributes
+        @original_key = nil
         set_persisted!
         true
       end

data/lib/super_settings/storage/transaction.rb

@@ -20,10 +20,12 @@ module SuperSettings
 
               yield(changes)
 
-              if save_all(changes) != false
-                changes.each do |object|
-                  object.persisted = true if object.respond_to?(:persisted=)
-                end
+              if save_all(changes) == false
+                raise SuperSettings::Setting::PersistenceError.new("Settings could not be saved")
+              end
+
+              changes.each do |object|
+                object.persisted = true if object.respond_to?(:persisted=)
               end
             ensure
               Thread.current[transaction_key] = nil

data/lib/super_settings.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "json"
+require "time"
 
 # This is the main interface to the access settings.
 module SuperSettings

data/super_settings.gemspec

@@ -37,7 +37,5 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler"
-
   spec.required_ruby_version = ">= 2.7"
 end