Request based constraints implementation #166
There are no files selected for viewing
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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| 'use strict' | ||
|
|
||
| const ConstraintsStore = require('./constraints-store') | ||
|
|
||
| const acceptVersionStrategy = require('./strategies/accept-version') | ||
| const acceptHostStrategy = require('./strategies/accept-host') | ||
|
|
||
| const DEFAULT_STRATEGIES_NAMES = ['version', 'host'] | ||
|
|
||
| module.exports = (customStrategies) => { | ||
| const strategies = [ | ||
| new acceptVersionStrategy(), | ||
| new acceptHostStrategy() | ||
| ] | ||
|
|
||
| if (customStrategies) { | ||
| for (let i = 0; i < customStrategies.length; i++) { | ||
| const strategy = new customStrategies[i]() | ||
| if (DEFAULT_STRATEGIES_NAMES.indexOf(strategy.name) !== -1) { | ||
| strategies[i] = strategy | ||
| } else { | ||
| strategies.push(strategy) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return { | ||
| storage: function () { | ||
| const stores = {} | ||
| for (var i = 0; i < strategies.length; i++) { | ||
| stores[strategies[i].name] = strategies[i].storage() | ||
| } | ||
| return ConstraintsStore(stores) | ||
| }, | ||
| deriveConstraints: function (req, ctx) { | ||
| const derivedConstraints = {} | ||
|
There was a problem hiding this comment. This is no longer a super hot path and only gets invoked once per route match, right? Maybe not worth it, but if you wanted to be really fancy, you could set up this object's prototype outside this object literal with the early-prototype-definition trick Fastify uses elsewhere and that you mentioned in a comment. module.exports = (customStrategies) => {
const strategies = [
new acceptVersionStrategy(),
new acceptHostStrategy()
]
if (customStrategies) {
for (let i = 0; i < customStrategies.length; i++) {
const strategy = new customStrategies[i]()
if (DEFAULT_STRATEGIES_NAMES.indexOf(strategy.name) !== -1) {
strategies[i] = strategy
} else {
strategies.push(strategy)
}
}
}
// Bang out a full prototype ahead of time
const derivedConstraintsPrototype = class {};
for (const strategy of strategies) {
derivedConstraintsPrototype.prototype[strategy.name] = null
}
return {
storage: function () {
const stores = {}
for (var i = 0; i < strategies.length; i++) {
stores[strategies[i].name] = strategies[i].storage()
}
return ConstraintsStore(stores)
},
deriveConstraints: function (req, ctx) {
const derivedConstraints = new derivedConstraintsPrototype()
let value, hasConstraint = false
for (var i = 0; i < strategies.length; i++) {
value = strategies[i].deriveConstraint(req, ctx)
if (value) {
hasConstraint = true
derivedConstraints[strategies[i].name] = value
}
}
return hasConstraint ? derivedConstraints : null
}
}
} |
||
| let value, hasConstraint = false | ||
| for (var i = 0; i < strategies.length; i++) { | ||
| value = strategies[i].deriveConstraint(req, ctx) | ||
| if (value) { | ||
| hasConstraint = true | ||
| derivedConstraints[strategies[i].name] = value | ||
| } | ||
| } | ||
|
|
||
| return hasConstraint ? derivedConstraints : null | ||
| } | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| 'use strict' | ||
|
|
||
| const assert = require('assert') | ||
|
|
||
| function ConstraintsStore (stores) { | ||
| if (!(this instanceof ConstraintsStore)) { | ||
| return new ConstraintsStore(stores) | ||
| } | ||
| this.storeIdCounter = 1 | ||
| this.stores = stores | ||
| this.storeMap = new Map() | ||
| } | ||
|
|
||
| ConstraintsStore.prototype.set = function (constraints, store) { | ||
| // TODO: Should I check for existence of at least one constraint? | ||
|
|
||
| if (typeof constraints !== 'object' || constraints === null) { | ||
| throw new TypeError('Constraints should be an object') | ||
| } | ||
|
|
||
| const storeId = this.storeIdCounter++ | ||
| this.storeMap.set(storeId, store) | ||
|
|
||
| var kConstraint | ||
| const kConstraints = Object.keys(constraints) | ||
| for (var i = 0; i < kConstraints.length; i++) { | ||
| kConstraint = kConstraints[i] | ||
| assert(this.stores[kConstraint] !== null, `No strategy available for handling the constraint '${kConstraint}'`) | ||
| this.stores[kConstraint].set(constraints[kConstraint], storeId) | ||
| } | ||
|
|
||
| return this | ||
| } | ||
|
|
||
| ConstraintsStore.prototype.get = function (constraints, method) { | ||
| if (typeof constraints !== 'object' || constraints === null) { | ||
| throw new TypeError('Constraints should be an object') | ||
| } | ||
|
|
||
| var tmpStoreId, storeId | ||
| const kConstraints = Object.keys(constraints) | ||
| for (var i = 0; i < kConstraints.length; i++) { | ||
| const kConstraint = kConstraints[i] | ||
| assert(this.stores[kConstraint] !== null, `No strategy available for handling the constraint '${kConstraint}'`) | ||
| tmpStoreId = this.stores[kConstraint].get(constraints[kConstraint]) | ||
| if (!tmpStoreId || (storeId && tmpStoreId !== storeId)) return null | ||
| else storeId = tmpStoreId | ||
| } | ||
|
|
||
| if (storeId) { | ||
| const store = this.storeMap.get(storeId) | ||
| if (store && store[method]) return store | ||
| } | ||
|
|
||
| return null | ||
| } | ||
|
|
||
| module.exports = ConstraintsStore | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| 'use strict' | ||
|
|
||
| // TODO: Add regex support | ||
| function acceptHost() {} | ||
|
|
||
| function HostStore() { | ||
| let hosts = {} | ||
| return { | ||
| get: (host) => { return hosts[host] || null }, | ||
| set: (host, store) => { hosts[host] = store }, | ||
| del: (host) => { delete hosts[host] }, | ||
| empty: () => { hosts = {} } | ||
| } | ||
| } | ||
|
|
||
| acceptHost.prototype.name = 'host' | ||
| acceptHost.prototype.storage = HostStore | ||
| acceptHost.prototype.deriveConstraint = function (req, ctx) { | ||
| return req.headers['host'] | ||
| } | ||
|
|
||
| module.exports = acceptHost |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you mean?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I meant should the validation code check the properties inside
opts.constraintsand make sure there are strategies to handle each one of them?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes please, thanks.