Replace jquery_ujs with rails-ujs in frontend and backend #3027
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
This page allows changing memo via an ajax call and this behavior should be tested.
rails-ujs has a different api handling ajax events than jquery_ujs. The former passes all the event information into the event.detail object while the latter accept different parameters. For more details see: - https://edgeguides.rubyonrails.org/working_with_javascript_in_rails.html#rails-ujs-event-handlers - https://github.com/rails/jquery-ujs/wiki/ajax
Starting from version 5.1, Rails already includes a built-in unobtrusive scripting adapter, named rails-ujs. This library does not depend anymore on jQuery and we should start adopting it.
It's already included in spree/backend/all.js that is generated by the install command and injected into apps. Having those same requires in both places is not creating issues since sprockets is smart enough to understand that and add them once: https://github.com/rails/sprockets#require By doing this way we can let users choose which ujs they want to use since they can just change the value in the spree/backend/all.js that we are injecting in their application.
This is now needed since those requires have been removed from spree/backend manifest and need to be required manually.
kennyadsl
changed the title
jacobherrington
approved these changes
Jan 12, 2019
aitbw
approved these changes
Jan 14, 2019
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.
Why swtiching to rails-ujs?
Starting from version 5.1, Rails already includes a built-in unobtrusive scripting adapter, named
rails-ujs. This library does not depend anymore on jQuery, likejquery_ujsand we should start adopting it.This PR switches Solidus to this new library to second what Rails does, still allowing users to change it in their own app manifests if needed.
Backward compatibility
Backward compatibility should be respected since existing stores manifests files are not changed, so when users upgrade to newer version of Solidus they should still use what they was previously doing.
The only breaking scenario could be when stores changed the provided
backendmanifest from:to
which should be legit since
jqueryandjquery_ujswere already included intospree/backendmanifest. (This PR also removes these double requires). In this case, users can just re-add these two requires to their manifest using eitherrails-ujsorjquery_ujs.Differences between rails-ujs and jquery_ujs
The only difference in the API is related to how ajax event are handled:
rails-ujspasses all the event information into the event.detail object whilejquery_ujsaccepts different parameters. For more details see:1b20df7