workarea-core 3.4.45 → 3.5.0.beta.1

data/lib/generators/workarea/install/USAGE

@@ -6,7 +6,6 @@ Example:
 
     This will create:
         config/initializers/workarea.rb
-        config/puma.rb
         db/seeds.rb
 
     This will modify:

data/lib/generators/workarea/install/install_generator.rb

@@ -37,14 +37,6 @@ module Workarea
       environment '# Run Sidekiq tasks synchronously so that Sidekiq is not required in Development', env: 'development'
     end
 
-    def configure_puma
-      remove_file 'config/puma.rb'
-      create_file 'config/puma.rb', <<~TEXT
-        require 'workarea/configuration/puma'
-        Workarea::Configuration::Puma.load(self)
-      TEXT
-    end
-
     def update_test_helper
       inject_into_file(
         'test/test_helper.rb',
@@ -63,19 +55,6 @@ module Workarea
       remove_file 'public/favicon.ico'
     end
 
-    def add_development_mailer_port
-      development_port = <<-CODE
-
-  config.action_mailer.default_url_options = { port: 3000 }
-      CODE
-
-      inject_into_file(
-        'config/environments/development.rb',
-        development_port,
-        before: /^end/
-      )
-    end
-
     private
 
     def app_name

data/lib/generators/workarea/install/templates/initializer.rb.erb

@@ -4,7 +4,7 @@ Workarea.configure do |config|
 
   config.host = {
     'test' => 'www.example.com',
-    'development' => 'localhost',
+    'development' => 'localhost:3000',
     'production' => 'www.<%= app_name.dasherize %>.com' # TODO
   }[Rails.env]
 

data/lib/tasks/insights.rake

@@ -39,6 +39,7 @@ namespace :workarea do
       Workarea::Metrics::SearchByWeek.delete_all
       Workarea::Metrics::SearchForLastWeek.delete_all
       Workarea::Metrics::SkuByDay.delete_all
+      Workarea::Metrics::TenderByDay.delete_all
       Workarea::Metrics::TrafficReferrerByDay.delete_all
       Workarea::Metrics::User.delete_all
       Workarea::Insights::Base.delete_all

data/lib/tasks/migrate.rake

@@ -0,0 +1,106 @@
+namespace :workarea do
+  namespace :migrate do
+    desc 'Migrate the database from v3.4 to v3.5'
+    task v3_5: :environment do
+      count = 0
+
+      Workarea::Release.where(:undo_at.gte => Time.current).each do |release|
+        undo = release.build_undo(publish_at: release.undo_at).tap(&:save!)
+
+        release.changesets.each do |changeset|
+          changeset.build_undo(release: undo).save!
+        end
+
+        Workarea::Scheduler.delete(release.undo_job_id)
+
+        release.update_attributes!(undo_at: nil, undo_job_id: nil)
+        count += 1
+      end
+
+      Workarea::Release.all.each { |r| Workarea::IndexAdminSearch.perform(r) }
+
+      puts "✅ #{count} undo releases have been created."
+
+      count = 0
+
+      Workarea::Tax::Category.each_by(100) do |category|
+        category.rates.each_by(500) do |rate|
+          rate.postal_code_percentage = rate.percentage
+          rate.percentage = nil
+        end
+
+        category.save!
+        count += 1
+      end
+
+      puts "✅ #{count} tax categories updated."
+
+      Workarea::Catalog::Product.each_by(500) do |product|
+        next unless product.digital?
+
+        product.skus.each do |sku|
+          fulfillment = Workarea::Fulfillment::Sku.find_or_initialize_by(id: sku)
+          fulfillment.policy = 'ignore'
+          fulfillment.save!
+        end
+      end
+
+      puts "✅ #{count} fulfillment skus for digital product have been created."
+
+      count = 0
+      failed_ids = []
+      backup = Mongo::Collection.new(Mongoid::Clients.default.database, 'workarea_legacy_segments')
+
+      legacy_segments = Workarea::Segment.collection.find.to_a
+      legacy_segments.each do |doc|
+        backup.insert_one(doc)
+        Workarea::Segment.collection.delete_one(doc.slice('_id'))
+
+        segment = Workarea::Segment.new(
+          id: doc['_id'],
+          name: doc['name'],
+          subscribed_user_ids: doc['subscribed_user_ids'],
+          created_at: doc['created_at'],
+          updated_at: doc['updated_at']
+        )
+
+        doc['conditions'].each do |condition|
+          if condition['_type'] =~ /UserTag/
+            segment.rules << Workarea::Segment::Rules::Tags.new(tags: condition['tags'])
+          elsif condition['_type'] =~ /TotalSpent/
+            rule = Workarea::Segment::Rules::Revenue.new
+
+            if condition['operator'] == 'equals'
+              rule.minimum = rule.maximum = Money.demongoize(condition['amount'])
+            elsif condition['operator'] == 'less_than_or_equals'
+              rule.maximum = Money.demongoize(condition['amount'])
+            elsif condition['operator'] == 'less_than'
+              rule.maximum = (Money.demongoize(condition['amount']) - 0.01.to_m)
+            elsif condition['operator'] == 'greater_than_or_equals'
+              rule.minimum = Money.demongoize(condition['amount'])
+            elsif condition['operator'] == 'greater_than'
+              rule.minimum = (Money.demongoize(condition['amount']) + 0.01.to_m)
+            end
+
+            segment.rules << rule
+          end
+        end
+
+        if doc['conditions'].size == segment.rules.size && segment.save
+          count += 1
+        else
+          failed_ids << doc['_id']
+        end
+      end
+
+      puts "✅ #{count} segments have been migrated." if count > 0
+      if failed_ids.any?
+        puts "⛔️ #{failed_ids.count} segments failed to migrate."
+        puts "You can find copies of the original segments in the workarea_legacy_segments collection."
+        puts "The segments that failed are #{failed_ids.to_sentence}."
+      end
+
+      puts "\nMigration complete!"
+    end
+  end
+end

data/lib/tasks/search.rake

@@ -1,5 +1,10 @@
 namespace :workarea do
   namespace :search_index do
+    def setup
+      require 'sidekiq/testing/inline' unless ENV['INLINE'] == 'false'
+      Workarea.config.bulk_index_batch_size = ENV['BATCH_SIZE'].to_i if ENV['BATCH_SIZE'].present?
+    end
+
     desc 'Reindex all data'
     task all: :environment do
       Rake::Task['workarea:search_index:storefront'].invoke
@@ -9,17 +14,14 @@ namespace :workarea do
 
     desc 'Reindex admin'
     task admin: :environment do
-      require 'sidekiq/testing/inline' unless ENV['INLINE'] == 'false'
+      setup
       puts 'Indexing admin...'
-
-      Workarea::QueuesPauser.with_paused_queues do
-        Workarea::Search::Admin.reset_indexes!
-      end
+      Workarea::Search::Admin.reset_indexes!
 
       Mongoid.models.each do |klass|
         next unless Workarea::Search::Admin.for(klass.first).present?
 
-        klass.all.each_slice_of(100) do |models|
+        klass.all.each_slice_of(Workarea.config.bulk_index_batch_size) do |models|
           Workarea::BulkIndexAdmin.perform_by_models(models)
         end
       end
@@ -31,13 +33,11 @@ namespace :workarea do
 
     desc 'Reindex storefront'
     task storefront: :environment do
-      require 'sidekiq/testing/inline' unless ENV['INLINE'] == 'false'
+      setup
       puts 'Indexing storefront...'
 
-      Workarea::QueuesPauser.with_paused_queues do
-        Workarea::Search::Storefront.reset_indexes!
-        Workarea::Search::Storefront.ensure_dynamic_mappings
-      end
+      Workarea::Search::Storefront.reset_indexes!
+      Workarea::Search::Storefront.ensure_dynamic_mappings
 
       # This code finds all unique filters for products so we can index a sample
       # product for each to ensure the dynamic mappings get created.
@@ -65,12 +65,12 @@ namespace :workarea do
         Workarea::Search::Storefront::Product.new(product).save
       end
 
-      Workarea::Catalog::Category.all.each_by(100) do |category|
-        Workarea::Search::Storefront::Product.add_category(category)
+      Workarea::Catalog::Category.all.each_by(Workarea.config.bulk_index_batch_size) do |category|
+        Workarea::Search::Storefront::CategoryQuery.new(category).create
         Workarea::Search::Storefront::Category.new(category).save
       end
 
-      Workarea::Content::Page.all.each_by(100) do |page|
+      Workarea::Content::Page.all.each_by(Workarea.config.bulk_index_batch_size) do |page|
         Workarea::Search::Storefront::Page.new(page).save
       end
 
@@ -80,14 +80,12 @@ namespace :workarea do
 
     desc 'Reindex help'
     task help: :environment do
-      require 'sidekiq/testing/inline' unless ENV['INLINE'] == 'false'
+      setup
       puts 'Indexing help...'
 
-      Workarea::QueuesPauser.with_paused_queues do
-        Workarea::Search::Help.reset_indexes!
-      end
+      Workarea::Search::Help.reset_indexes!
 
-      Workarea::Help::Article.all.each_by(100) do |help_article|
+      Workarea::Help::Article.all.each_by(Workarea.config.bulk_index_batch_size) do |help_article|
         Workarea::Search::Help.new(help_article).save
       end
     end

data/lib/tasks/tests.rake

@@ -86,7 +86,7 @@ namespace :workarea do
               Workarea::Plugin.installed.map(&:root) +
               [Rails.root]
 
-    ENV['PERF_TEST'] = 'true'
+    ENV['PERF_TEST'] = true
     Rails::TestUnit::Runner.rake_run(
       roots
         .map { |r| FileList["#{r}/test/performance/**/*_test.rb"] }

data/lib/workarea/cache.rb

@@ -7,10 +7,8 @@ module Workarea
     end
 
     class Varies
-      class UnsupportedSessionAccess < RuntimeError; end
-
-      attr_reader :env
-      delegate_missing_to :request
+      attr_reader :visit
+      delegate_missing_to :visit
 
       # This allows varying the HTTP and fragment caching on cookies, session or
       # other request-based info (like headers). This is useful when you'd like
@@ -66,40 +64,13 @@ module Workarea
         Workarea.config.cache_varies << block
       end
 
-      def initialize(env, varies = Workarea.config.cache_varies)
-        @env = env
-        @varies = Array.wrap(varies)
+      def initialize(visit, varies = Workarea.config.cache_varies)
+        @visit = visit
+        @varies = varies || []
       end
 
       def to_s
-        @to_s ||= @varies.map { |v| instance_exec(&v).to_s }.join(':')
-      end
-
-      def cookies
-        request.cookie_jar
-      end
-
-      def session
-        raise UnsupportedSessionAccess unless session_cookie_store?
-        @session ||= (cookies.signed_or_encrypted[session_key] || {}).with_indifferent_access
-      end
-
-      def request
-        @request ||= ActionDispatch::Request.new(env)
-      end
-
-      def geolocation
-        @geolocation ||= Workarea::Geolocation.new(env, request.remote_ip)
-      end
-
-      private
-
-      def session_key
-        Rails.application.config.session_options[:key]
-      end
-
-      def session_cookie_store?
-        Rails.application.config.session_store == ActionDispatch::Session::CookieStore
+        @to_s ||= @varies.map { |v| visit.instance_exec(&v).to_s }.join(':')
       end
     end
   end

data/lib/workarea/changelog.rake

@@ -38,7 +38,7 @@ namespace :workarea do
         author: author
       }
 
-      if subject.start_with?('Revert "')
+      if subject.start_with?('Revert')
         reverts << body.match(/[a-f0-9]{40}/)
         reverts << sha
       end
@@ -67,7 +67,7 @@ namespace :workarea do
           message << "    #{line.strip}"
         end
       end
-      message << "\n    #{entry[:author]}\n"
+      message << "    #{entry[:author]}\n"
     end
 
     # ensure and append to changelog

data/lib/workarea/configuration/administrable/definition.rb

@@ -0,0 +1,42 @@
+module Workarea
+  module Configuration
+    module Administrable
+      class Definition
+        attr_reader :fieldsets
+        delegate :field, to: :application_fieldset
+
+        def initialize
+          @fieldsets = SwappableList.new
+          @fieldsets.push(Fieldset.new('Application', namespaced: false))
+        end
+
+        def fieldset(name, override: false, namespaced: true, &block)
+          fieldset = Fieldset.new(name, namespaced: namespaced)
+          existing = find_fieldset(fieldset.id)
+
+          if override && existing.present?
+            @fieldsets.swap(existing, fieldset)
+            fieldset.instance_eval(&block) if block_given?
+          elsif existing.present?
+            existing.instance_eval(&block) if block_given?
+          else
+            @fieldsets.push(fieldset)
+            fieldset.instance_eval(&block) if block_given?
+          end
+        end
+
+        def application_fieldset
+          @application_fieldset ||= find_fieldset(:application)
+        end
+
+        def find_fieldset(id)
+          @fieldsets.detect { |fieldset| fieldset.id == id.to_sym }
+        end
+
+        def fields
+          @fieldsets.flat_map(&:fields)
+        end
+      end
+    end
+  end
+end

data/lib/workarea/configuration/administrable/field.rb

@@ -0,0 +1,79 @@
+module Workarea
+  module Configuration
+    module Administrable
+      class Field
+        class Invalid < StandardError; end
+
+        attr_reader :name, :type, :fieldset, :options
+        delegate :default, :description, :values_type, :encrypted, to: :options
+
+        def initialize(name, type:, fieldset: nil,  **options)
+          @name = name
+          @type = type.to_s.underscore.to_sym
+          @fieldset = fieldset
+          @options = OpenStruct.new(options)
+        end
+
+        def id
+          @id ||= (options.id || name.to_s.systemize).to_sym
+        end
+
+        def key
+          @key ||= fieldset&.namespaced? ? :"#{fieldset.id}_#{id}" : id
+        end
+
+        def type_class
+          Workarea.config.configurable_field_types[type]&.constantize
+        end
+
+        def values
+          return options.values unless options.values.respond_to?(:call)
+          options.values.call
+        end
+
+        def values_type_class
+          return unless type == :hash
+
+          values_type = options.values_type || :string
+          Workarea.config.configurable_field_types[values_type]&.constantize
+        end
+
+        def overridden?
+          Workarea.config.key?(key)
+        end
+
+        def encrypted?
+          !!encrypted
+        end
+
+        def validate!
+          validate_id
+          validate_type
+          self
+        end
+
+        def allow_blank?
+          !!@options.allow_blank
+        end
+
+        def merge!(options = {})
+          @options = OpenStruct.new(options.to_h.merge(options))
+        end
+
+        private
+
+        def validate_id
+          unless id.to_s.valid_method_name?
+            raise Invalid.new("configuration field '#{name}' does not have a valid id - #{id}.")
+          end
+        end
+
+        def validate_type
+          unless type_class.present?
+            raise Invalid.new("configuration field '#{name}' does not have a valid type - #{@type}.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/workarea/configuration/administrable/fieldset.rb

@@ -0,0 +1,44 @@
+module Workarea
+  module Configuration
+    module Administrable
+      class Fieldset
+        attr_accessor :fields, :name
+
+        def initialize(name, namespaced: true)
+          @name = name
+          @namespaced = namespaced
+          @fields = SwappableList.new
+        end
+
+        def id
+          name.to_s.systemize.to_sym
+        end
+
+        def namespaced?
+          @namespaced
+        end
+
+        def field(name, type: nil, override: false, **options)
+          field = Field.new(name, fieldset: self, type: type, **options)
+          existing = find_field(field.id)
+
+          if existing.present? && override
+            @fields.swap(existing, field.validate!)
+          elsif existing.present?
+            existing.merge!(options)
+            existing.validate!
+          else
+            @fields.push(field.validate!)
+          end
+
+          return unless field.encrypted?
+          Rails.application.config.filter_parameters << field.key
+        end
+
+        def find_field(id)
+          @fields.detect { |field| field.id == id.to_sym }
+        end
+      end
+    end
+  end
+end

data/lib/workarea/configuration/administrable_options.rb

@@ -0,0 +1,24 @@
+module Workarea
+  module Configuration
+    class AdministrableOptions < ActiveSupport::InheritableOptions
+      def method_missing(name, *args)
+        static_config = super
+        return static_config if static_config.present? || static_config.to_s == 'false'
+        return static_config unless check_fieldsets?(name)
+
+        Configuration::Admin.instance.send(name)
+      end
+
+      def respond_to_missing?(name, include_private)
+        true
+      end
+
+      private
+
+      def check_fieldsets?(name)
+        ::Mongoid.clients.any? &&
+          Configuration::Admin.fields.keys.include?(name.to_s)
+      end
+    end
+  end
+end

data/lib/workarea/configuration/cache_store.rb

@@ -7,7 +7,9 @@ module Workarea
         if Rails.env.test?
           Rails.application.config.cache_store = :null_store
         elsif !Rails.env.development?
-          Rails.application.config.cache_store = :redis_store, Workarea::Configuration::Redis.cache.to_url
+          Rails.application.config.cache_store = :redis_cache_store, {
+            url: Workarea::Configuration::Redis.cache.to_url
+          }
 
           require 'redis-rack-cache'
           Rails.application.config.action_dispatch.rack_cache = {

data/lib/workarea/configuration/content_blocks.rb

@@ -0,0 +1,17 @@
+module Workarea
+  module Configuration
+    module ContentBlocks
+      extend self
+
+      def building_blocks
+        @building_blocks ||= []
+      end
+
+      def load
+        building_blocks.each do |block|
+          Content::BlockTypeDefinition.define(&block)
+        end
+      end
+    end
+  end
+end

data/lib/workarea/configuration/mongoid.rb

@@ -13,10 +13,7 @@ module Workarea
       end
 
       def indexes_enforced?
-        servers = ::Mongoid::Clients.default.cluster.servers
-        addresses = servers.map(&:address).map(&:to_s)
-
-        client = Mongo::Client.new(addresses, database: 'admin')
+        client = ::Mongoid::Clients.default.use('admin')
         result = client.command(getParameter: 1, notablescan: nil)
         client.close
 

data/lib/workarea/configuration/session.rb

@@ -0,0 +1,36 @@
+module Workarea
+  module Configuration
+    module Session
+      class NoExpirationConfigured < StandardError; end
+      extend self
+
+      def cookie_store?
+        return @cookie_store if defined?(@cookie_store)
+        @cookie_store = Rails.application.config.session_store == ActionDispatch::Session::CookieStore
+      end
+
+      def key
+        Rails.application.config.session_options[:key]
+      end
+
+      def ttl
+        Rails.application.config.session_options[:expire_after]
+      end
+
+      def validate!
+        if ttl.blank?
+          raise(
+            NoExpirationConfigured,
+            <<~eos
+
+              Problem:
+                Workarea requires a session expiration to be set. We recommend 30 minutes.
+              Solution:
+                Add `expire_after: 30.minutes` to your session configuration in `config/initializers/session_store.rb`
+            eos
+          )
+        end
+      end
+    end
+  end
+end

data/lib/workarea/configuration/sidekiq.rb

@@ -9,6 +9,7 @@ module Workarea
         require_dependency "#{Workarea::Core::Engine.root}/app/middleware/workarea/audit_log_client_middleware"
         require_dependency "#{Workarea::Core::Engine.root}/app/middleware/workarea/audit_log_server_middleware"
         require_dependency "#{Workarea::Core::Engine.root}/app/middleware/workarea/release_server_middleware"
+        require_dependency "#{Workarea::Core::Engine.root}/app/middleware/workarea/query_cache_middleware"
 
         unless manually_configured?
           ::Sidekiq.options.merge!(
@@ -34,6 +35,7 @@ module Workarea
         ::Sidekiq.configure_server do |config|
           config.server_middleware do |chain|
             chain.add I18nServerMiddleware
+            chain.add QueryCacheMiddleware
             chain.add AuditLogServerMiddleware
             chain.add ReleaseServerMiddleware
           end
@@ -96,7 +98,7 @@ module Workarea
 
       def queues
         ENV['WORKAREA_SIDEKIQ_QUEUES'].to_s.split(',').presence ||
-          %w(high default low mailers)
+          %w(releases high default low mailers)
       end
 
       def pool_size