Allow Turbo to reload the page instead of morphing #40
Conversation
Morphing is the default, but setting config.hotwire.spark.html_reload_strategy to "turbo" will switch the reload strategy to Turbo reloading the current page.
|
Thanks a lot for working on this one 🙏! I'm traveling tomorrow, so I'll probably review it on Monday. Something I'd like to see is to keep the scroll when reloading the page with the Turbo visit. I've seen some discussions about how to achieve that with turbo. I think that listenting to |
There was a problem hiding this comment.
Thanks for working on this @codergeek121. This is a great feature. I added a first round of comments. Your approach is fine but I'd like to refine things a bit. Thanks 🙏
README.md
Outdated
| @@ -46,6 +46,7 @@ config.hotwire.spark.html_paths += %w[ lib ] | |||
| | `stimulus_paths` | Paths where file changes trigger a Stimulus controller refresh. By default: `app/javascript/controllers`. | | |||
| | `enabled` | Enable or disable live reloading. By default, it's only enabled in `development`. | | |||
| | `logging` | Show logs in the browser console when reloading happens. It's false by default. | | |||
| | `html_reload_strategy` | Reload html by morphing (`"morph"`) or with a Turbo page reload (`"turbo"`). By default `"morph"`. Use Turbo if your app is incompatible with morphing. | | |||
There was a problem hiding this comment.
I'd rename this option html_reload_method and offer as options morph or replace (to make this symmetric to page refresh options in Turbo)
Also, notice that the table should be formatted by aligning the column separators.
|
|
||
| export class HtmlReloader { | ||
| static async reload() { | ||
| return new HtmlReloader().reload() | ||
| } | ||
|
|
||
| async reload() { | ||
| const reloadedDocument = await this.#reloadHtml() | ||
| await this.#reloadStimulus(reloadedDocument) | ||
| if(HotwireSpark.config.htmlReloadStrategy == "morph") { |
There was a problem hiding this comment.
It think it would be good to place this call in the monitoring channel: to configure one reloader or the other depending on the config options. That way, we have separated reloaders for each option. They are quite different from each other, so I think it's better if each reload method has its own class:
reloadHtml() {
return this.#htmlReloader.reload()
},
get #htmlReloader() {
if (HotwireSpark.config.htmlReloadMethod == "morph") {
return MorphHtmlReloader
} else {
return ReplaceHtmlReloader
}
}
lib/hotwire/spark/middleware.rb
Outdated
| @@ -46,10 +46,15 @@ def inject_options(html) | |||
| html.sub("</head>", "#{logging_option}</head>") | |||
| else | |||
| html | |||
| end | |||
| end.sub("</head>", "#{html_reload_strategy_option}</head>") | |||
There was a problem hiding this comment.
Now that we have more than one option I think it would be nicer if we separated:
- The replacement action.
- From the logic composing the list of options
def inject_options(html)
html.sub("</head>", "#{options}</head>")
end
def options
[ logging_option, reload_method_option ].compact.join("\n")
end
def logging_option
view_helpers.tag.meta(name: "hotwire-spark:logging", content: "true") if Hotwire::Spark.logging
end
def reload_method_option
view_helpers.tag.meta(name: "hotwire-spark:html-reload-strategy", content: Hotwire::Spark.html_reload_method)
endThere was a problem hiding this comment.
I applied your suggestion 👍
An alternative/different approach could be to inject only a single meta tag with the complete JSON configuration:
view_helpers.tag.meta(name: "hotwire-spark:configuration", content: { ... }.to_json)document.addEventListener("DOMContentLoaded", function() {
const metaConfig = document.querySelector(`meta[name="hotwire-spark:configuration"]`)
HotwireSpark.config = JSON.parse(metaConfig.content)
})
|
@jorgemanrubia your review comments make sense to me! I'll address them in the coming days 👍Thank you for the review 🙇 |
turbo:load fires for initial page loads, so without my additional firstLoad check the attribute would always be set, even for the morph test. Now, only a second turbo:load event will add the attribute.
|
@jorgemanrubia I applied your first review suggestions. Let me know if you want me to adapt other parts as well 👍 |
Great idea/project!
I took a first stab at #24 to allow Turbo reloads instead of morphing.
Morphing is still the default, but setting
config.hotwire.spark.html_reload_strategyto "turbo" will switch the reload strategy to Turbo reloading the current page.I'm not sure if my custom promise for waiting until the turbo page reload is fully done is the best way to reload a page with Turbo, but I haven't found a better method for waiting until a visit is done.