Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-27 22:49:56 -05:00
Code Issues Activity
ghost/core/server/web/api/app.js

35 lines
1.6 KiB
JavaScript
Raw Normal View History

Switch to @tryghost/debug, remove ghost-ignition no issue The only pieces of Ghost-Ignition used in Ghost were debug and logging. Both of these modules have been superceded by the Framework monorepo, and all usages of Ignition have now been removed, replaced with @tryghost/debug and @tryghost/logging.
2021-06-15 17:01:22 +01:00
const debug = require('@tryghost/debug')('web:api:default:app');
Added a server testmode to help test behaviour - A simple way to test behaviours without having to do complex interactions to e.g. generate errors or slow requests - Makes it easier to test the new shutdown behaviour, among other things
2020-08-10 16:19:09 +01:00
const config = require('../../../shared/config');
Moved express init + sentry to a shared util - added core/shared to watched folders in grunt - moved sentry to shared - moved express initialisation to a shared file - always set trust proxy + sentry error handler - use this new express init everywhere, and remove duplicate trust proxy and sentry error handler code
2020-04-25 20:53:58 +01:00
const express = require('../../../shared/express');
Moved core/server/lib/url-utils to core/shared/url-utils (#11856) * moved url-utils from server to shared * updated imports of url-utils
2020-05-28 05:57:02 -05:00
const urlUtils = require('../../../shared/url-utils');
Replace error handler middleware with @tryghost/mw-error-handler (#13879) refs: https://github.com/TryGhost/Toolbox/issues/137 Extract error handling middleware and replace with a package.
2021-12-14 15:18:46 +00:00
const sentry = require('../../../shared/sentry');
const errorHandler = require('@tryghost/mw-error-handler');
Renamed app related files+variables for clarity - renamed the parentApp in index.js to ghostApp, to reduce confusion with the layer that is named parentApp - renamed the adminApp inside of parentApp to backendApp to reflect the fact it's both admin+api - renamed a bunch more variables there to be backend, rather than admin - renamed the api index.js file to app.js and created a new index which is an actual index
2020-04-27 16:54:31 +01:00
module.exports = function setupApiApp() {
debug('Parent API setup start');
Added Router etc to shared/express + use everywhere - Added a wrapper around express.Router to our shared/express util - Also export static and _express - Use this shared util everywhre, meaning express is only used directly in this one file - ATM this file is mostly an experiment / debug helper, it might be removed again later - The aim is to have a minimal framework wrapping express that allows us to: - reduce our usage of express() in favour of Router() - unify some of our duplicated logic - fix some structural issues e.g. Sentry - make it easier to understand the codebase
2020-05-01 19:29:42 +01:00
const apiApp = express('api');
Renamed app related files+variables for clarity - renamed the parentApp in index.js to ghostApp, to reduce confusion with the layer that is named parentApp - renamed the adminApp inside of parentApp to backendApp to reflect the fact it's both admin+api - renamed a bunch more variables there to be backend, rather than admin - renamed the api index.js file to app.js and created a new index which is an actual index
2020-04-27 16:54:31 +01:00
Added a server testmode to help test behaviour - A simple way to test behaviours without having to do complex interactions to e.g. generate errors or slow requests - Makes it easier to test the new shutdown behaviour, among other things
2020-08-10 16:19:09 +01:00
if (config.get('server:testmode')) {
apiApp.use(require('./testmode')());
}
⚡ Improved Ghost boot time and memory usage by lazy loading routes no issue - right now, we mount all API endpoints (v2, v3 and canary), alongside some other routes, when Ghost is booting. This is wasteful because we don't necessarily need any of the endpoints to get Ghost up and running - even when Admin is used, it uses `canary` so `v2` and `v3` sit in memory - the better approach here is to lazy load these endpoints, so they only get mounted when needed - this commit adds the `lazyUse` function into our Express lib, which takes a mount path and a module function to execute down the line. This gets passed to the wonderful `express-lazy-router` lib which detects when we're calling an unmounted module and will mount it for us - from local testing, this speeds up boot time by about 18% and reduces initial memory usage by about 6% 🚀
2021-10-11 12:06:03 +02:00
apiApp.lazyUse(urlUtils.getVersionPath({version: 'v2', type: 'content'}), require('./v2/content/app'));
apiApp.lazyUse(urlUtils.getVersionPath({version: 'v2', type: 'admin'}), require('./v2/admin/app'));
Renamed app related files+variables for clarity - renamed the parentApp in index.js to ghostApp, to reduce confusion with the layer that is named parentApp - renamed the adminApp inside of parentApp to backendApp to reflect the fact it's both admin+api - renamed a bunch more variables there to be backend, rather than admin - renamed the api index.js file to app.js and created a new index which is an actual index
2020-04-27 16:54:31 +01:00
⚡ Improved Ghost boot time and memory usage by lazy loading routes no issue - right now, we mount all API endpoints (v2, v3 and canary), alongside some other routes, when Ghost is booting. This is wasteful because we don't necessarily need any of the endpoints to get Ghost up and running - even when Admin is used, it uses `canary` so `v2` and `v3` sit in memory - the better approach here is to lazy load these endpoints, so they only get mounted when needed - this commit adds the `lazyUse` function into our Express lib, which takes a mount path and a module function to execute down the line. This gets passed to the wonderful `express-lazy-router` lib which detects when we're calling an unmounted module and will mount it for us - from local testing, this speeds up boot time by about 18% and reduces initial memory usage by about 6% 🚀
2021-10-11 12:06:03 +02:00
apiApp.lazyUse(urlUtils.getVersionPath({version: 'v3', type: 'content'}), require('./v3/content/app'));
apiApp.lazyUse(urlUtils.getVersionPath({version: 'v3', type: 'admin'}), require('./v3/admin/app'));
Renamed app related files+variables for clarity - renamed the parentApp in index.js to ghostApp, to reduce confusion with the layer that is named parentApp - renamed the adminApp inside of parentApp to backendApp to reflect the fact it's both admin+api - renamed a bunch more variables there to be backend, rather than admin - renamed the api index.js file to app.js and created a new index which is an actual index
2020-04-27 16:54:31 +01:00
⚡ Improved Ghost boot time and memory usage by lazy loading routes no issue - right now, we mount all API endpoints (v2, v3 and canary), alongside some other routes, when Ghost is booting. This is wasteful because we don't necessarily need any of the endpoints to get Ghost up and running - even when Admin is used, it uses `canary` so `v2` and `v3` sit in memory - the better approach here is to lazy load these endpoints, so they only get mounted when needed - this commit adds the `lazyUse` function into our Express lib, which takes a mount path and a module function to execute down the line. This gets passed to the wonderful `express-lazy-router` lib which detects when we're calling an unmounted module and will mount it for us - from local testing, this speeds up boot time by about 18% and reduces initial memory usage by about 6% 🚀
2021-10-11 12:06:03 +02:00
apiApp.lazyUse(urlUtils.getVersionPath({version: 'v4', type: 'content'}), require('./canary/content/app'));
apiApp.lazyUse(urlUtils.getVersionPath({version: 'v4', type: 'admin'}), require('./canary/admin/app'));
Added missing v4 API endpoints mount refs https://github.com/TryGhost/Ghost/commit/ff6d31e08f132981ddd4ef0f0b90f2e80fe40f09 refs https://github.com/TryGhost/Team/issues/513 - The API was missing from the referenced commit when v3 was being extracted
2021-03-03 18:44:00 +13:00
⚡ Improved Ghost boot time and memory usage by lazy loading routes no issue - right now, we mount all API endpoints (v2, v3 and canary), alongside some other routes, when Ghost is booting. This is wasteful because we don't necessarily need any of the endpoints to get Ghost up and running - even when Admin is used, it uses `canary` so `v2` and `v3` sit in memory - the better approach here is to lazy load these endpoints, so they only get mounted when needed - this commit adds the `lazyUse` function into our Express lib, which takes a mount path and a module function to execute down the line. This gets passed to the wonderful `express-lazy-router` lib which detects when we're calling an unmounted module and will mount it for us - from local testing, this speeds up boot time by about 18% and reduces initial memory usage by about 6% 🚀
2021-10-11 12:06:03 +02:00
apiApp.lazyUse(urlUtils.getVersionPath({version: 'canary', type: 'content'}), require('./canary/content/app'));
apiApp.lazyUse(urlUtils.getVersionPath({version: 'canary', type: 'admin'}), require('./canary/admin/app'));
Renamed app related files+variables for clarity - renamed the parentApp in index.js to ghostApp, to reduce confusion with the layer that is named parentApp - renamed the adminApp inside of parentApp to backendApp to reflect the fact it's both admin+api - renamed a bunch more variables there to be backend, rather than admin - renamed the api index.js file to app.js and created a new index which is an actual index
2020-04-27 16:54:31 +01:00
// Error handling for requests to non-existent API versions
apiApp.use(errorHandler.resourceNotFound);
Replace error handler middleware with @tryghost/mw-error-handler (#13879) refs: https://github.com/TryGhost/Toolbox/issues/137 Extract error handling middleware and replace with a package.
2021-12-14 15:18:46 +00:00
apiApp.use(errorHandler.handleJSONResponse(sentry));
Renamed app related files+variables for clarity - renamed the parentApp in index.js to ghostApp, to reduce confusion with the layer that is named parentApp - renamed the adminApp inside of parentApp to backendApp to reflect the fact it's both admin+api - renamed a bunch more variables there to be backend, rather than admin - renamed the api index.js file to app.js and created a new index which is an actual index
2020-04-27 16:54:31 +01:00
debug('Parent API setup end');
return apiApp;
};
Reference in a new issue Copy permalink