elastic_ar_sync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd13df6ed68262c7b4c23444f09d48a3530ad97e5df6f682f505ec32f9304de1
+  data.tar.gz: 3b4e0cb0b9c5f0226eaa85aab9d4c68b10a4a1e57c1a435f877a1dbcaa61b257
+SHA512:
+  metadata.gz: 219487c1c412620a86beabe73e1ef4db107a17d427d69e775ef301e20fe98a24cec1f9af23ee98611a777ba6b05604551ac25fb4e06fbe43b5878e6b020b0be0
+  data.tar.gz: bc3b782c8f7b8626383b3dee9ec539ad4d7d00d62702c6edfa91eeeab9be91edfe25b3e693fa602b859b85ed52ad746d1d037e8d6d2847119be4770b80ef3436

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 KitakatsuTed
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# ElasticArSync
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elastic_ar_sync'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install elastic_ar_sync
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ElasticArSync'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/elastic_ar_sync.rb

@@ -0,0 +1,15 @@
+require "elastic_ar_sync/railtie"
+
+module ElasticArSync
+  module Elastic
+    module Services
+      autoload :DocumentIndexer, 'elastic_ar_sync/elastic/services/document_indexer'
+      autoload :IndexHandler, 'elastic_ar_sync/elastic/services/index_handler'
+    end
+    module Worker
+      autoload :IndexImportWorker, 'elastic_ar_sync/elastic/worker/index_import_worker'
+      autoload :IndexWorker, 'elastic_ar_sync/elastic/worker/index_worker'
+    end
+    autoload :Syncable, 'elastic_ar_sync/elastic/syncable'
+  end
+end

data/lib/elastic_ar_sync/elastic/services/document_indexer.rb

@@ -0,0 +1,21 @@
+class ElasticArSync::Elastic::Services::DocumentIndexer
+  def index_document(klass, operation, record_id)
+    case operation.to_s
+    when /index/
+      record = Object.const_get(klass).find(record_id)
+
+      Elasticsearch::Model.client.index(
+        index: record.__elasticsearch__.index_name,
+        type: record.__elasticsearch__.document_type,
+        id: record.id,
+        body: record.__elasticsearch__.as_indexed_json)
+    when /delete/
+      Elasticsearch::Model.client.delete(index: Object.const_get(klass).__elasticsearch__.index_name,
+                            type: Object.const_get(klass).__elasticsearch__.document_type,
+                            id: record_id)
+    else
+      raise ArgumentError, "Unknown operation '#{operation.to_s}'"
+    end
+  end
+end
+

data/lib/elastic_ar_sync/elastic/services/index_handler.rb

@@ -0,0 +1,40 @@
+class ElasticArSync::Elastic::Services::IndexHandler
+  def initialize(klass)
+    @klass = klass
+  end
+
+  # インデックスを作成 デフォルトは クラス名の小文字_環境名
+  def create_index(new_index_name)
+    @klass.__elasticsearch__.client.indices.create index: new_index_name, body: { settings: @klass.settings.to_hash, mappings: @klass.mapping.to_hash }
+  end
+
+  def delete_index(target_index)
+    raise 'can not delete because this index is using now' if target_index == target_alias
+
+    @klass.__elasticsearch__.client.indices.delete index: target_index rescue false
+  end
+
+  # DBの内容をESのインデックスに同期する
+  # レコード量が多いと時間がかかるのでこれだけは非同期実行
+  def import_all_record(target_index ,batch_size = 100)
+    @klass.__elasticsearch__.import(index: target_index, batch_size: batch_size)
+  end
+
+  # ダウンタイムなしでインデックスを切り替える
+  # https://techlife.cookpad.com/entry/2015/09/25/170000
+  def switch_alias(alias_name:, new_index_name:)
+    raise 'this is already assigned' if new_index_name == target_alias
+
+    actions = [{ add: { index: new_index_name, alias: alias_name } }]
+    old_indexes = @klass.get_aliases.keys
+    old_indexes.each { |old_index| actions << { remove: { index: old_index, alias: alias_name } } }
+
+    @klass.__elasticsearch__.client.indices.update_aliases(body: { actions: actions })
+  end
+
+  private
+
+  def target_alias
+    @klass.get_aliases.keys.select { |index| @klass.get_aliases[index]["aliases"].present? }.first
+  end
+end

data/lib/elastic_ar_sync/elastic/syncable.rb

@@ -0,0 +1,106 @@
+module ElasticArSync
+  module Elastic
+    module Syncable
+      extend ActiveSupport::Concern
+      include ElasticArSync::Elastic::Worker
+      include ElasticArSync::Elastic::Services
+
+      included do
+        include Elasticsearch::Model
+
+        index_name "#{self.to_s.downcase.pluralize}_#{Rails.env}"
+
+        # after_commitでRDBを操作した時にESのインデックスも同期させる
+        # アプリのサーバーに負荷をかけ無いように非同期で実行させる
+        after_commit on: [:create] do
+          document_sync_create(self.class, id)
+        end
+
+        after_commit on: [:update] do
+          document_sync_update(self.class, id)
+        end
+
+        after_commit on: [:destroy] do
+          document_sync_delete(self.class, id)
+        end
+
+        def document_sync_create(klass, record_id)
+          ElasticArSync::Elastic::Worker::IndexWorker.perform_async(klass, :index, record_id)
+        end
+
+        def document_sync_update(klass, record_id)
+          ElasticArSync::Elastic::Worker::IndexWorker.perform_async(klass, :index, record_id)
+        end
+
+        def document_sync_delete(klass, record_id)
+          ElasticArSync::Elastic::Worker::IndexWorker.perform_async(klass, :delete, record_id)
+        end
+
+        def as_indexed_json(_option = {})
+          attributes.symbolize_keys.select { |key, _| self.class.mapping_list_keys.include?(key) }
+        end
+      end
+
+      module ClassMethods
+        def index_setup
+          response = create_index
+          switch_alias(new_index_name: response["index"])
+          import_all_record(target_index: response["index"])
+        end
+        # インデックスを作成 デフォルトは クラス名の小文字_環境名
+        def create_index
+          ElasticArSync::Elastic::Services::IndexHandler.new(self).create_index("#{index_name}_#{Time.zone.now.strftime('%Y%m%d%H%M')}")
+        end
+
+        def delete_index(target_index)
+          ElasticArSync::Elastic::Services::IndexHandler.new(self).delete_index(target_index)
+        end
+
+        # DBの内容をESのインデックスに同期する
+        def import_all_record(target_index: ,batch_size: 100)
+          ElasticArSync::Elastic::Worker::IndexImportWorker.perform_async(self, target_index, batch_size)
+        end
+
+        # ダウンタイムなしでインデックスを切り替える
+        # https://techlife.cookpad.com/entry/2015/09/25/170000
+        def switch_alias(new_index_name:)
+          ElasticArSync::Elastic::Services::IndexHandler.new(self).switch_alias(alias_name: index_name, new_index_name: new_index_name)
+        end
+
+        def index_config(dynamic: 'false', number_of_shards: 1, attr_mappings: default_index_mapping)
+          settings index: { number_of_shards: number_of_shards } do
+            # ES6からStringが使えないのでtextかkeywordにする。
+            mappings dynamic: dynamic do
+              attr_mappings.each do |key, value|
+                indexes key, type: value
+              end
+            end
+          end
+        end
+
+        def default_index_mapping
+          mapping = {}
+          attribute_types.each do |attribute, active_model_type|
+            type = active_model_type.type
+            type = :text if (active_model_type.type.to_sym == :string) || (type == :integer && defined_enums.symbolize_keys.keys.include?(attribute.to_sym))
+            type = :date if active_model_type.type == :datetime
+            mapping[attribute.to_sym] = type
+          end
+          mapping
+        end
+
+        def mapping_list_keys
+          mappings.to_hash[:_doc][:properties].keys
+        end
+
+        def get_aliases
+          begin
+            __elasticsearch__.client.indices.get_alias(index: '')
+          rescue Elasticsearch::Transport::Transport::Errors::NotFound
+            raise Elasticsearch::Transport::Transport::Errors::NotFound, "インデックスがありません alias_name: #{alias_name}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elastic_ar_sync/elastic/worker/index_import_worker.rb

@@ -0,0 +1,16 @@
+class ElasticArSync::Elastic::Worker::IndexImportWorker
+  include Sidekiq::Worker
+  sidekiq_options queue: :elasticsearch, retry: false
+
+  def perform(klass, target_index, batch_size)
+    Rails.logger.debug "[elastic IndexImportWorker] start import #{target_index}"
+
+    begin
+      ElasticArSync::Elastic::Services::IndexHandler.new(Object.const_get(klass)).import_all_record(target_index, batch_size)
+    rescue => e
+      Rails.logger.debug "[elastic IndexImportWorker] error occur #{target_index} \n #{e.message}"
+    end
+
+    Rails.logger.debug "[elastic IndexImportWorker] finish import #{target_index}"
+  end
+end

data/lib/elastic_ar_sync/elastic/worker/index_worker.rb

@@ -0,0 +1,9 @@
+class ElasticArSync::Elastic::Worker::IndexWorker
+  include Sidekiq::Worker
+  sidekiq_options queue: :elasticsearch, retry: false
+
+  def perform(klass, operation, record_id)
+    Rails.logger.debug "[elasticsearch IndexWorker] operation: #{operation} #{klass} ID: #{record_id}"
+    ElasticArSync::Elastic::Services::DocumentIndexer.new.index_document(klass, operation, record_id)
+  end
+end

data/lib/elastic_ar_sync/railtie.rb

@@ -0,0 +1,4 @@
+module ElasticArSync
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/elastic_ar_sync/version.rb

@@ -0,0 +1,3 @@
+module ElasticArSync
+  VERSION = '0.1.0'
+end

data/lib/tasks/elastic_ar_sync_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :elastic_ar_sync do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: elastic_ar_sync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- KitakatsuTed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem has useful methods to sync rdb data with es data.
+email:
+- travy300637@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/elastic_ar_sync.rb
+- lib/elastic_ar_sync/elastic/services/document_indexer.rb
+- lib/elastic_ar_sync/elastic/services/index_handler.rb
+- lib/elastic_ar_sync/elastic/syncable.rb
+- lib/elastic_ar_sync/elastic/worker/index_import_worker.rb
+- lib/elastic_ar_sync/elastic/worker/index_worker.rb
+- lib/elastic_ar_sync/railtie.rb
+- lib/elastic_ar_sync/version.rb
+- lib/tasks/elastic_ar_sync_tasks.rake
+homepage: https://github.com/KitakatsuTed/elastic_ar_sync
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: easy setup elasticsearch for ActiveRecord
+test_files: []