@adobe/helix-html-pipeline 5.0.0 → 5.0.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [5.0.2](https://github.com/adobe/helix-html-pipeline/compare/v5.0.1...v5.0.2) (2023-09-14)
+
+
+### Bug Fixes
+
+* supress empty non-fallback values ([#399](https://github.com/adobe/helix-html-pipeline/issues/399)) ([1e5629d](https://github.com/adobe/helix-html-pipeline/commit/1e5629d7cb08de210c713654479bd6d5301a905e))
+
+## [5.0.1](https://github.com/adobe/helix-html-pipeline/compare/v5.0.0...v5.0.1) (2023-09-09)
+
+
+### Bug Fixes
+
+* properly handle empty string ([#395](https://github.com/adobe/helix-html-pipeline/issues/395)) ([daac492](https://github.com/adobe/helix-html-pipeline/commit/daac49224642eeb69951ee68256fcb7f264f4f0c))
+
 # [5.0.0](https://github.com/adobe/helix-html-pipeline/compare/v4.1.5...v5.0.0) (2023-09-09)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -53,7 +53,7 @@
     "hast-util-to-html": "8.0.4",
     "hast-util-to-string": "2.0.0",
     "hastscript": "7.2.0",
-    "jose": "4.14.5",
+    "jose": "4.14.6",
     "mdast-util-to-hast": "12.3.0",
     "mdast-util-to-string": "4.0.0",
     "mime": "3.0.0",
@@ -76,16 +76,16 @@
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "10.0.5",
     "c8": "8.0.1",
-    "eslint": "8.48.0",
+    "eslint": "8.49.0",
     "eslint-import-resolver-exports": "1.0.0-beta.5",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.28.1",
-    "esmock": "2.3.8",
+    "esmock": "2.4.1",
     "husky": "8.0.3",
     "js-yaml": "4.1.0",
     "jsdom": "22.1.0",
     "junit-report-builder": "3.0.1",
-    "lint-staged": "13.3.0",
+    "lint-staged": "14.0.1",
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.3.1",

package/src/steps/extract-metadata.js

@@ -142,12 +142,25 @@ function extractDescription(hast) {
 }
 
 /**
- * Extracts the metadata and stores it in the content meta
+ * Extracts the metadata from config and the metadata block and stores it in the content.meta.page:
+ * - all the non-empty values from the config metadata are applied.
+ * - config value with an empty string (explicit "") are removed from the result
+ * - all the values from the metadata block are applied. empty values remain empty for the
+ *   properties that can have a default: 'title', 'description', 'image', 'image-alt', 'url'
+ *   the others are removed.
+ * - the defaults for 'title', 'description', 'image', 'image-alt', 'url' are applied if missing
+ * - twitter: properties default to their og: counterparts if missing.
+ *
  * @type PipelineStep
  * @param {PipelineState} state
  * @param {PipelineRequest} req
  */
 export default function extractMetaData(state, req) {
+  const FIXED = new Set([
+    'title', 'description', 'image', 'image-alt', 'url',
+    'twitter:card', 'og:url', 'canonical',
+  ]);
+
   const { content } = state;
   const { meta, hast } = content;
 
@@ -160,13 +173,19 @@ export default function extractMetaData(state, req) {
 
   // prune empty values and explicit "" strings from sheet based metadata
   Object.entries(metaConfig).forEach(([name, value]) => {
-    if (!value || value === '""') {
+    if (!value) {
       delete metaConfig[name];
+    } else if (value === '""') {
+      metaConfig[name] = undefined;
     }
   });
 
   // apply document local overrides
-  Object.assign(metaConfig, getLocalMetadata(hast));
+  Object.entries(getLocalMetadata(hast)).forEach(([name, value]) => {
+    if (value || FIXED.has(name)) {
+      metaConfig[name] = value;
+    }
+  });
 
   // first process supported metadata properties
   [
@@ -191,9 +210,6 @@ export default function extractMetaData(state, req) {
     meta['twitter:card'] = 'summary_large_image';
   }
 
-  // add rest to meta.custom
-  meta.custom = metaConfig;
-
   if (meta.keywords) {
     meta.keywords = toList(meta.keywords).join(', ');
   }
@@ -234,9 +250,55 @@ export default function extractMetaData(state, req) {
   if (!('image' in meta)) {
     meta.image = getAbsoluteUrl(
       state,
-      optimizeMetaImage(state.info.path, meta.image || content.image || '/default-meta-image.png'),
+      optimizeMetaImage(state.info.path, content.image || '/default-meta-image.png'),
     );
   }
 
   meta.imageAlt = meta['image-alt'] ?? content.imageAlt;
+
+  // compute the final page metadata
+  const metadata = {
+    description: meta.description,
+    keywords: meta.keywords,
+    'og:title': meta.title,
+    'og:description': meta.description,
+    'og:url': meta.url,
+    'og:image': meta.image,
+    'og:image:secure_url': meta.image,
+    'og:image:alt': meta.imageAlt,
+    'og:updated_time': meta.modified_time,
+    'article:tag': meta.tags || [],
+    'article:section': meta.section,
+    'article:published_time': meta.published_time,
+    'article:modified_time': meta.modified_time,
+    'twitter:card': meta['twitter:card'],
+    'twitter:title': '',
+    'twitter:description': '',
+    'twitter:image': '',
+  };
+
+  // append custom metadata
+  Object.assign(metadata, metaConfig);
+
+  // 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 metaConfig)) {
+      metadata[from] = metadata[to];
+    }
+  }
+
+  // remove undefined metadata
+  for (const name of Object.keys(metadata)) {
+    if (metadata[name] === undefined) {
+      delete metadata[name];
+    }
+  }
+
+  meta.page = metadata;
 }

package/src/steps/render.js

@@ -55,54 +55,9 @@ export default async function render(state, req, res) {
     $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)
-  const metadata = {
-    'og:title': meta.title,
-    'og:description': meta.description,
-    'og:url': meta.url,
-    'og:image': meta.image,
-    'og:image:secure_url': meta.image,
-    'og:image:alt': meta.imageAlt,
-    'og:updated_time': meta.modified_time,
-    'article:tag': meta.tags || [],
-    'article:section': meta.section,
-    'article:published_time': meta.published_time,
-    'article:modified_time': meta.modified_time,
-    'twitter:card': meta['twitter:card'],
-    'twitter:title': '',
-    'twitter:description': '',
-    'twitter:image': '',
-  };
-
-  // append custom metadata
-  Object.assign(metadata, meta.custom);
-
-  // 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', 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)) {
+  for (const [name, value] of Object.entries(meta.page)) {
     const attr = name.includes(':') && !name.startsWith('twitter:') ? 'property' : 'name';
     if (Array.isArray(value)) {
       for (const v of value) {