Merge branch 'maintain-correlation-id-in-sidekiq-retry' into 'master'

        # be reinstantiated by Sidekiq-server when running the job.

        class Client

          def call(_worker_class, job, _queue, _redis_pool)

            Labkit::Context.with_context do |context|

            attributes = {}

            # Don't overwrite the correlation_id from the job. A new context

            # will always generate a new correlation_id and we'd rather carry

            # through the correlation_id from the previous job if it is

            # present (eg. for retries).

            attributes[Labkit::Context::CORRELATION_ID_KEY] = job["correlation_id"] if job["correlation_id"]

            Labkit::Context.with_context(attributes) do |context|

              job.merge!(context.to_h)

              yield

# frozen_string_literal: true

require "sidekiq/testing"

require "active_support"

require "active_support/core_ext"

require_relative "../../../../support/sidekiq_middleware/shared_contexts"

describe Labkit::Middleware::Sidekiq::Context::Client do

    expect(job.keys).to include(Labkit::Context::CORRELATION_ID_KEY)

  end

  it "does not override the correlation_id in the event of a retry" do

    job = { "jid" => "thejobid", "correlation_id" => "thecorrelationid" }

    yielded = false

    # Here we cannot easily simulate a sidekiq job retrying so we instead just

    # call the middleware directly to unit test how the `job` is manipulated

    described_class.new.call(test_worker.class, job, nil, nil) do

      expect(job["correlation_id"]).to eq("thecorrelationid")

      yielded = true

    end

    expect(yielded).to eq(true)

  end

  def find_job(jid)

    test_worker.jobs.find { |j| j["jid"] == jid }

  end