npm - kempo-server - Versions diffs - 3.0.3 → 3.0.5 - Mend

kempo-server 3.0.3 → 3.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (29) hide show

package/dist/router.js +1 -1
package/dist/templating/index.js +1 -1
package/dist/templating/parse.js +1 -1
package/docs/caching.html +18 -13
package/docs/cli-utils.html +16 -13
package/docs/configuration.html +18 -13
package/docs/examples.html +16 -13
package/docs/fs-utils.html +16 -13
package/docs/getting-started.html +16 -13
package/docs/index.html +16 -13
package/docs/middleware.html +16 -13
package/docs/request-response.html +18 -13
package/docs/routing.html +16 -13
package/docs/templating.html +87 -31
package/docs-src/advanced-links.global.html +10 -0
package/docs-src/caching.page.html +2 -0
package/docs-src/configuration.page.html +2 -0
package/docs-src/getting-started-links.global.html +7 -0
package/docs-src/index.page.html +3 -0
package/docs-src/nav.fragment.html +1 -13
package/docs-src/request-response.page.html +2 -0
package/docs-src/templating.page.html +71 -18
package/package.json +2 -2
package/src/router.js +60 -21
package/src/templating/index.js +37 -4
package/src/templating/parse.js +28 -5
package/tests/router-custom-route-ssr.node-test.js +189 -0
package/tests/templating-parse.node-test.js +43 -9
package/tests/templating-render.node-test.js +91 -0

package/tests/router-custom-route-ssr.node-test.js ADDED Viewed

@@ -0,0 +1,189 @@
+import http from 'http';
+import path from 'path';
+import {withTempDir} from './utils/temp-dir.js';
+import {write} from './utils/file-writer.js';
+import {randomPort} from './utils/port.js';
+import {httpGet} from './utils/http.js';
+import router from '../src/router.js';
+const startServer = async (dir, flags, config) => {
+  await write(dir, `${flags.root}/.config.json`, JSON.stringify(config));
+  const handler = await router({...flags, logging: 0}, () => {});
+  const server = http.createServer(handler);
+  const port = randomPort();
+  await new Promise(r => server.listen(port, r));
+  await new Promise(r => setTimeout(r, 30));
+  return {server, port};
+};
+export default {
+  'wildcard custom route renders .page.html via SSR': async ({pass, fail}) => {
+    try {
+      await withTempDir(async (dir) => {
+        const template = '<html><body><location name="main" /></body></html>';
+        const page = '<page template="default"><content location="main"><h1>Admin Page</h1></content></page>';
+        await write(dir, 'admin/default.template.html', template);
+        await write(dir, 'admin/dashboard.page.html', page);
+        await write(dir, 'public/index.html', '<h1>root</h1>');
+        const prev = process.cwd();
+        process.chdir(dir);
+        const {server, port} = await startServer(dir, {root: 'public'}, {
+          customRoutes: {'/admin/**': '../admin/**'},
+          templating: {ssr: true}
+        });
+        try {
+          const r = await httpGet(`http://localhost:${port}/admin/dashboard`);
+          if(r.res.statusCode !== 200) throw new Error(`expected 200, got ${r.res.statusCode}`);
+          const body = r.body.toString();
+          if(!body.includes('<h1>Admin Page</h1>')) throw new Error(`missing page content: ${body}`);
+          if(!body.includes('<html>')) throw new Error(`missing template wrapper: ${body}`);
+        } finally {
+          server.close();
+          process.chdir(prev);
+        }
+      });
+      pass('wildcard custom route renders .page.html via SSR');
+    } catch(e) {
+      fail(e.message);
+    }
+  },
+  'wildcard custom route renders index.page.html for directory path': async ({pass, fail}) => {
+    try {
+      await withTempDir(async (dir) => {
+        const template = '<html><body><location name="main" /></body></html>';
+        const page = '<page template="default"><content location="main"><h1>Section Index</h1></content></page>';
+        await write(dir, 'admin/default.template.html', template);
+        await write(dir, 'admin/users/index.page.html', page);
+        await write(dir, 'public/index.html', '<h1>root</h1>');
+        const prev = process.cwd();
+        process.chdir(dir);
+        const {server, port} = await startServer(dir, {root: 'public'}, {
+          customRoutes: {'/admin/**': '../admin/**'},
+          templating: {ssr: true}
+        });
+        try {
+          const r = await httpGet(`http://localhost:${port}/admin/users`);
+          if(r.res.statusCode !== 200) throw new Error(`expected 200, got ${r.res.statusCode}`);
+          const body = r.body.toString();
+          if(!body.includes('<h1>Section Index</h1>')) throw new Error(`missing page content: ${body}`);
+        } finally {
+          server.close();
+          process.chdir(prev);
+        }
+      });
+      pass('wildcard custom route renders index.page.html for directory path');
+    } catch(e) {
+      fail(e.message);
+    }
+  },
+  'SSR not attempted for custom route when templating.ssr is false': async ({pass, fail}) => {
+    try {
+      await withTempDir(async (dir) => {
+        const template = '<html><body><location name="main" /></body></html>';
+        const page = '<page template="default"><content location="main"><h1>Should Not Render</h1></content></page>';
+        await write(dir, 'admin/default.template.html', template);
+        await write(dir, 'admin/dashboard.page.html', page);
+        await write(dir, 'public/index.html', '<h1>root</h1>');
+        const prev = process.cwd();
+        process.chdir(dir);
+        const {server, port} = await startServer(dir, {root: 'public'}, {
+          customRoutes: {'/admin/**': '../admin/**'},
+          templating: {ssr: false}
+        });
+        try {
+          const r = await httpGet(`http://localhost:${port}/admin/dashboard`);
+          if(r.res.statusCode !== 404) throw new Error(`expected 404, got ${r.res.statusCode}`);
+        } finally {
+          server.close();
+          process.chdir(prev);
+        }
+      });
+      pass('SSR not attempted when templating.ssr is false');
+    } catch(e) {
+      fail(e.message);
+    }
+  },
+  'wildcard custom route SSR uses custom root for template/fragment lookup': async ({pass, fail}) => {
+    try {
+      await withTempDir(async (dir) => {
+        const template = '<html><fragment name="nav" /><location name="main" /></html>';
+        const fragment = '<nav>Custom Nav</nav>';
+        const page = '<page template="default"><content location="main"><p>Content</p></content></page>';
+        await write(dir, 'admin/default.template.html', template);
+        await write(dir, 'admin/nav.fragment.html', fragment);
+        await write(dir, 'admin/about.page.html', page);
+        await write(dir, 'public/index.html', '<h1>root</h1>');
+        const prev = process.cwd();
+        process.chdir(dir);
+        const {server, port} = await startServer(dir, {root: 'public'}, {
+          customRoutes: {'/admin/**': '../admin/**'},
+          templating: {ssr: true}
+        });
+        try {
+          const r = await httpGet(`http://localhost:${port}/admin/about`);
+          if(r.res.statusCode !== 200) throw new Error(`expected 200, got ${r.res.statusCode}`);
+          const body = r.body.toString();
+          if(!body.includes('<nav>Custom Nav</nav>')) throw new Error(`fragment not resolved: ${body}`);
+          if(!body.includes('<p>Content</p>')) throw new Error(`page content missing: ${body}`);
+        } finally {
+          server.close();
+          process.chdir(prev);
+        }
+      });
+      pass('custom route SSR uses custom root for template/fragment lookup');
+    } catch(e) {
+      fail(e.message);
+    }
+  },
+  'preRender renders .page.html files in wildcard custom route directory': async ({pass, fail}) => {
+    try {
+      await withTempDir(async (dir) => {
+        const template = '<html><body><location name="main" /></body></html>';
+        const page = '<page template="default"><content location="main"><h1>Pre-rendered</h1></content></page>';
+        await write(dir, 'admin/default.template.html', template);
+        await write(dir, 'admin/info.page.html', page);
+        await write(dir, 'public/index.html', '<h1>root</h1>');
+        const prev = process.cwd();
+        process.chdir(dir);
+        const {server, port} = await startServer(dir, {root: 'public'}, {
+          customRoutes: {'/admin/**': '../admin/**'},
+          templating: {preRender: true}
+        });
+        try {
+          // preRender should have written admin/info.html
+          const {readFile} = await import('fs/promises');
+          const rendered = await readFile(path.join(dir, 'admin', 'info.html'), 'utf8');
+          if(!rendered.includes('<h1>Pre-rendered</h1>')) throw new Error(`missing content: ${rendered}`);
+          // Serving the static pre-rendered file should also work
+          const r = await httpGet(`http://localhost:${port}/admin/info.html`);
+          if(r.res.statusCode !== 200) throw new Error(`expected 200, got ${r.res.statusCode}`);
+        } finally {
+          server.close();
+          process.chdir(prev);
+        }
+      });
+      pass('preRender renders .page.html files in wildcard custom route directory');
+    } catch(e) {
+      fail(e.message);
+    }
+  }
+};

package/tests/templating-parse.node-test.js CHANGED Viewed

@@ -1,6 +1,7 @@
 import {
   extractAttrs,
   extractContentBlocks,
+  mergeContentBlocks,
   replaceLocations,
   stripFragmentWrapper,
   resolveVars,
@@ -26,13 +27,33 @@ export default {
   'extractContentBlocks extracts named blocks': ({pass, fail}) => {
     const xml = '<content location="main">Hello</content><content location="sidebar">World</content>';
     const blocks = extractContentBlocks(xml);
-    if(blocks.main !== 'Hello') return fail('main wrong');
-    if(blocks.sidebar !== 'World') return fail('sidebar wrong');
+    if(!Array.isArray(blocks.main) || blocks.main[0].html !== 'Hello') return fail('main wrong');
+    if(!Array.isArray(blocks.sidebar) || blocks.sidebar[0].html !== 'World') return fail('sidebar wrong');
+    pass();
+  },
+  'extractContentBlocks captures priority': ({pass, fail}) => {
+    const xml = '<content location="main" priority="5">hi</content>';
+    const blocks = extractContentBlocks(xml);
+    if(blocks.main[0].priority !== 5) return fail(`priority wrong: ${blocks.main[0].priority}`);
+    pass();
+  },
+  'extractContentBlocks defaults priority to 0': ({pass, fail}) => {
+    const xml = '<content location="main">hi</content>';
+    const blocks = extractContentBlocks(xml);
+    if(blocks.main[0].priority !== 0) return fail(`priority wrong: ${blocks.main[0].priority}`);
+    pass();
+  },
+  'mergeContentBlocks combines maps': ({pass, fail}) => {
+    const a = {main: [{html: 'A', priority: 0}]};
+    const b = {main: [{html: 'B', priority: 0}], sidebar: [{html: 'S', priority: 0}]};
+    const merged = mergeContentBlocks(a, b);
+    if(merged.main.length !== 2) return fail(`main length wrong: ${merged.main.length}`);
+    if(!merged.sidebar) return fail('sidebar missing');
     pass();
   },
   'replaceLocations fills named locations': ({pass, fail}) => {
     const html = '<location name="main" />';
-    const result = replaceLocations(html, {main: '<p>Hi</p>'});
+    const result = replaceLocations(html, {main: [{html: '<p>Hi</p>', priority: 0}]});
     if(result !== '<p>Hi</p>') return fail(`got: ${result}`);
     pass();
   },
@@ -44,10 +65,21 @@ export default {
   },
   'replaceLocations uses content over fallback': ({pass, fail}) => {
     const html = '<location name="main">fallback</location>';
-    const result = replaceLocations(html, {main: 'real'});
+    const result = replaceLocations(html, {main: [{html: 'real', priority: 0}]});
     if(result !== 'real') return fail(`got: ${result}`);
     pass();
   },
+  'replaceLocations orders by priority descending': ({pass, fail}) => {
+    const html = '<location name="scripts" />';
+    const entries = [
+      {html: 'low', priority: 1},
+      {html: 'high', priority: 10},
+      {html: 'mid', priority: 5}
+    ];
+    const result = replaceLocations(html, {scripts: entries});
+    if(result !== 'highmidlow') return fail(`got: ${result}`);
+    pass();
+  },
   'stripFragmentWrapper removes wrapping fragment tag': ({pass, fail}) => {
     const result = stripFragmentWrapper('<fragment name="nav"><nav>Hi</nav></fragment>');
     if(result !== '<nav>Hi</nav>') return fail(`got: ${result}`);
@@ -210,28 +242,30 @@ export default {
   },
   'extractContentBlocks defaults location to default': ({pass, fail}) => {
     const blocks = extractContentBlocks('<content>Hello</content>');
-    if(blocks.default !== 'Hello') return fail(`got: ${blocks.default}`);
+    if(!Array.isArray(blocks.default) || blocks.default[0].html !== 'Hello') return fail(`got: ${JSON.stringify(blocks.default)}`);
     pass();
   },
   'extractContentBlocks concatenates multiple contents to same location': ({pass, fail}) => {
     const xml = '<content location="main">A</content><content location="main">B</content>';
     const blocks = extractContentBlocks(xml);
-    if(blocks.main !== 'AB') return fail(`got: ${blocks.main}`);
+    if(blocks.main.length !== 2) return fail(`expected 2 entries, got: ${JSON.stringify(blocks.main)}`);
+    if(blocks.main[0].html !== 'A' || blocks.main[1].html !== 'B') return fail(`got: ${JSON.stringify(blocks.main)}`);
     pass();
   },
   'extractContentBlocks concatenates default contents': ({pass, fail}) => {
     const xml = '<content>A</content><content>B</content>';
     const blocks = extractContentBlocks(xml);
-    if(blocks.default !== 'AB') return fail(`got: ${blocks.default}`);
+    if(blocks.default.length !== 2) return fail(`expected 2 entries, got: ${JSON.stringify(blocks.default)}`);
+    if(blocks.default[0].html !== 'A' || blocks.default[1].html !== 'B') return fail(`got: ${JSON.stringify(blocks.default)}`);
     pass();
   },
   'replaceLocations defaults nameless location to default': ({pass, fail}) => {
-    const result = replaceLocations('<location />', {default: 'Hi'});
+    const result = replaceLocations('<location />', {default: [{html: 'Hi', priority: 0}]});
     if(result !== 'Hi') return fail(`got: ${result}`);
     pass();
   },
   'replaceLocations defaults nameless block location to default': ({pass, fail}) => {
-    const result = replaceLocations('<location>fallback</location>', {default: 'Hi'});
+    const result = replaceLocations('<location>fallback</location>', {default: [{html: 'Hi', priority: 0}]});
     if(result !== 'Hi') return fail(`got: ${result}`);
     pass();
   },

package/tests/templating-render.node-test.js CHANGED Viewed

@@ -184,5 +184,96 @@ export default {
       if(!html.includes(String(new Date().getFullYear()))) return fail(`year missing: ${html}`);
       pass();
     });
+  },
+  'renderPage injects global content into template location': async ({pass, fail}) => {
+    await withTempDir(async dir => {
+      await setupFiles(dir, {
+        'default.template.html': '<head><location name="head" /></head><body><location name="main" /></body>',
+        'site.global.html': '<content location="head"><meta charset="utf-8"></content>',
+        'index.page.html': '<page template="default"><content location="main">hello</content></page>'
+      });
+      const html = await renderPage(path.join(dir, 'index.page.html'), dir);
+      if(!html.includes('<meta charset="utf-8">')) return fail(`global head missing: ${html}`);
+      if(!html.includes('hello')) return fail(`page content missing: ${html}`);
+      pass();
+    });
+  },
+  'renderPage merges page and global content into same location': async ({pass, fail}) => {
+    await withTempDir(async dir => {
+      await setupFiles(dir, {
+        'default.template.html': '<location name="scripts" />',
+        'site.global.html': '<content location="scripts"><script src="analytics.js"></script></content>',
+        'index.page.html': '<page template="default"><content location="scripts"><script src="page.js"></script></content></page>'
+      });
+      const html = await renderPage(path.join(dir, 'index.page.html'), dir);
+      if(!html.includes('analytics.js')) return fail(`global script missing: ${html}`);
+      if(!html.includes('page.js')) return fail(`page script missing: ${html}`);
+      pass();
+    });
+  },
+  'renderPage respects priority ordering — higher number first': async ({pass, fail}) => {
+    await withTempDir(async dir => {
+      await setupFiles(dir, {
+        'default.template.html': '<location name="scripts" />',
+        'site.global.html': '<content location="scripts" priority="10">FIRST</content><content location="scripts" priority="1">LAST</content>',
+        'index.page.html': '<page template="default"></page>'
+      });
+      const html = await renderPage(path.join(dir, 'index.page.html'), dir);
+      if(html.indexOf('FIRST') > html.indexOf('LAST')) return fail(`wrong order: ${html}`);
+      pass();
+    });
+  },
+  'renderPage page content priority beats global at same location': async ({pass, fail}) => {
+    await withTempDir(async dir => {
+      await setupFiles(dir, {
+        'default.template.html': '<location name="scripts" />',
+        'site.global.html': '<content location="scripts" priority="0">global</content>',
+        'index.page.html': '<page template="default"><content location="scripts" priority="5">page</content></page>'
+      });
+      const html = await renderPage(path.join(dir, 'index.page.html'), dir);
+      if(html.indexOf('page') > html.indexOf('global')) return fail(`page should come before global: ${html}`);
+      pass();
+    });
+  },
+  'renderPage fills locations inside page content from globals': async ({pass, fail}) => {
+    await withTempDir(async dir => {
+      await setupFiles(dir, {
+        'default.template.html': '<location name="main" />',
+        'site.global.html': '<content location="badge"><span class="badge">NEW</span></content>',
+        'index.page.html': '<page template="default"><content location="main"><h1>Title</h1><location name="badge" /></content></page>'
+      });
+      const html = await renderPage(path.join(dir, 'index.page.html'), dir);
+      if(!html.includes('<span class="badge">NEW</span>')) return fail(`badge missing: ${html}`);
+      pass();
+    });
+  },
+  'renderPage loads globals from subdirectories': async ({pass, fail}) => {
+    await withTempDir(async dir => {
+      await setupFiles(dir, {
+        'default.template.html': '<location name="head" /><location name="main" />',
+        'sub/site.global.html': '<content location="head">subglobal</content>',
+        'index.page.html': '<page template="default"><content location="main">x</content></page>'
+      });
+      const html = await renderPage(path.join(dir, 'index.page.html'), dir);
+      if(!html.includes('subglobal')) return fail(`subdir global missing: ${html}`);
+      pass();
+    });
+  },
+  'renderDir applies global content to all pages': async ({pass, fail}) => {
+    await withTempDir(async dir => {
+      await setupFiles(dir, {
+        'default.template.html': '<location name="head" /><location name="main" />',
+        'site.global.html': '<content location="head"><meta name="global"></content>',
+        'index.page.html': '<page template="default"><content location="main">home</content></page>',
+        'about.page.html': '<page template="default"><content location="main">about</content></page>'
+      });
+      const outDir = path.join(dir, 'out');
+      await renderDir(dir, outDir);
+      const home = await readFile(path.join(outDir, 'index.html'), 'utf8');
+      const about = await readFile(path.join(outDir, 'about.html'), 'utf8');
+      if(!home.includes('<meta name="global">')) return fail(`home missing global: ${home}`);
+      if(!about.includes('<meta name="global">')) return fail(`about missing global: ${about}`);
+      pass();
+    });
   }
 };