feat: pass through hot: only to webpack-dev-server
#378
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
G-Rath
approved these changes
Nov 17, 2023
There was a problem hiding this comment.
Yeah it looks like those tests are pretty busted - this patch looks to be roughly what's needed to fix them:
Index: spec/shakapacker/dev_server_runner_spec.rb
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/spec/shakapacker/dev_server_runner_spec.rb b/spec/shakapacker/dev_server_runner_spec.rb
--- a/spec/shakapacker/dev_server_runner_spec.rb (revision 93d92f521c291c20531e1539e4981e77197f35d2)
+++ b/spec/shakapacker/dev_server_runner_spec.rb (date 1700249852510)
@@ -107,6 +107,38 @@
end.and_return(dev_server)
end
+ it "supports --hot" do
+ cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--hot"]
+
+ dev_server = double()
+ allow(dev_server).to receive(:host).and_return("localhost")
+ allow(dev_server).to receive(:port).and_return("3035")
+ allow(dev_server).to receive(:protocol).and_return("https")
+ allow(dev_server).to receive(:pretty?).and_return(false)
+ allow(dev_server).to receive(:https?).and_return(false)
+ allow(dev_server).to receive(:hmr?).and_return(true)
+
+ allow(Shakapacker::DevServer).to receive(:new).and_return(dev_server)
+
+ verify_command(cmd, argv: [])
+ end
+
+ it "supports --hot being 'only'" do
+ cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--hot", "only"]
+
+ dev_server = double()
+ allow(dev_server).to receive(:host).and_return("localhost")
+ allow(dev_server).to receive(:port).and_return("3035")
+ allow(dev_server).to receive(:protocol).and_return("https")
+ allow(dev_server).to receive(:pretty?).and_return(false)
+ allow(dev_server).to receive(:https?).and_return(false)
+ allow(dev_server).to receive(:hmr?).and_return("only")
+
+ allow(Shakapacker::DevServer).to receive(:new).and_return(dev_server)
+
+ verify_command(cmd, argv: [])
+ end
+
it "accepts environment variables" do
cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
env = Shakapacker::Compiler.env.dup
That gets it passing, but it probably means there's some refactoring that could be done to simplify the setup across all the tests.
I think it would be best to fix all the tests in that file in a dedicated PR so this change should be fine to land with or without my patch above
3 tasks
|
@G-Rath I merged your other chanegs. Please suggest the next steps on this one. |
|
@SimenB should be able to rebase and add tests now, which should also pretty much be the patch I've written up anyway - also happy to just merge as-is and I can do a new PR adding tests as I know how busy you can get Simen 🙂 |
|
Hey Gareth! 😀 I'm fine to add tests here - this is for work, so easier to prioritize 🙂 Lemme give it a whack. Especially as it's probably just copying on what you wrote down 👍 |
|
Pushed up a test. Just tweaking |
justin808
approved these changes
Dec 5, 2023
|
@SimenB @ahangarha @G-Rath |
|
@justin808 I've already fixed that in #383, the branch is just out of date - so it should be fine to be merged in |
|
I merged in master, so hopefully this is good to go now |
|
@SimenB thanks for your contribution! 🌺 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Webpack
devServer.hotproperty can be set to the stringonlyif you don't want an automatic refresh of the page it the update isn't accepted.https://webpack.js.org/configuration/dev-server/#devserverhot
This PR adds support for that setting in
shakapacker.yml.I tried adding tests, but changing e.g.
shakapacker/spec/shakapacker/dev_server_runner_spec.rb
Line 58 in c78a5c0
to
verify_command(cmd, argv: (["--nope, not here"]))does not fail the test - it still passes. So I'm not sure how to test it 😅It does work though - I've verified in my own project.
Pull Request checklist
Update documentation