Class: UniversalRenderer::Client::Stream

Inherits:
Object
  • Object
show all
Defined in:
lib/universal_renderer/client/stream.rb,
lib/universal_renderer/client/stream/setup.rb,
lib/universal_renderer/client/stream/execution.rb,
lib/universal_renderer/client/stream/error_logger.rb

Defined Under Namespace

Modules: ErrorLogger, Execution, Setup

Class Method Summary collapse

Class Method Details

.call(url, props, template, response) ⇒ Boolean

Orchestrates the streaming process for server-side rendering.

Parameters:

  • url (String) —

    The URL of the page to render.

  • props (Hash) —

    Data to be passed for rendering, including layout HTML.

  • template (String) —

    The HTML template to use for rendering.

  • response (ActionDispatch::Response) —

    The Rails response object to stream to.

Returns:

  • (Boolean) —

    True if streaming was initiated, false otherwise.



20
21
22
23
24
25
26
 
# File 'lib/universal_renderer/client/stream.rb', line 20

def self.call(url, props, template, response)
  Instrumentation.instrument(url: url, mode: :streaming) do |event|
    succeeded = perform(url, props, template, response, event)
    event[:outcome] = :error if !succeeded && event[:outcome] == :ok
    succeeded
  end
end

.perform(url, props, template, response, event = {}) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/universal_renderer/client/stream.rb', line 28

def self.perform(url, props, template, response, event = {})
  initialize_event(event, url)

  config = UniversalRenderer.config

  unless Setup.ensure_ssr_server_url_configured?(config)
    event[:outcome] = :not_configured
    UniversalRenderer.log do |log|
      log.warn(
        "Stream: SSR URL (config.url) is not configured. Falling back."
      )
    end
    return false
  end

  stream_uri_obj = nil
  full_ssr_url_for_log = config.url.to_s # For logging in case of early error

  begin
    body = { url: url, props: props, template: template }

    actual_stream_uri, http_client, http_post_request =
      Setup.build_stream_request_components(body, config)

    stream_uri_obj = actual_stream_uri

    full_ssr_url_for_log = actual_stream_uri.to_s # Update for more specific logging
  rescue URI::InvalidURIError => e
    event[:outcome] = :error
    event[:error] = e
    ErrorLogger.log_setup_error(e, config.url.to_s, event)
    return false
  rescue StandardError => e
    event[:outcome] = :error
    event[:error] = e
    ErrorLogger.log_setup_error(e, full_ssr_url_for_log, event)
    return false
  end

  Execution.perform_streaming(
    http_client,
    http_post_request,
    response,
    stream_uri_obj
  ) do |error, details|
    event.merge!(details)
    event[:error] = error
    Instrumentation.report(
      error,
      event.merge(target: stream_uri_obj.to_s)
    )
  end
rescue Errno::ECONNREFUSED,
       Errno::EHOSTUNREACH,
       Net::OpenTimeout,
       Net::ReadTimeout,
       SocketError,
       IOError => e
  uri_str_for_conn_error =
    stream_uri_obj ? stream_uri_obj.to_s : full_ssr_url_for_log

  event[:outcome] = failure_outcome(e)
  event[:error] = e
  ErrorLogger.log_connection_error(e, uri_str_for_conn_error, event)

  false
rescue StandardError => e
  uri_str_for_unexpected_error =
    stream_uri_obj ? stream_uri_obj.to_s : full_ssr_url_for_log

  event[:outcome] = :error
  event[:error] = e
  ErrorLogger.log_unexpected_error(
    e,
    uri_str_for_unexpected_error,
    "Stream: Unexpected error during SSR stream process",
    event
  )

  false
end