motor-admin 0.1.35 → 0.1.41

data/lib/motor/configs.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Motor
+  module Configs
+    FILE_PATH = 'config/motor.yml'
+    SYNC_API_PATH = '/motor_configs_sync'
+    SYNC_ACCESS_KEY = ENV.fetch('MOTOR_SYNC_API_KEY', '')
+  end
+end
+
+require_relative './configs/load_from_cache'
+require_relative './configs/build_ui_app_tag'
+require_relative './configs/build_configs_hash'
+require_relative './configs/write_to_file'
+require_relative './configs/sync_from_hash'
+require_relative './configs/sync_from_file'
+require_relative './configs/sync_with_remote'

data/lib/motor/configs/build_configs_hash.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Motor
+  module Configs
+    module BuildConfigsHash
+      module_function
+
+      def call
+        cache_keys = LoadFromCache.load_cache_keys
+
+        normalize_hash(
+          engine_version: Motor::VERSION,
+          file_version: cache_keys.values.compact.max.to_time,
+          resources: build_resources_hash(cache_keys[:resources]),
+          configs: build_configs_hash(cache_keys[:configs]),
+          queries: build_queries_hash(cache_keys[:queries]),
+          dashboards: build_dashboards_hash(cache_keys[:dashboards]),
+          forms: build_forms_hash(cache_keys[:forms]),
+          alerts: build_alerts_hash(cache_keys[:alerts])
+        )
+      end
+
+      def build_queries_hash(cache_key = nil)
+        Motor::Configs::LoadFromCache.load_queries(cache_key: cache_key).sort_by(&:id).map do |query|
+          query.slice(%i[id name sql_body description preferences])
+               .merge(tags: query.tags.map(&:name), updated_at: query.updated_at.to_time)
+        end
+      end
+
+      def build_dashboards_hash(cache_key = nil)
+        Motor::Configs::LoadFromCache.load_dashboards(cache_key: cache_key).sort_by(&:id).map do |dashboard|
+          dashboard.slice(%i[id title description preferences])
+                   .merge(tags: dashboard.tags.map(&:name), updated_at: dashboard.updated_at.to_time)
+        end
+      end
+
+      def build_alerts_hash(cache_key = nil)
+        Motor::Configs::LoadFromCache.load_alerts(cache_key: cache_key).sort_by(&:id).map do |alert|
+          alert.slice(%i[id name query_id to_emails is_enabled description preferences])
+               .merge(tags: alert.tags.map(&:name), updated_at: alert.updated_at.to_time)
+        end
+      end
+
+      def build_forms_hash(cache_key = nil)
+        Motor::Configs::LoadFromCache.load_forms(cache_key: cache_key).sort_by(&:id).map do |form|
+          form.slice(%i[id name http_method api_path description preferences])
+              .merge(tags: form.tags.map(&:name), updated_at: form.updated_at.to_time)
+        end
+      end
+
+      def build_configs_hash(cache_key = nil)
+        Motor::Configs::LoadFromCache.load_configs(cache_key: cache_key).sort_by(&:key).map do |config|
+          {
+            key: config.key,
+            value: config.value,
+            updated_at: config.updated_at.to_time
+          }
+        end
+      end
+
+      def build_resources_hash(cache_key = nil)
+        Motor::Configs::LoadFromCache.load_resources(cache_key: cache_key).sort_by(&:name).map do |resource|
+          {
+            name: resource.name,
+            preferences: resource.preferences,
+            updated_at: resource.updated_at.to_time
+          }
+        end
+      end
+
+      def normalize_hash(value)
+        case value
+        when Hash, HashWithIndifferentAccess
+          value.to_h.stringify_keys.transform_values { |v| normalize_hash(v) }
+        when Array
+          value.map { |e| normalize_hash(e) }
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/motor/configs/build_ui_app_tag.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Motor
+  module Configs
+    module BuildUiAppTag
+      CACHE_STORE =
+        if Motor.development?
+          ActiveSupport::Cache::NullStore.new
+        else
+          ActiveSupport::Cache::MemoryStore.new(size: 5.megabytes)
+        end
+
+      module_function
+
+      def call
+        cache_keys = LoadFromCache.load_cache_keys
+
+        CACHE_STORE.fetch(cache_keys.hash) do
+          CACHE_STORE.clear
+
+          Motor::ApplicationController.helpers.content_tag(
+            :div, '', id: 'app', data: build_data(cache_keys)
+          )
+        end
+      end
+
+      # @return [Hash]
+      def build_data(cache_keys = {})
+        {
+          base_path: Motor::Admin.routes.url_helpers.motor_path,
+          schema: Motor::BuildSchema.call(cache_keys),
+          header_links: header_links_data_hash(cache_keys[:configs]),
+          queries: queries_data_hash(cache_keys[:queries]),
+          dashboards: dashboards_data_hash(cache_keys[:dashboards]),
+          alerts: alerts_data_hash(cache_keys[:alerts]),
+          forms: forms_data_hash(cache_keys[:forms])
+        }
+      end
+
+      def header_links_data_hash(cache_key = nil)
+        configs = Motor::Configs::LoadFromCache.load_configs(cache_key: cache_key)
+
+        configs.find { |c| c.key == 'header.links' }&.value || []
+      end
+
+      def queries_data_hash(cache_key = nil)
+        Motor::Configs::LoadFromCache.load_queries(cache_key: cache_key)
+                                     .as_json(only: %i[id name updated_at],
+                                              include: { tags: { only: %i[id name] } })
+      end
+
+      def dashboards_data_hash(cache_key = nil)
+        Motor::Configs::LoadFromCache.load_dashboards(cache_key: cache_key)
+                                     .as_json(only: %i[id title updated_at],
+                                              include: { tags: { only: %i[id name] } })
+      end
+
+      def alerts_data_hash(cache_key = nil)
+        Motor::Configs::LoadFromCache.load_alerts(cache_key: cache_key)
+                                     .as_json(only: %i[id name is_enabled updated_at],
+                                              include: { tags: { only: %i[id name] } })
+      end
+
+      def forms_data_hash(cache_key = nil)
+        Motor::Configs::LoadFromCache.load_forms(cache_key: cache_key)
+                                     .as_json(only: %i[id name updated_at],
+                                              include: { tags: { only: %i[id name] } })
+      end
+    end
+  end
+end

data/lib/motor/configs/load_from_cache.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Motor
+  module Configs
+    module LoadFromCache
+      CACHE_STORE = ActiveSupport::Cache::MemoryStore.new(size: 10.megabytes)
+
+      module_function
+
+      def call
+        cache_keys = load_cache_keys
+
+        {
+          configs: load_configs(cache_key: cache_keys[:configs]),
+          resources: load_resources(cache_key: cache_keys[:resources]),
+          queries: load_queries(cache_key: cache_keys[:queries]),
+          dashboards: load_dashboards(cache_key: cache_keys[:dashboards]),
+          alerts: load_alerts(cache_key: cache_keys[:alerts]),
+          forms: load_forms(cache_key: cache_keys[:forms])
+        }
+      end
+
+      def load_configs(cache_key: nil)
+        maybe_fetch_from_cache('configs', cache_key) do
+          Motor::Config.all.load
+        end
+      end
+
+      def load_resources(cache_key: nil)
+        maybe_fetch_from_cache('resources', cache_key) do
+          Motor::Resource.all.load
+        end
+      end
+
+      def load_queries(cache_key: nil)
+        maybe_fetch_from_cache('queries', cache_key) do
+          Motor::Query.all.active.preload(:tags).load
+        end
+      end
+
+      def load_dashboards(cache_key: nil)
+        maybe_fetch_from_cache('dashboards', cache_key) do
+          Motor::Dashboard.all.active.preload(:tags).load
+        end
+      end
+
+      def load_alerts(cache_key: nil)
+        maybe_fetch_from_cache('alerts', cache_key) do
+          Motor::Alert.all.active.preload(:tags).load
+        end
+      end
+
+      def load_forms(cache_key: nil)
+        maybe_fetch_from_cache('forms', cache_key) do
+          Motor::Form.all.active.preload(:tags).load
+        end
+      end
+
+      def maybe_fetch_from_cache(type, cache_key, &block)
+        return block.call unless cache_key
+
+        CACHE_STORE.fetch(type + cache_key.to_s, &block)
+      end
+
+      def load_cache_keys
+        ActiveRecord::Base.connection.execute(
+          "(#{
+            [
+              Motor::Config.select("'configs', MAX(updated_at)").to_sql,
+              Motor::Resource.select("'resources', MAX(updated_at)").to_sql,
+              Motor::Dashboard.select("'dashboards', MAX(updated_at)").to_sql,
+              Motor::Alert.select("'alerts', MAX(updated_at)").to_sql,
+              Motor::Query.select("'queries', MAX(updated_at)").to_sql,
+              Motor::Form.select("'forms', MAX(updated_at)").to_sql
+            ].join(') UNION (')
+          })"
+        ).to_a.map(&:values).to_h.with_indifferent_access
+      end
+    end
+  end
+end

data/lib/motor/configs/sync_from_file.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Motor
+  module Configs
+    module SyncFromFile
+      FILE_PATH = Motor::Configs::FILE_PATH
+      MUTEXT = Mutex.new
+      FILE_TIMESTAMPS_STORE = ActiveSupport::Cache::MemoryStore.new(size: 1.megabyte)
+
+      module_function
+
+      def call(with_exception: false)
+        MUTEXT.synchronize do
+          file = Rails.root.join(FILE_PATH)
+
+          file_timestamp =
+            begin
+              file.ctime
+            rescue Errno::ENOENT
+              raise if with_exception
+
+              nil
+            end
+
+          next unless file_timestamp
+
+          FILE_TIMESTAMPS_STORE.fetch(file_timestamp.to_s) do
+            Motor::Configs::SyncFromHash.call(
+              YAML.safe_load(file.read, permitted_classes: [Time, Date])
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/motor/configs/sync_from_hash.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Motor
+  module Configs
+    module SyncFromHash
+      module_function
+
+      def call(configs_hash)
+        return if configs_hash.blank?
+
+        configs_hash = configs_hash.with_indifferent_access
+
+        Motor::ApplicationRecord.transaction do
+          sync_queries(configs_hash)
+          sync_alerts(configs_hash)
+          sync_dashboards(configs_hash)
+          sync_forms(configs_hash)
+          sync_configs(configs_hash)
+          sync_resources(configs_hash)
+        end
+      end
+
+      def sync_queries(configs_hash)
+        sync_taggable(
+          Motor::Configs::LoadFromCache.load_queries,
+          configs_hash[:queries],
+          configs_hash[:file_version],
+          Motor::Queries::Persistance.method(:update_from_params!)
+        )
+      end
+
+      def sync_alerts(configs_hash)
+        sync_taggable(
+          Motor::Configs::LoadFromCache.load_alerts,
+          configs_hash[:alerts],
+          configs_hash[:file_version],
+          Motor::Alerts::Persistance.method(:update_from_params!)
+        )
+      end
+
+      def sync_forms(configs_hash)
+        sync_taggable(
+          Motor::Configs::LoadFromCache.load_forms,
+          configs_hash[:forms],
+          configs_hash[:file_version],
+          Motor::Forms::Persistance.method(:update_from_params!)
+        )
+      end
+
+      def sync_dashboards(configs_hash)
+        sync_taggable(
+          Motor::Configs::LoadFromCache.load_dashboards,
+          configs_hash[:dashboards],
+          configs_hash[:file_version],
+          Motor::Dashboards::Persistance.method(:update_from_params!)
+        )
+      end
+
+      def sync_configs(configs_hash)
+        configs_index = Motor::Configs::LoadFromCache.load_configs.index_by(&:key)
+
+        configs_hash[:configs].each do |attrs|
+          record = configs_index[attrs[:key]] || Motor::Config.new
+
+          next if record.updated_at && attrs[:updated_at] <= record.updated_at
+
+          record.update!(attrs)
+        end
+      end
+
+      def sync_resources(configs_hash)
+        resources_index = Motor::Configs::LoadFromCache.load_resources.index_by(&:name)
+
+        configs_hash[:resources].each do |attrs|
+          record = resources_index[attrs[:name]] || Motor::Resource.new
+
+          next if record.updated_at && attrs[:updated_at] <= record.updated_at
+
+          record.update!(attrs)
+        end
+      end
+
+      def sync_taggable(records, config_items, configs_timestamp, update_proc)
+        processed_records, create_items = update_taggable_items(records, config_items, update_proc)
+
+        create_taggable_items(create_items, records.klass, update_proc)
+
+        archive_taggable_items(records - processed_records, configs_timestamp)
+
+        ActiveRecord::Base.connection.reset_pk_sequence!(records.klass.table_name)
+      end
+
+      def update_taggable_items(records, config_items, update_proc)
+        record_ids_hash = records.index_by(&:id)
+
+        config_items.each_with_object([[], []]) do |attrs, (processed_acc, create_acc)|
+          record = record_ids_hash[attrs[:id]]
+
+          next create_acc << attrs unless record
+
+          processed_acc << record if record
+
+          next if record.updated_at >= attrs[:updated_at]
+
+          update_proc.call(record, attrs, force_replace: true)
+        end
+      end
+
+      def create_taggable_items(create_items, records_class, update_proc)
+        create_items.each do |attrs|
+          record = records_class.find_or_initialize_by(id: attrs[:id]).tap { |e| e.deleted_at = nil }
+
+          update_proc.call(record, attrs, force_replace: true)
+        end
+      end
+
+      def archive_taggable_items(records_to_remove, configs_timestamp)
+        records_to_remove.each do |record|
+          next if record.updated_at > configs_timestamp
+
+          record.update!(deleted_at: Time.current) if record.deleted_at.blank?
+        end
+      end
+    end
+  end
+end

data/lib/motor/configs/sync_middleware.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Motor
+  module Configs
+    class SyncMiddleware
+      KeyNotSpecified = Class.new(StandardError)
+      NotAuthenticated = Class.new(StandardError)
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if env['PATH_INFO'] == Motor::Configs::SYNC_API_PATH
+          authenticate!(env['HTTP_X_AUTHORIZATION'])
+
+          case env['REQUEST_METHOD']
+          when 'GET'
+            respond_with_configs
+          when 'POST'
+            input = env['rack.input']
+            input.rewind
+            sync_configs(input.read)
+          else
+            @app.call(env)
+          end
+        else
+          @app.call(env)
+        end
+      rescue NotAuthenticated
+        [403, {}, ['Invalid synchronization API key']]
+      rescue KeyNotSpecified
+        [404, {}, ['Set `MOTOR_SYNC_API_KEY` environment variable in order to sync configs']]
+      end
+
+      private
+
+      def authenticate!(token)
+        raise KeyNotSpecified if Motor::Configs::SYNC_ACCESS_KEY.blank?
+        raise NotAuthenticated if token.blank?
+
+        is_token_valid =
+          ActiveSupport::SecurityUtils.secure_compare(
+            Digest::SHA256.hexdigest(token),
+            Digest::SHA256.hexdigest(Motor::Configs::SYNC_ACCESS_KEY)
+          )
+
+        raise NotAuthenticated unless is_token_valid
+      end
+
+      def respond_with_configs
+        [
+          200,
+          { 'Content-Type' => 'application/json' },
+          [Motor::Configs::BuildConfigsHash.call.to_json]
+        ]
+      rescue StandardError => e
+        [500, {}, [e.message]]
+      end
+
+      def sync_configs(body)
+        configs_hash = JSON.parse(body)
+
+        Motor::Configs::SyncFromHash.call(configs_hash)
+
+        [200, {}, []]
+      rescue StandardError => e
+        [500, {}, [e.message]]
+      end
+    end
+  end
+end