Which strategy ensures zero-downtime migration to Pug for existing Node.js views?

Answer the Question First

Yes, Express can render multiple view engines simultaneously by mapping each engine to a distinct file extension. The safest, zero‑downtime approach is to keep the legacy views with their original extension (e.g., .html or .ejs) and register Pug for .pug. Then, for each route you migrate, change the view file name and route reference atomically, or guard the switch behind a feature flag or request header.

Confirmed Facts

• Express’s app.engine(ext, fn) registers a renderer for ext. The last registration wins for that extension.
• Views are chosen by file extension; res.render('index') will look for index.pug if .pug is registered, otherwise index.html (or index.ejs) if that extension is registered.
• Renaming a view file without updating the route that references it will result in a 404 or “template not found” error.
• A lightweight middleware can inspect a header (e.g., X-Use-Pug) or a feature‑flag environment variable to decide which file to render.

Practical Steps for a Phased Rollout

1. Register Both Engines

   const express = require('express');
   const app = express();
   
   // Legacy engine (e.g., EJS)
   app.engine('html', require('ejs').__express);
   app.set('view engine', 'html');
   app.set('views', __dirname + '/views');
   
   // Pug engine
   app.engine('pug', require('pug').__express);
   

2. Keep View Names Distinct
   • Legacy views remain *.html (or *.ejs).
   • New Pug views are named *.pug.
   • Do not rename a legacy file to .pug until the route that uses it is updated atomically.
3. Optional Feature‑Flag Middleware

   app.use((req, res, next) => {
     const usePug = process.env.USE_PUG === 'true' || req.headers['x-use-pug'] === 'true';
     req.usePug = usePug;
     next();
   });
   

4. Route‑Level Switch

   app.get('/dashboard', (req, res) => {
     const view = req.usePug ? 'dashboard' : 'dashboard'; // same name, different extension
     res.render(view);
   });
   

   When req.usePug is true, Express will resolve dashboard.pug; otherwise dashboard.html.

5. Atomic Route Updates

   Deploy a new version that:

   • Creates dashboard.pug.
   • Updates the route to point to dashboard (no extension in res.render).
   • Removes or renames the legacy dashboard.html only after all traffic is routed to Pug.

6. Verification
   • Send a request with X-Use-Pug: true and confirm the Pug view renders.
   • Send a request without the header and confirm the legacy view renders.
   • Monitor logs for any “template not found” errors during the transition window.

When the Migration Is Complete

Once all routes use .pug and the legacy files are removed, you can drop the legacy engine registration or keep it for safety. The application will continue to serve traffic without downtime because the rendering logic is controlled by extensions and optional flags.