super_settings 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deffd163ccbba074051f5e7df4138216f24da7c8fa068c5a25fdaa7c83326799
-  data.tar.gz: af00d68c45251327f0e73867c16bdb4171110929f02290db374178c88718f0ec
+  metadata.gz: 6f33b56ee26912045f574c3ec5d6e0bd9ddd283517ebcb7f7ed96173b83cc745
+  data.tar.gz: 2a585b3400896dc3f502550a56f37761a588f23cb2504e72fe5e41fbe42bfa25
 SHA512:
-  metadata.gz: d496dfbfeaba9952c624f15680323d83fe055a03f48f17c660a5dee8e3512a4692bbe249212bfdf1830026ec0e726cb312acc0134a8c8260e95433b6c325abc8
-  data.tar.gz: de6887cbbe6ec06ba1cb20e75769377008a5d7fa4eb1a55bcbb6be87e3cdff508890209a0984dc3cdf4ae293d895ce946eb807582097c65e052a9f0b0fcef081
+  metadata.gz: 54cf6302e4c2e760b945e829bfaa8b289f920e7a2d794ddcd711ff4bf4683e9c5ef5eb0b6275f62f2927ecd28b5dcd6f5575809acda291eef3f177a66738a28a
+  data.tar.gz: 8019ec60d65105961f9d7bc6cb0db0e1e740a298d02c4e99106cebc34bbe1dff7a0f5b32f89a798bd0d2a9f36dc117fc192bd8468b871f535851b8f2d4b5f077

data/CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.1.0
+
+## Fixed
+
+- More robust handling of history tracking when keys are deleted and then reused. Previously, the history was not fully recorded when a key was reused. Now the history on the old key is recorded as a delete and the history on the new key is recorded as being an update.
+
+## Changed
+
+- Times are now consistently encoded in UTC in ISO-8601 format with microseconds whenever they are serialized to JSON.
+
 ## 2.0.3
 
 ### Fixed

data/VERSION

@@ -1 +1 @@
-2.0.3
+2.1.0

data/lib/super_settings/application/scripts.js

@@ -384,7 +384,7 @@
     payload.histories.forEach(function(history) {
       const date = new Date(Date.parse(history.created_at));
       const dateString = dateFormatter().format(date);
-      const value = (payload.encrypted ? "<em>n/a</em>" : escapeHTML(history.value));
+      const value = (history.deleted ? '<em class="super-settings-text-danger">deleted</em>' : escapeHTML(history.value));
       rowsHTML += `<tr><td class="super-settings-text-nowrap">${escapeHTML(dateString)}</td><td>${escapeHTML(history.changed_by)}</td><td>${value}</td></tr>`;
     });
     tbody.insertAdjacentHTML("beforeend", rowsHTML);

data/lib/super_settings/coerce.rb

@@ -36,6 +36,7 @@ module SuperSettings
       def time(value)
         value = nil if value.nil? || value.to_s.empty?
         return nil if value.nil?
+
         time = if value.is_a?(Numeric)
           Time.at(value)
         elsif value.respond_to?(:to_time)
@@ -52,6 +53,7 @@ module SuperSettings
       # @return [Boolean] true if the value is nil or empty.
       def blank?(value)
         return true if value.nil?
+
         if value.respond_to?(:empty?)
           value.empty?
         else

data/lib/super_settings/history_item.rb

@@ -34,5 +34,14 @@ module SuperSettings
         changed_by
       end
     end
+
+    def as_json
+      {
+        value: value,
+        changed_by: changed_by,
+        created_at: created_at&.utc&.iso8601(6),
+        deleted: deleted?
+      }
+    end
   end
 end

data/lib/super_settings/rest_api.rb

@@ -145,7 +145,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}
+          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
@@ -163,7 +163,7 @@ module SuperSettings
       #     last_updated_at: iso8601 string
       #   }
       def last_updated_at
-        {last_updated_at: Setting.last_updated_at.utc.iso8601}
+        {last_updated_at: Setting.last_updated_at.utc.iso8601(6)}
       end
 
       # Return settings that have been updated since a specified timestamp.

data/lib/super_settings/setting.rb

@@ -446,18 +446,17 @@ module SuperSettings
     #
     # @return [void]
     def save!
-      record_value_change
-
       unless valid?
         raise InvalidRecordError.new(errors.values.join("; "))
       end
 
       timestamp = Time.now
       self.created_at ||= timestamp
-      self.updated_at = timestamp unless updated_at && changed?(:updated_at)
+      self.updated_at = timestamp if updated_at.nil? || !changed?(:updated_at)
 
       self.class.storage.with_connection do
         self.class.storage.transaction do
+          record_value_change
           @record.save!
         end
 
@@ -525,8 +524,8 @@ module SuperSettings
         value: value,
         value_type: value_type,
         description: description,
-        created_at: created_at,
-        updated_at: updated_at
+        created_at: created_at&.utc&.iso8601(6),
+        updated_at: updated_at&.utc&.iso8601(6)
       }
       attributes[:deleted] = true if deleted?
       attributes
@@ -592,8 +591,16 @@ module SuperSettings
     # Update the histories association whenever the value or key is changed.
     def record_value_change
       return unless changed?(:raw_value) || changed?(:deleted) || changed?(:key)
+
       recorded_value = (deleted? ? nil : raw_value)
-      @record.create_history(value: recorded_value, deleted: deleted?, changed_by: changed_by, created_at: Time.now)
+      @record.class.create_history(key: key, value: recorded_value, deleted: deleted?, changed_by: changed_by, created_at: updated_at)
+
+      if changed?(:key)
+        key_was = @changes["key"][0]
+        if key_was
+          @record.class.create_history(key: key_was, changed_by: changed_by, created_at: updated_at, deleted: true)
+        end
+      end
     end
 
     def clear_changes

data/lib/super_settings/storage/active_record_storage.rb

@@ -52,6 +52,10 @@ module SuperSettings
           end
         end
 
+        def create_history(key:, changed_by:, created_at:, value: nil, deleted: false)
+          HistoryModel.create!(key: key, value: value, deleted: deleted, changed_by: changed_by, created_at: created_at)
+        end
+
         def with_connection(&block)
           Model.connection_pool.with_connection(&block)
         end
@@ -117,15 +121,6 @@ module SuperSettings
           HistoryItem.new(key: key, value: record.value, changed_by: record.changed_by, created_at: record.created_at, deleted: record.deleted?)
         end
       end
-
-      def create_history(changed_by:, created_at:, value: nil, deleted: false)
-        history_attributes = {value: value, deleted: deleted, changed_by: changed_by, created_at: created_at}
-        if @model.persisted?
-          @model.history_items.create!(history_attributes)
-        else
-          @model.history_items.build(history_attributes)
-        end
-      end
     end
   end
 end

data/lib/super_settings/storage/http_storage.rb

@@ -71,6 +71,10 @@ module SuperSettings
           SuperSettings::Coerce.time(value)
         end
 
+        def create_history(key:, changed_by:, created_at:, value: nil, deleted: false)
+          # No-op since history is maintained by the source system.
+        end
+
         def save_all(changes)
           payload = []
           changes.each do |setting|
@@ -132,10 +136,6 @@ module SuperSettings
         end
       end
 
-      def create_history(changed_by:, created_at:, value: nil, deleted: false)
-        # No-op since history is maintained by the source system.
-      end
-
       def reload
         self.class.find_by_key(key)
         self.attributes = self.class.find_by_key(key).attributes

data/lib/super_settings/storage/json_storage.rb

@@ -19,9 +19,32 @@ module SuperSettings
       include Transaction
 
       class HistoryStorage < HistoryAttributes
+        class << self
+          def create!(attributes)
+            record = new(attributes)
+            record.save!
+            record
+          end
+        end
+
+        def initialize(*)
+          @storage = nil
+          super
+        end
+
+        attr_writer :storage
+
         def created_at=(val)
           super(TimePrecision.new(val).time)
         end
+
+        def save!
+          raise ArgumentError.new("Missing key") if Coerce.blank?(key)
+
+          @storage.transaction do |changes|
+            changes << self
+          end
+        end
       end
 
       class << self
@@ -37,36 +60,54 @@ module SuperSettings
           active.detect { |setting| setting.key == key }
         end
 
+        def create_history(key:, changed_by:, created_at:, value: nil, deleted: false)
+          HistoryStorage.create!(key: key, value: value, changed_by: changed_by, created_at: created_at, deleted: deleted, storage: self)
+        end
+
         def save_all(changes)
           existing = {}
           parse_settings(settings_json_payload).each do |setting|
             existing[setting.key] = setting
           end
 
-          changes.each do |setting|
-            existing[setting.key] = setting
+          history_items = []
+          changes.each do |record|
+            if record.is_a?(HistoryStorage)
+              history_items << record
+            else
+              existing[record.key] = record
+            end
           end
 
           settings = existing.values.sort_by(&:key)
+
           changed_histories = {}
-          changes.collect do |setting|
-            history = (setting.new_history + setting.history).sort_by(&:created_at).reverse
-            changed_histories[setting.key] = 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?
-              }
+          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
             end
-            setting.new_history.clear
+            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|
-            history_json = JSON.dump(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
         end
@@ -128,11 +169,6 @@ module SuperSettings
         end
       end
 
-      def initialize(*)
-        @new_history = []
-        super
-      end
-
       def created_at=(val)
         super(TimePrecision.new(val).time)
       end
@@ -149,14 +185,6 @@ module SuperSettings
         end
       end
 
-      def create_history(changed_by:, created_at:, value: nil, deleted: false)
-        history = HistoryStorage.new(key: key, value: value, changed_by: changed_by, created_at: created_at, deleted: deleted)
-        @new_history.unshift(history)
-        history
-      end
-
-      attr_reader :new_history
-
       def as_json
         {
           key: key,

data/lib/super_settings/storage/mongodb_storage.rb

@@ -26,6 +26,26 @@ module SuperSettings
       @mutex = Mutex.new
 
       class HistoryStorage < HistoryAttributes
+        class << self
+          def create!(attributes)
+            record = new(attributes)
+            record.save!
+            record
+          end
+        end
+
+        def created_at=(value)
+          super(TimePrecision.new(value, :millisecond).time)
+        end
+
+        def save!
+          raise ArgumentError.new("Missing key") if Coerce.blank?(key)
+
+          MongoDBStorage.transaction do |changes|
+            changes << self
+          end
+        end
+
         def as_bson
           attributes = {
             value: value,
@@ -89,13 +109,16 @@ module SuperSettings
           last_updated_setting["updated_at"] if last_updated_setting
         end
 
+        def create_history(key:, changed_by:, created_at:, value: nil, deleted: false)
+          HistoryStorage.create!(key: key, value: value, changed_by: changed_by, created_at: created_at, deleted: deleted)
+        end
+
         def destroy_all
           settings_collection.delete_many({})
         end
 
         def save_all(changes)
           upserts = changes.collect { |setting| upsert(setting) }
-          changes.each { |setting| setting.new_history.clear }
           settings_collection.bulk_write(upserts)
           true
         end
@@ -108,17 +131,18 @@ module SuperSettings
 
         private
 
-        def upsert(setting)
-          doc = setting.as_bson
-          history = setting.new_history.collect(&:as_bson)
+        def upsert(record)
+          update = {"$setOnInsert": {key: record.key}}
+          if record.is_a?(MongoDBStorage::HistoryStorage)
+            update["$push"] = {history: record.as_bson}
+          else
+            update["$set"] = record.as_bson.except(:key)
+          end
+
           {
             update_one: {
-              filter: {key: setting.key},
-              update: {
-                "$set": doc.except(:key, :history),
-                "$setOnInsert": {key: setting.key},
-                "$push": {history: {"$each": history}}
-              },
+              filter: {key: record.key},
+              update: update,
               upsert: true
             }
           }
@@ -146,13 +170,6 @@ module SuperSettings
         end
       end
 
-      attr_reader :new_history
-
-      def initialize(*)
-        @new_history = []
-        super
-      end
-
       def history(limit: nil, offset: 0)
         pipeline = [
           {
@@ -195,13 +212,6 @@ module SuperSettings
         end
       end
 
-      def create_history(changed_by:, created_at:, value: nil, deleted: false)
-        created_at = TimePrecision.new(created_at, :millisecond).time
-        history = HistoryStorage.new(key: key, value: value, changed_by: changed_by, created_at: created_at, deleted: deleted)
-        @new_history.unshift(history)
-        history
-      end
-
       def created_at=(val)
         super(TimePrecision.new(val, :millisecond).time)
       end

data/lib/super_settings/storage/redis_storage.rb

@@ -116,6 +116,10 @@ module SuperSettings
           record unless record.deleted?
         end
 
+        def create_history(key:, changed_by:, created_at:, value: nil, deleted: false)
+          HistoryStorage.create!(key: key, value: value, deleted: deleted, changed_by: changed_by, created_at: created_at)
+        end
+
         def last_updated_at
           result = with_redis { |redis| redis.zrevrange(UPDATED_KEY, 0, 1, withscores: true).first }
           return nil unless result
@@ -184,10 +188,6 @@ module SuperSettings
         end
       end
 
-      def create_history(changed_by:, created_at:, value: nil, deleted: false)
-        HistoryStorage.create!(key: key, value: value, deleted: deleted, changed_by: changed_by, created_at: created_at)
-      end
-
       def save_to_redis(redis)
         redis.hset(SETTINGS_KEY, key, payload_json)
         redis.zadd(UPDATED_KEY, self.class.microseconds(updated_at), key)

data/lib/super_settings/storage/test_storage.rb

@@ -59,6 +59,20 @@ module SuperSettings
           settings.values.collect { |attributes| attributes[:updated_at] }.max
         end
 
+        def create_history(key:, changed_by:, created_at:, value: nil, deleted: false)
+          history = @history[key]
+          unless history
+            history = []
+            @history[key] = history
+          end
+
+          created_at = SuperSettings::TimePrecision.new(created_at).time if created_at
+          item = {key: key, value: value, deleted: deleted, changed_by: changed_by, created_at: created_at}
+          history.unshift(item)
+
+          item
+        end
+
         protected
 
         def default_load_asynchronous?
@@ -85,11 +99,6 @@ module SuperSettings
         end
       end
 
-      def create_history(changed_by:, created_at:, value: nil, deleted: false)
-        item = {key: key, value: value, deleted: deleted, changed_by: changed_by, created_at: created_at}
-        self.class.history(key).unshift(item)
-      end
-
       def save!
         self.updated_at ||= Time.now
         self.created_at ||= updated_at
@@ -123,11 +132,15 @@ module SuperSettings
       end
 
       def created_at=(value)
-        @created_at = SuperSettings::Coerce.time(value)
+        time = SuperSettings::Coerce.time(value)
+        time = SuperSettings::TimePrecision.new(time).time if time
+        @created_at = time
       end
 
       def updated_at=(value)
-        @updated_at = SuperSettings::Coerce.time(value)
+        time = SuperSettings::Coerce.time(value)
+        time = SuperSettings::TimePrecision.new(time).time if time
+        @updated_at = time
       end
 
       def deleted?

data/lib/super_settings/storage/transaction.rb

@@ -53,8 +53,9 @@ module SuperSettings
       end
 
       def save!
-        self.updated_at ||= Time.now
-        self.created_at ||= updated_at
+        timestamp = Time.now
+        self.updated_at ||= timestamp if respond_to?(:updated_at)
+        self.created_at ||= (respond_to?(:updated_at) ? updated_at : timestamp)
 
         self.class.transaction do |changes|
           changes << self

data/lib/super_settings/storage.rb

@@ -67,6 +67,15 @@ module SuperSettings
         # :nocov:
       end
 
+      # Create a history item for the setting.
+      #
+      # @return [void]
+      def create_history(key:, changed_by:, created_at:, value: nil, deleted: false)
+        # :nocov:
+        raise NotImplementedError
+        # :nocov:
+      end
+
       # Implementing classes can override this method to setup a thread safe connection within a block.
       #
       # @return [void]
@@ -253,9 +262,7 @@ module SuperSettings
     #
     # @return [void]
     def create_history(changed_by:, created_at:, value: nil, deleted: false)
-      # :nocov:
-      raise NotImplementedError
-      # :nocov:
+      self.class.create_history(key: key, changed_by: changed_by, created_at: created_at, value: value, deleted: deleted)
     end
 
     # Persist the record to storage.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: super_settings
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Brian Durand