path: root/actionpack/test/dispatch/reloader_test.rb

require "abstract_unit"

class ReloaderTest < ActiveSupport::TestCase
  Reloader = ActionDispatch::Reloader

  teardown do
    ActiveSupport::Reloader.reset_callbacks :prepare
    ActiveSupport::Reloader.reset_callbacks :complete
  end

  def test_prepare_callbacks
    a = b = c = nil
    assert_deprecated do
      Reloader.to_prepare { |*args| a = b = c = 1 }
      Reloader.to_prepare { |*args| b = c = 2 }
      Reloader.to_prepare { |*args| c = 3 }
    end

    # Ensure to_prepare callbacks are not run when defined
    assert_nil a || b || c

    # Run callbacks
    call_and_return_body

    assert_equal 1, a
    assert_equal 2, b
    assert_equal 3, c
  end

  class MyBody < Array
    def initialize(&block)
      @on_close = block
    end

    def foo
      "foo"
    end

    def bar
      "bar"
    end

    def close
      @on_close.call if @on_close
    end
  end

  def test_returned_body_object_always_responds_to_close
    body = call_and_return_body
    assert_respond_to body, :close
  end

  def test_returned_body_object_always_responds_to_close_even_if_called_twice
    body = call_and_return_body
    assert_respond_to body, :close
    body.close

    body = call_and_return_body
    assert_respond_to body, :close
    body.close
  end

  def test_condition_specifies_when_to_reload
    i, j = 0, 0, 0, 0
    assert_deprecated do
      Reloader.to_prepare { |*args| i += 1 }
      Reloader.to_cleanup { |*args| j += 1 }
    end

    x = Class.new(ActiveSupport::Reloader)
    x.check = lambda { i < 3 }

    app = Reloader.new(lambda { |env| [200, {}, []] }, x)
    5.times do
      resp = app.call({})
      resp[2].close
    end
    assert_equal 3, i
    assert_equal 3, j
  end

  def test_returned_body_object_behaves_like_underlying_object
    body = call_and_return_body do
      b = MyBody.new
      b << "hello"
      b << "world"
      [200, { "Content-Type" => "text/html" }, b]
    end
    assert_equal 2, body.size
    assert_equal "hello", body[0]
    assert_equal "world", body[1]
    assert_equal "foo", body.foo
    assert_equal "bar", body.bar
  end

  def test_it_calls_close_on_underlying_object_when_close_is_called_on_body
    close_called = false
    body = call_and_return_body do
      b = MyBody.new do
        close_called = true
      end
      [200, { "Content-Type" => "text/html" }, b]
    end
    body.close
    assert close_called
  end

  def test_returned_body_object_responds_to_all_methods_supported_by_underlying_object
    body = call_and_return_body do
      [200, { "Content-Type" => "text/html" }, MyBody.new]
    end
    assert_respond_to body, :size
    assert_respond_to body, :each
    assert_respond_to body, :foo
    assert_respond_to body, :bar
  end

  def test_cleanup_callbacks_are_called_when_body_is_closed
    cleaned = false
    assert_deprecated do
      Reloader.to_cleanup { cleaned = true }
    end

    body = call_and_return_body
    assert !cleaned

    body.close
    assert cleaned
  end

  def test_prepare_callbacks_arent_called_when_body_is_closed
    prepared = false
    assert_deprecated do
      Reloader.to_prepare { prepared = true }
    end

    body = call_and_return_body
    prepared = false

    body.close
    assert !prepared
  end

  def test_manual_reloading
    prepared = cleaned = false
    assert_deprecated do
      Reloader.to_prepare { prepared = true }
      Reloader.to_cleanup { cleaned  = true }
    end

    assert_deprecated do
      Reloader.prepare!
    end
    assert prepared
    assert !cleaned

    prepared = cleaned = false
    assert_deprecated do
      Reloader.cleanup!
    end
    assert prepared
    assert cleaned
  end

  def test_prepend_prepare_callback
    i = 10
    assert_deprecated do
      Reloader.to_prepare { i += 1 }
      Reloader.to_prepare(prepend: true) { i = 0 }
    end

    assert_deprecated do
      Reloader.prepare!
    end
    assert_equal 1, i
  end

  def test_cleanup_callbacks_are_called_on_exceptions
    cleaned = false
    assert_deprecated do
      Reloader.to_cleanup { cleaned  = true }
    end

    begin
      call_and_return_body do
        raise "error"
      end
    rescue
    end

    assert cleaned
  end

  private
    def call_and_return_body(&block)
      x = Class.new(ActiveSupport::Reloader)
      x.check = lambda { true }

      @response ||= "response"
      @reloader ||= Reloader.new(block || proc {[200, {}, @response]}, x)
      @reloader.call("rack.input" => StringIO.new(""))[2]
    end
end