@adobe/helix-html-pipeline 4.1.5 → 5.0.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [5.0.0](https://github.com/adobe/helix-html-pipeline/compare/v4.1.5...v5.0.0) (2023-09-09)
+
+
+### Features
+
+* better metadata fallback ([2c7481c](https://github.com/adobe/helix-html-pipeline/commit/2c7481c19c52cce38559a50360c8c5eabc201b27)), closes [#382](https://github.com/adobe/helix-html-pipeline/issues/382)
+
+
+### BREAKING CHANGES
+
+* metadata fallback is different for empty values.
+
 ## [4.1.5](https://github.com/adobe/helix-html-pipeline/compare/v4.1.4...v4.1.5) (2023-09-02)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "4.1.5",
+  "version": "5.0.0",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -29,7 +29,10 @@
   },
   "homepage": "https://github.com/adobe/helix-html-pipeline#readme",
   "mocha": {
-    "require": "test/setup-env.js",
+    "require": [
+      "test/setup-env.js",
+      "mocha-suppress-logs"
+    ],
     "recursive": "true",
     "reporter": "mocha-multi-reporters",
     "reporter-options": "configFile=.mocha-multi.json",
@@ -85,6 +88,7 @@
     "lint-staged": "13.3.0",
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
+    "mocha-suppress-logs": "0.3.1",
     "semantic-release": "21.1.1"
   },
   "lint-staged": {

package/src/steps/extract-metadata.js

@@ -82,10 +82,7 @@ function readBlockConfig($block) {
             value = $img.properties.src;
           }
         }
-        if (value) {
-          // only keep non-empty value
-          config[name] = value;
-        }
+        config[name] = value;
       }
     }
   });
@@ -159,9 +156,18 @@ export default function extractMetaData(state, req) {
   const metaConfig = Object.assign(
     state.metadata.getModifiers(state.info.unmappedPath || state.info.path),
     state.mappedMetadata.getModifiers(state.info.unmappedPath),
-    getLocalMetadata(hast),
   );
 
+  // prune empty values and explicit "" strings from sheet based metadata
+  Object.entries(metaConfig).forEach(([name, value]) => {
+    if (!value || value === '""') {
+      delete metaConfig[name];
+    }
+  });
+
+  // apply document local overrides
+  Object.assign(metaConfig, getLocalMetadata(hast));
+
   // first process supported metadata properties
   [
     'title',
@@ -172,15 +178,18 @@ export default function extractMetaData(state, req) {
     'image-alt',
     'canonical',
     'feed',
+    'twitter:card',
   ].forEach((name) => {
-    if (metaConfig[name]) {
+    if (name in metaConfig) {
       meta[name] = metaConfig[name];
       delete metaConfig[name];
     }
   });
-  // default value for twitter:card (mandatory for rendering URLs as cards in tweets)
-  meta['twitter:card'] = metaConfig['twitter:card'] || 'summary_large_image';
-  delete metaConfig['twitter:card'];
+
+  if (!('twitter:card' in meta)) {
+    // default value for twitter:card (mandatory for rendering URLs as cards in tweets)
+    meta['twitter:card'] = 'summary_large_image';
+  }
 
   // add rest to meta.custom
   meta.custom = metaConfig;
@@ -193,7 +202,7 @@ export default function extractMetaData(state, req) {
   }
 
   // complete metadata with insights from content
-  if (!meta.title) {
+  if (!('title' in meta)) {
     // content.title is not correct if the h1 is in a page-block since the pipeline
     // only respects the heading nodes in the mdast
     const $title = select('div h1', hast);
@@ -202,13 +211,13 @@ export default function extractMetaData(state, req) {
     }
     meta.title = content.title;
   }
-  if (!meta.description) {
-    meta.description = extractDescription(hast);
+  if (!('description' in meta)) {
+    meta.description = extractDescription(hast) || undefined;
   }
 
   // use the req.url and not the state.info.path in case of folder mapping
   meta.url = makeCanonicalHtmlUrl(getAbsoluteUrl(state, req.url.pathname));
-  if (!meta.canonical) {
+  if (!('canonical' in meta)) {
     meta.canonical = meta.url;
   }
 
@@ -222,10 +231,12 @@ export default function extractMetaData(state, req) {
     }
   }
 
-  meta.image = getAbsoluteUrl(
-    state,
-    optimizeMetaImage(state.info.path, meta.image || content.image || '/default-meta-image.png'),
-  );
+  if (!('image' in meta)) {
+    meta.image = getAbsoluteUrl(
+      state,
+      optimizeMetaImage(state.info.path, meta.image || content.image || '/default-meta-image.png'),
+    );
+  }
 
-  meta.imageAlt = meta['image-alt'] || content.imageAlt;
+  meta.imageAlt = meta['image-alt'] ?? content.imageAlt;
 }

package/src/steps/render.js

@@ -26,7 +26,7 @@ function createElement(name, ...attrs) {
   const properties = {};
   for (let i = 0; i < attrs.length; i += 2) {
     const value = attrs[i + 1];
-    if (!value) {
+    if (value === undefined) {
       return null;
     }
     properties[attrs[i]] = value;
@@ -50,9 +50,10 @@ export default async function render(state, req, res) {
     res.document = hast;
     return;
   }
-  const $head = h('head', [
-    h('title', meta.title),
-  ]);
+  const $head = h('head');
+  if (meta.title !== undefined) {
+    $head.children.push(h('title', meta.title));
+  }
 
   // add meta
   // (this is so complicated to keep the order backward compatible to make the diff tests happy)
@@ -69,27 +70,37 @@ export default async function render(state, req, res) {
     'article:published_time': meta.published_time,
     'article:modified_time': meta.modified_time,
     'twitter:card': meta['twitter:card'],
-    'twitter:title': meta.title,
-    'twitter:description': meta.description,
-    'twitter:image': meta.image,
+    'twitter:title': '',
+    'twitter:description': '',
+    'twitter:image': '',
   };
-  // remove meta with no values
-  for (const name of Object.keys(metadata)) {
-    if (!metadata[name]) {
-      delete metadata[name];
-    }
-  }
+
   // append custom metadata
   Object.assign(metadata, meta.custom);
 
-  // remove og:url with explicit removal marker
-  if (metadata['og:url'] === '""') {
-    delete metadata['og:url'];
+  // fallback for twitter
+  const FALLBACKS = [
+    ['twitter:title', 'og:title'],
+    ['twitter:description', 'og:description'],
+    ['twitter:image', 'og:image'],
+  ];
+
+  for (const [from, to] of FALLBACKS) {
+    if (!(from in meta.custom)) {
+      metadata[from] = metadata[to];
+    }
+  }
+
+  // remove undefined metadata
+  for (const name of Object.keys(metadata)) {
+    if (metadata[name] === undefined) {
+      delete metadata[name];
+    }
   }
 
-  appendElement($head, createElement('link', 'rel', 'canonical', 'href', content.meta.canonical));
-  appendElement($head, createElement('meta', 'name', 'description', 'content', content.meta.description));
-  appendElement($head, createElement('meta', 'name', 'keywords', 'content', content.meta.keywords));
+  appendElement($head, createElement('link', 'rel', 'canonical', 'href', meta.canonical));
+  appendElement($head, createElement('meta', 'name', 'description', 'content', meta.description));
+  appendElement($head, createElement('meta', 'name', 'keywords', 'content', meta.keywords));
 
   for (const [name, value] of Object.entries(metadata)) {
     const attr = name.includes(':') && !name.startsWith('twitter:') ? 'property' : 'name';