модуль ActionController::Live

Смешайте этот модуль в свой контроллер, и все действия в этом контроллере смогут передавать данные клиенту по мере их записи.

class MyController < ActionController::Base
  include ActionController::Live

  def stream
    response.headers['Content-Type'] = 'text/event-stream'
    100.times {
      response.stream.write "hello world\n"
      sleep 1
    }
  ensure
    response.stream.close
  end
end

Есть несколько ограничений в использовании этого модуля. Вы не можете записывать заголовки после того, как ответ был подтвержден (Response#committed? вернёт значение, отличное от false). Вызов write или close на потоке ответа приведет к подтверждению объекта ответа. Убедитесь, что все заголовки установлены до вызова write или close на вашем потоке.

Вы обязаны вызвать close на вашем потоке, когда вы закончите, в противном случае сокет может остаться открытым навсегда.

Последнее ограничение заключается в том, что ваши действия выполняются в отдельном потоке, отличном от основного. Убедитесь, что ваши действия потокобезопасны, и это не должно быть проблемой (не используйте общие данные между потоками и т.д).

Публичные методы экземпляра

process(name) Показать исходный код

# File actionpack/lib/action_controller/metal/live.rb, line 249
def process(name)
  t1 = Thread.current
  locals = t1.keys.map { |key| [key, t1[key]] }

  error = nil
  # This processes the action in a child thread. It lets us return the
  # response code and headers back up the Rack stack, and still process
  # the body in parallel with sending data to the client.
  new_controller_thread {
    ActiveSupport::Dependencies.interlock.running do
      t2 = Thread.current

      # Since we're processing the view in a different thread, copy the
      # thread locals from the main thread to the child thread. :'(
      locals.each { |k, v| t2[k] = v }

      begin
        super(name)
      rescue => e
        if @_response.committed?
          begin
            @_response.stream.write(ActionView::Base.streaming_completion_on_exception) if request.format == :html
            @_response.stream.call_on_error
          rescue => exception
            log_error(exception)
          ensure
            log_error(e)
            @_response.stream.close
          end
        else
          error = e
        end
      ensure
        @_response.commit!
      end
    end
  }

  ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
    @_response.await_commit
  end

  raise error if error
end

Вызывает метод суперкласса

response_body=(body) Показать исходный код

# File actionpack/lib/action_controller/metal/live.rb, line 294
def response_body=(body)
  super
  response.close if response
end

Вызывает метод суперкласса

send_stream(filename:, disposition: "attachment", type: nil) { |stream| ... } Показать исходный код

# File actionpack/lib/action_controller/metal/live.rb, line 320
def send_stream(filename:, disposition: "attachment", type: nil)
  response.headers["Content-Type"] =
    (type.is_a?(Symbol) ? Mime[type].to_s : type) ||
    Mime::Type.lookup_by_extension(File.extname(filename).downcase.delete(".")) ||
    "application/octet-stream"

  response.headers["Content-Disposition"] =
    ActionDispatch::Http::ContentDisposition.format(disposition: disposition, filename: filename)

  yield response.stream
ensure
  response.stream.close
end

Отправляет поток в браузер, что полезно при генерации экспортов или других динамических данных, где вам не нужно буферизовать весь файл в памяти сразу. Аналогично send_data, но данные генерируются в реальном времени.

Параметры:

:filename — предлагает имя файла для использования браузером.
:type — указывает тип содержимого HTTP. Вы можете указать строку или символ для зарегистрированного типа с Mime::Type.register, например :json. Если опущено, тип будет определён из расширения файла, указанного в :filename. Если для расширения не зарегистрирован тип содержимого, будет использоваться тип по умолчанию 'application/octet-stream'.
:disposition — указывает, будет ли файл отображаться встроенным или скачиваться. Допустимые значения — 'inline' и 'attachment' (по умолчанию).

Пример генерации CSV-экспорта:

send_stream(filename: "subscribers.csv") do |stream|
  stream.write "email_address,updated_at\n"

  @subscribers.find_each do |subscriber|
    stream.write "#{subscriber.email_address},#{subscriber.updated_at}\n"
  end
end