From bab57641799e516a1cc2cc276dcf4a7662493e2c Mon Sep 17 00:00:00 2001 From: Hannah Wolfe Date: Tue, 6 Jul 2021 11:02:37 +0100 Subject: [PATCH] Simplified + unified debug naming conventions - Reduced the number of levels in our debug naming in the frontend - Unified components like "themes" and "routing" under one name - Should help to make debug slightly more useful again --- core/bridge.js | 3 +++ core/frontend/services/routing/CollectionRouter.js | 2 +- core/frontend/services/routing/ParentRouter.js | 2 +- core/frontend/services/routing/StaticPagesRouter.js | 2 +- core/frontend/services/routing/StaticRoutesRouter.js | 2 +- core/frontend/services/routing/TaxonomyRouter.js | 2 +- core/frontend/services/routing/bootstrap.js | 5 +++-- core/server/services/themes/loader.js | 2 +- core/server/services/themes/storage.js | 3 ++- core/server/services/themes/validate.js | 2 +- core/server/web/members/app.js | 2 +- core/server/web/parent/frontend.js | 4 ++-- core/server/web/site/app.js | 4 ++-- core/server/web/site/routes.js | 2 ++ 14 files changed, 22 insertions(+), 15 deletions(-) diff --git a/core/bridge.js b/core/bridge.js index 43127abddb..d852c5b067 100644 --- a/core/bridge.js +++ b/core/bridge.js @@ -8,6 +8,8 @@ * * This file is a great place for all the cross-component event handling in lieu of refactoring */ + +const debug = require('@tryghost/debug')('bridge'); const errors = require('@tryghost/errors'); const config = require('./shared/config'); const logging = require('@tryghost/logging'); @@ -73,6 +75,7 @@ class Bridge { reloadFrontend() { const apiVersion = this.getFrontendApiVersion(); + debug('reload frontend', apiVersion); const siteApp = require('./server/web/site/app'); siteApp.reload({apiVersion}); } diff --git a/core/frontend/services/routing/CollectionRouter.js b/core/frontend/services/routing/CollectionRouter.js index aecc03f7ee..ba6d66d8a8 100644 --- a/core/frontend/services/routing/CollectionRouter.js +++ b/core/frontend/services/routing/CollectionRouter.js @@ -1,4 +1,4 @@ -const debug = require('@tryghost/debug')('services:routing:collection-router'); +const debug = require('@tryghost/debug')('routing:collection-router'); const events = require('../../../server/lib/common/events'); const urlUtils = require('../../../shared/url-utils'); const ParentRouter = require('./ParentRouter'); diff --git a/core/frontend/services/routing/ParentRouter.js b/core/frontend/services/routing/ParentRouter.js index 006273ba90..642ba876ca 100644 --- a/core/frontend/services/routing/ParentRouter.js +++ b/core/frontend/services/routing/ParentRouter.js @@ -7,7 +7,7 @@ * Only allows for .use and .get at the moment - we don't have clear use-cases for anything else yet. */ -const debug = require('@tryghost/debug')('services:routing:ParentRouter'); +const debug = require('@tryghost/debug')('routing:parent-router'); const EventEmitter = require('events').EventEmitter; const express = require('../../../shared/express'); diff --git a/core/frontend/services/routing/StaticPagesRouter.js b/core/frontend/services/routing/StaticPagesRouter.js index 463117c6aa..e300415c7f 100644 --- a/core/frontend/services/routing/StaticPagesRouter.js +++ b/core/frontend/services/routing/StaticPagesRouter.js @@ -1,4 +1,4 @@ -const debug = require('@tryghost/debug')('services:routing:static-pages-router'); +const debug = require('@tryghost/debug')('routing:static-pages-router'); const urlUtils = require('../../../shared/url-utils'); const ParentRouter = require('./ParentRouter'); const controllers = require('./controllers'); diff --git a/core/frontend/services/routing/StaticRoutesRouter.js b/core/frontend/services/routing/StaticRoutesRouter.js index 0e5bb58a92..9f68ebd35b 100644 --- a/core/frontend/services/routing/StaticRoutesRouter.js +++ b/core/frontend/services/routing/StaticRoutesRouter.js @@ -1,4 +1,4 @@ -const debug = require('@tryghost/debug')('services:routing:static-routes-router'); +const debug = require('@tryghost/debug')('routing:static-routes-router'); const events = require('../../../server/lib/common/events'); const errors = require('@tryghost/errors'); const urlUtils = require('../../../shared/url-utils'); diff --git a/core/frontend/services/routing/TaxonomyRouter.js b/core/frontend/services/routing/TaxonomyRouter.js index 322e8dc133..584793659c 100644 --- a/core/frontend/services/routing/TaxonomyRouter.js +++ b/core/frontend/services/routing/TaxonomyRouter.js @@ -1,4 +1,4 @@ -const debug = require('@tryghost/debug')('services:routing:taxonomy-router'); +const debug = require('@tryghost/debug')('routing:taxonomy-router'); const config = require('../../../shared/config'); const events = require('../../../server/lib/common/events'); const ParentRouter = require('./ParentRouter'); diff --git a/core/frontend/services/routing/bootstrap.js b/core/frontend/services/routing/bootstrap.js index e983873857..abbd27c25d 100644 --- a/core/frontend/services/routing/bootstrap.js +++ b/core/frontend/services/routing/bootstrap.js @@ -1,4 +1,4 @@ -const debug = require('@tryghost/debug')('services:routing:bootstrap'); +const debug = require('@tryghost/debug')('routing'); const _ = require('lodash'); const events = require('../../../server/lib/common/events'); const frontendSettings = require('../settings'); @@ -28,7 +28,7 @@ let siteRouter; * @returns {ExpressRouter} */ module.exports.init = (options = {start: false}) => { - debug('bootstrap'); + debug('bootstrap init', options); registry.resetAllRouters(); registry.resetAllRoutes(); @@ -65,6 +65,7 @@ module.exports.init = (options = {start: false}) => { * @param {object} dynamicRoutes */ module.exports.start = (apiVersion, dynamicRoutes) => { + debug('bootstrap start', apiVersion, dynamicRoutes); const RESOURCE_CONFIG = require(`./config/${apiVersion}`); const unsubscribeRouter = new UnsubscribeRouter(); diff --git a/core/server/services/themes/loader.js b/core/server/services/themes/loader.js index caeaef3be6..8e4363c21e 100644 --- a/core/server/services/themes/loader.js +++ b/core/server/services/themes/loader.js @@ -1,4 +1,4 @@ -const debug = require('@tryghost/debug')('themes:loader'); +const debug = require('@tryghost/debug')('themes'); const config = require('../../../shared/config'); const packageJSON = require('@tryghost/package-json'); const themeList = require('./list'); diff --git a/core/server/services/themes/storage.js b/core/server/services/themes/storage.js index 5e8b017413..0cd0ca0219 100644 --- a/core/server/services/themes/storage.js +++ b/core/server/services/themes/storage.js @@ -1,3 +1,4 @@ +const debug = require('@tryghost/debug')('themes'); const fs = require('fs-extra'); const bridge = require('../../../bridge'); @@ -11,7 +12,7 @@ const settingsCache = require('../../../shared/settings-cache'); const i18n = require('../../../shared/i18n'); const logging = require('@tryghost/logging'); const errors = require('@tryghost/errors'); -const debug = require('@tryghost/debug')('api:themes'); + const ObjectID = require('bson-objectid'); let themeStorage; diff --git a/core/server/services/themes/validate.js b/core/server/services/themes/validate.js index c995dea899..e82c51b072 100644 --- a/core/server/services/themes/validate.js +++ b/core/server/services/themes/validate.js @@ -1,4 +1,4 @@ -const debug = require('@tryghost/debug')('theme:validate'); +const debug = require('@tryghost/debug')('themes'); const _ = require('lodash'); const Promise = require('bluebird'); const fs = require('fs-extra'); diff --git a/core/server/web/members/app.js b/core/server/web/members/app.js index 196fff8fe5..3706b32a29 100644 --- a/core/server/web/members/app.js +++ b/core/server/web/members/app.js @@ -1,4 +1,4 @@ -const debug = require('@tryghost/debug')('web:members:app'); +const debug = require('@tryghost/debug')('members'); const {URL} = require('url'); const cors = require('cors'); const bodyParser = require('body-parser'); diff --git a/core/server/web/parent/frontend.js b/core/server/web/parent/frontend.js index c38319b428..6276195eef 100644 --- a/core/server/web/parent/frontend.js +++ b/core/server/web/parent/frontend.js @@ -1,4 +1,4 @@ -const debug = require('@tryghost/debug')('web:frontend'); +const debug = require('@tryghost/debug')('frontend'); const express = require('../../../shared/express'); const shared = require('../shared'); @@ -9,7 +9,7 @@ const shared = require('../shared'); * @returns {import('express').RequestHandler} */ module.exports = (options) => { - debug('FrontendApp setup start'); + debug('FrontendApp setup start', options); // FRONTEND const frontendApp = express('frontend'); diff --git a/core/server/web/site/app.js b/core/server/web/site/app.js index 6cd0897d92..603cd7233e 100644 --- a/core/server/web/site/app.js +++ b/core/server/web/site/app.js @@ -1,4 +1,4 @@ -const debug = require('@tryghost/debug')('web:site:app'); +const debug = require('@tryghost/debug')('frontend'); const path = require('path'); const express = require('../../../shared/express'); const cors = require('cors'); @@ -73,7 +73,7 @@ function SiteRouter(req, res, next) { } module.exports = function setupSiteApp(options = {}) { - debug('Site setup start'); + debug('Site setup start', options); const siteApp = express('site'); diff --git a/core/server/web/site/routes.js b/core/server/web/site/routes.js index 6d3cef475c..6badbe821b 100644 --- a/core/server/web/site/routes.js +++ b/core/server/web/site/routes.js @@ -1,5 +1,7 @@ +const debug = require('@tryghost/debug')('routing'); const routing = require('../../../frontend/services/routing'); module.exports = function siteRoutes(options = {}) { + debug('site Routes', options); return routing.bootstrap.init(options); };