fix(rack): ensure OPTIONS preflight requests are handled #18
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
paulsturgess
force-pushed
the
handle-options
branch
from
4b4006e to
af24b05
Compare
paulsturgess
commented
Nov 2, 2023
lib/apia/rack.rb
Outdated
Comment on lines
82
to
83
| route = find_route(request_method, api_path) | ||
| access_control_request_method = env['HTTP_ACCESS_CONTROL_REQUEST_METHOD']&.upcase | ||
| route = find_route((access_control_request_method || request_method), api_path) |
There was a problem hiding this comment.
In the options preflight request it tells us the request method of the actual API request in HTTP_ACCESS_CONTROL_REQUEST_METHOD, so we use that to find the corresponding route. Otherwise we just get a 404.
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method
There was a problem hiding this comment.
I think we should only use this header when requests themselves are OPTIONS.
jimeh
approved these changes
Nov 8, 2023
paulsturgess
force-pushed
the
handle-options
branch
from
9654854 to
81738e4
Compare
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.
This fix, to handle OPTIONS requests, allows us to use the swagger-editor user interface to test out OpenAPI generated specs from Apia.
To test this locally you'll need an API running with an OpenAPI spec for that API. Import the spec into swagger-editor and then use the "try it out" feature. It will send an OPTIONS preflight request, followed by the actual API request.