Module: ActionController::Live

Extended by:
ActiveSupport::Concern
Defined in:
lib/action_controller/metal/live.rb,
lib/action_controller/test_case.rb

Overview

Mix this module into your controller, and all actions in that controller will be able to stream data to the client as it's written.

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

There are a few caveats with this module. You cannot write headers after the response has been committed (Response#committed? will return truthy). Calling write or close on the response stream will cause the response object to be committed. Make sure all headers are set before calling write or close on your stream.

You must call close on your stream when you're finished, otherwise the socket may be left open forever.

The final caveat is that your actions are executed in a separate thread than the main thread. Make sure your actions are thread safe, and this shouldn't be a problem (don't share state across threads, etc).

Defined Under Namespace

Modules: ClassMethods Classes: Buffer, ClientDisconnected, Response, SSE

Instance Method Summary collapse

Instance Method Details

#log_error(exception) ⇒ Object



295
296
297
298
299
300
301
302
303
304
305
# File 'lib/action_controller/metal/live.rb', line 295

def log_error(exception)
  logger = ActionController::Base.logger
  return unless logger

  logger.fatal do
    message = "\n#{exception.class} (#{exception.message}):\n".dup
    message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
    message << "  " << exception.backtrace.join("\n  ")
    "#{message}\n\n"
  end
end

#new_controller_threadObject

Spawn a new thread to serve up the controller in. This is to get around the fact that Rack isn't based around IOs and we need to use a thread to stream data from the response bodies. Nobody should call this method except in Rails internals. Seriously!



24
25
26
# File 'lib/action_controller/test_case.rb', line 24

def new_controller_thread # :nodoc:
  yield
end

#process(name) ⇒ Object



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'lib/action_controller/metal/live.rb', line 238

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) ⇒ Object



307
308
309
310
# File 'lib/action_controller/metal/live.rb', line 307

def response_body=(body)
  super
  response.close if response
end