workarea-core 3.5.8 → 3.5.13

data/app/workers/workarea/process_import.rb

@@ -17,11 +17,11 @@ module Workarea
       import.process!
 
     ensure
-      if import.error?
+      if import&.error?
         Admin::DataFileMailer.import_error(id).deliver_now
-      elsif import.failure?
+      elsif import&.failure?
         Admin::DataFileMailer.import_failure(id).deliver_now
-      else
+      elsif import.present?
         Admin::DataFileMailer.import(id).deliver_now
       end
     end

data/app/workers/workarea/reindex_release.rb

@@ -0,0 +1,42 @@
+module Workarea
+  class ReindexRelease
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      enqueue_on: {
+        Release => :save,
+        only_if: -> { publish_at_changed? },
+        with: -> { [id, publish_at_was, publish_at] }
+      },
+      queue: 'high'
+    )
+
+    def perform(id, previous_publish_at, new_publish_at)
+      rescheduled_release = Release.find(id)
+      earlier, later = if previous_publish_at.present? && new_publish_at.present?
+        [previous_publish_at, new_publish_at].sort
+      elsif previous_publish_at.present?
+        [previous_publish_at, nil]
+      else
+        [new_publish_at, nil]
+      end
+
+      affected_releases = Release.scheduled(after: earlier, before: later).includes(:changesets).to_a
+      affected_releases += [rescheduled_release]
+      affected_releases.uniq!
+
+      affected_models = affected_releases.flat_map(&:changesets).flat_map(&:releasable)
+
+      affected_releases.each do |release|
+        affected_models.each do |releasable|
+          Search::Storefront.new(releasable.in_release(release)).destroy
+
+          # Different models have different indexing workers, running callbacks
+          # ensures the appropriate worker is triggered
+          releasable.run_callbacks(:save_release_changes)
+        end
+      end
+    end
+  end
+end

data/app/workers/workarea/synchronize_user_metrics.rb

@@ -19,8 +19,18 @@ module Workarea
 
     def perform(id)
       user = User.find(id)
-      metrics = Metrics::User.find_or_create_by(id: user.email)
-      metrics.set(admin: user.admin?, tags: user.tags)
+
+      Metrics::User.collection.update_one(
+        { _id: user.email },
+        {
+          '$set' => {
+            admin: user.admin?,
+            tags: user.tags,
+            updated_at: Time.current.utc
+          }
+        },
+        upsert: true
+      )
     end
   end
 end

data/lib/tasks/search.rake

@@ -16,7 +16,9 @@ namespace :workarea do
     task admin: :environment do
       setup
       puts 'Indexing admin...'
-      Workarea::Search::Admin.reset_indexes!
+      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?
@@ -36,8 +38,10 @@ namespace :workarea do
       setup
       puts 'Indexing storefront...'
 
-      Workarea::Search::Storefront.reset_indexes!
-      Workarea::Search::Storefront.ensure_dynamic_mappings
+      Workarea::QueuesPauser.with_paused_queues do
+        Workarea::Search::Storefront.reset_indexes!
+        Workarea::Search::Storefront.ensure_dynamic_mappings
+      end
 
       # This code finds all unique filters for products so we can index a sample
       # product for each to ensure the dynamic mappings get created.
@@ -83,7 +87,9 @@ namespace :workarea do
       setup
       puts 'Indexing help...'
 
-      Workarea::Search::Help.reset_indexes!
+      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

data/lib/workarea/cache.rb

@@ -70,7 +70,7 @@ module Workarea
       end
 
       def to_s
-        @to_s ||= @varies.map { |v| visit.instance_exec(&v).to_s }.join(':')
+        @to_s ||= ([I18n.locale] + @varies.map { |v| visit.instance_exec(&v).to_s }).join(':')
       end
     end
   end

data/lib/workarea/changelog.rake

@@ -67,7 +67,7 @@ namespace :workarea do
           message << "    #{line.strip}"
         end
       end
-      message << "    #{entry[:author]}\n"
+      message << "\n    #{entry[:author]}\n"
     end
 
     # ensure and append to changelog

data/lib/workarea/core.rb

@@ -131,6 +131,8 @@ require 'workarea/ext/freedom_patches/dragonfly_callable_url_host'
 require 'workarea/ext/freedom_patches/active_support_duration'
 require 'workarea/ext/freedom_patches/premailer'
 require 'workarea/ext/freedom_patches/referer_parser'
+require 'workarea/ext/freedom_patches/mongoid_localized_defaults'
+require 'workarea/ext/freedom_patches/i18n_js'
 require 'workarea/ext/mongoid/list_field'
 require 'workarea/ext/mongoid/each_by'
 require 'workarea/ext/mongoid/except'
@@ -219,6 +221,7 @@ require 'workarea/mail_interceptor'
 require 'workarea/visit'
 require 'workarea/warnings'
 require 'workarea/latest_version'
+require 'workarea/queues_pauser'
 
 #
 # Engines

data/lib/workarea/elasticsearch/document.rb

@@ -44,22 +44,27 @@ module Workarea
 
         def save(document, options = {})
           options = options.merge(type: type)
-          I18n.for_each_locale { current_index.save(document, options) }
+          current_index.save(document, options)
         end
 
-        def bulk(documents, options = {})
+        def bulk(documents = [], options = {})
           options = options.merge(type: type)
-          I18n.for_each_locale { current_index.bulk(documents, options) }
+
+          if block_given?
+            I18n.for_each_locale { current_index.bulk(Array.wrap(yield), options) }
+          else
+            current_index.bulk(documents, options)
+          end
         end
 
         def update(document, options = {})
           options = options.merge(type: type)
-          I18n.for_each_locale { current_index.update(document, options) }
+          current_index.update(document, options)
         end
 
         def delete(id, options = {})
           options = options.merge(type: type)
-          I18n.for_each_locale { current_index.delete(id, options) }
+          current_index.delete(id, options)
         end
 
         def count(query = nil, options = {})
@@ -97,12 +102,14 @@ module Workarea
       end
 
       def save(options = {})
-        document = as_document.merge(Serializer.serialize(model))
-        self.class.save(document, options)
+        I18n.for_each_locale do
+          document = as_document.merge(Serializer.serialize(model))
+          self.class.save(document, options)
+        end
       end
 
       def destroy(options = {})
-        self.class.delete(id, options)
+        I18n.for_each_locale { self.class.delete(id, options) }
       end
     end
   end

data/lib/workarea/ext/freedom_patches/i18n_js.rb

@@ -0,0 +1,27 @@
+module I18n
+  module JS
+    class FallbackLocales
+      # i18n-js uses just the second part of this check out-of-the-box. This
+      # causes the I18n fallbacks to get autoloaded without the developer
+      # knowing.
+      #
+      # This surfaces in tests. System or integration tests will do this check
+      # for compiling assets, then I18n fallbacks get autoloaded. So this shows
+      # as some tests not having fallbacks if they run before one of those tests
+      # or magically having fallbacks if they run after one of those types of
+      # tests.
+      #
+      # Adding the `respond_to?` check doesn't cause autoload, but will return
+      # `true` if fallbacks are enabled. Retain the original check because we
+      # want the current I18n::JS backend to be checked, once fallbacks are
+      # `require`d `I18n.respond_to?(:fallbacks)` will always return `true`.
+      #
+      # See also: https://github.com/fnando/i18n-js/blob/master/lib/i18n/js/fallback_locales.rb#L49-L58
+      #
+      def using_i18n_fallbacks_module?
+        I18n.respond_to?(:fallbacks) &&
+          I18n::JS.backend.class.included_modules.include?(I18n::Backend::Fallbacks)
+      end
+    end
+  end
+end

data/lib/workarea/ext/freedom_patches/mongoid_localized_defaults.rb

@@ -0,0 +1,25 @@
+module Mongoid
+  module Fields
+    module LocalizedDefaults
+      def create_accessors(name, meth, options = {})
+        super
+
+        if options[:localize]
+          field = fields[name]
+
+          define_method meth do |*args|
+            result = super(*args)
+            return result unless result.nil?
+
+            default_name = field.send(:default_name)
+            return send(default_name) if respond_to?(default_name)
+
+            field.default_val
+          end
+        end
+      end
+    end
+
+    ClassMethods.prepend(LocalizedDefaults)
+  end
+end

data/lib/workarea/geolocation.rb

@@ -57,15 +57,7 @@ module Workarea
     end
 
     def names
-      @names ||= [
-        postal_code,
-        city,
-        region,
-        subdivision&.name,
-        country&.alpha2,
-        country&.alpha3,
-        country&.name
-      ].reject(&:blank?)
+      @names ||= [postal_code, city, subdivision&.name, country&.name].reject(&:blank?)
     end
 
     private

data/lib/workarea/queues_pauser.rb

@@ -0,0 +1,26 @@
+module Workarea
+  module QueuesPauser
+    extend self
+
+    def pause_queues!
+      pauser = Sidekiq::Throttled::QueuesPauser.instance
+      queues.each { |queue| pauser.pause!(queue) }
+    end
+
+    def resume_queues!
+      pauser = Sidekiq::Throttled::QueuesPauser.instance
+      queues.each { |queue| pauser.resume!(queue) }
+    end
+
+    def with_paused_queues(&block)
+      pause_queues!
+      yield
+    ensure
+      resume_queues!
+    end
+
+    def queues
+      Configuration::Sidekiq.queues
+    end
+  end
+end

data/lib/workarea/version.rb

@@ -2,7 +2,7 @@ module Workarea
   module VERSION
     MAJOR = 3
     MINOR = 5
-    PATCH = 8
+    PATCH = 13
     PRE   = nil
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
 

data/lib/workarea/visit.rb

@@ -38,7 +38,10 @@ module Workarea
     end
 
     def current_email
-      cookies.signed[:email]
+      # For performance, prefer to use the cookie. The fallback to looking it up
+      # by user is a failsafe against a blank email cookie (e.g. from a raised
+      # error or poor application coding).
+      cookies.signed[:email].presence || (email_from_user_id if logged_in?)
     end
 
     def metrics
@@ -91,5 +94,9 @@ module Workarea
     def blank_metrics
       @blank_metrics ||= Metrics::User.new
     end
+
+    def email_from_user_id
+      User.find(session[:user_id]).email rescue nil
+    end
   end
 end

data/lib/workarea/warnings.rb

@@ -51,13 +51,12 @@ db.getSiblingDB("admin").runCommand( { setParameter: 1, notablescan: 0 } )
 **************************************************
 ⛔️ WARNING: Dragonfly is configured to use the filesystem.
 
-This means all dragonfly assets (assets, product images, etc.) will be stored
+This means all Dragonfly assets (assets, product images, etc.) will be stored
 locally and not accessible to all servers within your environment.
 
 We recommend using S3 when running in a live environment by setting
-WORKAREA_S3_REGION and WORKAREA_S3_BUCKET_NAME in your environment variables.
-Workarea will automatically configure Dragonfly to use S3 if those values
-are present.
+WORKAREA_S3_REGION and WORKAREA_S3_BUCKET_NAME in your environment variables,
+and setting `Workarea.config.asset_store = :s3` in an initializer.
 **************************************************
         eos
       end

data/test/helpers/workarea/i18n_helper_test.rb

@@ -7,12 +7,14 @@ module Workarea
       params[:controller] = 'controller'
       params[:action] = 'action'
       params[:foo] = 'bar'
+      params[:locale] = 'es'
 
       assert_includes(switch_locale_fields, 'foo')
       assert_includes(switch_locale_fields, 'bar')
       refute_includes(switch_locale_fields, 'utf8')
       refute_includes(switch_locale_fields, 'controller')
       refute_includes(switch_locale_fields, 'action')
+      refute_includes(switch_locale_fields, 'locale')
     end
   end
 end

data/test/integration/workarea/authentication_test.rb

@@ -185,5 +185,15 @@ module Workarea
       get '/test_logout'
       refute(cookies[:email].present?)
     end
+
+    def test_ensures_locale_passthrough_for_return_to
+      set_locales(available: [:en, :es], default: :en, current: :en)
+
+      get '/login_required', params: { locale: 'es', return_to: '/blah?foo=bar' }
+      get '/test_login', params: { user_id: @user.id }
+      assert(response.redirect?)
+      assert_match('locale=es', response.location)
+      assert_match('foo=bar', response.location)
+    end
   end
 end

data/test/integration/workarea/cache_varies_integration_test.rb

@@ -25,6 +25,10 @@ module Workarea
         render plain: session[:foo].presence || 'nil'
       end
 
+      def varies
+        render plain: request.env['workarea.cache_varies']
+      end
+
       def current_user
         nil
       end
@@ -34,6 +38,11 @@ module Workarea
       Rails.application.routes.prepend do
         post 'cache_varies_test_set_session', to: 'workarea/cache_varies_integration_test/caching#set_session'
         get 'cache_varies_test_foo', to: 'workarea/cache_varies_integration_test/caching#foo'
+
+        scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+          get 'cache_varies_test_varies', to: 'workarea/cache_varies_integration_test/caching#varies'
+          patch 'cache_varies_test_varies', to: 'workarea/cache_varies_integration_test/caching#varies'
+        end
       end
 
       Rails.application.reload_routes!
@@ -74,5 +83,27 @@ module Workarea
       assert_equal('baz', response.body)
       assert_equal('fresh', response.headers['X-Rack-Cache'])
     end
+
+    def test_varies_includes_locale
+      set_locales(available: [:en, :es], default: :en, current: :en)
+
+      get '/cache_varies_test_varies'
+      assert_includes(response.body, 'en')
+
+      get '/cache_varies_test_varies', params: { locale: 'es' }
+      assert_includes(response.body, 'es')
+
+      get '/es/cache_varies_test_varies'
+      assert_includes(response.body, 'es')
+
+      patch '/cache_varies_test_varies'
+      assert_includes(response.body, 'en')
+
+      patch '/cache_varies_test_varies', params: { locale: 'es' }
+      assert_includes(response.body, 'es')
+
+      patch '/es/cache_varies_test_varies'
+      assert_includes(response.body, 'es')
+    end
   end
 end

data/test/lib/workarea/elasticsearch/document_test.rb

@@ -67,6 +67,26 @@ module Workarea
         assert_equal({ 'id' => '1' }, results.first['_source'])
       end
 
+      def test_bulk_with_block
+        set_locales(available: [:en, :es], default: :en, current: :en)
+        Foo.bulk { { id: I18n.locale.to_s, bulk_action: 'index' } }
+
+        find_results = -> do
+          Foo
+            .current_index
+            .search({ query: { match_all: {} } }, type: 'foo')
+            .dig('hits', 'hits')
+        end
+
+        I18n.locale = :en
+        assert(1, Foo.count)
+        assert_equal({ 'id' => 'en' }, find_results.call.first['_source'])
+
+        I18n.locale = :es
+        assert(1, Foo.count)
+        assert_equal({ 'id' => 'es' }, find_results.call.first['_source'])
+      end
+
       def test_update
         Foo.save(id: '1')
         Foo.update(id: '1', foo: 'bar')