Document Request.js in the guides [ci-skip] #47365
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
p8
force-pushed
the
guides/document-request-js
branch
2 times, most recently
from
4a6e5f9
to
c82ce11
Compare
zzak
reviewed
Feb 13, 2023
| When using another library to make Ajax calls, it is necessary to add the | ||
| security token as a default header for Ajax calls in your library. To get the | ||
| token, have a look at <meta name='csrf-token' content='THE-TOKEN'> tag printed | ||
| by <%= csrf_meta_tags %> in your application view. |
There was a problem hiding this comment.
I don't think users should be copy/pasting the output of csrf_meta_tags in their code as it will break the next time the secret changes.
I'm not sure the right approach is here though off the top of my head.
There was a problem hiding this comment.
document.head.querySelector("meta[name=csrf-token]")?.content does the trick (adapted from here)
There was a problem hiding this comment.
Thanks @bdewater !
I copied the original text from the security guide. I'll change it there as well.
p8
force-pushed
the
guides/document-request-js
branch
4 times, most recently
from
9706dd2
to
e3d5472
Compare
With the removal of UJS as a default dependency, it can be unclear what to use for Ajax calls. The Rails Request.js is the official library to use in this case, so it should be documented in the guides.
p8
force-pushed
the
guides/document-request-js
branch
from
e3d5472
to
83574a7
Compare
zzak
reviewed
Feb 14, 2023
| @@ -300,3 +301,43 @@ added to the form that the `button_to` helper renders internally: | |||
| ```erb | |||
| <%= button_to "Delete post", post, method: :delete, form: { data: { turbo_confirm: "Are you sure?" } } %> | |||
| ``` | |||
|
|
|||
| ### Ajax Requests | |||
There was a problem hiding this comment.
How about a link to the security doc with more detail on CSRF?
zzak
approved these changes
Apr 9, 2023
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.
With the removal of UJS as a default dependency, it can be unclear what to use for Ajax calls. The Rails Request.js is the official library to use in this case, so it should be documented in the guides.
Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]