feature: allow actions to render turbo streams #2796

Paul-Bob · 2024-05-22T16:50:46Z

Description

This PR enables enhancing action response by adding custom turbo streams.

def handle(**args)
  # ...

  # Single
  append_to_response -> {
    turbo_stream.set_title("Dummy action custom stream ;)")
  }

  # Array
  append_to_response -> {
    [
      turbo_stream.set_title("Cool title"),
      turbo_stream.set_title("Cool title 2")
    ]
  }
end

Checklist:

I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
- append to response docs.avohq.io#241
I have added tests that prove my fix is effective or that my feature works

Screenshots & recording

Manual review steps

Step 1
Step 2

Manual reviewer: please leave a comment with output from the test if that's the case.

codeclimate · 2024-05-22T16:51:14Z

Code Climate has analyzed commit 5b269f4 and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	1

View more on Code Climate.

lib/avo/base_action.rb

github-actions · 2024-06-07T02:00:29Z

This PR has been marked as stale because there was no activity for the past 15 days.

github-actions · 2024-06-27T02:00:27Z

This PR has been marked as stale because there was no activity for the past 15 days.

adrianthedev

Let's rename it to respond_with and left a few tweaks

adrianthedev · 2024-07-09T08:19:12Z

spec/dummy/app/avo/actions/test/close_modal.rb

+    enhance_response turbo_stream: -> {
+      turbo_stream.set_title("Dummy action custom stream ;)")
+    }
  end


Let's rename it to respond_with and pass in an array or a single turbo_stream action.

The reason why I'm thinking to not do this turbo_stream: -> si because we only respond with turbo streams... It's a bit redundant to declare it every time, right?
Do you see any caveats?

Suggested change

enhance_response turbo_stream: -> {

turbo_stream.set_title("Dummy action custom stream ;)")

}

end

enhance_response turbo_stream: -> {

turbo_stream.set_title("Dummy action custom stream ;)")

}

end

Let's rename it to respond_with ...

respond_with kinda sounds like is overriding the default responses.

enhance_response - "Add this to response"
respond_with - "Respond with this`

...and pass in an array or a single turbo_stream action.
The reason why I'm thinking to not do this turbo_stream: -> si because we only respond with turbo streams... It's a bit redundant to declare it every time, right?
Do you see any caveats?

You mean something like (I'll use enhance_response until renaming):

enhance_response turbo_stream: turbo_stream.set_title("Dummy action custom stream ;)") # OR enhance_response turbo_stream.set_title("Dummy action custom stream ;)")

And for array:

enhance_response turbo_stream: [ turbo_stream.set_title("Dummy action custom stream ;)"), turbo_stream... ] # OR enhance_response [ turbo_stream.set_title("Dummy action custom stream ;)"), turbo_stream... ]

Do you see any caveats?

1 - not sure if turbo_stream helper method is present.
2 - no more controller response context

adrianthedev · 2024-07-09T08:19:58Z

app/controllers/avo/actions_controller.rb

          end
+
+          responses = if @action.enhanced_turbo_streams.present?


can't we include this if statement in the case statement above?

The scope of this feature is to add one or several turbo-stream responses to the pre-existing response

def handle(**args) succeed "Modal closed!!" close_modal enhance_response turbo_stream: -> { turbo_stream.set_title("Dummy action custom stream ;)") } end

For example on the code above we want the success message to be rendered, the modal to be closed then enhance that response with the turbo_stream.set_title("Dummy action custom stream ;)")

If we add the if statement on the case above the action would respond only with turbo_stream.set_title("Dummy action custom stream ;)") ignoring succeed "Modal closed!!" and close_modal responses.

Paul-Bob · 2024-07-10T08:24:40Z

Naming suggestions:
1 - respond_with
2 - add_to_response
3 - append_to_response
4 - attach_to_response
5 - merge_with_response
6 - include_in_response
7 - insert_into_response
8 - concatenate_response

adrianthedev · 2024-07-10T09:12:26Z

I like append_to_response @Paul-Bob. Let's push it!

spec/system/avo/actions_spec.rb

Paul-Bob · 2024-07-10T10:05:42Z

@adrianthedev changes & docs applied

github-actions · 2024-07-10T10:10:23Z

spec/system/avo/actions_spec.rb

@@ -196,6 +197,7 @@
      click_on "Run"
      expect(page).not_to have_selector(modal)
      expect(page).to have_text "Modal closed!!"
+      expect(page).to have_title("Cool title")


[rubocop] _{reported by reviewdog 🐶}
[Corrected] Style/StringLiterals: Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

github-actions · 2024-07-10T10:10:24Z

spec/system/avo/actions_spec.rb

@@ -196,6 +197,7 @@
      click_on "Run"
      expect(page).not_to have_selector(modal)
      expect(page).to have_text "Modal closed!!"
+      expect(page).to have_title("Cool title")


[rubocop] _{reported by reviewdog 🐶}
[Corrected] Style/StringLiterals: Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

adrianthedev · 2024-07-10T10:37:45Z

spec/dummy/app/avo/actions/test/close_modal.rb

+    append_to_response -> {
+      turbo_stream.set_title("Cool title")
+    }


Haven't we settled on using an array notation?
I mean, why the extra block?

Suggested change

append_to_response -> {

turbo_stream.set_title("Cool title")

}

append_to_response([

turbo_stream.set_title("Cool title")

])

I guess we could do

append_to_response do turbo_stream... end

Forget about it. A block is enough. I hope users don't mistake it for the Execution Context.

LEt's also discuss this possibility

# turbo_stream_response will be executed instead the default `render turbo_stream: responses` from actions controller turbo_stream_response -> { render turbo_stream: [ *default_responses, # can include or not the default responses turbo_stream.set_title("Cool title"), turbo_stream.... ] }

github-actions · 2024-07-12T13:30:48Z

This PR has been merged into main. The functionality will be available in the next release.

Please check the release guide for more information.

feature: allow actions to render turbo streams

aa96f6f

Paul-Bob self-assigned this May 22, 2024

Paul-Bob marked this pull request as draft May 22, 2024 16:50

github-actions bot added the Feature label May 22, 2024

github-actions bot reviewed May 22, 2024

View reviewed changes

lib/avo/base_action.rb Outdated Show resolved Hide resolved

github-actions bot added the Stale label Jun 7, 2024

adrianthedev removed the Stale label Jun 7, 2024

adrianthedev mentioned this pull request Jun 7, 2024

Action responses should have an option to only refresh relevant section #2787

Closed

github-actions bot added the Stale label Jun 27, 2024

Paul-Bob removed the Stale label Jul 5, 2024

Paul-Bob and others added 3 commits July 8, 2024 11:09

lint

256454b

fix & test

3850c27

Merge branch 'main' into feature/allow_actions_to_render_turbo_streams

e93124a

Paul-Bob marked this pull request as ready for review July 8, 2024 09:34

Paul-Bob requested a review from adrianthedev July 8, 2024 09:35

adrianthedev requested changes Jul 9, 2024

View reviewed changes

rename & drop turbo_stream keyword

c25ab93

github-actions bot reviewed Jul 10, 2024

View reviewed changes

spec/system/avo/actions_spec.rb Outdated Show resolved Hide resolved

spec/system/avo/actions_spec.rb Outdated Show resolved Hide resolved

Paul-Bob requested a review from adrianthedev July 10, 2024 10:03

lint

f3c3d3b

github-actions bot reviewed Jul 10, 2024

View reviewed changes

adrianthedev reviewed Jul 10, 2024

View reviewed changes

Paul-Bob added 2 commits July 12, 2024 16:08

fix tests

5b53f80

lint

5b269f4

Paul-Bob merged commit b396c12 into main Jul 12, 2024
19 of 21 checks passed

Paul-Bob deleted the feature/allow_actions_to_render_turbo_streams branch July 12, 2024 13:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: allow actions to render turbo streams #2796

feature: allow actions to render turbo streams #2796

Paul-Bob commented May 22, 2024 •

edited

Loading

codeclimate bot commented May 22, 2024 •

edited

Loading

github-actions bot commented Jun 7, 2024

github-actions bot commented Jun 27, 2024

adrianthedev left a comment

adrianthedev Jul 9, 2024

Paul-Bob Jul 9, 2024 •

edited

Loading

adrianthedev Jul 9, 2024

Paul-Bob Jul 9, 2024

Paul-Bob commented Jul 10, 2024

adrianthedev commented Jul 10, 2024

Paul-Bob commented Jul 10, 2024

github-actions bot Jul 10, 2024

github-actions bot Jul 10, 2024

adrianthedev Jul 10, 2024

adrianthedev Jul 10, 2024

adrianthedev Jul 10, 2024

Paul-Bob Jul 10, 2024

github-actions bot commented Jul 12, 2024

feature: allow actions to render turbo streams #2796

feature: allow actions to render turbo streams #2796

Conversation

Paul-Bob commented May 22, 2024 • edited Loading

Description

Checklist:

Screenshots & recording

Manual review steps

codeclimate bot commented May 22, 2024 • edited Loading

github-actions bot commented Jun 7, 2024

github-actions bot commented Jun 27, 2024

adrianthedev left a comment

Choose a reason for hiding this comment

adrianthedev Jul 9, 2024

Choose a reason for hiding this comment

Paul-Bob Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

adrianthedev Jul 9, 2024

Choose a reason for hiding this comment

Paul-Bob Jul 9, 2024

Choose a reason for hiding this comment

Paul-Bob commented Jul 10, 2024

adrianthedev commented Jul 10, 2024

Paul-Bob commented Jul 10, 2024

github-actions bot Jul 10, 2024

Choose a reason for hiding this comment

github-actions bot Jul 10, 2024

Choose a reason for hiding this comment

adrianthedev Jul 10, 2024

Choose a reason for hiding this comment

adrianthedev Jul 10, 2024

Choose a reason for hiding this comment

adrianthedev Jul 10, 2024

Choose a reason for hiding this comment

Paul-Bob Jul 10, 2024

Choose a reason for hiding this comment

github-actions bot commented Jul 12, 2024

Paul-Bob commented May 22, 2024 •

edited

Loading

codeclimate bot commented May 22, 2024 •

edited

Loading

Paul-Bob Jul 9, 2024 •

edited

Loading