Improve DX around version mismatch warnings #641
Merged
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
✅ Deploy Preview for stimulusreflex ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
andrewmcodes
reviewed
Mar 5, 2023
|
Still need to review the code, but this is lovely. |
hopsoft
approved these changes
Mar 7, 2023
marcoroth
force-pushed
the
better-version-mismatch-warnings
branch
from
f1eba2d
to
a35fa9a
Compare
julianrubisch
approved these changes
Mar 13, 2023
2 tasks
marcoroth
added a commit
that referenced
this pull request
Mar 27, 2023
#651) Following up on #641 and #650, this pull request also shows version mismatch toasts when the CableReady versions don't match. Perviously it would just show toast messages when the StimulusReflex versions didn't match. ## Why should this be added Previously this just showed a console error message when the user enabled the client-side `debug` option to `true`. Now this message is always printed, regular of the option. But additionally it now shows a version mismatch toast message when the `debug` option is set to `true`:  This helps to know what's up and why a reflex action might not have worked. If you didn't have the console open you wouldn't know why the reflex action didn't work.
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.
Type of PR
Enhancement
Description
This pull request enhances the developer experience when the StimulusReflex client- and server-side versions mismatch. It will show a toast message in the lower right corner of the screen if there's a version mismatch. Previously it would just show it in the Rails server log.
It will only show the toasts if you try to trigger a reflex action, it won't complain earlier, which is also much friendlier, because in previous versions of StimulusReflex it wouldn't even let you start the Rails server.
This is what happens now if you try to trigger a reflex:
on
:exitit will show a red error toast message and won't execute the trigged reflex:on
:warnit will show a yellow warning toast message but will still execute the triggered reflex:on
:ignoreit won't show anything and also will also regularly execute the triggered reflex.Note: the
toastify-jsdependency will be bundled up with the built JavaScript version of the package, so it won't show up as a runtime dependency in applications running thestimulus_reflexnpm package.The toasts are currently not disabled in production environments, but I'm also not sure if we should. Any opinions on this?
Why should this be added
Improves the developer experience and makes it easier to noticed/work with.
Checklist