workarea-core 3.5.17 → 3.5.22

data/lib/workarea.rb

@@ -182,6 +182,16 @@ module Workarea
   def self.deprecation
     @deprecation ||= ActiveSupport::Deprecation.new('3.6', 'Workarea')
   end
+
+  # Whether the app should skip connecting to external services on boot,
+  # such as Mongo, Elasticsearch, or Redis. Note that this will break
+  # functionality relying on these services.
+  #
+  # @return [Boolean]
+  #
+  def self.skip_services?
+    !!(ENV['WORKAREA_SKIP_SERVICES'] =~ /true/)
+  end
 end
 
 require 'workarea/core'

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

data/lib/workarea/configuration.rb

@@ -26,8 +26,6 @@ module Workarea
 
       config.site_name = 'Workarea'
       config.host = 'www.example.com'
-      config.email_to = 'customerservice@example.com'
-      config.email_from = 'noreply@example.com'
 
       # Config sent to the ImageMagick through Dragonfly for optimizing jpgs
       # All metadata profiles are removed, comments cleared by comment -set ""
@@ -942,7 +940,10 @@ module Workarea
 
       # Whether the app should skip connecting to external services on boot,
       # such as Mongo, Elasticsearch, or Redis.
-      config.skip_service_connections = ENV['WORKAREA_SKIP_SERVICES'].to_s =~ /true/
+      #
+      # @deprecated Use `Workarea.skip_services?` instead
+      #
+      config.skip_service_connections = Workarea.skip_services?
 
       # This is a feature flag, which enables localized active fields. If you're
       # upgrading, you can set this to false to avoid having to do a MongoDB

data/lib/workarea/configuration/administrable_options.rb

@@ -12,7 +12,8 @@ module Workarea
       private
 
       def check_fieldsets?(name)
-        ::Mongoid.clients.any? &&
+        !Workarea.skip_services? &&
+          ::Mongoid.clients.any? &&
           Configuration::Admin.fields.keys.include?(name.to_s)
       end
     end

data/lib/workarea/core/engine.rb

@@ -78,6 +78,10 @@ module Workarea
         # get autoloaded. Without this, admin actions like updating product
         # attributes raises a {NameError} "uninitialized constant BulkIndexProducts".
         require_dependency 'workarea/bulk_index_products'
+
+        # Fixes a constant error raised in middleware (when doing segmentation)
+        # No idea what the cause is. TODO revisit after Zeitwerk.
+        require_dependency 'workarea/metrics/user'
       end
     end
   end

data/lib/workarea/scheduled_jobs.rb

@@ -5,7 +5,7 @@ module Workarea
     # removing a previously scheduled job from initializers doesn't
     # actually stop the job from being enqueued.
     def self.clean
-      return if Workarea.config.skip_service_connections
+      return if Workarea.skip_services?
 
       Sidekiq::Cron::Job.all.each do |job|
         job.destroy unless const_defined?(job.klass)

data/lib/workarea/tasks/cache.rb

@@ -0,0 +1,43 @@
+module Workarea
+  module Tasks
+    module Cache
+      extend self
+
+      def prime_images
+        include Rails.application.routes.url_helpers
+        include Workarea::Storefront::ProductsHelper
+        include Workarea::Core::Engine.routes.url_helpers
+
+        built_in_jobs = [:thumb, :gif, :jpg, :png, :strip, :convert, :optimized]
+
+        jobs = Dragonfly.app(:workarea).processor_methods.reject do |job|
+          built_in_jobs.include?(job)
+        end
+
+        Workarea::Catalog::Product.all.each_by(50) do |product|
+          product.images.each do |image|
+            jobs.each do |job|
+              url = URI.join(
+                "https://#{Workarea.config.host}",
+                dynamic_product_image_url(
+                  image.product.slug,
+                  image.option,
+                  image.id,
+                  job,
+                  only_path: true
+                )
+              ).to_s
+
+              begin
+                `curl #{url}`
+                puts "Downloaded image #{url}"
+              rescue StandardError => e
+                puts e.inspect
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/workarea/tasks/help.rb

@@ -0,0 +1,55 @@
+module Workarea
+  module Tasks
+    module Help
+      extend self
+
+      def reload
+        Workarea::Help::Article.delete_all
+        Workarea::Help::Asset.delete_all
+        Workarea::HelpSeeds.new.perform
+      end
+
+      def dump
+        Workarea::Help::Article.all.each_by(50) do |article|
+          article_root = Rails.root.join(
+            'data',
+            'help',
+            article.category.systemize,
+            article.name.systemize
+          )
+
+          asset_path = article_root.join('assets')
+
+          FileUtils.mkdir_p(article_root)
+
+          if article.thumbnail.present?
+            article.thumbnail.to_file(article_root.join(article.thumbnail.name))
+          end
+
+          Workarea::Help::Asset.all.each_by(50) do |asset|
+            if article.summary.include?(asset.url) || article.body.include?(asset.url)
+              FileUtils.mkdir_p(asset_path)
+              asset.to_file(asset_path.join(asset.name))
+              reference = "<%= #{asset.name.split('.').first} %>"
+
+              article.summary.gsub!(asset.url, reference)
+              article.body.gsub!(asset.url, reference)
+            end
+          end
+
+          if article.summary.present?
+            File.open(article_root.join('summary.md'), 'w') do |file|
+              file.write(article.summary)
+            end
+          end
+
+          if article.body.present?
+            File.open(article_root.join('body.md'), 'w') do |file|
+              file.write(article.body)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/workarea/tasks/insights.rb

@@ -0,0 +1,47 @@
+module Workarea
+  module Tasks
+    module Insights
+      extend self
+
+      def generate
+        require 'active_support/testing/time_helpers'
+        include ActiveSupport::Testing::TimeHelpers
+        batch_size = ENV['WORKAREA_INSIGHTS_BATCH_SIZE'].presence || 1000
+
+        Workarea::Order
+          .placed
+          .each_by(batch_size.to_i) { |o| Workarea::SaveOrderMetrics.perform(o) }
+
+        8.times do |i|
+          travel_to (i.weeks.ago.beginning_of_week + 1.hour)
+          Workarea::GenerateInsights.generate_all!
+        end
+      end
+
+      # Clear the metrics/insights environment - deletes lots of data, this task
+      # is very dangerous! Useful for testing/debugging.
+      def reset!
+        Workarea::Order
+          .where(:metrics_saved_at.gt => 0)
+          .update_all(metrics_saved_at: nil)
+
+        Workarea::Metrics::CategoryByDay.delete_all
+        Workarea::Metrics::CountryByDay.delete_all
+        Workarea::Metrics::DiscountByDay.delete_all
+        Workarea::Metrics::MenuByDay.delete_all
+        Workarea::Metrics::ProductByDay.delete_all
+        Workarea::Metrics::ProductByWeek.delete_all
+        Workarea::Metrics::ProductForLastWeek.delete_all
+        Workarea::Metrics::SalesByDay.delete_all
+        Workarea::Metrics::SearchByDay.delete_all
+        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
+      end
+    end
+  end
+end

data/lib/workarea/tasks/migrate.rb

@@ -0,0 +1,106 @@
+module Workarea
+  module Tasks
+    module Migrate
+      extend self
+
+      def v3_5
+        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.all.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."
+
+        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
+
+        Workarea::Segment::LifeCycle.create!
+        puts "✅ Life cycle segments have been created."
+
+        admin_ids = Workarea::User.admins.pluck(:id)
+        admin_ids.each do |id|
+          Workarea::SynchronizeUserMetrics.new.perform(id)
+        end
+        puts "✅ #{admin_ids.count} admins have had their metrics synchronized." if admin_ids.count > 0
+
+        puts "\nMigration complete!"
+      end
+    end
+  end
+end

data/lib/workarea/tasks/search.rb

@@ -0,0 +1,105 @@
+module Workarea
+  module Tasks
+    module Search
+      extend self
+
+      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
+
+      def index_admin
+        Workarea::QueuesPauser.with_paused_queues do
+          Workarea::Search::Admin.reset_indexes!
+        end
+
+        Mongoid.models.each do |klass|
+          next unless Workarea::Search::Admin.for(klass.first).present?
+
+          klass.all.each_slice_of(Workarea.config.bulk_index_batch_size) do |models|
+            Workarea::BulkIndexAdmin.perform_by_models(models)
+          end
+        end
+
+        Workarea.config.jump_to_navigation.to_a.each do |tuple|
+          Workarea::Search::Admin::Navigation.new(tuple).save
+        end
+      end
+
+      def index_storefront
+        Workarea::QueuesPauser.with_paused_queues do
+          Workarea::Search::Storefront.reset_indexes!
+          Workarea::Search::Storefront.ensure_dynamic_mappings
+        end
+
+        ensure_dynamic_mappings_for_current_product_filters
+
+        index_storefront_categories
+        index_storefront_content_pages
+        index_storefront_products
+        index_storefront_searches
+      end
+
+      def index_help
+        Workarea::QueuesPauser.with_paused_queues do
+          Workarea::Search::Help.reset_indexes!
+        end
+
+        Workarea::Help::Article.all.each_by(Workarea.config.bulk_index_batch_size) do |help_article|
+          Workarea::Search::Help.new(help_article).save
+        end
+      end
+
+      private
+
+      # This code finds all unique filters for products so we can index a sample
+      # product for each to ensure the dynamic mappings get created.
+      #
+      # This is necessary to fix mapping errors from Elasticsearch when trying
+      # to index category percolations against fields which have no mapping.
+      #
+      def ensure_dynamic_mappings_for_current_product_filters
+        map = %{
+          function() {
+            for (var key in this.filters.#{I18n.locale}) {
+              emit(key, null);
+            }
+          }
+        }
+        reduce = 'function(key) { return null; }'
+        results = Workarea::Catalog::Product.map_reduce(map, reduce).out(inline: 1)
+        unique_filters = results.map { |r| r['_id'] }
+
+        sample_products = unique_filters.reduce([]) do |memo, filter|
+          filter = "filters.#{I18n.locale}.#{filter}"
+          memo << Workarea::Catalog::Product.exists(filter => true).sample
+        end
+
+        sample_products.each do |product|
+          Workarea::Search::Storefront::Product.new(product).save
+        end
+      end
+
+      def index_storefront_categories
+        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
+      end
+
+      def index_storefront_content_pages
+        Workarea::Content::Page.all.each_by(Workarea.config.bulk_index_batch_size) do |page|
+          Workarea::Search::Storefront::Page.new(page).save
+        end
+      end
+
+      def index_storefront_products
+        Workarea::BulkIndexProducts.perform
+      end
+
+      def index_storefront_searches
+        Workarea::BulkIndexSearches.perform
+      end
+    end
+  end
+end

data/lib/workarea/tasks/services.rb

@@ -0,0 +1,71 @@
+module Workarea
+  module Tasks
+    module Services
+      extend self
+
+      def assert_docker_compose_installed!
+        unless system('docker-compose -v > /dev/null 2>&1')
+          STDERR.puts <<~eos
+  **************************************************
+  ⛔️ ERROR: workarea:services tasks depend on Docker Compose being installed. \
+  See https://docs.docker.com/compose/install/ for how to install.
+  **************************************************
+            eos
+          exit
+        end
+      end
+
+      def compose_file_path
+        File.join(Gem::Specification.find_by_name('workarea').gem_dir, 'docker-compose.yml')
+      end
+
+      def compose_env
+        require 'workarea/version'
+
+        {
+          'COMPOSE_FILE' => compose_file_path,
+          'COMPOSE_PROJECT_NAME' => File.basename(Dir.pwd),
+
+          'MONGODB_VERSION' => Workarea::VERSION::MONGODB::STRING,
+          'MONGODB_PORT' => ENV['WORKAREA_MONGODB_PORT'] || '27017',
+
+          'REDIS_VERSION' => Workarea::VERSION::REDIS::STRING,
+          'REDIS_PORT' => ENV['WORKAREA_REDIS_PORT'] || '6379',
+
+          'ELASTICSEARCH_VERSION' => Workarea::VERSION::ELASTICSEARCH::STRING,
+          'ELASTICSEARCH_PORT' => ENV['WORKAREA_ELASTICSEARCH_PORT'] || '9200'
+        }
+      end
+
+      def up
+        assert_docker_compose_installed!
+
+        if system(compose_env, "docker-compose up -d #{ENV['COMPOSE_ARGUMENTS']} #{ENV['WORKAREA_SERVICES']}")
+          puts '✅ Success! Workarea services are running in the background. Run workarea:services:down to stop them.'
+        else
+          STDERR.puts '⛔️ Error! There was an error starting Workarea services.'
+        end
+      end
+
+      def down
+        assert_docker_compose_installed!
+
+        if system(compose_env, "docker-compose down #{ENV['COMPOSE_ARGUMENTS']}")
+          puts '✅ Success! Workarea services are stopped. Run workarea:services:up to start them.'
+        else
+          STDERR.puts '⛔️ Error! There was an error stopping Workarea services.'
+        end
+      end
+
+      def clean
+        assert_docker_compose_installed!
+
+        if system(compose_env, "docker-compose down -v #{ENV['COMPOSE_ARGUMENTS']}")
+          puts '✅ Success! Workarea service volumes have been removed. Run workarea:services:up to start services and recreate volumes.'
+        else
+          STDERR.puts '⛔️ Error! There was an error removing Workarea service volumes.'
+        end
+      end
+    end
+  end
+end