RubyGems - copy_tuner_client - Versions diffs - 2.2.0 → 2.3.0 - Mend

copy_tuner_client 2.2.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +2 -235
data/CLAUDE.md +10 -0
data/README.md +42 -5
data/docs/poller-startup.md +108 -0
data/lib/copy_tuner_client/configuration.rb +37 -12
data/lib/copy_tuner_client/fork_hook.rb +53 -0
data/lib/copy_tuner_client/poller.rb +87 -23
data/lib/copy_tuner_client/process_guard.rb +13 -4
data/lib/copy_tuner_client/queue_with_timeout.rb +8 -2
data/lib/copy_tuner_client/version.rb +1 -1
data/skills/copy-tuner-to-locales-cleanup/SKILL.md +5 -5
data/skills/copy-tuner-to-locales-migrate-prefix/SKILL.md +69 -37
data/skills/copy-tuner-to-locales-migrate-prefix/references/example-touchpoints.md +31 -10
data/skills/copy-tuner-to-locales-migrate-prefix/scripts/migrate_prefix.rb +144 -6
data/spec/copy_tuner_client/configuration_spec.rb +173 -0
data/spec/copy_tuner_client/fork_hook_spec.rb +171 -0
data/spec/copy_tuner_client/poller_spec.rb +148 -1
data/spec/copy_tuner_client/process_guard_spec.rb +8 -0
data/spec/copy_tuner_client/queue_with_timeout_spec.rb +27 -0
data/spec/copy_tuner_client/warden_integration_spec.rb +95 -0
data/spec/spec_helper.rb +6 -0
data/spec/support/middleware_stack.rb +39 -5
metadata +6 -1

data/spec/copy_tuner_client/process_guard_spec.rb CHANGED Viewed

@@ -20,6 +20,14 @@ describe CopyTunerClient::ProcessGuard do
     process_guard
   end
+  it 'fork の前後で poller を張り直すフックを登録する' do
+    allow(CopyTunerClient::ForkHook).to receive(:install)
+    build_process_guard.start
+    expect(CopyTunerClient::ForkHook).to have_received(:install)
+  end
   it 'starts polling from a worker process' do
     process_guard = build_process_guard
     process_guard.start

data/spec/copy_tuner_client/queue_with_timeout_spec.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'timeout'
+describe CopyTunerClient::QueueWithTimeout do
+  subject(:queue) { described_class.new }
+  describe '#pop_with_timeout' do
+    it 'キューに要素があれば取り出す' do
+      queue << :sync
+      expect(queue.pop_with_timeout(0)).to eq(:sync)
+    end
+    it '要素が無いままタイムアウトしたら ThreadError を投げる' do
+      expect { queue.pop_with_timeout(0.1) }.to raise_error(ThreadError)
+    end
+    it 'ウォールクロックが巻き戻ってもタイムアウトが伸びない' do
+      # 待っている最中に NTP の step 補正や手動の時刻変更で時計が後ろへ飛ぶ状況を模す。
+      # 経過時間をウォールクロックで測っていると、飛んだ幅がそのまま待ち時間に乗る
+      base = Time.now
+      allow(Time).to receive(:now).and_return(base, base - 3600)
+      expect { Timeout.timeout(2) { queue.pop_with_timeout(0.1) } }.to raise_error(ThreadError)
+    end
+  end
+end

data/spec/copy_tuner_client/warden_integration_spec.rb ADDED Viewed

@@ -0,0 +1,95 @@
+require 'spec_helper'
+require 'copy_tuner_client/copyray_middleware'
+require 'copy_tuner_client/copyray'
+require 'copy_tuner_client/copyray/marker'
+require 'copy_tuner_client/translation_log'
+# Warden::Manager の catch(:warden) と failure app 呼び出しだけを模した fake（warden gem に依存しないため）
+class FakeWarden
+  def initialize(app, failure_app)
+    @app = app
+    @failure_app = failure_app
+  end
+  def call(env)
+    result = catch(:warden) { @app.call(env) }
+    result.is_a?(Array) ? result : @failure_app.call(env)
+  end
+end
+# NOTE: CopyrayMiddleware 単体ではなく、Warden 相当の fake との組み合わせ位置を検証するため
+# describe の第一引数はクラスではなく説明文にしている
+describe 'throw :warden と CopyrayMiddleware の位置関係' do # rubocop:disable RSpec/DescribeClass
+  def marker(key)
+    CopyTunerClient::Copyray::Marker.encode(key)
+  end
+  # NOTE: authenticate_user! 失敗を模す。throw :warden するとこの @app.call(env) は正常リターンせず、
+  # CopyrayMiddleware が内側にあると Rewriter.rewrite が実行されない。
+  let(:throwing_app) { ->(_env) { throw :warden } }
+  let(:failure_status) { 200 }
+  let(:failure_app) do
+    ->(_env) do
+      [failure_status, { 'Content-Type' => 'text/html' }, [failure_body]]
+    end
+  end
+  let(:failure_body) { "<html><body><p>#{marker('devise.failure.unauthenticated')}Please sign in</p></body></html>" }
+  before do
+    CopyTunerClient.configure do |configuration|
+      configuration.project_id = 1
+      configuration.client = FakeClient.new
+    end
+  end
+  # NOTE: append_js は Rails の ActionController::Base.helpers に依存するため、
+  # copyray_middleware_spec.rb と同じ手法で no-op スタブに差し替え、Rewriter の効果だけを見る。
+  def stub_append_js(middleware)
+    allow(middleware).to receive(:append_js) { |html, *| html }
+  end
+  context '内側構成（CopyrayMiddleware が Warden より内側）のとき' do
+    it 'マーカー ⟦CT: がレスポンスに残る（不具合の記録）' do
+      copyray = CopyTunerClient::CopyrayMiddleware.new(throwing_app)
+      stub_append_js(copyray)
+      warden = FakeWarden.new(copyray, failure_app)
+      _status, _headers, response = warden.call({})
+      result = response.join
+      expect(result).to match(CopyTunerClient::Copyray::Marker::SCAN_REGEXP)
+    end
+  end
+  context '外側構成（CopyrayMiddleware が Warden より外側）のとき' do
+    it 'マーカーが消え data-copyray-key に変換される' do
+      warden = FakeWarden.new(throwing_app, failure_app)
+      copyray = CopyTunerClient::CopyrayMiddleware.new(warden)
+      stub_append_js(copyray)
+      _status, _headers, response = copyray.call({})
+      result = response.join
+      expect(result).to include('data-copyray-key="devise.failure.unauthenticated"')
+      expect(result).not_to match(CopyTunerClient::Copyray::Marker::SCAN_REGEXP)
+    end
+    context 'failure app が 422 を返すとき（Devise.responder.error_status = :unprocessable_entity 相当）' do
+      let(:unprocessable_failure_app) do
+        ->(_env) { [422, { 'Content-Type' => 'text/html' }, [failure_body]] }
+      end
+      it 'マーカーが消え data-copyray-key に変換される' do
+        warden = FakeWarden.new(throwing_app, unprocessable_failure_app)
+        copyray = CopyTunerClient::CopyrayMiddleware.new(warden)
+        stub_append_js(copyray)
+        _status, _headers, response = copyray.call({})
+        result = response.join
+        expect(result).to include('data-copyray-key="devise.failure.unauthenticated"')
+        expect(result).not_to match(CopyTunerClient::Copyray::Marker::SCAN_REGEXP)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb CHANGED Viewed

@@ -26,4 +26,10 @@ RSpec.configure do |config|
     FakeCopyTunerApp.reset
     reset_config
   end
+  # apply を通す spec は本物の poller スレッドを起動するので、example ごとに止める。
+  # 放置するとスレッドがスイート終了まで積み上がり、実際に HTTP を叩き続ける
+  config.after do
+    CopyTunerClient.configuration&.poller&.stop
+  end
 end

data/spec/support/middleware_stack.rb CHANGED Viewed

@@ -1,13 +1,47 @@
+# ActionDispatch::MiddlewareStack の挿入 API を模した fake（挿入順序と引数を検証するため）
 class MiddlewareStack
-  def initialize
-    @middlewares = []
+  Entry = Struct.new(:klass, :args)
+  def initialize(existing = [])
+    @middlewares = existing.map { |klass| Entry.new(klass, []) }
+  end
+  def use(klass, *args)
+    @middlewares << Entry.new(klass, args)
+  end
+  def insert_before(target, klass, *args)
+    index = index_of!(target, 'before')
+    @middlewares.insert(index, Entry.new(klass, args))
   end
-  def use(klass, *)
-    @middlewares << klass.new('fake_app', *)
+  def insert_after(target, klass, *args)
+    index = index_of!(target, 'after')
+    @middlewares.insert(index + 1, Entry.new(klass, args))
   end
   def include?(klass)
-    @middlewares.any?(klass)
+    classes.include?(klass)
+  end
+  def classes
+    @middlewares.map(&:klass)
+  end
+  def index(klass)
+    classes.index(klass)
+  end
+  def args_for(klass)
+    @middlewares.find { |entry| entry.klass == klass }&.args
+  end
+  private
+  def index_of!(target, where)
+    index = classes.index(target)
+    raise "No such middleware to insert #{where}: #{target.inspect}" if index.nil?
+    index
   end
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: copy_tuner_client
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - SonicGarden
@@ -200,6 +200,7 @@ files:
 - app/assets/javascripts/copytuner.js
 - biome.json
 - copy_tuner_client.gemspec
+- docs/poller-startup.md
 - gemfiles/8.0.gemfile
 - gemfiles/8.1.gemfile
 - gemfiles/main.gemfile
@@ -215,6 +216,7 @@ files:
 - lib/copy_tuner_client/dotted_hash.rb
 - lib/copy_tuner_client/engine.rb
 - lib/copy_tuner_client/errors.rb
+- lib/copy_tuner_client/fork_hook.rb
 - lib/copy_tuner_client/helper_extension.rb
 - lib/copy_tuner_client/i18n_backend.rb
 - lib/copy_tuner_client/i18n_compat.rb
@@ -251,13 +253,16 @@ files:
 - spec/copy_tuner_client/copyray_middleware_spec.rb
 - spec/copy_tuner_client/copyray_spec.rb
 - spec/copy_tuner_client/dotted_hash_spec.rb
+- spec/copy_tuner_client/fork_hook_spec.rb
 - spec/copy_tuner_client/helper_extension_spec.rb
 - spec/copy_tuner_client/i18n_backend_spec.rb
 - spec/copy_tuner_client/poller_spec.rb
 - spec/copy_tuner_client/prefixed_logger_spec.rb
 - spec/copy_tuner_client/process_guard_spec.rb
+- spec/copy_tuner_client/queue_with_timeout_spec.rb
 - spec/copy_tuner_client/request_sync_spec.rb
 - spec/copy_tuner_client/translation_log_spec.rb
+- spec/copy_tuner_client/warden_integration_spec.rb
 - spec/copy_tuner_client_spec.rb
 - spec/spec_helper.rb
 - spec/support/client_spec_helpers.rb