chewy 8.0.0 → 8.1.0

data/docs/troubleshooting.md

@@ -1,101 +0,0 @@
-# Troubleshooting
-
-## `UndefinedUpdateStrategy` error
-
-This is the most common Chewy error. When you save a model that has an `update_index` callback and no update strategy is active, Chewy raises `Chewy::UndefinedUpdateStrategy`:
-
-```
-Index update strategy is undefined for current context.
-Please wrap your code with `Chewy.strategy(:strategy_name)` block.
-```
-
-**Fix:** wrap the code that triggers the save in a strategy block:
-
-```ruby
-Chewy.strategy(:atomic) do
-  city.save!
-end
-```
-
-In a Rails app, controller actions already use the `:atomic` strategy by default. This error typically appears in background jobs, rake tasks, or console sessions. For console use, you can set `:urgent` as a persistent strategy:
-
-```ruby
-Chewy.strategy(:urgent)
-```
-
-If you want to suppress index updates entirely (e.g. in tests or migrations), use `:bypass`:
-
-```ruby
-Chewy.root_strategy = :bypass
-```
-
-See [configuration.md](configuration.md#index-update-strategies) for the full list of strategies.
-
-## Elasticsearch 8 security defaults
-
-Elasticsearch 8 enables security (TLS + authentication) by default. If you see connection refused or authentication errors after upgrading, you need to configure credentials and the CA certificate. See the [Security section](../README.md#security) in the main README for setup instructions.
-
-## Wildcard index deletion disabled in ES 8
-
-Starting from Elasticsearch 8, wildcard deletion of indices is disabled by default. If `Chewy.massacre` or other bulk-delete operations fail with a `Chewy::FeatureDisabled` error, you need to set the cluster setting `action.destructive_requires_name` to `false`:
-
-```
-PUT _cluster/settings
-{ "persistent": { "action.destructive_requires_name": false } }
-```
-
-## Import errors and debugging
-
-When using `import!` (with a bang), Chewy raises `Chewy::ImportFailed` if any documents fail to index. The error message groups failures by action type (index, delete) and includes the document IDs:
-
-```
-Import failed for `ProductsIndex` with:
-    Index errors:
-      `mapper_parsing_exception`
-        on 3 documents: ["1", "2", "3"]
-```
-
-For non-bang `import`, errors are silently swallowed. To debug import issues, set up a logger:
-
-```ruby
-Chewy.logger = Logger.new(STDOUT)
-```
-
-You can also subscribe to `import_objects.chewy` notifications — see [configuration.md](configuration.md#activesupportnotifications-support) for the payload format.
-
-## Import scope cleanup warnings
-
-When an `index_scope` includes `order`, `limit`, or `offset`, Chewy strips them before importing (they don't make sense for batch processing). By default this logs a warning. If you see unexpected warnings during import, you can control this via:
-
-```ruby
-Chewy.import_scope_cleanup_behavior = :ignore # no warning
-Chewy.import_scope_cleanup_behavior = :raise   # raise Chewy::ImportScopeCleanupError
-```
-
-See [configuration.md](configuration.md#import-scope-clean-up-behavior) for details.
-
-## Missing optional dependencies
-
-Some Chewy features require additional gems that are not listed as hard dependencies:
-
-- **`parallel`** — required for `chewy:parallel:*` rake tasks. Install it with `gem 'parallel'` in your Gemfile.
-- **`method_source`** — required for the Witchcraft technology (compiled value procs). Install it with `gem 'method_source'`.
-
-If these gems are missing you'll get a `LoadError` when the relevant feature is used.
-
-## Pre-request filter
-
-Should you need to inspect the query prior to it being dispatched to Elasticsearch during any queries, you can use the `before_es_request_filter`. `before_es_request_filter` is a callable object, as demonstrated below:
-
-```ruby
-Chewy.before_es_request_filter = -> (method_name, args, kw_args) { ... }
-```
-
-While using the `before_es_request_filter`, please consider the following:
-
-* `before_es_request_filter` acts as a simple proxy before any request made via the `Elasticsearch::Client`. The arguments passed to this filter include:
-  * `method_name` — the name of the method being called (e.g. search, count, bulk).
-  * `args` and `kw_args` — the positional and keyword arguments provided in the method call.
-* The operation is synchronous, so avoid executing any heavy or time-consuming operations within the filter to prevent performance degradation.
-* The return value of the proc is disregarded. This filter is intended for inspection or modification of the query rather than generating a response.
-* Any exception raised inside the callback will propagate upward and halt the execution of the query. It is essential to handle potential errors adequately to ensure the stability of your search functionality.

data/filters

@@ -1,78 +0,0 @@
-term
-  name == 'value'
-  name != 'value'
-terms
-  name == ['value1', 'value2']   plain
-  name != ['value1', 'value2']
-
-  name(:&) == ['value1', 'value2']   or
-  name(:|) == ['value1', 'value2']   and
-  name(:b) == ['value1', 'value2']   bool
-  name(:f) == ['value1', 'value2']   fielddata
-regexp
-  name == /regexp/
-  name =~ /regexp/
-  name != /regexp/
-  name !~ /regexp/
-  name(:anystring, :intersection) == /regexp/
-prefix
-  name =~ 'pref'
-  name !~ 'pref'
-
-exists
-  name?
-missing
-  !name
-  !name?
-  name == nil
-
-numeric_range Numeric
-range Other
-  date >= Date.today
-  date > Date.today
-  date <= Date.today
-  date < Date.today
-
-  date == (2.days.ago..3.days.since)   ()
-  date == [2.days.ago..3.days.since]   []
-
-bool
-  must(name == 'name', email == 'email')
-    .should(name == 'name', email == 'email')
-    .must_not(name == 'name', email == 'email')
-and
-  (name == 'name') & (email == 'email')
-or
-  (name == 'name') | (email == 'email')
-not
-  !(name == 'name')
-  email != 'email'
-
-script s()
-match all
-  match_all
-
-has child
-  has_child('type').query()
-  has_child('type').filter()
-has parent
-  has_parent('type').query()
-  has_parent('type').filter()
-nested
-  name.nested()
-
-query q()
-type
-  .types()
-
-geo bounding box
-geo distance
-geo distance range
-geo polygon
-geoshape
-geohash cell
-
-indices
-ids
-
-limit

data/gemfiles/base.gemfile

@@ -1,12 +0,0 @@
-gem 'database_cleaner'
-gem 'elasticsearch-extensions'
-gem 'method_source'
-gem 'rake'
-gem 'redis', require: false
-gem 'rspec', '>= 3.7.0'
-gem 'rspec-collection_matchers'
-gem 'rspec-its'
-gem 'rubocop', '1.84.2'
-gem 'sqlite3', '~> 2.1'
-gem 'timecop'
-gem 'unparser', '~> 0.6.15'

data/gemfiles/rails.7.2.activerecord.gemfile

@@ -1,14 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activejob', '~> 7.2.0'
-gem 'activerecord', '~> 7.2.0'
-gem 'activesupport', '~> 7.2.0'
-gem 'kaminari-core', '~> 1.1.0', require: false
-gem 'parallel', require: false
-gem 'rspec_junit_formatter', '~> 0.4.1'
-gem 'sidekiq', require: false
-
-gem 'rexml'
-
-gemspec path: '../'
-eval_gemfile 'base.gemfile'

data/gemfiles/rails.8.0.activerecord.gemfile

@@ -1,14 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activejob', '~> 8.0.0'
-gem 'activerecord', '~> 8.0.0'
-gem 'activesupport', '~> 8.0.0'
-gem 'kaminari-core', '~> 1.1.0', require: false
-gem 'parallel', require: false
-gem 'rspec_junit_formatter', '~> 0.4.1'
-gem 'sidekiq', require: false
-
-gem 'rexml'
-
-gemspec path: '../'
-eval_gemfile 'base.gemfile'

data/migration_guide.md

@@ -1,56 +0,0 @@
-# Migration guide
-
-This document outlines the steps you need to take when migrating between major versions of
-Chewy and Elasticsearch. For simplicity's sake the guide will assume that you're using
-Chewy alongside a matching Elasticsearch version.
-
-## Chewy 6/Elasticsearch 6 to Chewy 7/Elasticsearch 7
-
-In order to upgrade Chewy 6/Elasticsearch 6 to Chewy 7/Elasticsearch 7 in the most seamless manner you have to:
-
-* Upgrade to the latest 6.x stable releases, namely Chewy 6.0, Elasticsearch 6.8
-* Study carefully [Breaking changes in 7.0](https://www.elastic.co/guide/en/elasticsearch/reference/7.17/breaking-changes-7.0.html), make sure your application conforms.
-* Run your test suite on Chewy 7.0 / Elasticsearch 7
-* Run manual tests on Chewy 7.0 / Elasticsearch 7
-* Upgrade to Chewy 7.0
-  * The “total hits” counter is an integer for ES versions < 7 and an object (hash) for the versions starting from 7.0.0. Elasticsearch added a special option, `rest_total_hits_as_int`, to ease the upgrade, that could be appended to any request and results in the old “total hits” format. Unfortunately, this option is not recognized by ES versions prior to 7.0.0, which means that we have to check the version to decide if we need this option.
-    Normally Chewy does memoization of the current ES version, but this might be inappropriate for the upgrade, as the version changes live.
-    To handle that we have 2 versions of Chewy for this stage of the upgrade: 7.0.0 and 7.0.1. Version 7.0.0 does the memoization and version 7.0.1 requests the current version on every search request. 
-  * You can use the 7.0.0 version if it's fine for you to have an application restart immediately after ES cluster upgrade.
-  * If you're using the 7.0.1 version you might be interested in keeping the timeframe between this step and updating to Chewy 7.1 as small as possible, as version 7.0.1 skips ES version memoization for search requests to help dynamically detect ES version. This leads to an extra version request on each search request, i.e. could affect the overall performance/latency of the search and a load of ES cluster.
-* Perform a [rolling upgrade](https://www.elastic.co/guide/en/elasticsearch/reference//rolling-upgrades.html) of Elasticsearch
-* Run your test suite on Chewy 7.1 / Elasticsearch 7
-* Run manual tests on Chewy 7.1 / Elasticsearch 7
-* Upgrade to Chewy 7.1
-* Upgrade to Chewy 7.2:
-  * Remove all the `Chewy::Type` class usages, e.g. remove `CitiesIndex::City` / `CitiesIndex.city`
-    * `CitiesIndex::City.import! ...` becomes `CitiesIndex.import! ...`
-  * Update indexes with simplified DSL:
-    * `define_type` block -> `index_scope` clause
-      * it can be omitted completely, if you don't need to specify the scope or options, e.g. `name`
-  * Remove type names from string representations:
-    * in `update_index` ActiveRecord helper and RSpec matcher, e.g.
-      * `update_index('cities#city')` -> `update_index('cities')`
-      * `update_index(UsersIndex::User)` -> `update_index(UsersIndex)`
-    * in rake tasks (e.g. `rake chewy:update[cities#city]` -> `rake chewy:update[cities]`)
-    * rake tasks output is also changed (e.g. `Imported CitiesIndex::City in 1s, stats: index 3` -> `Imported CitiesIndex in 1s, stats: index 3`)
-  * Use index name instead of type name in loader additional scope
-    * e.g. `CitiesIndex.filter(...).load(city: {scope: City.where(...)})` -> `CitiesIndex.filter(...).load(cities: {scope: City.where(...)})`
-
-## Chewy 5/Elasticsearch 5 to Chewy 6/Elasticsearch 6
-
-In order to upgrade Chewy 5/Elasticsearch 5 to Chewy 6/Elasticsearch 6 in the most seamless manner you have to:
-
-* Upgrade to the latest 5.x stable releases, namely Chewy 5.2, Elasticsearch 5.6
-* [Migrate any multi-typed indexes into single-typed](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/removal-of-types.html)
-  * Using [multi-index queries](https://github.com/toptal/chewy/pull/657) could be helpful
-  * Parent/Child [relationship is deprecated](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/removal-of-types.html#parent-child-mapping-types) in favor of the [join field](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/parent-join.html)
-* Handle deprecation of `string` type & `not_analyzed` value for the `index` mapping parameter:
-  * replace fields with `{ type: 'string', index: 'not_analyzed'}` by `{type: 'keyword'}`
-  * replace fields with `{ type: 'string', index: 'analyzed'}` by `{type: 'text'}`
-* `PathHierarchy` tokenizer' param `delimiter` now accepts only one argument, [others should be replaced by character filter ](https://discuss.elastic.co/t/multichar-delimiter-in-path-hierarchy-tokenizer/16203)
-* Make sure you don't use any other of the [deprecated Elasticsearch 5 features](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/breaking-changes-6.0.html)
-* Run your test suite on Chewy 6 / Elasticsearch 6
-* Run manual tests on Chewy 6 / Elasticsearch 6
-* Upgrade to Chewy 6
-* Perform a [rolling upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/rolling-upgrades.html) of Elasticsearch

data/spec/chewy/config_spec.rb

@@ -1,110 +0,0 @@
-require 'spec_helper'
-
-describe Chewy::Config do
-  subject { described_class.send(:new) }
-
-  specify { expect(subject.logger).to be_nil }
-  specify { expect(subject.transport_logger).to be_nil }
-  specify { expect(subject.root_strategy).to eq(:base) }
-  specify { expect(subject.request_strategy).to eq(:atomic) }
-  specify { expect(subject.console_strategy).to eq(:urgent) }
-  specify { expect(subject.use_after_commit_callbacks).to eq(true) }
-  specify { expect(subject.indices_path).to eq('app/chewy') }
-  specify { expect(subject.reset_disable_refresh_interval).to eq(false) }
-  specify { expect(subject.reset_no_replicas).to eq(false) }
-  specify { expect(subject.disable_refresh_async).to eq(false) }
-  specify { expect(subject.search_class).to be < Chewy::Search::Request }
-
-  describe '#transport_logger=' do
-    let(:logger) { Logger.new('/dev/null') }
-    after { subject.transport_logger = nil }
-
-    specify do
-      expect { subject.transport_logger = logger }
-        .to change { Chewy.client.transport.logger }.to(logger)
-    end
-    specify do
-      expect { subject.transport_logger = logger }
-        .to change { subject.transport_logger }.to(logger)
-    end
-    specify do
-      expect { subject.transport_logger = logger }
-        .to change { subject.configuration[:logger] }.from(nil).to(logger)
-    end
-  end
-
-  describe '#transport_tracer=' do
-    let(:tracer) { Logger.new('/dev/null') }
-    after { subject.transport_tracer = nil }
-
-    specify do
-      expect { subject.transport_tracer = tracer }
-        .to change { Chewy.client.transport.tracer }.to(tracer)
-    end
-    specify do
-      expect { subject.transport_tracer = tracer }
-        .to change { subject.transport_tracer }.to(tracer)
-    end
-    specify do
-      expect { subject.transport_tracer = tracer }
-        .to change { subject.configuration[:tracer] }.from(nil).to(tracer)
-    end
-  end
-
-  describe '#search_class' do
-    context 'nothing is defined' do
-      before do
-        hide_const('Kaminari')
-      end
-
-      specify do
-        expect(subject.search_class.included_modules)
-          .not_to include(Chewy::Search::Pagination::Kaminari)
-      end
-    end
-
-    context 'kaminari' do
-      specify do
-        expect(subject.search_class.included_modules)
-          .to include(Chewy::Search::Pagination::Kaminari)
-      end
-    end
-  end
-
-  describe '#configuration' do
-    before { subject.settings = {indices_path: 'app/custom_indices_path'} }
-
-    specify do
-      expect(subject.configuration).to include(indices_path: 'app/custom_indices_path')
-    end
-
-    context 'when Rails::VERSION constant is defined' do
-      it 'looks for configuration in "config/chewy.yml"' do
-        module Rails
-          VERSION = '5.1.1'.freeze
-
-          def self.root
-            Pathname.new(__dir__)
-          end
-        end
-
-        expect(File).to receive(:exist?)
-          .with(Pathname.new(__dir__).join('config', 'chewy.yml'))
-        subject.configuration
-      end
-    end
-  end
-
-  describe '.console_strategy' do
-    context 'sets .console_strategy' do
-      let(:default_strategy) { subject.console_strategy }
-      let(:new_strategy) { :atomic }
-      after { subject.console_strategy = default_strategy }
-
-      specify do
-        expect { subject.console_strategy = new_strategy }
-          .to change { subject.console_strategy }.to(new_strategy)
-      end
-    end
-  end
-end

data/spec/chewy/elastic_client_spec.rb

@@ -1,26 +0,0 @@
-require 'spec_helper'
-
-describe Chewy::ElasticClient do
-  describe 'payload inspection' do
-    let(:filter) { instance_double('Proc') }
-    let!(:filter_previous_value) { Chewy.before_es_request_filter }
-
-    before do
-      drop_indices
-      stub_index(:products) do
-        field :id, type: :integer
-      end
-      ProductsIndex.create
-      Chewy.before_es_request_filter = filter
-    end
-
-    after do
-      Chewy.before_es_request_filter = filter_previous_value
-    end
-
-    it 'call filter with the request body' do
-      expect(filter).to receive(:call).with(:search, [{body: {size: 0}, index: ['products']}], {})
-      Chewy.client.search({index: ['products'], body: {size: 0}}).to_a
-    end
-  end
-end