mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-04-01 02:41:39 -05:00
Hooked up api version compatibility middleware
refs https://github.com/TryGhost/Toolbox/issues/280 - ctd of putting pieces together to allow Ghost notifying owner and admin users about version mismatch errors - The `@tryghost/mw-api-version-mismatch` in a combination with api version compatibility service make the whole notification process play nicely :) - The flow of the logic from the request to a sent notification email is following: 1. Request comes is with an Accept-Version header that's behind current Ghost version and is not supported 2. mw-error-handler middleware's 'resourceNotFound' detects such request and returns a 406 with a special 'code' identifying if the version of the client is ahead or behind 3. mw-api-version-mismatch intercepts the 406 request with "code === 'UPDATE_CLIENT'` and calls up APIVersionCompatibilityService 4. emails are sent out to active owner and admin users - The above flow is also illustratd in the e2e tests that come with the changeset
This commit is contained in:
Naz
naz
parent
b56557ea04
commit
cc71bbfd61
9 changed files with 139 additions and 5 deletions
|
|
@ -4,6 +4,8 @@ const express = require('../../../shared/express');
|
|||
const urlUtils = require('../../../shared/url-utils');
|
||||
const sentry = require('../../../shared/sentry');
|
||||
const errorHandler = require('@tryghost/mw-error-handler');
|
||||
const versionMissmatchHandler = require('@tryghost/mw-api-version-mismatch');
|
||||
const {APIVersionCompatibilityServiceInstance} = require('../../services/api-version-compatibility');
|
||||
|
||||
module.exports = function setupApiApp() {
|
||||
debug('Parent API setup start');
|
||||
|
|
@ -30,6 +32,7 @@ module.exports = function setupApiApp() {
|
|||
|
||||
// Error handling for requests to non-existent API versions
|
||||
apiApp.use(errorHandler.resourceNotFound);
|
||||
apiApp.use(versionMissmatchHandler(APIVersionCompatibilityServiceInstance));
|
||||
apiApp.use(errorHandler.handleJSONResponse(sentry));
|
||||
|
||||
debug('Parent API setup end');
|
||||
|
|
|
|||
|
|
@ -5,8 +5,10 @@ const bodyParser = require('body-parser');
|
|||
const shared = require('../../../shared');
|
||||
const apiMw = require('../../middleware');
|
||||
const errorHandler = require('@tryghost/mw-error-handler');
|
||||
const versionMissmatchHandler = require('@tryghost/mw-api-version-mismatch');
|
||||
const sentry = require('../../../../../shared/sentry');
|
||||
const routes = require('./routes');
|
||||
const {APIVersionCompatibilityServiceInstance} = require('../../../../services/api-version-compatibility');
|
||||
|
||||
module.exports = function setupApiApp() {
|
||||
debug('Admin API canary setup start');
|
||||
|
|
@ -33,6 +35,7 @@ module.exports = function setupApiApp() {
|
|||
|
||||
// API error handling
|
||||
apiApp.use(errorHandler.resourceNotFound);
|
||||
apiApp.use(versionMissmatchHandler(APIVersionCompatibilityServiceInstance));
|
||||
apiApp.use(errorHandler.handleJSONResponseV2(sentry));
|
||||
|
||||
debug('Admin API canary setup end');
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ const sentry = require('../../../../../shared/sentry');
|
|||
const shared = require('../../../shared');
|
||||
const routes = require('./routes');
|
||||
const errorHandler = require('@tryghost/mw-error-handler');
|
||||
const versionMissmatchHandler = require('@tryghost/mw-api-version-mismatch');
|
||||
const {APIVersionCompatibilityServiceInstance} = require('../../../../services/api-version-compatibility');
|
||||
|
||||
module.exports = function setupApiApp() {
|
||||
debug('Content API canary setup start');
|
||||
|
|
@ -27,6 +29,7 @@ module.exports = function setupApiApp() {
|
|||
|
||||
// API error handling
|
||||
apiApp.use(errorHandler.resourceNotFound);
|
||||
apiApp.use(versionMissmatchHandler(APIVersionCompatibilityServiceInstance));
|
||||
apiApp.use(errorHandler.handleJSONResponse(sentry));
|
||||
|
||||
debug('Content API canary setup end');
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ const shared = require('../../../shared');
|
|||
const apiMw = require('../../middleware');
|
||||
const routes = require('./routes');
|
||||
const errorHandler = require('@tryghost/mw-error-handler');
|
||||
const versionMissmatchHandler = require('@tryghost/mw-api-version-mismatch');
|
||||
const {APIVersionCompatibilityServiceInstance} = require('../../../../services/api-version-compatibility');
|
||||
|
||||
module.exports = function setupApiApp() {
|
||||
debug('Admin API v2 setup start');
|
||||
|
|
@ -33,6 +35,7 @@ module.exports = function setupApiApp() {
|
|||
|
||||
// API error handling
|
||||
apiApp.use(errorHandler.resourceNotFound);
|
||||
apiApp.use(versionMissmatchHandler(APIVersionCompatibilityServiceInstance));
|
||||
apiApp.use(errorHandler.handleJSONResponseV2(sentry));
|
||||
|
||||
debug('Admin API v2 setup end');
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ const sentry = require('../../../../../shared/sentry');
|
|||
const shared = require('../../../shared');
|
||||
const routes = require('./routes');
|
||||
const errorHandler = require('@tryghost/mw-error-handler');
|
||||
const versionMissmatchHandler = require('@tryghost/mw-api-version-mismatch');
|
||||
const {APIVersionCompatibilityServiceInstance} = require('../../../../services/api-version-compatibility');
|
||||
|
||||
module.exports = function setupApiApp() {
|
||||
debug('Content API v2 setup start');
|
||||
|
|
@ -27,6 +29,7 @@ module.exports = function setupApiApp() {
|
|||
|
||||
// API error handling
|
||||
apiApp.use(errorHandler.resourceNotFound);
|
||||
apiApp.use(versionMissmatchHandler(APIVersionCompatibilityServiceInstance));
|
||||
apiApp.use(errorHandler.handleJSONResponse(sentry));
|
||||
|
||||
debug('Content API v2 setup end');
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ const shared = require('../../../shared');
|
|||
const apiMw = require('../../middleware');
|
||||
const routes = require('./routes');
|
||||
const errorHandler = require('@tryghost/mw-error-handler');
|
||||
const versionMissmatchHandler = require('@tryghost/mw-api-version-mismatch');
|
||||
const {APIVersionCompatibilityServiceInstance} = require('../../../../services/api-version-compatibility');
|
||||
|
||||
module.exports = function setupApiApp() {
|
||||
debug('Admin API v3 setup start');
|
||||
|
|
@ -33,6 +35,7 @@ module.exports = function setupApiApp() {
|
|||
|
||||
// API error handling
|
||||
apiApp.use(errorHandler.resourceNotFound);
|
||||
apiApp.use(versionMissmatchHandler(APIVersionCompatibilityServiceInstance));
|
||||
apiApp.use(errorHandler.handleJSONResponseV2(sentry));
|
||||
|
||||
debug('Admin API v3 setup end');
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ const sentry = require('../../../../../shared/sentry');
|
|||
const shared = require('../../../shared');
|
||||
const routes = require('./routes');
|
||||
const errorHandler = require('@tryghost/mw-error-handler');
|
||||
const versionMissmatchHandler = require('@tryghost/mw-api-version-mismatch');
|
||||
const {APIVersionCompatibilityServiceInstance} = require('../../../../services/api-version-compatibility');
|
||||
|
||||
module.exports = function setupApiApp() {
|
||||
debug('Content API v3 setup start');
|
||||
|
|
@ -27,6 +29,7 @@ module.exports = function setupApiApp() {
|
|||
|
||||
// API error handling
|
||||
apiApp.use(errorHandler.resourceNotFound);
|
||||
apiApp.use(versionMissmatchHandler(APIVersionCompatibilityServiceInstance));
|
||||
apiApp.use(errorHandler.handleJSONResponse(sentry));
|
||||
|
||||
debug('Content API v3 setup end');
|
||||
|
|
|
|||
|
|
@ -83,11 +83,69 @@ Object {
|
|||
}
|
||||
`;
|
||||
|
||||
exports[`API Versioning Admin API responds with error and sends email ONCE when requested version is BEHIND and CANNOT respond multiple times 1: [body] 1`] = `
|
||||
Object {
|
||||
"errors": Array [
|
||||
Object {
|
||||
"code": "UPDATE_CLIENT",
|
||||
"context": StringMatching /Provided client version v3\\.5 is outdated and is behind current Ghost version v\\\\d\\+\\\\\\.\\\\d\\+/,
|
||||
"details": null,
|
||||
"help": "Upgrade your Ghost API client.",
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
|
||||
"message": "Request not acceptable for provided Accept-Version header.",
|
||||
"property": null,
|
||||
"type": "RequestNotAcceptableError",
|
||||
},
|
||||
],
|
||||
}
|
||||
`;
|
||||
|
||||
exports[`API Versioning Admin API responds with error and sends email ONCE when requested version is BEHIND and CANNOT respond multiple times 2: [headers] 1`] = `
|
||||
Object {
|
||||
"access-control-allow-origin": "http://127.0.0.1:2369",
|
||||
"cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
|
||||
"content-length": "354",
|
||||
"content-type": "application/json; charset=utf-8",
|
||||
"etag": Any<String>,
|
||||
"vary": "Origin, Accept-Encoding",
|
||||
"x-powered-by": "Express",
|
||||
}
|
||||
`;
|
||||
|
||||
exports[`API Versioning Admin API responds with error and sends email ONCE when requested version is BEHIND and CANNOT respond multiple times 3: [body] 1`] = `
|
||||
Object {
|
||||
"errors": Array [
|
||||
Object {
|
||||
"code": "UPDATE_CLIENT",
|
||||
"context": StringMatching /Provided client version v3\\.5 is outdated and is behind current Ghost version v\\\\d\\+\\\\\\.\\\\d\\+/,
|
||||
"details": null,
|
||||
"help": "Upgrade your Ghost API client.",
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
|
||||
"message": "Request not acceptable for provided Accept-Version header.",
|
||||
"property": null,
|
||||
"type": "RequestNotAcceptableError",
|
||||
},
|
||||
],
|
||||
}
|
||||
`;
|
||||
|
||||
exports[`API Versioning Admin API responds with error and sends email ONCE when requested version is BEHIND and CANNOT respond multiple times 4: [headers] 1`] = `
|
||||
Object {
|
||||
"access-control-allow-origin": "http://127.0.0.1:2369",
|
||||
"cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
|
||||
"content-length": "354",
|
||||
"content-type": "application/json; charset=utf-8",
|
||||
"etag": Any<String>,
|
||||
"vary": "Origin, Accept-Encoding",
|
||||
"x-powered-by": "Express",
|
||||
}
|
||||
`;
|
||||
|
||||
exports[`API Versioning Admin API responds with error requested version is AHEAD and CANNOT respond 1: [body] 1`] = `
|
||||
Object {
|
||||
"errors": Array [
|
||||
Object {
|
||||
"code": null,
|
||||
"code": "UPDATE_GHOST",
|
||||
"context": StringMatching /Provided client version v999\\\\\\.1 is ahead of current Ghost instance version v\\\\d\\+\\\\\\.\\\\d\\+/,
|
||||
"details": null,
|
||||
"help": "Upgrade your Ghost instance.",
|
||||
|
|
@ -104,7 +162,7 @@ exports[`API Versioning Admin API responds with error requested version is AHEAD
|
|||
Object {
|
||||
"access-control-allow-origin": "http://127.0.0.1:2369",
|
||||
"cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
|
||||
"content-length": "338",
|
||||
"content-length": "348",
|
||||
"content-type": "application/json; charset=utf-8",
|
||||
"etag": Any<String>,
|
||||
"vary": "Origin, Accept-Encoding",
|
||||
|
|
@ -116,7 +174,7 @@ exports[`API Versioning Admin API responds with error when requested version is
|
|||
Object {
|
||||
"errors": Array [
|
||||
Object {
|
||||
"code": null,
|
||||
"code": "UPDATE_CLIENT",
|
||||
"context": StringMatching /Provided client version v3\\.1 is outdated and is behind current Ghost version v\\\\d\\+\\\\\\.\\\\d\\+/,
|
||||
"details": null,
|
||||
"help": "Upgrade your Ghost API client.",
|
||||
|
|
@ -133,7 +191,7 @@ exports[`API Versioning Admin API responds with error when requested version is
|
|||
Object {
|
||||
"access-control-allow-origin": "http://127.0.0.1:2369",
|
||||
"cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
|
||||
"content-length": "343",
|
||||
"content-length": "354",
|
||||
"content-type": "application/json; charset=utf-8",
|
||||
"etag": Any<String>,
|
||||
"vary": "Origin, Accept-Encoding",
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
const {agentProvider, fixtureManager, matchers} = require('../../utils/e2e-framework');
|
||||
const {agentProvider, fixtureManager, matchers, mockManager} = require('../../utils/e2e-framework');
|
||||
const {anyErrorId, anyString, stringMatching} = matchers;
|
||||
|
||||
describe('API Versioning', function () {
|
||||
|
|
@ -11,6 +11,14 @@ describe('API Versioning', function () {
|
|||
await agentAdminAPI.loginAsOwner();
|
||||
});
|
||||
|
||||
beforeEach(function () {
|
||||
mockManager.mockMail();
|
||||
});
|
||||
|
||||
afterEach(function () {
|
||||
mockManager.restore();
|
||||
});
|
||||
|
||||
it('responds with no content version header when accept version header is NOT PRESENT', async function () {
|
||||
await agentAdminAPI
|
||||
.get('site/')
|
||||
|
|
@ -79,6 +87,7 @@ describe('API Versioning', function () {
|
|||
await agentAdminAPI
|
||||
.get('removed_endpoint')
|
||||
.header('Accept-Version', 'v3.1')
|
||||
.header('User-Agent', 'Zapier 1.3')
|
||||
.expectStatus(406)
|
||||
.matchHeaderSnapshot({
|
||||
etag: anyString
|
||||
|
|
@ -89,6 +98,52 @@ describe('API Versioning', function () {
|
|||
id: anyErrorId
|
||||
}]
|
||||
});
|
||||
|
||||
mockManager.assert.sentEmailCount(1);
|
||||
mockManager.assert.sentEmail({
|
||||
subject: 'Attention required: Your Zapier 1.3 integration has failed',
|
||||
to: 'jbloggs@example.com'
|
||||
});
|
||||
});
|
||||
|
||||
it('responds with error and sends email ONCE when requested version is BEHIND and CANNOT respond multiple times', async function () {
|
||||
await agentAdminAPI
|
||||
.get('removed_endpoint')
|
||||
.header('Accept-Version', 'v3.5')
|
||||
.header('User-Agent', 'Zapier 1.4')
|
||||
.expectStatus(406)
|
||||
.matchHeaderSnapshot({
|
||||
etag: anyString
|
||||
})
|
||||
.matchBodySnapshot({
|
||||
errors: [{
|
||||
context: stringMatching(/Provided client version v3.5 is outdated and is behind current Ghost version v\d+\.\d+/),
|
||||
id: anyErrorId
|
||||
}]
|
||||
});
|
||||
|
||||
mockManager.assert.sentEmailCount(1);
|
||||
mockManager.assert.sentEmail({
|
||||
subject: 'Attention required: Your Zapier 1.4 integration has failed',
|
||||
to: 'jbloggs@example.com'
|
||||
});
|
||||
|
||||
await agentAdminAPI
|
||||
.get('removed_endpoint')
|
||||
.header('Accept-Version', 'v3.5')
|
||||
.header('User-Agent', 'Zapier 1.4')
|
||||
.expectStatus(406)
|
||||
.matchHeaderSnapshot({
|
||||
etag: anyString
|
||||
})
|
||||
.matchBodySnapshot({
|
||||
errors: [{
|
||||
context: stringMatching(/Provided client version v3.5 is outdated and is behind current Ghost version v\d+\.\d+/),
|
||||
id: anyErrorId
|
||||
}]
|
||||
});
|
||||
|
||||
mockManager.assert.sentEmailCount(1);
|
||||
});
|
||||
|
||||
it('responds with 404 error when the resource cannot be found', async function () {
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue