Changed servePublicFile from middleware to router

ref https://linear.app/ghost/issue/BER-3095

- Extracted the public files code from the middleware to the router.
This avoids route comparison on every requests Ghost receives.

Author: rmgpinto

ghost/core/content/themes/source

@@ -4,6 +4,5 @@ module.exports = {
     frontendCaching: require('./frontend-caching'),
     handleImageSizes: require('./handle-image-sizes'),
     redirectGhostToAdmin: require('./redirect-ghost-to-admin'),
-    servePublicFile: require('./serve-public-file'),
     staticTheme: require('./static-theme')
 };

ghost/core/core/frontend/web/middleware/index.js

@@ -5,6 +5,9 @@ const errors = require('@tryghost/errors');
 const config = require('../../../shared/config');
 const urlUtils = require('../../../shared/url-utils');
 const tpl = require('@tryghost/tpl');
+const {cardAssets} = require('../../services/assets-minification');
+const themeEngine = require('../../services/theme-engine');
+const settingsCache = require('../../../shared/settings-cache');
 
 const messages = {
     imageNotFound: 'Image not found',
@@ -99,7 +102,6 @@ function createPublicFileMiddleware(location, file, mime, maxAge, options = {})
     };
 }
 
-// ### servePublicFile Middleware
 // Handles requests to robots.txt and favicon.ico (and caches them)
 function servePublicFile(location, file, type, maxAge, options = {}) {
     const publicFileMiddleware = createPublicFileMiddleware(location, file, type, maxAge, options);
@@ -113,6 +115,72 @@ function servePublicFile(location, file, type, maxAge, options = {}) {
     };
 }
 
-module.exports = servePublicFile;
+// Handles requests to public static files served by Ghost
+function servePublicFiles(siteApp) {
+    // Serve sitemap.xsl file if not found in theme
+    const defaultSitemapXslMiddleware = createPublicFileMiddleware('static', 'sitemap.xsl', 'text/xsl', config.get('caching:sitemapXSL:maxAge'));
+    siteApp.get('/sitemap.xsl', function serveSitemapXsl(req, res, next) {
+        const activeTheme = themeEngine.getActive();
+        if (!activeTheme) {
+            return defaultSitemapXslMiddleware(req, res, next);
+        }
+
+        const themeSitemapXslPath = path.join(activeTheme.path, 'sitemap.xsl');
+        fs.access(themeSitemapXslPath, fs.constants.R_OK, (err) => {
+            if (err) {
+                // Theme doesn't have sitemap.xsl, serve default
+                return defaultSitemapXslMiddleware(req, res, next);
+            }
+            // Theme has sitemap.xsl, let staticTheme middleware handle it
+            return next();
+        });
+    });
+
+    // Serve stylesheets for default templates
+    siteApp.get('/public/ghost.css', createPublicFileMiddleware('static', 'public/ghost.css', 'text/css', config.get('caching:publicAssets:maxAge')));
+    siteApp.get('/public/ghost.min.css', createPublicFileMiddleware('static', 'public/ghost.min.css', 'text/css', config.get('caching:publicAssets:maxAge')));
+
+    // Traffic analytics tracking script
+    siteApp.get('/public/ghost-stats.min.js', createPublicFileMiddleware('static', 'public/ghost-stats.min.js', 'application/javascript', config.get('caching:publicAssets:maxAge')));
+
+    // Card assets (built on the fly)
+    siteApp.get('/public/cards.min.css', cardAssets.serveMiddleware(), createPublicFileMiddleware('built', 'public/cards.min.css', 'text/css', config.get('caching:publicAssets:maxAge')));
+    siteApp.get('/public/cards.min.js', cardAssets.serveMiddleware(), createPublicFileMiddleware('built', 'public/cards.min.js', 'application/javascript', config.get('caching:publicAssets:maxAge')));
+
+    // Comment counts
+    siteApp.get('/public/comment-counts.min.js', createPublicFileMiddleware('static', 'public/comment-counts.min.js', 'application/javascript', config.get('caching:publicAssets:maxAge')));
+
+    // Member attribution
+    siteApp.get('/public/member-attribution.min.js', createPublicFileMiddleware('static', 'public/member-attribution.min.js', 'application/javascript', config.get('caching:publicAssets:maxAge')));
+
+    // Recommendations well-known
+    siteApp.get('/.well-known/recommendations.json', createPublicFileMiddleware('built', '.well-known/recommendations.json', 'application/json', config.get('caching:publicAssets:maxAge'), {disableServerCache: true}));
+
+    // Serve robots.txt if not found in theme (and blog is not private)
+    const defaultRobotsTxtMiddleware = createPublicFileMiddleware('static', 'robots.txt', 'text/plain', config.get('caching:robotstxt:maxAge'));
+    siteApp.get('/robots.txt', function serveRobotsTxt(req, res, next) {
+        // If private blogging is enabled, let filterPrivateRoutes handle it
+        if (settingsCache.get('is_private')) {
+            return next();
+        }
+
+        const activeTheme = themeEngine.getActive();
+        if (!activeTheme) {
+            return defaultRobotsTxtMiddleware(req, res, next);
+        }
+
+        const themeRobotsTxtPath = path.join(activeTheme.path, 'robots.txt');
+        fs.access(themeRobotsTxtPath, fs.constants.R_OK, (err) => {
+            if (err) {
+                // Theme doesn't have robots.txt, serve default
+                return defaultRobotsTxtMiddleware(req, res, next);
+            }
+            // Theme has robots.txt, let staticTheme middleware handle it
+            return next();
+        });
+    });
+}
+
+module.exports = servePublicFiles;
 module.exports.servePublicFile = servePublicFile;
 module.exports.createPublicFileMiddleware = createPublicFileMiddleware;

…tend/web/middleware/serve-public-file.js …rontend/web/routers/serve-public-file.jsghost/core/core/frontend/web/middleware/serve-public-file.js renamed to ghost/core/core/frontend/web/routers/serve-public-file.js ghost/core/core/frontend/web/middleware/serve-public-file.js renamed to ghost/core/core/frontend/web/routers/serve-public-file.js

@@ -10,13 +10,13 @@ const storage = require('../../server/adapters/storage');
 const urlUtils = require('../../shared/url-utils');
 const sitemapHandler = require('../services/sitemap/handler');
 const serveFavicon = require('./routers/serve-favicon');
+const servePublicFiles = require('./routers/serve-public-file');
 const themeEngine = require('../services/theme-engine');
 const themeMiddleware = themeEngine.middleware;
 const membersService = require('../../server/services/members');
 const offersService = require('../../server/services/offers');
 const customRedirects = require('../../server/services/custom-redirects');
 const linkRedirects = require('../../server/services/link-redirection');
-const {cardAssets} = require('../services/assets-minification');
 const siteRoutes = require('./routes');
 const shared = require('../../server/web/shared');
 const errorHandler = require('@tryghost/mw-error-handler');
@@ -65,25 +65,8 @@ module.exports = function setupSiteApp(routerConfig) {
     // Favicon
     serveFavicon(siteApp);
 
-    // Serve sitemap.xsl file
-    siteApp.use(mw.servePublicFile('static', 'sitemap.xsl', 'text/xsl', config.get('caching:sitemapXSL:maxAge')));
-
-    // Serve stylesheets for default templates
-    siteApp.use(mw.servePublicFile('static', 'public/ghost.css', 'text/css', config.get('caching:publicAssets:maxAge')));
-    siteApp.use(mw.servePublicFile('static', 'public/ghost.min.css', 'text/css', config.get('caching:publicAssets:maxAge')));
-
-    // Traffic analytics tracking script
-    siteApp.use(mw.servePublicFile('static', 'public/ghost-stats.min.js', 'application/javascript', config.get('caching:publicAssets:maxAge')));
-
-    // Card assets
-    siteApp.use(cardAssets.serveMiddleware(), mw.servePublicFile('built', 'public/cards.min.css', 'text/css', config.get('caching:publicAssets:maxAge')));
-    siteApp.use(cardAssets.serveMiddleware(), mw.servePublicFile('built', 'public/cards.min.js', 'application/javascript', config.get('caching:publicAssets:maxAge')));
-
-    // Comment counts
-    siteApp.use(mw.servePublicFile('static', 'public/comment-counts.min.js', 'application/javascript', config.get('caching:publicAssets:maxAge')));
-
-    // Member attribution
-    siteApp.use(mw.servePublicFile('static', 'public/member-attribution.min.js', 'application/javascript', config.get('caching:publicAssets:maxAge')));
+    // Public files (sitemap.xsl, stylesheets, scripts, etc.)
+    servePublicFiles(siteApp);
 
     // Serve site images using the storage adapter
     siteApp.use(STATIC_IMAGE_URL_PREFIX, mw.handleImageSizes, storage.getStorage('images').serve());
@@ -101,9 +84,6 @@ module.exports = function setupSiteApp(routerConfig) {
         }
     );
 
-    // Recommendations well-known
-    siteApp.use(mw.servePublicFile('built', '.well-known/recommendations.json', 'application/json', config.get('caching:publicAssets:maxAge'), {disableServerCache: true}));
-
     // setup middleware for internal apps
     // @TODO: refactor this to be a proper app middleware hook for internal apps
     config.get('apps:internal').forEach((appName) => {
@@ -117,9 +97,6 @@ module.exports = function setupSiteApp(routerConfig) {
     // Theme static assets/files
     siteApp.use(mw.staticTheme());
 
-    // Serve robots.txt if not found in theme
-    siteApp.use(mw.servePublicFile('static', 'robots.txt', 'text/plain', config.get('caching:robotstxt:maxAge')));
-
     debug('Static content done');
 
     // site map - this should probably be refactored to be an internal app

ghost/core/core/frontend/web/site.js

@@ -1,7 +1,7 @@
 const should = require('should');
 const sinon = require('sinon');
 const fs = require('fs-extra');
-const servePublicFile = require('../../../../../core/frontend/web/middleware/serve-public-file');
+const {servePublicFile} = require('../../../../../core/frontend/web/routers/serve-public-file');
 
 describe('servePublicFile', function () {
     let res;