live_cable 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +368 -196
  3. data/README.md +87 -54
  4. data/app/assets/javascript/controllers/live_controller.js +10 -0
  5. data/app/assets/javascript/loading.js +3 -3
  6. data/app/assets/javascript/subscriptions.js +137 -60
  7. data/app/helpers/live_cable_helper.rb +18 -4
  8. data/lib/live_cable/arel_predications.rb +15 -0
  9. data/lib/live_cable/component/broadcasting.rb +13 -5
  10. data/lib/live_cable/component/dispatching.rb +2 -1
  11. data/lib/live_cable/component/events.rb +2 -1
  12. data/lib/live_cable/component/rendering.rb +25 -4
  13. data/lib/live_cable/connection/broadcasting.rb +42 -10
  14. data/lib/live_cable/connection/messaging.rb +18 -3
  15. data/lib/live_cable/connection.rb +5 -5
  16. data/lib/live_cable/defaults_signer.rb +62 -2
  17. data/lib/live_cable/delegation/hash.rb +5 -0
  18. data/lib/live_cable/delegation/model.rb +6 -1
  19. data/lib/live_cable/delegator.rb +23 -15
  20. data/lib/live_cable/engine.rb +5 -0
  21. data/lib/live_cable/model_observer.rb +46 -1
  22. data/lib/live_cable/observer_tracking.rb +10 -1
  23. data/lib/live_cable/predicate_builder.rb +19 -1
  24. data/lib/live_cable/record_ids.rb +37 -0
  25. data/lib/live_cable/render_context.rb +66 -14
  26. data/lib/live_cable/rendering/controller_renderer.rb +15 -11
  27. data/lib/live_cable/rendering/dependency_visitor.rb +35 -2
  28. data/lib/live_cable/rendering/handler.rb +1 -1
  29. data/lib/live_cable/rendering/partial.rb +16 -12
  30. data/lib/live_cable/rendering/partial_renderer.rb +30 -65
  31. data/lib/live_cable/rendering/renderer.rb +19 -3
  32. data/lib/live_cable/rendering/view_buffer.rb +3 -2
  33. data/lib/live_cable/testing/render_state.rb +1 -1
  34. data/lib/live_cable/testing/test_component.rb +2 -2
  35. data/lib/live_cable/testing.rb +4 -2
  36. data/lib/live_cable/version.rb +1 -1
  37. metadata +11 -9
@@ -45,16 +45,17 @@ function createDOMFromHTML(html) {
45
45
  return template.content.childNodes[0]
46
46
  }
47
47
 
48
- const TEXT_INPUT_TYPES = new Set(['text', 'search', 'email', 'url', 'tel', 'password', 'number'])
48
+ const UNTYPED_INPUT_TYPES = new Set(['checkbox', 'radio', 'file', 'hidden', 'submit', 'reset', 'button', 'image'])
49
49
 
50
50
  /**
51
- * Whether the user types the element's value.
51
+ * Whether the user enters the element's value, by typing or with a picker or
52
+ * slider.
52
53
  * @param {Element} element
53
54
  * @returns {boolean}
54
55
  */
55
- function isTextField(element) {
56
+ function isTypedField(element) {
56
57
  return element instanceof HTMLTextAreaElement ||
57
- (element instanceof HTMLInputElement && TEXT_INPUT_TYPES.has(element.type))
58
+ (element instanceof HTMLInputElement && !UNTYPED_INPUT_TYPES.has(element.type))
58
59
  }
59
60
 
60
61
  /**
@@ -92,7 +93,7 @@ class SubscriptionManager {
92
93
  * reference instead of creating a new subscription - unless the element
93
94
  * brings different defaults, in which case the old subscription is replaced
94
95
  * so the server builds the component again from them.
95
- * If a ComponentState exists and the controller element matches, reuses it.
96
+ * If a parent's render left a ComponentState for it, the subscription takes it.
96
97
  *
97
98
  * @param {string} id - Raw ID for the component (e.g., "room-1")
98
99
  * @param {string} component - Component class name (e.g., "chat/chat_room")
@@ -110,16 +111,10 @@ class SubscriptionManager {
110
111
  if (!this.#subscriptions[liveId]) {
111
112
  const componentState = this.#componentStates[liveId]
112
113
 
113
- // Check if we have a pre-existing component state and if the element matches
114
- if (componentState && componentState.element === controller.element) {
115
- // Create subscription with existing state
116
- this.#subscriptions[liveId] = new Subscription(id, component, defaults, controller, componentState)
117
- // Clean up component state
118
- delete this.#componentStates[liveId]
119
- } else {
120
- // Create new subscription normally
121
- this.#subscriptions[liveId] = new Subscription(id, component, defaults, controller)
122
- }
114
+ // Whichever element its controller connected on: a morph keeps a
115
+ // prerendered root with an id in place of the one the parent's render built
116
+ this.#subscriptions[liveId] = new Subscription(id, component, defaults, controller, componentState)
117
+ delete this.#componentStates[liveId]
123
118
  }
124
119
 
125
120
  this.#subscriptions[liveId].controller = controller
@@ -201,12 +196,27 @@ class SubscriptionManager {
201
196
  * @param {HTMLElement} newBody - The incoming page body element from turbo:before-render
202
197
  */
203
198
  prune(newBody) {
204
- const newLiveIds = this.#extractLiveIds(newBody)
199
+ const newElements = this.#extractLiveIds(newBody)
200
+ const newLiveIds = new Set(newElements.keys())
201
+ const rebuilt = new Set()
202
+
203
+ // A component built again from other defaults builds its children again,
204
+ // including those a cached page still shows
205
+ newElements.forEach((element, liveId) => {
206
+ const subscription = this.#subscriptions[liveId]
207
+
208
+ if (subscription && !this.#carriedOver(element) && this.#defaultsChanged(subscription, this.#defaultsOf(element))) {
209
+ rebuilt.add(liveId)
210
+ this.#extractLiveIds(element).forEach((_, childId) => newLiveIds.delete(childId))
211
+ }
212
+ })
205
213
 
206
- // Inline children are prerendered without a live id, but a kept component
207
- // rebuilds them from their state; the set grows to take in grandchildren
214
+ // Inline children have no live id on a rendered page; a component kept
215
+ // with its defaults rebuilds them, and the set grows to take in grandchildren
208
216
  newLiveIds.forEach(liveId => {
209
- this.getComponentState(liveId)?.childLiveIds.forEach(childId => newLiveIds.add(childId))
217
+ if (!rebuilt.has(liveId)) {
218
+ this.getComponentState(liveId)?.childLiveIds.forEach(childId => newLiveIds.add(childId))
219
+ }
210
220
  })
211
221
 
212
222
  Object.entries(this.#subscriptions).forEach(([liveId, subscription]) => {
@@ -223,29 +233,52 @@ class SubscriptionManager {
223
233
  }
224
234
 
225
235
  /**
226
- * Extract the set of live IDs present in a body element.
227
- * Handles both fresh server renders (live-id attributes, not yet mutated)
228
- * and Turbo cache restores (data-live-id-value attributes, already mutated).
236
+ * Extract the live IDs present inside an element, with the element each
237
+ * belongs to. Handles both fresh server renders (live-id attributes, not
238
+ * yet mutated) and Turbo cache restores (data-live-id-value attributes,
239
+ * already mutated).
229
240
  *
230
241
  * @param {HTMLElement} body
231
- * @returns {Set<string>}
242
+ * @returns {Map<string, HTMLElement>}
232
243
  */
233
244
  #extractLiveIds(body) {
234
- const ids = new Set()
245
+ const elements = new Map()
235
246
 
236
247
  body.querySelectorAll('[live-id]').forEach(el => {
237
248
  const id = el.getAttribute('live-id')
238
249
  const component = el.getAttribute('live-component')
239
- if (id && component) ids.add(`${component}/${id}`)
250
+ if (id && component) elements.set(`${component}/${id}`, el)
240
251
  })
241
252
 
242
253
  body.querySelectorAll('[data-live-id-value]').forEach(el => {
243
254
  const id = el.getAttribute('data-live-id-value')
244
255
  const component = el.getAttribute('data-live-component-value')
245
- if (id && component) ids.add(`${component}/${id}`)
256
+ if (id && component) elements.set(`${component}/${id}`, el)
246
257
  })
247
258
 
248
- return ids
259
+ return elements
260
+ }
261
+
262
+ /**
263
+ * Whether Turbo will keep what is already on the page in place of this
264
+ * element: it carries a [data-turbo-permanent] element over, with all it
265
+ * holds, when the new page has a permanent element with the same id.
266
+ *
267
+ * @param {HTMLElement} element - An element in the incoming page
268
+ * @returns {boolean}
269
+ */
270
+ #carriedOver(element) {
271
+ const permanent = element.closest('[id][data-turbo-permanent]')
272
+
273
+ return Boolean(permanent && document.getElementById(permanent.id)?.hasAttribute('data-turbo-permanent'))
274
+ }
275
+
276
+ /**
277
+ * @param {HTMLElement} element
278
+ * @returns {string} The signed defaults blob the element carries
279
+ */
280
+ #defaultsOf(element) {
281
+ return element.getAttribute('live-defaults') ?? element.getAttribute('data-live-defaults-value') ?? ''
249
282
  }
250
283
 
251
284
  /**
@@ -329,8 +362,9 @@ class ComponentState {
329
362
  * @returns {string[]}
330
363
  */
331
364
  get childLiveIds() {
332
- const html = (this.#partsByTemplate[this.#lastTemplate] ?? []).join('')
333
- return Array.from(html.matchAll(/<LiveCable child-live-id="([^"]+)"/g), ([, liveId]) => liveId)
365
+ const template = document.createElement('template')
366
+ template.innerHTML = (this.#partsByTemplate[this.#lastTemplate] ?? []).join('')
367
+ return Array.from(template.content.querySelectorAll('LiveCable'), el => el.getAttribute('child-live-id'))
334
368
  }
335
369
 
336
370
  /**
@@ -414,6 +448,8 @@ class Subscription {
414
448
  #pending = []
415
449
  /** @type {number} - The render count when the first in-flight message was sent */
416
450
  #renderCountAtSend = 0
451
+ /** @type {Map<string, *>} - The value last sent for each live-reactive name */
452
+ #sentValues = new Map()
417
453
  /**
418
454
  * Creates a new subscription to a LiveCable component.
419
455
  *
@@ -522,6 +558,13 @@ class Subscription {
522
558
  this.#renderCountAtSend = this.#componentState.renderCount
523
559
  }
524
560
 
561
+ // Only a reply to live-reactive updates alone can be an echo
562
+ if (message.messages.every(({ _action }) => _action === '_reactive')) {
563
+ message.messages.forEach(({ name, value }) => this.#sentValues.set(name, value))
564
+ } else {
565
+ this.#sentValues.clear()
566
+ }
567
+
525
568
  if (!this.#confirmed || !this.#subscription.send(message)) {
526
569
  this.#pending.push(message)
527
570
  }
@@ -584,7 +627,9 @@ class Subscription {
584
627
  #connected = () => {
585
628
  this.#confirmed = true
586
629
  // ActionCable can replace a stale socket without calling disconnected
587
- this.#settleLostMessages()
630
+ if (this.#settleLostMessages()) {
631
+ this.catchUp()
632
+ }
588
633
 
589
634
  while (this.#pending.length > 0) {
590
635
  // The socket closed again mid-flush; the next confirmation resumes it
@@ -604,20 +649,37 @@ class Subscription {
604
649
  */
605
650
  #disconnected = () => {
606
651
  this.#confirmed = false
607
- this.#settleLostMessages()
652
+ if (this.#settleLostMessages()) {
653
+ this.catchUp()
654
+ }
608
655
  this.#handleStatus('disconnected')
609
656
  }
610
657
 
611
658
  /**
612
659
  * End the loading state of messages sent on a socket that has since
613
660
  * closed - their replies will never arrive. Held messages still will.
661
+ * @returns {boolean} Whether that ended the loading state
614
662
  * @private
615
663
  */
616
664
  #settleLostMessages() {
617
665
  const lost = (this.#controller?.inFlight ?? 0) - this.#pending.length
666
+ let settled = false
618
667
 
619
668
  for (let i = 0; i < lost; i++) {
620
- this.#controller.finishLoading()
669
+ settled = this.#controller.finishLoading()
670
+ }
671
+
672
+ return settled
673
+ }
674
+
675
+ /**
676
+ * Morph the last render in again if renders arrived after the first
677
+ * in-flight message went out: the pending elements skipped them. For a
678
+ * loading state that ended without a render to apply.
679
+ */
680
+ catchUp() {
681
+ if (this.#componentState.renderCount !== this.#renderCountAtSend) {
682
+ this.#handleRefresh(null)
621
683
  }
622
684
  }
623
685
 
@@ -630,32 +692,44 @@ class Subscription {
630
692
  * @param {string} [data._refresh] - HTML to morph into the DOM
631
693
  * @param {string} [data._error] - Raw error HTML to replace the component with
632
694
  * @param {boolean} [data._reply] - Whether a _refresh answers this
633
- * component's own message; absent from servers before 0.4.1, whose
634
- * refreshes all count as replies
695
+ * component's own message; absent from 0.4 servers, whose refreshes all
696
+ * count as replies
635
697
  * @param {boolean} [data._subscribed] - Marks the frame the server sends
636
698
  * when it (re)subscribes the component
637
- * @param {boolean} [data._ack] - Answers a message when the component's own
638
- * re-render didn't: nothing changed, or its render rode in its parent's
699
+ * @param {boolean} [data._ack] - Answers a message that no re-render of the
700
+ * component's own answered, as when its render rode in its parent's
639
701
  * refresh; clears the loading state
702
+ * @param {boolean} [data._rendered] - Marks an _ack whose message's render
703
+ * of the component rode in its parent's refresh
640
704
  * @param {Array} [data._events] - Events to dispatch as CustomEvents; when
641
705
  * attached to a _refresh they fire after the DOM has been morphed
642
706
  * @private
643
707
  */
644
708
  #received = (data) => {
645
- if (data['_subscribed']) {
646
- this.#settleLostMessages()
709
+ // A re-subscribe render brings the component up to date; a status frame doesn't
710
+ if (data['_subscribed'] && this.#settleLostMessages() && !data['_refresh']) {
711
+ this.catchUp()
647
712
  }
648
713
 
649
714
  if (data['_status']) {
650
715
  this.#handleStatus(data['_status'])
651
716
  } else if (data['_refresh']) {
652
- this.#handleRefresh(data['_refresh'], { reply: !('_reply' in data) || data['_reply'] === true })
717
+ const legacy = !('_reply' in data)
718
+ this.#handleRefresh(data['_refresh'], { reply: legacy || data['_reply'] === true, legacy })
653
719
  } else if (data['_error']) {
654
720
  this.#handleError(data['_error'])
655
721
  } else if (data['_ack']) {
656
- // Pending elements skipped the renders that came while they waited
657
- if (this.#controller?.finishLoading() && this.#componentState.renderCount !== this.#renderCountAtSend) {
658
- this.#handleRefresh(null)
722
+ this.#handleStatus('subscribed')
723
+
724
+ // Pending elements skipped the renders that came while they waited. When
725
+ // the server says one was this message's, inside its parent's refresh,
726
+ // catching up to it replies
727
+ const missed = this.#componentState.renderCount !== this.#renderCountAtSend
728
+
729
+ if (data['_rendered'] && missed && this.#controller?.inFlight === 1) {
730
+ this.#handleRefresh(null, { reply: true })
731
+ } else if (this.#controller?.finishLoading()) {
732
+ this.catchUp()
659
733
  }
660
734
  }
661
735
 
@@ -728,9 +802,11 @@ class Subscription {
728
802
  * @param {Object} [options]
729
803
  * @param {boolean} [options.reply] - Whether the refresh answers this
730
804
  * component's own message, which ends its loading state
805
+ * @param {boolean} [options.legacy] - Whether it came from a 0.4 server,
806
+ * which never answers an inline child
731
807
  * @private
732
808
  */
733
- #handleRefresh(refresh, { reply = false } = {}) {
809
+ #handleRefresh(refresh, { reply = false, legacy = false } = {}) {
734
810
  // If we're getting a refresh we must be connected
735
811
  this.#handleStatus('subscribed')
736
812
 
@@ -739,10 +815,11 @@ class Subscription {
739
815
  return
740
816
  }
741
817
 
742
- // A focused field whose form or trigger awaits a reply takes that reply's
743
- // value like any other; read before the restore below unmarks it
818
+ // A focused field whose form or trigger awaits a reply takes its value,
819
+ // unless that echoes what the field itself sent; read before the restore
744
820
  const focused = document.activeElement
745
- const focusedAwaitsReply = Boolean(focused?.closest('[live-loading]:not([data-live-id-value])'))
821
+ const awaiting = focused?.closest('[live-loading]:not([data-live-id-value])')
822
+ const sent = awaiting === focused ? this.#sentValues.get(focused.name) : undefined
746
823
 
747
824
  // Restore live-loading / live-disable-with state before morphing so the
748
825
  // morph applies the server-rendered truth on top of the original DOM.
@@ -783,23 +860,26 @@ class Subscription {
783
860
  return false
784
861
  }
785
862
 
786
- // A nested component's pending elements wait for its own reply,
787
- // unless this refresh carries its render
788
- if (fromEl.hasAttribute('live-loading') && !fromEl.hasAttribute('data-live-id-value')) {
789
- const owner = fromEl.closest('[data-live-id-value]')
863
+ // A nested component's loading state waits for its own answer, unless a
864
+ // 0.4 server, which never answers an inline child, sent its render
865
+ const owner = fromEl.hasAttribute('live-loading') && fromEl.closest('[data-live-id-value]')
790
866
 
791
- if (owner && owner !== rootElement) {
792
- const liveId = `${owner.getAttribute('data-live-component-value')}/${owner.getAttribute('data-live-id-value')}`
867
+ if (owner && owner !== rootElement) {
868
+ const liveId = `${owner.getAttribute('data-live-component-value')}/${owner.getAttribute('data-live-id-value')}`
793
869
 
794
- if (!(liveId in childResults)) {
870
+ if (!legacy || !(liveId in childResults)) {
871
+ if (owner !== fromEl) {
795
872
  return false
796
873
  }
874
+
875
+ toEl.setAttribute('live-loading', '')
797
876
  }
798
877
  }
799
878
 
800
879
  // defaultValue is what the server last rendered for the field
801
880
  if (fromEl === focused) {
802
- keepFocusedValue = !focusedAwaitsReply && isTextField(fromEl) && fromEl.defaultValue === toEl.defaultValue
881
+ keepFocusedValue = isTypedField(fromEl) &&
882
+ (awaiting ? toEl.defaultValue === sent : fromEl.defaultValue === toEl.defaultValue)
803
883
  }
804
884
 
805
885
  return true
@@ -807,16 +887,13 @@ class Subscription {
807
887
  // Skipping its children skips morphdom's value sync, so the focused
808
888
  // field keeps what the user typed
809
889
  onBeforeElChildrenUpdated(fromEl, toEl) {
810
- if (keepFocusedValue && fromEl === focused) {
811
- return false
812
- }
813
-
814
- // morphdom updates a textarea's text node, which an empty one lacks
890
+ // morphdom updates a textarea's text node, which an empty one lacks;
891
+ // once typed into, setting it leaves the value alone
815
892
  if (fromEl instanceof HTMLTextAreaElement && fromEl.defaultValue !== toEl.defaultValue) {
816
893
  fromEl.defaultValue = toEl.defaultValue
817
894
  }
818
895
 
819
- return true
896
+ return !(keepFocusedValue && fromEl === focused)
820
897
  },
821
898
  // Use stable keys for better morphing performance and state preservation
822
899
  getNodeKey(node) {
@@ -27,6 +27,7 @@ module LiveCableHelper
27
27
  end
28
28
  ensure
29
29
  context_stack.pop
30
+ context.forget_tracked_values
30
31
  end
31
32
 
32
33
  [value, context]
@@ -39,6 +40,16 @@ module LiveCableHelper
39
40
  ctx.render_part(index, &)
40
41
  end
41
42
 
43
+ # Relative t('.key') lookups resolve against @virtual_path, which ActionView
44
+ # only sets while the template's compiled method runs, not while its parts do.
45
+ def with_live_cable_virtual_path(virtual_path)
46
+ previous = @virtual_path
47
+ @virtual_path = virtual_path
48
+ yield
49
+ ensure
50
+ @virtual_path = previous
51
+ end
52
+
42
53
  def live(component, id:, **defaults)
43
54
  unless component.is_a?(String)
44
55
  raise LiveCable::Error, '`live` helper only accepts string component names. Use render(component) directly if ' \
@@ -50,7 +61,8 @@ module LiveCableHelper
50
61
  live_id = "#{component}/#{id}"
51
62
 
52
63
  component = render_context&.get_component(live_id) || LiveCable.instance_from_string(component, id)
53
- component.defaults = render_context ? defaults.transform_values { |value| render_context.track(value) } : defaults
64
+ track = render_context && !component.defaults_applied
65
+ component.defaults = track ? defaults.transform_values { |value| render_context.track(value) } : defaults
54
66
 
55
67
  render(component)
56
68
  end
@@ -69,9 +81,11 @@ module LiveCableHelper
69
81
  # Templates get the plain value inside a reactive one, so Rails helpers and
70
82
  # `case` see a real Array or Hash.
71
83
  def live_cable_unwrap(value)
72
- return value unless value.is_a?(LiveCable::Delegator)
73
-
74
- render_context.unwrap(value)
84
+ case value
85
+ when LiveCable::Delegator then render_context.unwrap(value)
86
+ when Array, Hash then render_context.live_connection ? render_context.unwrap_nested(value) : value
87
+ else value
88
+ end
75
89
  end
76
90
 
77
91
  private
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ module LiveCable
4
+ # Arel's in and not_in, which in_order_of also uses, only see an Array as a
5
+ # list of values when it is Enumerable, and a reactive one isn't.
6
+ module ArelPredications
7
+ def in(other)
8
+ super(Delegator.unwrap(other))
9
+ end
10
+
11
+ def not_in(other)
12
+ super(Delegator.unwrap(other))
13
+ end
14
+ end
15
+ end
@@ -29,9 +29,16 @@ module LiveCable
29
29
  end
30
30
 
31
31
  # Answers a message batch when the component's own render didn't -
32
- # nothing changed, or its render went out inside its parent's.
33
- def broadcast_ack
34
- broadcast({ _ack: true })
32
+ # nothing changed, or its render went out inside its parent's. Events
33
+ # the batch queued ride along, so they fire once the loading state ends.
34
+ #
35
+ # @param rendered [Boolean] whether a parent's frame carried its render
36
+ def broadcast_ack(rendered: false)
37
+ data = { _ack: true }
38
+ data[:_rendered] = true if rendered
39
+ events = flush_events
40
+ data[:_events] = events if events.any?
41
+ broadcast(data)
35
42
  end
36
43
 
37
44
  def broadcast_destroy
@@ -48,16 +55,17 @@ module LiveCable
48
55
 
49
56
  run_callbacks :render do
50
57
  result = render
51
- events = flush_events
52
58
 
53
59
  # Leaves the reply unclaimed, so the message is answered with an _ack
54
60
  if !subscribed && result.is_a?(LiveCable::Rendering::RenderResult) && result.blank?
55
- broadcast(_events: events) if events.any?
61
+ broadcast_events unless live_connection&.awaiting_reply?(self)
56
62
  next
57
63
  end
58
64
 
65
+ events = flush_events
59
66
  data = { _refresh: result.as_json, _reply: live_connection&.take_reply(self) }
60
67
  data[:_subscribed] = true if subscribed
68
+ live_connection&.carried(data[:_refresh][:c])
61
69
 
62
70
  # Events ride along with the render so the client can fire them
63
71
  # after the DOM has been morphed
@@ -24,7 +24,8 @@ module LiveCable
24
24
  if dispatch.reactive?
25
25
  public_send("#{dispatch.name}=", dispatch.value)
26
26
  else
27
- action = method(dispatch.name)
27
+ # A reactive variable named method replaces Kernel#method
28
+ action = Kernel.instance_method(:method).bind_call(self, dispatch.name)
28
29
  action.arity.positive? ? action.call(dispatch.params) : action.call
29
30
  end
30
31
  end
@@ -7,7 +7,8 @@ module LiveCable
7
7
 
8
8
  # Queue a DOM event to be dispatched on the client. Events are
9
9
  # delivered with the next broadcast for this component - attached to
10
- # the render when state changed, or on their own when it didn't - and
10
+ # the render when state changed, to the _ack answering its message, or
11
+ # on their own - and
11
12
  # fire on the client after the DOM has been morphed, so handlers see
12
13
  # the updated markup.
13
14
  #
@@ -77,8 +77,19 @@ module LiveCable
77
77
  result.for_component(self, view_context).render_changes(changes)
78
78
  end
79
79
 
80
+ # A render callback halted this inline render: the client keeps the
81
+ # child's last render, and its children stay owned but unrendered
82
+ if view.nil? && live_connection && !render_context.root?
83
+ render_context.inherit_skipped(previous_render_context) if previous_render_context
84
+ @previous_render_context = render_context
85
+
86
+ # Without a Partial the client stores nothing for the child to keep
87
+ return plain_html ? insert_root_attributes(plain_html, view_context) : child_placeholder(view_context)
88
+ end
89
+
80
90
  unless (partial = view.is_a?(Array))
81
91
  view = [view]
92
+ @plain_html = view[0] if live_connection
82
93
  end
83
94
 
84
95
  # If we are rendering the initial page, we only need to add the attributes to most parent element
@@ -92,8 +103,8 @@ module LiveCable
92
103
 
93
104
  if previous_render_context
94
105
  render_context.inherit_skipped(previous_render_context) unless template_changed
95
- destroyed = previous_render_context.owned_children - render_context.owned_children
96
- destroyed.each(&:destroy)
106
+ owned = render_context.owned_children.to_set(&:object_id)
107
+ previous_render_context.owned_children.each { |child| child.destroy unless owned.include?(child.object_id) }
97
108
  end
98
109
 
99
110
  # We didn't get a LiveCable Partial, so just return it with one part
@@ -106,7 +117,10 @@ module LiveCable
106
117
  end
107
118
 
108
119
  if live_connection
109
- @static_sent[previous_template_path] = true
120
+ @plain_html = nil
121
+
122
+ # A frame with no subscription to carry it is dropped, so the client never gets these parts
123
+ @static_sent[previous_template_path] = true if render_context.root_component.subscribed?
110
124
 
111
125
  @previous_render_context = render_context
112
126
  result = LiveCable::Rendering::RenderResult.new(live_id, view, to_partial_path)
@@ -120,7 +134,7 @@ module LiveCable
120
134
  # This allows JavaScript to store the component before subscription connects
121
135
  render_context << result
122
136
 
123
- return "<LiveCable child-live-id=\"#{live_id}\"></LiveCable>".html_safe
137
+ return child_placeholder(view_context)
124
138
  end
125
139
  end
126
140
 
@@ -148,6 +162,9 @@ module LiveCable
148
162
  # @return [LiveCable::RenderContext, nil]
149
163
  attr_reader :previous_render_context
150
164
 
165
+ # @return [String, nil] the last connected render of a template without a Partial
166
+ attr_reader :plain_html
167
+
151
168
  def insert_root_attributes(html, view_context)
152
169
  matches = html.match(/(?:\n\s*|^\s*|<!--.*?-->)<([a-zA-Z0-9-]+)/)
153
170
 
@@ -179,6 +196,10 @@ module LiveCable
179
196
  "#{html[0...insert_at]}#{rendered_attributes}#{html[insert_at..]}".html_safe
180
197
  end
181
198
 
199
+ def child_placeholder(view_context)
200
+ view_context.content_tag('LiveCable', nil, 'child-live-id' => live_id)
201
+ end
202
+
182
203
  def locals(view_context)
183
204
  identifiers = channel ? channel.connection.identifiers.to_a : []
184
205
 
@@ -14,31 +14,37 @@ module LiveCable
14
14
  private
15
15
 
16
16
  def broadcast_changeset_unsynchronized
17
- rendered = []
17
+ rendered = Set.new.compare_by_identity
18
18
  shared_changeset = containers[SHARED_CONTAINER]&.changeset
19
+ changed = lambda do |component|
20
+ containers[component.live_id]&.changed? || component.shared_reactive_variables.intersect?(shared_changeset)
21
+ end
22
+
23
+ list = components.values
24
+ list = list.any?(&changed) ? parents_first(list) : []
19
25
 
20
- # Use a copy of the components since new ones can get added while rendering
21
- # and causes an issue here.
22
- components.values.dup.each do |component|
26
+ list.each do |component|
23
27
  # Component may have already been re-rendered by a parent, so don't render it again
24
28
  next if rendered.include?(component)
29
+ next unless changed.call(component)
25
30
 
26
- container = containers[component.live_id]
27
-
28
- next unless container&.changed? || component.shared_reactive_variables.intersect?(shared_changeset)
31
+ # Still last cycle's: a render that a callback halts doesn't replace it
32
+ component.rendered_children.clear
29
33
 
30
34
  begin
31
35
  component.broadcast_render
32
36
  rescue StandardError => error
33
37
  handle_error(component, error)
38
+ add_tree(component, :owned_children, rendered)
34
39
  end
35
40
 
36
- rendered |= [component] | component.rendered_children
41
+ add_tree(component, :rendered_children, rendered)
37
42
  end
38
43
 
39
44
  # Deliver events from components that didn't broadcast a render this
40
45
  # cycle (no state change, or rendered inline by a parent) - rendered
41
- # components already flushed their events with the refresh.
46
+ # components already flushed their events with the refresh, and the
47
+ # component awaiting its reply sends them with its _ack.
42
48
  #
43
49
  # A component rendered inline by a parent has no channel of its own
44
50
  # yet, so it can't deliver anything. Leave its events queued (don't
@@ -46,11 +52,37 @@ module LiveCable
46
52
  # rather than silently dropped here.
47
53
  components.each_value do |component|
48
54
  next unless component.subscribed?
55
+ next if awaiting_reply?(component)
49
56
 
50
57
  component.broadcast_events
51
58
  end
52
59
 
53
- rendered
60
+ rendered.to_a
61
+ end
62
+
63
+ # Parents come before the children they own, so a child its parent
64
+ # renders inline is already handled when the loop reaches it.
65
+ def parents_first(list)
66
+ children = list.each_with_object({}.compare_by_identity) do |component, by_parent|
67
+ by_parent[component] = component.owned_children
68
+ end
69
+ owned = Set.new.compare_by_identity.merge(children.values.flatten)
70
+ ordered = {}.compare_by_identity
71
+ visit = lambda do |component|
72
+ next if ordered.key?(component) || !children.key?(component)
73
+
74
+ ordered[component] = true
75
+ children[component].each(&visit)
76
+ end
77
+ list.each { |component| visit.call(component) unless owned.include?(component) }
78
+
79
+ ordered.keys.concat(list.reject { |component| ordered.key?(component) })
80
+ end
81
+
82
+ def add_tree(component, children, seen)
83
+ return unless seen.add?(component)
84
+
85
+ component.public_send(children).each { |child| add_tree(child, children, seen) }
54
86
  end
55
87
  end
56
88
  end