Module: Upkeep::Rails::ActionViewCapture

Defined in:
lib/upkeep/rails/action_view_capture.rb

Defined Under Namespace

Modules: CollectionRendererHook, TemplateHook, TurboFrameHelperHook, ViewHelpers Classes: RefusedCollection

Constant Summary collapse

FRAME_STACK_KEY = 
:upkeep_rails_frame_stack
RENDER_SITE_STACK_KEY = 
:upkeep_rails_render_site_stack
MANIFEST_PARSE_OPTIONS = 
HerbSupport::TemplateManifest::DEFAULT_PARSE_OPTIONS.merge(
  transform_conditionals: false
).freeze
REPLAY_HTTP_ENV_KEYS = 
%w[
  HTTP_ACCEPT
  HTTP_HOST
  HTTP_X_FORWARDED_HOST
  HTTP_X_FORWARDED_PROTO
].freeze
REQUEST_REPLAY_ENV_KEYS = 
{
  "host" => "HTTP_HOST",
  "request_method" => "REQUEST_METHOD",
  "user_agent" => "HTTP_USER_AGENT",
  "remote_ip" => "REMOTE_ADDR"
}.freeze

Class Method Summary collapse

Class Method Details

.active_record_relation?(value) ⇒ Boolean

Returns:

  • (Boolean) 


771
772
773
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 771

def active_record_relation?(value)
  value.respond_to?(:klass) && value.respond_to?(:to_sql)
end

.analyze_relation_for_snapshot(value) ⇒ Object 



811
812
813
814
815
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 811

def analyze_relation_for_snapshot(value)
  ActiveRecordQuery.analyze(value)
rescue ActiveRecordQuery::OpaqueRelationError => error
  handle_refused_collection(error)
end

.capture_collection(partial, collection, rendered_collection, context, options, block, collection_analysis: nil) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 95

def capture_collection(partial, collection, rendered_collection, context, options, block, collection_analysis: nil)
  # No active capture (e.g. a request that opted out via upkeep_reactive_request?):
  # render the collection normally without building dependencies or replay
  # snapshots, which would otherwise analyze and refuse an opaque relation on a
  # page that is deliberately not reactive.
  return yield unless Runtime::Observation.recording?

  render_site = current_render_site
  unless render_site
    record_collection_dependency(collection, collection_analysis: collection_analysis)
    return yield
  end

  captured_options = render_options_for_replay(options)
  metadata = collection_metadata(partial, collection, render_site: render_site)
  frame_id = "site:#{metadata.fetch(:site_id)}"
  recipe = collection_recipe(
    frame_id: frame_id,
    partial: partial,
    collection: collection,
    rendered_collection: rendered_collection,
    context: context,
    controller: controller_for_view(context),
    options: captured_options,
    metadata: metadata,
    block: block,
    collection_analysis: collection_analysis
  )

  Runtime::Observation.capture_frame(frame_id, metadata.merge(recipe: recipe)) do
    record_collection_dependency(collection, collection_analysis: collection_analysis)
    yield
  end
end

.capture_template(template, view, locals, implicit_locals:, add_to_stack:, block:) ⇒ Object 



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
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 58

def capture_template(template, view, locals, implicit_locals:, add_to_stack:, block:)
  instrument_template_source!(template)
  unless Runtime::Observation.recording?
    return yield unless template.identifier.to_s.end_with?(".erb")

    metadata = template_static_metadata(template)
    frame_id = frame_id_for_template(metadata, locals)
    return with_frame_id(frame_id) { yield }
  end

  captured_locals = locals.dup
  metadata = template_metadata(template, captured_locals)
  controller = controller_for_view(view)
  page_controller = controller if metadata.fetch(:kind) == "page"
  metadata = metadata.merge(controller: controller_metadata(page_controller)) if page_controller
  frame_id = frame_id_for_template(metadata, captured_locals)
  recipe = if page_controller
    controller_page_recipe(frame_id: frame_id, controller: page_controller, metadata: metadata)
  else
    template_recipe(
      frame_id: frame_id,
      template: template,
      view: view,
      controller: controller,
      locals: captured_locals,
      metadata: metadata,
      implicit_locals: implicit_locals,
      add_to_stack: add_to_stack,
      block: block
    )
  end

  Runtime::Observation.capture_frame(frame_id, metadata.merge(recipe: recipe)) do
    with_frame_id(frame_id) { yield }
  end
end

.capture_turbo_frame(view, target_id) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 130

def capture_turbo_frame(view, target_id)
  return yield unless Runtime::Observation.recording?

  frame_id = "turbo_frame:#{target_id}"
  controller = controller_for_view(view)
  metadata = {
    kind: "turbo_frame",
    target_id: target_id.to_s
  }
  metadata[:controller] = controller_metadata(controller) if controller
  recipe = turbo_frame_recipe(frame_id: frame_id, target_id: target_id, controller: controller)

  Runtime::Observation.capture_frame(frame_id, metadata.merge(recipe: recipe).compact) { yield }
end

.collect_response_body(body) ⇒ Object 



447
448
449
450
451
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 447

def collect_response_body(body)
  body.each.to_a.join
ensure
  body.close if body.respond_to?(:close)
end

.collection_analysis(collection) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 171

def collection_analysis(collection)
  # Only analyze rendered collections during an active capture. Outside a capture
  # (e.g. a request that opted out via upkeep_reactive_request?) there is no
  # dependency to build, and analyzing would refuse/raise on an opaque relation
  # that the page deliberately keeps non-reactive.
  return unless Runtime::Observation.recording?

  provenance = Runtime::Observation.relation_provenance_for(collection)
  return provenance if provenance
  return unless active_record_relation?(collection)

  ActiveRecordQuery.analyze(collection)
rescue ActiveRecordQuery::OpaqueRelationError => error
  handle_refused_collection(error)
end

.collection_capture_pair(collection) ⇒ Object 



187
188
189
190
191
192
193
194
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 187

def collection_capture_pair(collection)
  if active_record_relation?(collection)
    rendered_collection = Runtime::RelationObserver.suppress_dependency_tracking { collection.to_a }
    [collection, rendered_collection]
  else
    [collection, collection]
  end
end

.collection_key(collection) ⇒ Object 



873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 873

def collection_key(collection)
  provenance = Runtime::Observation.relation_provenance_for(collection)
  if provenance
    {
      table: provenance.primary_table,
      predicate_digest: Digest::SHA256.hexdigest(provenance.sql)[0, 16],
      materialized: true
    }
  elsif collection.respond_to?(:klass) && collection.respond_to?(:to_sql)
    {
      table: collection.klass.table_name,
      predicate_digest: Digest::SHA256.hexdigest(collection.to_sql)[0, 16]
    }
  elsif collection.respond_to?(:to_ary)
    { class: collection.class.name, size: collection.to_ary.size }
  else
    { class: collection.class.name }
  end
end

.collection_metadata(partial, collection, render_site: nil) ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 200

def collection_metadata(partial, collection, render_site: nil)
  collection_key = collection_key(collection)
  site_id = render_site.fetch(:site_id)

  {
    kind: "render_site",
    site_id: site_id,
    partial: partial.to_s,
    collection: collection_key
  }.merge(manifest_metadata(render_site))
end

.collection_recipe(frame_id:, partial:, collection:, rendered_collection:, context:, controller:, options:, metadata:, block:, collection_analysis: nil) ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 278

def collection_recipe(frame_id:, partial:, collection:, rendered_collection:, context:, controller:, options:, metadata:, block:, collection_analysis: nil)
  ::Upkeep::Replay::Recipe.new(
    kind: :render_site,
    frame_id: frame_id,
    target_kind: "render_site",
    target_id: metadata.fetch(:site_id),
    metadata: metadata,
    runtime: "rails",
    replay: ::Upkeep::Replay::Collection.new(
      controller_class: controller&.class&.name,
      partial: partial == :derived ? "derived" : partial.to_s,
      collection: snapshot_value(collection, rendered_collection: rendered_collection, relation_analysis: collection_analysis),
      options: snapshot_render_options(options)
    )
  ) do
    replay_collection = replay_collection_value(collection, collection_analysis)

    if partial == :derived
      context.render(replay_collection, &block)
    else
      replay_options = replay_render_options(options)
      replay_options[:partial] = partial
      replay_options[:collection] = replay_collection
      context.render(replay_options, &block)
    end
  end
end

.constantize(name) ⇒ Object 



893
894
895
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 893

def constantize(name)
  name.to_s.split("::").reject(&:empty?).reduce(Object) { |scope, const_name| scope.const_get(const_name) }
end

.controller_for_view(view) ⇒ Object 



306
307
308
309
310
311
312
313
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 306

def controller_for_view(view)
  return unless view.respond_to?(:controller)

  controller = view.controller
  return unless controller&.respond_to?(:request) && controller.respond_to?(:action_name)

  controller
end

.controller_metadata(controller) ⇒ Object 



315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 315

def controller_metadata(controller)
  request = controller.request
  {
    class: controller.class.name,
    action: controller.action_name,
    request_method: request.env["REQUEST_METHOD"].to_s,
    path: request.env["PATH_INFO"].to_s,
    query_string_digest: Digest::SHA256.hexdigest(request.env["QUERY_STRING"].to_s)[0, 16],
    path_parameters: request.path_parameters.keys.map(&:to_s).sort
  }
end

.controller_page_recipe(frame_id:, controller:, metadata:) ⇒ Object 



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
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 243

def controller_page_recipe(frame_id:, controller:, metadata:)
  controller_class = controller.class
  action_name = controller.action_name
  ambient_inputs = request_ambient_replay_inputs
  env = replay_env(
    controller.request.env,
    path_parameters: controller.request.path_parameters,
    ambient_inputs: ambient_inputs
  )

  ::Upkeep::Replay::Recipe.new(
    kind: :page,
    frame_id: frame_id,
    target_kind: "page",
    target_id: frame_id,
    template: metadata.fetch(:template),
    metadata: metadata,
    runtime: "rails",
    replay: ::Upkeep::Replay::ControllerPage.new(
      controller_class: controller_class.name,
      action: action_name,
      env: serializable_replay_env(
        controller.request.env,
        path_parameters: controller.request.path_parameters,
        ambient_inputs: ambient_inputs
      )
    )
  ) do
    _status, _headers, body = ControllerRuntime.suppress do
      controller_class.action(action_name).call(Replay.rack_env(env))
    end
    collect_response_body(body)
  end
end

.cookie_replay_header(observed_values) ⇒ Object 



420
421
422
423
424
425
426
427
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 420

def cookie_replay_header(observed_values)
  values = observed_values.transform_keys(&:to_s).reject { |_key, value| value.nil? }
  return if values.empty?

  values.map do |key, value|
    "#{CGI.escape(key)}=#{CGI.escape(value.to_s)}"
  end.join("; ")
end

.current_frame_id ⇒ Object 



532
533
534
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 532

def current_frame_id
  frame_stack.last
end

.current_render_site ⇒ Object 



547
548
549
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 547

def current_render_site
  render_site_stack.last
end

.erb_template?(template) ⇒ Boolean

Returns:

  • (Boolean) 


464
465
466
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 464

def erb_template?(template)
  template.identifier.to_s.end_with?(".erb") || template.respond_to?(:handler) && template.handler.class.name.include?("ERB")
end

.form_builder?(value) ⇒ Boolean

Returns:

  • (Boolean) 


775
776
777
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 775

def form_builder?(value)
  defined?(ActionView::Helpers::FormBuilder) && value.is_a?(ActionView::Helpers::FormBuilder)
end

.frame_id_for_template(metadata, locals) ⇒ Object 



588
589
590
591
592
593
594
595
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 588

def frame_id_for_template(metadata, locals)
  if metadata.fetch(:kind) == "fragment"
    identity = locals_identity(locals, identity_local: metadata[:identity_local])
    "fragment:rails:#{metadata.fetch(:template)}:#{identity}"
  else
    "page:rails:#{metadata.fetch(:template)}"
  end
end

.frame_stack ⇒ Object 



536
537
538
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 536

def frame_stack
  Thread.current[FRAME_STACK_KEY] ||= []
end

.handle_refused_collection(error) ⇒ Object 



788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 788

def handle_refused_collection(error)
  raise error if Upkeep::Rails.configuration.refused_boundary_behavior == :raise

  refused = RefusedCollection.new(
    "opaque_active_record_relation",
    error.message,
    error.suggestions,
    error
  )
  payload = {
    reason: refused.reason,
    message: refused.message,
    suggestions: refused.suggestions,
    source: "active_record_collection"
  }

  if Runtime::Observation.refuse_boundary(payload)
    ActiveSupport::Notifications.instrument("refused_boundary.upkeep", payload)
    warn_refused_boundary(payload)
  end
  refused
end

.install ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 41

def install
  unless @installed
    ::ActionView::Template.prepend(TemplateHook)
    ::ActionView::CollectionRenderer.prepend(CollectionRendererHook)
    ::ActionView::Base.include(ViewHelpers)
    @installed = true
  end

  if defined?(::Turbo::FramesHelper) && !::Turbo::FramesHelper.ancestors.include?(TurboFrameHelperHook)
    ::Turbo::FramesHelper.prepend(TurboFrameHelperHook)
  end
end

.installed? ⇒ Boolean

Returns:

  • (Boolean) 


54
55
56
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 54

def installed?
  !!@installed
end

.instrument_template_source!(template) ⇒ Object 



453
454
455
456
457
458
459
460
461
462
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 453

def instrument_template_source!(template)
  return if template.instance_variable_get(:@upkeep_herb_instrumented)
  return unless erb_template?(template)

  manifest = manifest_for_template(template)
  instrumented_source = HerbSupport::SourceInstrumenter.new(manifest: manifest).instrument(template.source)
  template.instance_variable_set(:@upkeep_herb_original_source, template.source)
  template.instance_variable_set(:@source, instrumented_source)
  template.instance_variable_set(:@upkeep_herb_instrumented, true)
end

.local_metadata(locals) ⇒ Object 



622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 622

def local_metadata(locals)
  locals.transform_values do |value|
    if value.is_a?(ActiveRecord::Base)
      { table: value.class.table_name, id: value.id }
    elsif value.respond_to?(:klass) && value.respond_to?(:to_sql)
      { class: value.class.name, table: value.klass.table_name }
    elsif value.is_a?(Array)
      { class: value.class.name, size: value.size }
    else
      value.class.name
    end
  end
end

.locals_identity(locals, identity_local: nil) ⇒ Object 



613
614
615
616
617
618
619
620
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 613

def locals_identity(locals, identity_local: nil)
  record = locals[identity_local.to_sym] if identity_local
  record = nil unless record.is_a?(ActiveRecord::Base)
  record ||= locals.values.find { |value| value.is_a?(ActiveRecord::Base) }
  return "#{record.class.table_name}:#{record.id}" if record

  Digest::SHA256.hexdigest(local_metadata(locals).inspect)[0, 16]
end

.manifest_cache ⇒ Object 



555
556
557
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 555

def manifest_cache
  @manifest_cache ||= HerbSupport::ManifestCache.new
end

.manifest_for_template(template) ⇒ Object 



468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 468

def manifest_for_template(template)
  template.instance_variable_get(:@upkeep_herb_manifest) || begin
    source = template.instance_variable_get(:@upkeep_herb_original_source) || template.source
    manifest = manifest_cache.fetch(
      path: template.virtual_path || template.identifier,
      source: source,
      parse_options: MANIFEST_PARSE_OPTIONS
    )
    template.instance_variable_set(:@upkeep_herb_manifest, manifest)
    manifest
  end
end

.manifest_metadata(manifest) ⇒ Object 



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 495

def manifest_metadata(manifest)
  return {} unless manifest

  path = if manifest.respond_to?(:path)
    manifest.path
  else
    manifest[:manifest_path] || manifest[:path]
  end

  fingerprint = if manifest.respond_to?(:fingerprint)
    manifest.fingerprint
  else
    manifest[:manifest_fingerprint] || manifest[:fingerprint]
  end

  return {} unless path && fingerprint

  metadata = {
    manifest_path: path,
    manifest_fingerprint: fingerprint,
    manifest: {
      path: path,
      fingerprint: fingerprint
    }
  }
  identity_local = manifest.root_shape[:identity_local] if manifest.respond_to?(:root_shape)
  metadata[:identity_local] = identity_local if identity_local
  metadata
end

.partial_template?(template) ⇒ Boolean

Returns:

  • (Boolean) 


897
898
899
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 897

def partial_template?(template)
  File.basename(template.virtual_path.to_s).start_with?("_")
end

.record_collection_dependency(collection, collection_analysis: nil) ⇒ Object 



563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 563

def record_collection_dependency(collection, collection_analysis: nil)
  # Collection dependencies only matter to an active capture. When nothing is
  # recording (e.g. a request that opted out via upkeep_reactive_request?, or any
  # render outside a captured request) there is no dependency to record, and we
  # must not analyze -- otherwise an opaque relation would raise/refuse on a page
  # that is deliberately not reactive. This mirrors the relation-load observer,
  # which also no-ops without a recorder.
  return unless Runtime::Observation.recording?
  return if refused_collection_analysis?(collection_analysis)

  analysis = collection_analysis
  analysis ||= ActiveRecordQuery.analyze(collection) if active_record_relation?(collection)
  return unless analysis

  dependency = Dependencies::ActiveRecordCollection.new(
    primary_table: analysis.primary_table,
    table_columns: analysis.table_columns,
    coverage: analysis.coverage,
    sql: analysis.sql,
    predicates: analysis.predicates
  )

  Runtime::Observation.record_dependency(dependency)
end

.refused_collection_analysis?(value) ⇒ Boolean

Returns:

  • (Boolean) 


817
818
819
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 817

def refused_collection_analysis?(value)
  value.is_a?(RefusedCollection)
end

.refused_relation_snapshot(value, refused) ⇒ Object 



825
826
827
828
829
830
831
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 825

def refused_relation_snapshot(value, refused)
  ::Upkeep::Replay::RefusedActiveRecordRelationValue.new(
    model: value.klass.name,
    sql_digest: Digest::SHA256.hexdigest(value.to_sql)[0, 16],
    reason: refused.reason
  )
end

.relation_member_ids(primary_key, rendered_collection) ⇒ Object 



759
760
761
762
763
764
765
766
767
768
769
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 759

def relation_member_ids(primary_key, rendered_collection)
  return [] unless primary_key

  if rendered_collection.respond_to?(:to_ary)
    return rendered_collection.to_ary.filter_map do |record|
      record.public_send(primary_key).to_s if record.respond_to?(primary_key)
    end
  end

  relation.pluck(primary_key).map(&:to_s)
end

.relation_provenance_analysis?(value) ⇒ Boolean

Returns:

  • (Boolean) 


821
822
823
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 821

def relation_provenance_analysis?(value)
  value.is_a?(Runtime::RelationProvenance)
end

.render_options_for_replay(options) ⇒ Object 



636
637
638
639
640
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 636

def render_options_for_replay(options)
  options.each_with_object({}) do |(key, value), replay_options|
    replay_options[key] = key == :locals && value.respond_to?(:dup) ? value.dup : value
  end
end

.render_site_stack ⇒ Object 



551
552
553
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 551

def render_site_stack
  Thread.current[RENDER_SITE_STACK_KEY] ||= []
end

.replay_collection_value(collection, collection_analysis) ⇒ Object 



865
866
867
868
869
870
871
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 865

def replay_collection_value(collection, collection_analysis)
  if collection.is_a?(Array) && relation_provenance_analysis?(collection_analysis)
    return constantize(collection_analysis.model_name).find_by_sql(collection_analysis.sql)
  end

  replay_value(collection)
end

.replay_env(env, path_parameters: nil, ambient_inputs: {}) ⇒ Object 



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 333

def replay_env(env, path_parameters: nil, ambient_inputs: {})
  copy = env.each_with_object({}) do |(key, value), replay|
    replay[key] = replay_env_value(value) if replay_env_key?(key)
  end

  session_snapshot = session_replay_snapshot(
    env["rack.session"],
    observed_values: ambient_inputs.fetch(:session, {})
  )
  cookie_header = cookie_replay_header(ambient_inputs.fetch(:cookie, {}))
  warden_snapshot = warden_replay_snapshot(ambient_inputs.fetch(:warden, {}))
  copy["rack.session"] = session_snapshot if session_snapshot
  copy["HTTP_COOKIE"] = cookie_header if cookie_header
  copy["warden"] = warden_snapshot if warden_snapshot
  request_replay_env(ambient_inputs.fetch(:request, {})).each do |key, value|
    copy[key] = value
  end
  copy["rack.input"] = StringIO.new
  copy["rack.errors"] ||= StringIO.new
  copy["action_dispatch.request.path_parameters"] = path_parameters if path_parameters
  copy
end

.replay_env_key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 356

def replay_env_key?(key)
  return false if key == "HTTP_COOKIE"

  REPLAY_HTTP_ENV_KEYS.include?(key) ||
    key.start_with?("REQUEST_") ||
    key.start_with?("SERVER_") ||
    key.start_with?("REMOTE_") ||
    key == "rack.url_scheme" ||
    %w[
      CONTENT_LENGTH
      CONTENT_TYPE
      HTTPS
      PATH_INFO
      QUERY_STRING
      SCRIPT_NAME
      action_dispatch.request.path_parameters
    ].include?(key)
end

.replay_env_scalar_value(value) ⇒ Object 



386
387
388
389
390
391
392
393
394
395
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 386

def replay_env_scalar_value(value)
  case value
  when Hash
    value.transform_values { |nested_value| replay_env_scalar_value(nested_value) }
  when Array
    value.map { |nested_value| replay_env_scalar_value(nested_value) }
  else
    value
  end
end

.replay_env_value(value) ⇒ Object 



375
376
377
378
379
380
381
382
383
384
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 375

def replay_env_value(value)
  case value
  when Hash
    value.transform_values { |nested_value| replay_env_scalar_value(nested_value) }
  when Array
    value.map { |nested_value| replay_env_scalar_value(nested_value) }
  else
    replay_env_scalar_value(value)
  end
end

.replay_form_builder(builder) ⇒ Object 



856
857
858
859
860
861
862
863
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 856

def replay_form_builder(builder)
  builder.class.new(
    builder.object_name,
    replay_value(builder.object),
    builder.instance_variable_get(:@template),
    replayable_form_builder_options(builder.options)
  )
end

.replay_locals(locals) ⇒ Object 



648
649
650
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 648

def replay_locals(locals)
  locals.transform_values { |value| replay_value(value) }
end

.replay_render_options(options) ⇒ Object 



642
643
644
645
646
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 642

def replay_render_options(options)
  options.each_with_object({}) do |(key, value), replay_options|
    replay_options[key] = key == :locals ? replay_locals(value || {}) : value
  end
end

.replay_value(value) ⇒ Object 



842
843
844
845
846
847
848
849
850
851
852
853
854
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 842

def replay_value(value)
  if value.is_a?(ActiveRecord::Base)
    value.class.find(value.id)
  elsif form_builder?(value)
    replay_form_builder(value)
  elsif value.respond_to?(:spawn) && value.respond_to?(:klass)
    value.spawn
  elsif value.is_a?(Array)
    value.map { |item| replay_value(item) }
  else
    value
  end
end

.replayable_form_builder_options(options) ⇒ Object 



779
780
781
782
783
784
785
786
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 779

def replayable_form_builder_options(options)
  options.to_h.slice(
    :allow_method_names_outside_object,
    :index,
    :namespace,
    :skip_default_ids
  )
end

.replayable_view_assign_value?(value) ⇒ Boolean

Returns:

  • (Boolean) 


665
666
667
668
669
670
671
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 665

def replayable_view_assign_value?(value)
  return true if value.is_a?(ActiveRecord::Base)
  return value.all? { |item| replayable_view_assign_value?(item) } if value.is_a?(Array)
  return value.all? { |_key, item| replayable_view_assign_value?(item) } if value.is_a?(Hash)

  false
end

.replayable_view_assigns(view, controller: nil) ⇒ Object 



652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 652

def replayable_view_assigns(view, controller: nil)
  source = if controller&.respond_to?(:view_assigns)
    controller
  elsif view.respond_to?(:view_assigns)
    view
  end
  return {} unless source

  source.view_assigns.each_with_object({}) do |(name, value), assigns|
    assigns[name.to_s] = value if replayable_view_assign_value?(value)
  end
end

.request_ambient_replay_inputs ⇒ Object 



397
398
399
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 397

def request_ambient_replay_inputs
  Runtime::Observation.recorder&.ambient_replay_inputs_for(Runtime::Recorder::REQUEST_NODE_ID) || {}
end

.request_replay_env(observed_values) ⇒ Object 



440
441
442
443
444
445
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 440

def request_replay_env(observed_values)
  observed_values.transform_keys(&:to_s).each_with_object({}) do |(key, value), replay_env|
    env_key = REQUEST_REPLAY_ENV_KEYS[key]
    replay_env[env_key] = replay_env_scalar_value(value) if env_key && !value.nil?
  end
end

.reset_manifest_cache! ⇒ Object 



559
560
561
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 559

def reset_manifest_cache!
  @manifest_cache = HerbSupport::ManifestCache.new
end

.serializable_replay_env(env, path_parameters: nil, ambient_inputs: {}) ⇒ Object 



327
328
329
330
331
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 327

def serializable_replay_env(env, path_parameters: nil, ambient_inputs: {})
  replay_env(env, path_parameters: path_parameters, ambient_inputs: ambient_inputs).reject do |key, _value|
    key == "rack.input" || key == "rack.errors"
  end
end

.session_id_for_replay(session) ⇒ Object 



414
415
416
417
418
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 414

def session_id_for_replay(session)
  session.id if session.respond_to?(:id)
rescue StandardError
  nil
end

.session_replay_snapshot(session, observed_values:) ⇒ Object 



401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 401

def session_replay_snapshot(session, observed_values:)
  values = observed_values.transform_keys(&:to_s)
  return if values.empty?

  session_id = session_id_for_replay(session)
  values = values.merge("session_id" => session_id.to_s) if session_id && !session_id.to_s.empty?

  {
    "__upkeep_replay_type" => "rack_session",
    "values" => replay_env_scalar_value(values)
  }
end

.snapshot_hash(values) ⇒ Object 



697
698
699
700
701
702
703
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 697

def snapshot_hash(values)
  values.each_with_object({}) do |(key, value), snapshot|
    next if key.to_s.end_with?("_iteration")

    snapshot[key.to_s] = snapshot_value(value)
  end
end

.snapshot_render_options(options) ⇒ Object 



705
706
707
708
709
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 705

def snapshot_render_options(options)
  options.each_with_object({}) do |(key, value), snapshot|
    snapshot[key.to_s] = key == :locals ? ::Upkeep::Replay::HashValue.new(entries: snapshot_hash(value || {})) : snapshot_value(value)
  end
end

.snapshot_value(value, rendered_collection: nil, relation_analysis: nil) ⇒ Object 



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 711

def snapshot_value(value, rendered_collection: nil, relation_analysis: nil)
  if value.is_a?(ActiveRecord::Base)
    ::Upkeep::Replay.active_record_value(value)
  elsif form_builder?(value)
    ::Upkeep::Replay::RailsFormBuilderValue.new(
      builder_class: value.class.name,
      object_name: value.object_name,
      object: snapshot_value(value.object),
      options: snapshot_hash(replayable_form_builder_options(value.options))
    )
  elsif active_record_relation?(value)
    if refused_collection_analysis?(relation_analysis)
      return refused_relation_snapshot(value, relation_analysis)
    end

    analysis = relation_analysis || analyze_relation_for_snapshot(value)
    return refused_relation_snapshot(value, analysis) if refused_collection_analysis?(analysis)

    ::Upkeep::Replay::ActiveRecordRelationValue.new(
      model: value.klass.name,
      sql: analysis.sql,
      primary_key: analysis.primary_key,
      appendable: analysis.appendable?,
      limit_value: analysis.limit_value,
      predicates: analysis.predicates,
      member_ids: rendered_collection ? relation_member_ids(analysis.primary_key, rendered_collection) : []
    )
  elsif value.is_a?(Array) && relation_provenance_analysis?(relation_analysis)
    ::Upkeep::Replay::ActiveRecordRelationValue.new(
      model: relation_analysis.model_name,
      sql: relation_analysis.sql,
      primary_key: relation_analysis.primary_key,
      appendable: relation_analysis.appendable?,
      limit_value: relation_analysis.limit_value,
      predicates: relation_analysis.predicates,
      member_ids: rendered_collection ? relation_member_ids(relation_analysis.primary_key, rendered_collection) : []
    )
  elsif value.is_a?(Array)
    ::Upkeep::Replay::ArrayValue.new(items: value.map { |item| snapshot_value(item) })
  elsif value.is_a?(Hash)
    ::Upkeep::Replay::HashValue.new(entries: snapshot_hash(value))
  elsif value.nil? || value.is_a?(String) || value.is_a?(Numeric) || value == true || value == false || value.is_a?(Symbol)
    ::Upkeep::Replay::LiteralValue.new(value: value)
  else
    ::Upkeep::Replay::UnsupportedValue.new(class_name: value.class.name)
  end
end

.template_metadata(template, locals) ⇒ Object 



196
197
198
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 196

def template_metadata(template, locals)
  template_static_metadata(template).merge(locals: local_metadata(locals))
end

.template_recipe(frame_id:, template:, view:, controller:, locals:, metadata:, implicit_locals:, add_to_stack:, block:) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 212

def template_recipe(frame_id:, template:, view:, controller:, locals:, metadata:, implicit_locals:, add_to_stack:, block:)
  target_kind = metadata.fetch(:kind) == "fragment" ? "fragment" : "page"
  assigns = replayable_view_assigns(view, controller: controller)
  ::Upkeep::Replay::Recipe.new(
    kind: metadata.fetch(:kind).to_sym,
    frame_id: frame_id,
    target_kind: target_kind,
    target_id: frame_id,
    template: metadata.fetch(:template),
    metadata: metadata,
    runtime: "rails",
    replay: (target_kind == "fragment" ? ::Upkeep::Replay::Fragment : ::Upkeep::Replay::Template).new(
      controller_class: controller&.class&.name,
      template: metadata.fetch(:template),
      locals: snapshot_hash(locals),
      assigns: snapshot_hash(assigns)
    )
  ) do
    with_replayed_view_assigns(view, assigns) do
      template.render(
        view,
        replay_locals(locals),
        nil,
        implicit_locals: implicit_locals,
        add_to_stack: add_to_stack,
        &block
      )
    end
  end
end

.template_static_metadata(template) ⇒ Object 



481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 481

def template_static_metadata(template)
  template.instance_variable_get(:@upkeep_static_metadata) || begin
    virtual_path = template.virtual_path || template.identifier
    manifest = manifest_for_template(template)
    metadata = {
      kind: partial_template?(template) ? "fragment" : "page",
      template: virtual_path,
      identifier: template.identifier
    }.merge(manifest_metadata(manifest)).freeze
    template.instance_variable_set(:@upkeep_static_metadata, metadata)
    metadata
  end
end

.turbo_frame_recipe(frame_id:, target_id:, controller:) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 145

def turbo_frame_recipe(frame_id:, target_id:, controller:)
  return unless controller

  ambient_inputs = request_ambient_replay_inputs
  replay = ::Upkeep::Replay::ControllerTurboFrame.new(
    controller_class: controller.class.name,
    action: controller.action_name,
    env: serializable_replay_env(
      controller.request.env,
      path_parameters: controller.request.path_parameters,
      ambient_inputs: ambient_inputs
    ),
    target_id: target_id.to_s
  )

  ::Upkeep::Replay::Recipe.new(
    kind: :turbo_frame,
    frame_id: frame_id,
    target_kind: "turbo_frame",
    target_id: target_id.to_s,
    metadata: { kind: "turbo_frame", target_id: target_id.to_s },
    runtime: "rails",
    replay: replay
  )
end

.warden_replay_snapshot(observed_values) ⇒ Object 



429
430
431
432
433
434
435
436
437
438
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 429

def warden_replay_snapshot(observed_values)
  return if observed_values.empty?

  {
    "__upkeep_replay_type" => "warden",
    "users" => observed_values.transform_keys(&:to_s).transform_values do |user|
      snapshot_value(user).to_h
    end
  }
end

.warn_refused_boundary(payload) ⇒ Object 



833
834
835
836
837
838
839
840
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 833

def warn_refused_boundary(payload)
  return unless defined?(::Rails) && ::Rails.respond_to?(:logger) && ::Rails.logger

  ::Rails.logger.warn(
    "Upkeep refused #{payload.fetch(:source)}: #{payload.fetch(:reason)}. " \
    "#{payload.fetch(:suggestions).join(" ")}"
  )
end

.with_frame_id(frame_id) ⇒ Object 



525
526
527
528
529
530
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 525

def with_frame_id(frame_id)
  frame_stack.push(frame_id)
  yield
ensure
  frame_stack.pop
end

.with_render_site(render_site) ⇒ Object 



540
541
542
543
544
545
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 540

def with_render_site(render_site)
  render_site_stack.push(render_site)
  yield
ensure
  render_site_stack.pop
end

.with_replayed_view_assigns(view, assigns) ⇒ Object 



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'lib/upkeep/rails/action_view_capture.rb', line 673

def with_replayed_view_assigns(view, assigns)
  originals = {}

  assigns.each do |name, value|
    ivar = :"@#{name}"
    originals[ivar] = if view.instance_variable_defined?(ivar)
      [true, view.instance_variable_get(ivar)]
    else
      [false, nil]
    end
    view.instance_variable_set(ivar, replay_value(value))
  end

  yield
ensure
  originals&.each do |ivar, (defined, value)|
    if defined
      view.instance_variable_set(ivar, value)
    else
      view.remove_instance_variable(ivar) if view.instance_variable_defined?(ivar)
    end
  end
end