- Notifications
You must be signed in to change notification settings - Fork20.6k
WIP Build: Make the JavaScript middleware work on Nginx as well#5652
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
mgol wants to merge1 commit intojquery:mainChoose a base branch frommgol:nginx-js-middleware
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This file contains hidden or 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
We discussed this and I believe we're going to look into more options using docker. |
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
Summary
Extract handlers independent from
middleware-mockserver.cjs
into a separatemiddleware-handlers.js
file; add a separate wrapper for working with the nginx JavaScript engine.I wanted to get some opinions on whether this makes sense. nginx can be used with njs or QuickJS; I used the latter as njs is very limited (it doesn't even support named imports). JS feature support is pretty good but most Node.js modules are missing. On the other hand, handlers returning the status code, headers & body don't need a lot beyond the ability to read files (which works) & read the full body (available out of the box). I'm also reading
import.meta.dirname
which is not supported either so I'm just passing the dirname from nginx.Right now the nginx version only fails the multipart form data test, I haven't migrated that part. The rest passes.
A caveat: the nginx version available on macOS via Homebrew doesn't include the js module and it's impossible to add one. There's a separate tap for full nginx butit's broken at the moment.
I tried using the Docker
nginx:alpine
image and it worked without major issues, though. I could even use the config I currently use on macOS with only minor changes to enable the JS engine. The command to set this up:Then I just had to drop the
/etc/nginx
folder and create a symlink to/opt/homebrew/etc/nginx
in its place and add some config to the js module. It shouldn't be hard to create a Dockerfile for this if we wanted to make it easier for others as well.If we were to land this, I'd prefer to do this in multiple PRs to not lose history on
middleware-mockserver.cjs
.Checklist
New tests have been added to show the fix or feature worksIf needed, a docs issue/PR was created athttps://github.com/jquery/api.jquery.com