feat: make json-ld metadata more robust (#658)

adobe · Aug 1, 2024 · 3d3e5dc · 3d3e5dc
1 parent 1dd871a
commit 3d3e5dc
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 0 deletions.
diff --git a/src/steps/extract-metadata.js b/src/steps/extract-metadata.js
@@ -43,6 +43,12 @@ function readBlockConfig($block) {
       const [$name, $value] = $row.children;
       const name = toMetaName(toString($name));
       if (name) {
+        // special case for json-ld. don't apply any special formatting
+        if (name.toLowerCase() === 'json-ld') {
+          config[name] = toString($value).trim();
+          return;
+        }
+
         let value;
         const $firstChild = childNodes($value)[0];
         if ($firstChild) {

diff --git a/test/fixtures/content/page-metadata-jsonld-list.html b/test/fixtures/content/page-metadata-jsonld-list.html
@@ -0,0 +1,16 @@
+<head>
+    <title>Home | Helix Project Boilerplate</title>
+    <link rel="canonical" href="https://helix-pages.com/page-metadata-jsonld-list">
+    <meta property="og:title" content="Home | Helix Project Boilerplate">
+    <meta property="og:url" content="https://helix-pages.com/page-metadata-jsonld-list">
+    <meta property="og:image" content="https://helix-pages.com/default-meta-image.png?width=1200&#x26;format=pjpg&#x26;optimize=medium">
+    <meta property="og:image:secure_url" content="https://helix-pages.com/default-meta-image.png?width=1200&#x26;format=pjpg&#x26;optimize=medium">
+    <meta name="twitter:card" content="summary_large_image">
+    <meta name="twitter:title" content="Home | Helix Project Boilerplate">
+    <meta name="twitter:image" content="https://helix-pages.com/default-meta-image.png?width=1200&#x26;format=pjpg&#x26;optimize=medium">
+    <script type="application/ld+json">{"@context":"https://schema.org","@type":"Course","name":"Getting Started with AEM","description":"Setup your first project with AEM for Developers.","provider":{"@type":"Organization","name":"Adobe","sameAs":"http://www.adobe.com"}}</script>
+    <link id="favicon" rel="icon" type="image/svg+xml" href="/icons/spark.svg">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <script src="/scripts.js" type="module"></script>
+    <link rel="stylesheet" href="/styles.css">
+</head>
diff --git a/test/fixtures/content/page-metadata-jsonld-list.md b/test/fixtures/content/page-metadata-jsonld-list.md
@@ -0,0 +1,29 @@
+# JSON LD Test
+
+This is great.  
+
++-------------------------------------------------------------------------------------------+
+| Metadata                                                                                  |
++================+==========================================================================+
+| title          | Home \| Helix Project Boilerplate                                        |
++----------------+--------------------------------------------------------------------------|
+| json-ld        | {"@context": "https\://schema.org",                                      |
+|                |                                                                          |
+|                | "@type": "Course",                                                       |
+|                |                                                                          |
+|                | "name": "Getting Started with AEM",                                      |
+|                |                                                                          |
+|                | "description": "Setup your first project with AEM for Developers.",      |
+|                |                                                                          |
+|                | "provider": {                                                            |
+|                |                                                                          |
+|                | "@type": "Organization",                                                 |
+|                |                                                                          |
+|                | "name": "Adobe",                                                         |
+|                |                                                                          |
+|                | "sameAs": "http\://www\.adobe.com"                                       |
+|                |                                                                          |
+|                | }                                                                        |
+|                |                                                                          |
+|                | }                                                                        |
++----------------+--------------------------------------------------------------------------+
diff --git a/test/rendering.test.js b/test/rendering.test.js
@@ -414,6 +414,11 @@ describe('Rendering', () => {
       await testRender('page-metadata-jsonld', 'head');
     });
 
+    it('injects json ld even for multi-list cells', async () => {
+      config = DEFAULT_CONFIG_EMPTY;
+      await testRender('page-metadata-jsonld-list', 'head');
+    });
+
     it('chooses last json-ld if multiple', async () => {
       config = {
         ...DEFAULT_CONFIG_EMPTY,