Ghost/ghost/mw-version-match/lib/mw-version-match.js
Daniel Lockyer 93e0898c12
Extracted version-match middleware to separate package
- this middlware is standalone and has 100% test coverage, therefore we
  can move it out to a separate package and remap the requires
  accordingly
2023-02-27 18:34:03 +01:00

32 lines
1.1 KiB
JavaScript

const semver = require('semver');
const errors = require('@tryghost/errors');
const tpl = require('@tryghost/tpl');
const messages = {
versionMismatch: 'Client request for {clientVersion} does not match server version {serverVersion}.'
};
function checkVersionMatch(req, res, next) {
const clientVersion = req.get('X-Ghost-Version');
// can contain pre-release suffix, you should be able to use e.g. 1.19.0-pre [server] with 1.18.0 [client]
const serverVersion = res.locals.version.match(/^(\d+\.)?(\d+\.)?(\d+)/)[0];
const constraint = '^' + clientVersion + '.0';
// no error when client is on an earlier minor version than server
// error when client is on a later minor version than server
// always error when the major version is different
if (clientVersion && !semver.satisfies(serverVersion, constraint)) {
return next(new errors.VersionMismatchError({
message: tpl(messages.versionMismatch, {
clientVersion: clientVersion,
serverVersion: serverVersion
})
}));
}
next();
}
module.exports = checkVersionMatch;