Conversation
3131f28 to
5352311
Compare
At the moment middleware is executed in the order that it is registered.
This is fine if middleware is only registered in a single place, but in
distributed setups, there may be multiple places in code (possibly
across repos) that consumers may want to register middleware.
In order to allow some distributed way of defining an execution order
of middlewares, this is a non-breaking change that lets consumers define
an `order` for their middleware when registering:
```js
backend.use('commit', fn, 10);
```
This `order` will be used to sort the middlewares, such that higher
`order` execute after middleware with lower `order`. Ties are broken on
registration order (the current behaviour), since JavaScript's `.sort()`
[is stable][1].
The default value for `order` is `0`, so if consumers want to run
middleware before other middleware that has not specified an `order`,
they will need to set a negative `order` (which is legal):
```js
backend.use('commit', fn, -10);
```
[1]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#sort_stability
5352311 to
9064674
Compare
alecgibson
commented
Jul 24, 2025
| } | ||
| return this; | ||
| } | ||
| fn.__order = order || 0; |
Collaborator
Author
There was a problem hiding this comment.
I don't know how hacky/icky it is to define a property on the middleware function itself.
Ideally I would have wrapped this into an object or something:
{fn, order}...but this.middleware isn't prefixed, so consumers may technically assume it as part of the public API.
If I had access to modern ES features, I'd maybe use a WeakMap to avoid mutating the function, but we still technically target ES3.
Collaborator
Author
There was a problem hiding this comment.
There's also a bug here where if someone registers the same middleware on 2 different servers (in the same thread) with different orders, it'll overwrite the first order with the second order
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
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.
At the moment middleware is executed in the order that it is registered.
This is fine if middleware is only registered in a single place, but in distributed setups, there may be multiple places in code (possibly across repos) that consumers may want to register middleware.
In order to allow some distributed way of defining an execution order of middlewares, this is a non-breaking change that lets consumers define an
orderfor their middleware when registering:This
orderwill be used to sort the middlewares, such that higherorderexecute after middleware with lowerorder. Ties are broken on registration order (the current behaviour), since JavaScript's.sort()is stable.The default value for
orderis0, so if consumers want to run middleware before other middleware that has not specified anorder, they will need to set a negativeorder(which is legal):