TryGhost/Ghost

View on GitHub
ghost/mw-version-match/lib/mw-version-match.js

Summary

Maintainability
A
0 mins
Test Coverage
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;