# frozen_string_literal: true
# rubocop:todo all

require 'spec_helper'

describe Mongo::Server::ConnectionPool do

  let(:options) { {} }

  let(:server_options) do
    Mongo::Utils.shallow_symbolize_keys(Mongo::Client.canonicalize_ruby_options(
      SpecConfig.instance.all_test_options,
    )).tap do |opts|
      opts.delete(:min_pool_size)
      opts.delete(:max_pool_size)
      opts.delete(:wait_queue_timeout)
    end.update(options)
  end

  let(:address) do
    Mongo::Address.new(SpecConfig.instance.addresses.first)
  end

  let(:monitoring) do
    Mongo::Monitoring.new(monitoring: false)
  end

  let(:listeners) do
    Mongo::Event::Listeners.new
  end

  declare_topology_double

  let(:app_metadata) do
    Mongo::Server::AppMetadata.new(server_options)
  end

  let(:cluster) do
    double('cluster').tap do |cl|
      allow(cl).to receive(:topology).and_return(topology)
      allow(cl).to receive(:app_metadata).and_return(app_metadata)
      allow(cl).to receive(:options).and_return({})
      allow(cl).to receive(:update_cluster_time)
      allow(cl).to receive(:cluster_time).and_return(nil)
      allow(cl).to receive(:run_sdam_flow)
    end
  end

  let(:server) do
    register_server(
      Mongo::Server.new(address, cluster, monitoring, listeners,
        {monitoring_io: false}.update(server_options)
      ).tap do |server|
        allow(server).to receive(:description).and_return(ClusterConfig.instance.primary_description)
      end
    )
  end

  let(:pool) do
    register_pool(described_class.new(server, server_options)).tap do |pool|
      pool.ready
    end
  end

  let(:populate_semaphore) do
    pool.instance_variable_get(:@populate_semaphore)
  end

  let(:populator) do
    pool.instance_variable_get(:@populator)
  end

  describe '#initialize' do

    context 'when a min size is provided' do
      let (:options) do
        { min_pool_size: 2 }
      end

      it 'creates the pool with min size connections' do
        # Allow background thread to populate pool
        pool
        sleep 1

        expect(pool.size).to eq(2)
        expect(pool.available_count).to eq(2)
      end

      it 'does not use the same objects in the pool' do
        expect(pool.check_out).to_not equal(pool.check_out)
      end
    end

    context 'when min size exceeds default max size' do
      let (:options) do
        { min_pool_size: 50 }
      end

      it 'sets max size to equal provided min size' do
        expect(pool.max_size).to eq(50)
      end
    end

    context 'when min size is provided and max size is zero (unlimited)' do
      let (:options) do
        { min_size: 10, max_size: 0 }
      end

      it 'sets max size to zero (unlimited)' do
        expect(pool.max_size).to eq(0)
      end
    end

    context 'when no min size is provided' do

      it 'creates the pool with no connections' do
        expect(pool.size).to eq(0)
        expect(pool.available_count).to eq(0)
      end

      it "starts the populator" do
        expect(populator).to be_running
      end
    end

    context 'sizes given as min_size and max_size' do
      let (:options) do
        { min_size: 3, max_size: 7 }
      end

      it 'sets sizes correctly' do
        expect(pool.min_size).to eq(3)
        expect(pool.max_size).to eq(7)
      end
    end

    context 'sizes given as min_pool_size and max_pool_size' do
      let (:options) do
        { min_pool_size: 3, max_pool_size: 7 }
      end

      it 'sets sizes correctly' do
        expect(pool.min_size).to eq(3)
        expect(pool.max_size).to eq(7)
      end
    end

    context 'timeout given as wait_timeout' do
      let (:options) do
        { wait_timeout: 4 }
      end

      it 'sets wait timeout correctly' do
        expect(pool.wait_timeout).to eq(4)
      end
    end

    context 'timeout given as wait_queue_timeout' do
      let (:options) do
        { wait_queue_timeout: 4 }
      end

      it 'sets wait timeout correctly' do
        expect(pool.wait_timeout).to eq(4)
      end
    end
  end

  describe '#max_size' do
    context 'when a max pool size option is provided' do
      let (:options) do
        { max_pool_size: 3 }
      end

      it 'returns the max size' do
        expect(pool.max_size).to eq(3)
      end
    end

    context 'when no pool size option is provided' do
      it 'returns the default size' do
        expect(pool.max_size).to eq(20)
      end
    end

    context 'when pool is closed' do
      before do
        pool.close
      end

      it 'returns max size' do
        expect(pool.max_size).to eq(20)
      end
    end
  end

  describe '#wait_timeout' do
    context 'when the wait timeout option is provided' do
      let (:options) do
        { wait_queue_timeout: 3 }
      end

      it 'returns the wait timeout' do
        expect(pool.wait_timeout).to eq(3)
      end
    end

    context 'when the wait timeout option is not provided' do
      it 'returns the default wait timeout' do
        expect(pool.wait_timeout).to eq(10)
      end
    end
  end

  describe '#size' do
    context 'pool without connections' do
      it 'is 0' do
        expect(pool.size).to eq(0)
      end
    end

    context 'pool with a checked out connection' do
      before do
        pool.check_out
      end

      it 'is 1' do
        expect(pool.size).to eq(1)
      end
    end

    context 'pool with an available connection' do
      before do
        connection = pool.check_out
        pool.check_in(connection)
      end

      it 'is 1' do
        expect(pool.size).to eq(1)
      end
    end

    context 'when pool is closed' do
      before do
        pool.close
      end

      it 'raises PoolClosedError' do
        expect do
          pool.size
        end.to raise_error(Mongo::Error::PoolClosedError)
      end
    end
  end

  describe '#available_count' do
    context 'pool without connections' do
      it 'is 0' do
        expect(pool.available_count).to eq(0)
      end
    end

    context 'pool with a checked out connection' do
      before do
        pool.check_out
      end

      it 'is 0' do
        expect(pool.available_count).to eq(0)
      end
    end

    context 'pool with an available connection' do
      before do
        connection = pool.check_out
        pool.check_in(connection)
      end

      it 'is 1' do
        expect(pool.available_count).to eq(1)
      end
    end

    context 'when pool is closed' do
      before do
        pool.close
      end

      it 'raises PoolClosedError' do
        expect do
          pool.available_count
        end.to raise_error(Mongo::Error::PoolClosedError)
      end
    end
  end

  describe '#closed?' do
    context 'pool is not closed' do
      it 'is false' do
        expect(pool.closed?).to be false
      end
    end

    context 'pool is closed' do
      before do
        pool.close
      end

      it 'is true' do
        expect(pool.closed?).to be true
      end

      it "stops the populator" do
        expect(populator).to_not be_running
      end
    end
  end

  describe '#check_in' do
    let!(:pool) do
      server.pool
    end

    after do
      server.close
    end

    let(:options) do
      { max_pool_size: 2 }
    end

    let(:connection) do
      pool.check_out
    end

    context 'when a connection is checked out on the thread' do

      before do
        pool.check_in(connection)
      end

      it 'returns the connection to the pool' do
        expect(pool.size).to eq(1)
      end
    end

    shared_examples 'does not add connection to pool' do
      it 'disconnects connection and does not add connection to pool' do
        # connection was checked out
        expect(pool.available_count).to eq(0)
        expect(pool.size).to eq(1)
        expect(connection).to receive(:disconnect!)
        pool.check_in(connection)
        # connection is not added to the pool, and no replacement
        # connection has been created at this point
        expect(pool.available_count).to eq(0)
        expect(pool.size).to eq(0)
        expect(pool.check_out).not_to eq(connection)
      end
    end

    shared_examples 'adds connection to the pool' do
      it 'adds the connection to the pool' do
        # connection is checked out
        expect(pool.available_count).to eq(0)
        expect(pool.size).to eq(1)
        pool.check_in(connection)
        # now connection is in the queue
        expect(pool.available_count).to eq(1)
        expect(pool.size).to eq(1)
        expect(pool.check_out).to eq(connection)
      end
    end

    context 'connection of the same generation as pool' do
      # These tests are also applicable to load balancers, but
      # require different setup and assertions because load balancers
      # do not have a single global generation.
      require_topology :single, :replica_set, :sharded

      before do
        expect(pool.generation).to eq(connection.generation)
      end

      it_behaves_like 'adds connection to the pool'
    end

    context 'connection of earlier generation than pool' do
      # These tests are also applicable to load balancers, but
      # require different setup and assertions because load balancers
      # do not have a single global generation.
      require_topology :single, :replica_set, :sharded

      context 'when connection is not pinned' do
        let(:connection) do
          pool.check_out.tap do |connection|
            expect(connection).to receive(:generation).at_least(:once).and_return(0)
            expect(connection).not_to receive(:record_checkin!)
          end
        end

        before do
          expect(connection.generation).to be < pool.generation
        end

        it_behaves_like 'does not add connection to pool'
      end

      context 'when connection is pinned' do
        let(:connection) do
          pool.check_out.tap do |connection|
            allow(connection).to receive(:pinned?).and_return(true)
            expect(connection).to receive(:generation).at_least(:once).and_return(0)
            expect(connection).to receive(:record_checkin!)
          end
        end

        before do
          expect(connection.generation).to be < pool.generation
        end

        it_behaves_like 'adds connection to the pool'
      end
    end

    context 'connection of later generation than pool' do
      # These tests are also applicable to load balancers, but
      # require different setup and assertions because load balancers
      # do not have a single global generation.
      require_topology :single, :replica_set, :sharded

      let(:connection) do
        pool.check_out.tap do |connection|
          expect(connection).to receive(:generation).at_least(:once).and_return(7)
          expect(connection).not_to receive(:record_checkin!)
        end
      end

      before do
        expect(connection.generation > pool.generation).to be true
      end

      it_behaves_like 'does not add connection to pool'
    end

    context 'interrupted connection' do
      let!(:connection) do
        pool.check_out.tap do |connection|
          expect(connection).to receive(:interrupted?).at_least(:once).and_return(true)
          expect(connection).not_to receive(:record_checkin!)
        end
      end

      it_behaves_like 'does not add connection to pool'
    end

    context 'closed and interrupted connection' do
      let!(:connection) do
        pool.check_out.tap do |connection|
          expect(connection).to receive(:interrupted?).exactly(:once).and_return(true)
          expect(connection).to receive(:closed?).exactly(:once).and_return(true)
          expect(connection).not_to receive(:record_checkin!)
          expect(connection).not_to receive(:disconnect!)
        end
      end

      it "returns immediately" do
        expect(pool.check_in(connection)).to be_nil
      end
    end

    context 'when pool is closed' do
      before do
        connection
        pool.close
      end

      it 'closes connection' do
        expect(connection.closed?).to be false
        expect(pool.instance_variable_get('@available_connections').length).to eq(0)
        pool.check_in(connection)
        expect(connection.closed?).to be true
        expect(pool.instance_variable_get('@available_connections').length).to eq(0)
      end
    end

    context 'when connection is checked in twice' do
      it 'raises an ArgumentError and does not change pool state' do
        pool.check_in(connection)
        expect do
          pool.check_in(connection)
        end.to raise_error(ArgumentError, /Trying to check in a connection which is not currently checked out by this pool.*/)
        expect(pool.size).to eq(1)
        expect(pool.check_out).to eq(connection)
      end
    end

    context 'when connection is checked in to a different pool' do
      it 'raises an ArgumentError and does not change the state of either pool' do
        pool_other = register_pool(described_class.new(server))

        expect do
          pool_other.check_in(connection)
        end.to raise_error(ArgumentError, /Trying to check in a connection which was not checked out by this pool.*/)
        expect(pool.size).to eq(1)
        expect(pool_other.size).to eq(0)
      end
    end
  end

  describe '#check_out' do
    let!(:pool) do
      server.pool
    end

    context 'when max_size is zero (unlimited)' do
      let(:options) do
        { max_size: 0 }
      end

      it 'checks out a connection' do
        expect do
          pool.check_out
        end.not_to raise_error
      end
    end

    context 'when a connection is checked out on a different thread' do

      let!(:connection) do
        Thread.new { pool.check_out }.join
      end

      it 'returns a new connection' do
        expect(pool.check_out.address).to eq(server.address)
      end

      it 'does not return the same connection instance' do
        expect(pool.check_out).to_not eql(connection)
      end
    end

    context 'when connections are checked out and checked back in' do

      it 'pulls the connection from the front of the queue' do
        first = pool.check_out
        second = pool.check_out
        pool.check_in(second)
        pool.check_in(first)
        expect(pool.check_out).to be(first)
      end
    end

    context 'when there is an available connection which is stale' do
      # These tests are also applicable to load balancers, but
      # require different setup and assertions because load balancers
      # do not have a single global generation.
      require_topology :single, :replica_set, :sharded

      let(:options) do
        { max_pool_size: 2, max_idle_time: 0.1 }
      end

      context 'when connection is not pinned' do
        let(:connection) do
          pool.check_out.tap do |connection|
            allow(connection).to receive(:generation).and_return(pool.generation)
            allow(connection).to receive(:record_checkin!).and_return(connection)
            expect(connection).to receive(:last_checkin).at_least(:once).and_return(Time.now - 10)
          end
        end

        before do
          pool.check_in(connection)
        end

        it 'closes stale connection and creates a new one' do
          expect(connection).to receive(:disconnect!)
          expect(Mongo::Server::Connection).to receive(:new).and_call_original
          pool.check_out
        end
      end

      context 'when connection is pinned' do
        let(:connection) do
          pool.check_out.tap do |connection|
            allow(connection).to receive(:generation).and_return(pool.generation)
            allow(connection).to receive(:record_checkin!).and_return(connection)
            expect(connection).to receive(:pinned?).and_return(true)
          end
        end

        before do
          pool.check_in(connection)
        end

        it 'does not close stale connection' do
          expect(connection).not_to receive(:disconnect!)
          pool.check_out
        end
      end

    end

    context 'when there are no available connections' do

      let(:options) do
        { max_pool_size: 1, min_pool_size: 0 }
      end

      context 'when the max size is not reached' do

        it 'creates a new connection' do
          expect(Mongo::Server::Connection).to receive(:new).once.and_call_original
          expect(pool.check_out).to be_a(Mongo::Server::Connection)
          expect(pool.size).to eq(1)
        end
      end

      context 'when the max size is reached' do

        context 'without service_id' do
          it 'raises a timeout error' do
            expect(Mongo::Server::Connection).to receive(:new).once.and_call_original
            pool.check_out
            expect {
              pool.check_out
            }.to raise_error(::Timeout::Error)
            expect(pool.size).to eq(1)
          end
        end

        context 'with connection_global_id' do
          require_topology :load_balanced

          let(:connection_global_id) do
            pool.with_connection do |connection|
              connection.global_id.should_not be nil
              connection.global_id
            end
          end

          it 'raises a timeout error' do
            expect(Mongo::Server::Connection).to receive(:new).once.and_call_original
            connection_global_id

            pool.check_out(connection_global_id: connection_global_id)

            expect {
              pool.check_out(connection_global_id: connection_global_id)
            }.to raise_error(Mongo::Error::ConnectionCheckOutTimeout)

            expect(pool.size).to eq(1)
          end

          it 'waits for the timeout' do
            expect(Mongo::Server::Connection).to receive(:new).once.and_call_original
            connection_global_id

            pool.check_out(connection_global_id: connection_global_id)

            start_time = Mongo::Utils.monotonic_time
            expect {
              pool.check_out(connection_global_id: connection_global_id)
            }.to raise_error(Mongo::Error::ConnectionCheckOutTimeout)
            elapsed_time = Mongo::Utils.monotonic_time - start_time

            elapsed_time.should > 1
          end
        end
      end
    end

    context 'when waiting for a connection to be checked in' do

      let!(:connection) { pool.check_out }

      before do
        allow(connection).to receive(:record_checkin!).and_return(connection)
        Thread.new do
          sleep(0.5)
          pool.check_in(connection)
        end.join
      end

      it 'returns the checked in connection' do
        expect(pool.check_out).to eq(connection)
      end
    end

    context 'when pool is closed' do
      before do
        pool.close
      end

      it 'raises PoolClosedError' do
        expect do
          pool.check_out
        end.to raise_error(Mongo::Error::PoolClosedError)
      end
    end

    context 'when connection set up throws an error during check out' do
      let(:client) do
        authorized_client
      end

      let(:pool) do
        client.cluster.next_primary.pool
      end

      before do
        pool.ready
      end

      it 'raises an error and emits ConnectionCheckOutFailedEvent' do
        pool

        subscriber = Mrss::EventSubscriber.new
        client.subscribe(Mongo::Monitoring::CONNECTION_POOL, subscriber)

        subscriber.clear_events!
        expect(Mongo::Auth).to receive(:get).at_least(:once).and_raise(Mongo::Error)
        expect { pool.check_out }.to raise_error(Mongo::Error)
        expect(pool.size).to eq(0)

         checkout_failed_events = subscriber.published_events.select do |event|
          event.is_a?(Mongo::Monitoring::Event::Cmap::ConnectionCheckOutFailed)
        end
        expect(checkout_failed_events.size).to eq(1)
        expect(checkout_failed_events.first.reason).to be(:connection_error)
      end

      context "when the error is caused by close" do
        let(:pool) { server.pool }
        let(:options) { { max_size: 1 } }

        it "raises an error and returns immediately" do
          expect(pool.max_size).to eq(1)
          Timeout::timeout(1) do
            c1 = pool.check_out
            thread = Thread.new do
              c2 = pool.check_out
            end

            sleep 0.1
            expect do
              pool.close
              thread.join
            end.to raise_error(Mongo::Error::PoolClosedError)
          end
        end
      end
    end

    context "when the pool is paused" do
      require_no_linting

      before do
        pool.pause
      end

      it "raises a PoolPausedError" do
        expect do
          pool.check_out
        end.to raise_error(Mongo::Error::PoolPausedError)
      end
    end
  end

  describe "#ready" do
    require_no_linting

    let(:pool) do
      register_pool(described_class.new(server, server_options))
    end

    context "when the pool is closed" do
      before do
        pool.close
      end

      it "raises an error" do
        expect do
          pool.ready
        end.to raise_error(Mongo::Error::PoolClosedError)
      end
    end

    context "when readying an initialized pool" do
      before do
        pool.ready
      end

      it "starts the populator" do
        expect(populator).to be_running
      end

      it "readies the pool" do
        expect(pool).to be_ready
      end
    end

    context "when readying a paused pool" do
      before do
        pool.ready
        pool.pause
      end

      it "readies the pool" do
        pool.ready
        expect(pool).to be_ready
      end

      it "signals the populate semaphore" do
        RSpec::Mocks.with_temporary_scope do
          expect(populate_semaphore).to receive(:signal).and_wrap_original do |m, *args|
            m.call(*args)
          end
          pool.ready
        end
      end
    end
  end

  describe "#ready?" do
    require_no_linting

    let(:pool) do
      register_pool(described_class.new(server, server_options))
    end

    shared_examples "pool is ready" do
      it "is ready" do
        expect(pool).to be_ready
      end
    end

    shared_examples "pool is not ready" do
      it "is not ready" do
        expect(pool).to_not be_ready
      end
    end

    context "before readying the pool" do
      it_behaves_like "pool is not ready"
    end

    context "after readying the pool" do
      before do
        pool.ready
      end

      it_behaves_like "pool is ready"
    end

    context "after readying and pausing the pool" do
      before do
        pool.ready
        pool.pause
      end

      it_behaves_like "pool is not ready"
    end

    context "after readying, pausing, and readying the pool" do
      before do
        pool.ready
        pool.pause
        pool.ready
      end

      it_behaves_like "pool is ready"
    end

    context "after closing the pool" do
      before do
        pool.ready
        pool.close
      end

      it_behaves_like "pool is not ready"
    end
  end

  describe "#pause" do
    require_no_linting

    let(:pool) do
      register_pool(described_class.new(server, server_options))
    end

    context "when the pool is closed" do
      before do
        pool.close
      end

      it "raises an error" do
        expect do
          pool.pause
        end.to raise_error(Mongo::Error::PoolClosedError)
      end
    end

    context "when the pool is paused" do
      before do
        pool.ready
        pool.pause
      end

      it "is still paused" do
        expect(pool).to be_paused
        pool.pause
        expect(pool).to be_paused
      end
    end

    context "when the pool is ready" do
      before do
        pool.ready
      end

      it "is still paused" do
        expect(pool).to be_ready
        pool.pause
        expect(pool).to be_paused
      end

      it "does not stop the populator" do
        expect(populator).to be_running
      end
    end
  end

  describe "#paused?" do
    require_no_linting

    let(:pool) do
      register_pool(described_class.new(server, server_options))
    end

    shared_examples "pool is paused" do
      it "is paused" do
        expect(pool).to be_paused
      end
    end

    shared_examples "pool is not paused" do
      it "is not paused" do
        expect(pool).to_not be_paused
      end
    end

    context "before readying the pool" do
      it_behaves_like "pool is paused"
    end

    context "after readying the pool" do
      before do
        pool.ready
      end

      it_behaves_like "pool is not paused"
    end

    context "after readying and pausing the pool" do
      before do
        pool.ready
        pool.pause
      end

      it_behaves_like "pool is paused"
    end

    context "after readying, pausing, and readying the pool" do
      before do
        pool.ready
        pool.pause
        pool.ready
      end

      it_behaves_like "pool is not paused"
    end

    context "after closing the pool" do
      before do
        pool.ready
        pool.close
      end

      it "raises an error" do
        expect do
          pool.paused?
        end.to raise_error(Mongo::Error::PoolClosedError)
      end
    end
  end

  describe "#closed?" do
    require_no_linting

    let(:pool) do
      register_pool(described_class.new(server, server_options))
    end

    shared_examples "pool is closed" do
      it "is closed" do
        expect(pool).to be_closed
      end
    end

    shared_examples "pool is not closed" do
      it "is not closed" do
        expect(pool).to_not be_closed
      end
    end

    context "before readying the pool" do
      it_behaves_like "pool is not closed"
    end

    context "after readying the pool" do
      before do
        pool.ready
      end

      it_behaves_like "pool is not closed"
    end

    context "after readying and pausing the pool" do
      before do
        pool.ready
        pool.pause
      end

      it_behaves_like "pool is not closed"
    end

    context "after closing the pool" do
      before do
        pool.ready
        pool.close
      end

      it_behaves_like "pool is closed"
    end
  end

  describe '#disconnect!' do

    context 'when pool is closed' do
      before do
        pool.close
      end

      it 'does nothing' do
        expect do
          pool.disconnect!
        end.not_to raise_error
      end
    end
  end

  describe '#clear' do
    let(:checked_out_connections) { pool.instance_variable_get(:@checked_out_connections) }
    let(:available_connections) { pool.instance_variable_get(:@available_connections) }
    let(:pending_connections) { pool.instance_variable_get(:@pending_connections) }
    let(:interrupt_connections) { pool.instance_variable_get(:@interrupt_connections) }

    def create_pool(min_pool_size)
      opts = SpecConfig.instance.test_options.merge(max_pool_size: 3, min_pool_size: min_pool_size)
      described_class.new(server, opts).tap do |pool|
        pool.ready
        # kill background thread to test disconnect behavior
        pool.stop_populator
        expect(pool.instance_variable_get('@populator').running?).to be false
        # make pool be of size 2 so that it has enqueued connections
        # when told to disconnect
        c1 = pool.check_out
        c2 = pool.check_out
        allow(c1).to receive(:record_checkin!).and_return(c1)
        allow(c2).to receive(:record_checkin!).and_return(c2)
        pool.check_in(c1)
        pool.check_in(c2)
        expect(pool.size).to eq(2)
        expect(pool.available_count).to eq(2)
      end
    end

    shared_examples_for 'disconnects and removes all connections in the pool and bumps generation' do
      # These tests are also applicable to load balancers, but
      # require different setup and assertions because load balancers
      # do not have a single global generation.
      require_topology :single, :replica_set, :sharded
      require_no_linting

      it 'disconnects and removes and bumps' do
        old_connections = []
        pool.instance_variable_get('@available_connections').each do |connection|
          expect(connection).to receive(:disconnect!)
          old_connections << connection
        end

        expect(pool.size).to eq(2)
        expect(pool.available_count).to eq(2)

        RSpec::Mocks.with_temporary_scope do
          allow(pool.server).to receive(:unknown?).and_return(true)
          pool.disconnect!
        end

        expect(pool.size).to eq(0)
        expect(pool.available_count).to eq(0)
        expect(pool).to be_paused

        pool.ready

        new_connection = pool.check_out
        expect(old_connections).not_to include(new_connection)
        expect(new_connection.generation).to eq(2)
      end
    end

    context 'min size is 0' do
      let(:pool) do
        register_pool(create_pool(0))
      end

      it_behaves_like 'disconnects and removes all connections in the pool and bumps generation'
    end

    context 'min size is not 0' do
      let(:pool) do
        register_pool(create_pool(1))
      end

      it_behaves_like 'disconnects and removes all connections in the pool and bumps generation'
    end

    context 'when pool is closed' do
      before do
        pool.close
      end

      it 'raises PoolClosedError' do
        expect do
          pool.clear
        end.to raise_error(Mongo::Error::PoolClosedError)
      end
    end

    context "when interrupting in use connections" do
      context "when there's checked out connections" do
        require_topology :single, :replica_set, :sharded
        require_no_linting

        before do
          3.times { pool.check_out }
          connection = pool.check_out
          pool.check_in(connection)
          expect(checked_out_connections.length).to eq(3)
          expect(available_connections.length).to eq(1)

          pending_connections << pool.send(:create_connection)
        end

        it "interrupts the connections" do
          expect(pool).to receive(:populate).exactly(3).and_call_original
          RSpec::Mocks.with_temporary_scope do
            allow(pool.server).to receive(:unknown?).and_return(true)
            pool.clear(lazy: true, interrupt_in_use_connections: true)
          end

          ::Utils.wait_for_condition(3) do
            pool.size == 0
          end

          expect(pool.size).to eq(0)
          expect(available_connections).to be_empty
          expect(checked_out_connections).to be_empty
          expect(pending_connections).to be_empty
        end
      end
    end

    context "when in load-balanced mode" do
      require_topology :load_balanced

      it "does not pause the pool" do
        allow(pool.server).to receive(:unknown?).and_return(true)
        pool.clear
        expect(pool).to_not be_paused
      end
    end
  end

  describe '#close' do
    context 'when pool is not closed' do
      it 'closes the pool' do
        expect(pool).not_to be_closed

        pool.close

        expect(pool).to be_closed
      end
    end

    context 'when pool is closed' do
      before do
        pool.close
      end

      it 'is a no-op' do
        pool.close
        expect(pool).to be_closed
      end
    end

    it 'closes all pipes' do
      expect(pool.generation_manager).to receive(:close_all_pipes).and_call_original
      pool.close
    end
  end

  describe '#inspect' do
    let(:options) do
      { min_pool_size: 3, max_pool_size: 7, wait_timeout: 9, wait_queue_timeout: 9 }
    end

    let!(:pool) do
      server.pool
    end

    after do
      server.close
      pool.close # this will no longer be needed after server close kills bg thread
    end

    it 'includes the object id' do
      expect(pool.inspect).to include(pool.object_id.to_s)
    end

    it 'includes the min size' do
      expect(pool.inspect).to include('min_size=3')
    end

    it 'includes the max size' do
      expect(pool.inspect).to include('max_size=7')
    end

    it 'includes the wait timeout' do
      expect(pool.inspect).to include('wait_timeout=9')
    end

    it 'includes the current size' do
      expect(pool.inspect).to include('current_size=')
    end

=begin obsolete
    it 'includes the queue inspection' do
      expect(pool.inspect).to include(pool.__send__(:queue).inspect)
    end
=end

    it 'indicates the pool is not closed' do
      expect(pool.inspect).not_to include('closed')
    end

    context 'when pool is closed' do
      before do
        pool.close
      end

      it 'returns inspection string' do
        expect(pool.inspect).to include('min_size=')
      end

      it 'indicates the pool is closed' do
        expect(pool.inspect).to include('closed')
      end
    end
  end

  describe '#with_connection' do
    let!(:pool) do
      server.pool
    end

    context 'when a connection cannot be checked out' do

      it 'does not add the connection to the pool' do
        # fails because with_connection raises the SocketError which is not caught anywhere
        allow(pool).to receive(:check_out).and_raise(Mongo::Error::SocketError)
        expect do
          pool.with_connection { |c| c }
        end.to raise_error(Mongo::Error::SocketError)

        expect(pool.size).to eq(0)
      end
    end

    context 'when pool is closed' do
      before do
        pool.close
      end

      it 'raises PoolClosedError' do
        expect do
          pool.with_connection { |c| c }
        end.to raise_error(Mongo::Error::PoolClosedError)
      end
    end
  end

  describe '#close_idle_sockets' do
    let!(:pool) do
      server.pool
    end

    context 'when there is a max_idle_time specified' do

      let(:options) do
        { max_pool_size: 2, max_idle_time: 0.5 }
      end

      after do
        Timecop.return
      end

=begin obsolete
      context 'when the connections have not been checked out' do

        before do
          queue.each do |conn|
            expect(conn).not_to receive(:disconnect!)
          end
          sleep(0.5)
          pool.close_idle_sockets
        end

        it 'does not close any sockets' do
          expect(queue.none? { |c| c.connected? }).to be(true)
        end
      end
=end

      context 'when connections have been checked out and returned to the pool' do

        context 'when min size is 0' do

          let(:options) do
            { max_pool_size: 2, min_pool_size: 0, max_idle_time: 0.5 }
          end

          before do
            c1 = pool.check_out
            c2 = pool.check_out
            pool.check_in(c1)
            pool.check_in(c2)
            sleep(0.5)
            expect(c1).to receive(:disconnect!).and_call_original
            expect(c2).to receive(:disconnect!).and_call_original
            pool.close_idle_sockets
          end

          it 'closes all idle sockets' do
            expect(pool.size).to be(0)
          end
        end

        context 'when min size is > 0' do
          before do
            # Kill background thread to test close_idle_socket behavior
            pool.stop_populator
            expect(pool.instance_variable_get('@populator').running?).to be false
          end

          context 'when more than the number of min_size are checked out' do
            let(:options) do
              { max_pool_size: 5, min_pool_size: 3, max_idle_time: 0.5 }
            end

            it 'closes and removes connections with idle sockets and does not connect new ones' do
              first = pool.check_out
              second = pool.check_out
              third = pool.check_out
              fourth = pool.check_out
              fifth = pool.check_out

              pool.check_in(fifth)

              expect(fifth).to receive(:disconnect!).and_call_original
              expect(fifth).not_to receive(:connect!)

              Timecop.travel(Time.now + 1)
              expect(pool.size).to be(5)
              expect(pool.available_count).to be(1)
              pool.close_idle_sockets

              expect(pool.size).to be(4)
              expect(pool.available_count).to be(0)
              expect(fifth.connected?).to be(false)
            end
          end

          context 'when between 0 and min_size number of connections are checked out' do

            let(:options) do
              { max_pool_size: 5, min_pool_size: 3, max_idle_time: 0.5 }
            end

            it 'closes and removes connections with idle sockets and does not connect new ones' do
              first = pool.check_out
              second = pool.check_out
              third = pool.check_out
              fourth = pool.check_out
              fifth = pool.check_out

              pool.check_in(third)
              pool.check_in(fourth)
              pool.check_in(fifth)


              expect(third).to receive(:disconnect!).and_call_original
              expect(third).not_to receive(:connect!)

              expect(fourth).to receive(:disconnect!).and_call_original
              expect(fourth).not_to receive(:connect!)

              expect(fifth).to receive(:disconnect!).and_call_original
              expect(fifth).not_to receive(:connect!).and_call_original

              Timecop.travel(Time.now + 1)
              expect(pool.size).to be(5)
              expect(pool.available_count).to be(3)
              pool.close_idle_sockets

              expect(pool.size).to be(2)
              expect(pool.available_count).to be(0)

              expect(third.connected?).to be(false)
              expect(fourth.connected?).to be(false)
              expect(fifth.connected?).to be(false)
            end
          end
        end
      end
    end

    context 'when available connections include idle and non-idle ones' do
      let (:options) do
        { max_pool_size: 2, max_idle_time: 0.5 }
      end

      let(:connection) do
        pool.check_out.tap do |con|
          allow(con).to receive(:disconnect!)
        end
      end

      it 'disconnects all expired and only expired connections' do
        # Since per-test cleanup will close the pool and disconnect
        # the connection, we need to explicitly define the scope for the
        # assertions
        RSpec::Mocks.with_temporary_scope do
          c1 = pool.check_out
          expect(c1).to receive(:disconnect!)
          c2 = pool.check_out
          expect(c2).not_to receive(:disconnect!)

          pool.check_in(c1)
          Timecop.travel(Time.now + 1)
          pool.check_in(c2)

          expect(pool.size).to eq(2)
          expect(pool.available_count).to eq(2)

          expect(c1).not_to receive(:connect!)
          expect(c2).not_to receive(:connect!)

          pool.close_idle_sockets

          expect(pool.size).to eq(1)
          expect(pool.available_count).to eq(1)
        end
      end
    end

    context 'when there is no max_idle_time specified' do

      let(:connection) do
        conn = pool.check_out
        conn.connect!
        pool.check_in(conn)
        conn
      end

      it 'does not close any sockets' do
        # Since per-test cleanup will close the pool and disconnect
        # the connection, we need to explicitly define the scope for the
        # assertions
        RSpec::Mocks.with_temporary_scope do
          expect(connection).not_to receive(:disconnect!)
          pool.close_idle_sockets
          expect(connection.connected?).to be(true)
        end
      end
    end
  end

  describe '#populate' do
    require_no_linting

    before do
      # Disable the populator and clear the pool to isolate populate behavior
      pool.stop_populator
      pool.disconnect!
      # Manually mark the pool ready.
      pool.instance_variable_set('@ready', true)
    end

    let(:options) { {min_pool_size: 2, max_pool_size: 3} }

    context 'when pool size is at least min_pool_size' do

      before do
        first_connection = pool.check_out
        second_connection = pool.check_out
        expect(pool.size).to eq 2
        expect(pool.available_count).to eq 0
      end

      it 'does not create a connection and returns false' do
        expect(pool.populate).to be false
        expect(pool.size).to eq 2
        expect(pool.available_count).to eq 0
      end
    end

    context 'when pool size is less than min_pool_size' do
      before do
        first_connection = pool.check_out
        expect(pool.size).to eq 1
        expect(pool.available_count).to eq 0
      end

      it 'creates one connection, connects it, and returns true' do
        expect(pool.populate).to be true
        expect(pool.size).to eq 2
        expect(pool.available_count).to eq 1
      end
    end

    context 'when pool is closed' do
      before do
        pool.close
      end

      it 'does not create a connection and returns false' do
        expect(pool.populate).to be false

        # Can't just check pool size; size errors when pool is closed
        expect(pool.instance_variable_get('@available_connections').length).to eq(0)
        expect(pool.instance_variable_get('@checked_out_connections').length).to eq(0)
        expect(pool.instance_variable_get('@pending_connections').length).to eq(0)
      end
    end

    context 'when connect fails with socket related error once' do
      before do
        i = 0
        expect(pool).to receive(:connect_connection).exactly(:twice).and_wrap_original{ |m, *args|
          i += 1
          if i == 1
            raise Mongo::Error::SocketError
          else
            m.call(*args)
          end
        }
        expect(pool.size).to eq 0
      end

      it 'retries then succeeds in creating a connection' do
        expect(pool.populate).to be true
        expect(pool.size).to eq 1
        expect(pool.available_count).to eq 1
      end
    end

    context 'when connect fails with socket related error twice' do
      before do
        expect(pool).to receive(:connect_connection).exactly(:twice).and_raise(Mongo::Error::SocketError)
        expect(pool.size).to eq 0
      end

      it 'retries, raises the second error, and fails to create a connection' do
        expect{ pool.populate }.to raise_error(Mongo::Error::SocketError)
        expect(pool.size).to eq 0
      end
    end

    context 'when connect fails with non socket related error' do
      before do
        expect(pool).to receive(:connect_connection).once.and_raise(Mongo::Auth::InvalidMechanism.new(""))
        expect(pool.size).to eq 0
      end

      it 'does not retry, raises the error, and fails to create a connection' do
        expect{ pool.populate }.to raise_error(Mongo::Auth::InvalidMechanism)
        expect(pool.size).to eq 0
      end
    end
  end
end
