GoogleChrome · mattzeunert · Apr 16, 2019 · Apr 16, 2019 · Apr 16, 2019 · Apr 16, 2019
diff --git a/build/build-bundle.js b/build/build-bundle.js
@@ -65,7 +65,14 @@ async function browserifyFile(entryPath, distPath) {
     .ignore('raven')
     .ignore('mkdirp')
     .ignore('rimraf')
-    .ignore('pako/lib/zlib/inflate.js');
+    .ignore('pako/lib/zlib/inflate.js')
+    .ignore('file') // required by jsonlint-mod
+    .ignore('system'); // required by jsonlint-mod
+
+  // There is no way to add './doug-json-parse' to ignored packages via public API
+  // w/o browserify resolving the path into an absolute path
+  // @ts-ignore
+  bundle._ignore.push('./doug-json-parse');
 
   // Don't include the desktop protocol connection.
   bundle.ignore(require.resolve('../lighthouse-core/gather/connections/cri.js'));

diff --git a/lighthouse-cli/test/cli/__snapshots__/index-test.js.snap b/lighthouse-cli/test/cli/__snapshots__/index-test.js.snap
@@ -384,6 +384,9 @@ Object {
     Object {
       "path": "seo/canonical",
     },
+    Object {
+      "path": "seo/json-ld",
+    },
     Object {
       "path": "seo/manual/structured-data",
     },
@@ -1016,6 +1019,11 @@ Object {
           "id": "canonical",
           "weight": 1,
         },
+        Object {
+          "group": "seo-content",
+          "id": "json-ld",
+          "weight": 1,
+        },
         Object {
           "group": "seo-mobile",
           "id": "font-size",

diff --git a/lighthouse-cli/test/fixtures/dobetterweb/dbw_tester.html b/lighthouse-cli/test/fixtures/dobetterweb/dbw_tester.html
@@ -111,6 +111,15 @@
 <!-- Force FCP to be ~5s out, necessary to make sure our render-blocking audits still work -->
 <!-- even when other forces were responsible for delaying the render. -->
 <script src="./fcp-delayer.js?delay=5000"></script>
+
+<!-- FAIL(json-ld): unknown property in JSON-LD -->
+<script type="application/ld+json">
+{
+  "@context": "http://schema.org",
+  "@type": "Event",
+  "unknownProp": "Oh no"
+}
+</script>
 </head>
 <body>
 

diff --git a/lighthouse-cli/test/fixtures/seo/seo-failure-cases.html b/lighthouse-cli/test/fixtures/seo/seo-failure-cases.html
@@ -20,6 +20,14 @@
   <link rel="alternate" href="http://example.com/" hreflang=" x-default" />
   <!-- FAIL(canonical): multiple canonical URLs provided (another one is in the HTTP header) -->
   <link rel="canonical" href="https://example.com/other" />
+  <!-- FAIL(json-ld): invalid @type -->
+  <script type="application/ld+json">
+    {
+      "@context": "http://schema.org",
+      "@type": "CatConvention",
+      "name": "Cat Global"
+    }
+  </script>
 </head>
 <body>
   <h1>SEO</h1>

diff --git a/lighthouse-cli/test/fixtures/seo/seo-tester.html b/lighthouse-cli/test/fixtures/seo/seo-tester.html
@@ -19,6 +19,14 @@
   <link rel="alternate" href="http://example.com/" hreflang="x-default" />
   <!-- PASS(canonical): valid canonical URL -->
   <link rel="canonical" href="http://localhost:10200/seo/" />
+  <!-- PASS(json-ld): valid JSON-LD -->
+  <script type="application/ld+json">
+    {
+      "@context": "http://schema.org",
+      "@type": "Event",
+      "name": "Cat Global"
+    }
+  </script>
 
   <style>
     .small {

diff --git a/lighthouse-cli/test/smokehouse/seo/expectations.js b/lighthouse-cli/test/smokehouse/seo/expectations.js
@@ -197,6 +197,9 @@ module.exports = [
           score: null,
           scoreDisplayMode: 'notApplicable',
         },
+        'json-ld': {
+          score: 1,
+        },
       },
     }},
   {
@@ -258,6 +261,9 @@ module.exports = [
           score: 0,
           explanation: 'Multiple conflicting URLs (https://example.com/other, https://example.com/)',
         },
+        'json-ld': {
+          score: 0,
+        },
       },
     },
   },

diff --git a/lighthouse-core/audits/seo/json-ld.js b/lighthouse-core/audits/seo/json-ld.js
@@ -0,0 +1,171 @@
+/**
+ * @license Copyright 2019 Google Inc. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+'use strict';
+
+const Audit = require('../audit.js');
+const validateJsonLD = require('../../lib/sd-validation/sd-validation.js');
+const i18n = require('../../lib/i18n/i18n.js');
+
+const UIStrings = {
+  /** Title of a Lighthouse audit that provides detail on whether JSON-LD structured data snippets are valid. This descriptive title is shown when no invalid JSON-LD snippets were found. */
+  title: 'JSON-LD structured data syntax is valid',
+  /** Title of a Lighthouse audit that provides detail on whether JSON-LD structured data snippets are valid. This descriptive title is shown when JSON-LD snippets with invalid content were found. */
+  failureTitle: 'JSON-LD structured data syntax is invalid',
+  /** Description of a Lighthouse audit that tells the user whether JSON-LD snippets on the page are invalid. This is displayed after a user expands the section to see more. No character length limits. */
+  /* eslint-disable-next-line max-len */
+  description: 'This audit currently validates a subset of JSON-LD rules used in search engines. See also the [Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool/) to validate other types of structured data.',
+  /** Explanatory message stating how many JSON-LD structured data snippets are invalid */
+  displayValue: `{invalidSnippetCount, plural,
+    =1 {# invalid snippet}
+    other {# invalid snippets}
+    }`,
+};
+
+const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
+
+class StructuredDataAutomatic extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'json-ld',
+      title: str_(UIStrings.title),
+      failureTitle: str_(UIStrings.failureTitle),
+      description: str_(UIStrings.description),
+      requiredArtifacts: ['ScriptElements'],
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts) {
+    const jsonLDElements = artifacts.ScriptElements.filter(
+      script => script.type === 'application/ld+json' && !!script.content);
+
+    if (jsonLDElements.length === 0) {
+      return {
+        notApplicable: true,
+        score: 1,
+      };
+    }
+
+    const snippets = await Promise.all(jsonLDElements.map(async (element) => {
+      // We don't want to show empty lines around the snippet
+      // We can do this cast, because we know element.content to not be null
+      const content = /** @type string */ (element.content).trim();
+
+      return {
+        devtoolsNodePath: element.devtoolsNodePath,
+        content,
+        errors: await validateJsonLD(content),
+      };
+    }));
+    // Show invalid snippets at the top
+    snippets.sort((a, b) => {
+      return b.errors.length - a.errors.length;
+    });
+
+    const renderedSnippets = snippets.map(renderValidatedSnippet);
+    const details = Audit.makeListDetails(renderedSnippets);
+
+    const invalidSnippets = snippets.filter(vs => vs.errors.length > 0);
+    const displayValue = str_(UIStrings.displayValue, {
+      invalidSnippetCount: invalidSnippets.length,
+    });
+
+    return {
+      score: invalidSnippets.length === 0 ? 1 : 0,
+      details,
+      displayValue,
+    };
+  }
+}
+
+/**
+ * @param {{content: string, devtoolsNodePath: string, errors: LH.StructuredData.ValidationError[]}} validatedSnippet
+ */
+function renderValidatedSnippet(validatedSnippet) {
+  const {content, devtoolsNodePath, errors} = validatedSnippet;
+
+  /** @type {LH.StructuredData.JsonLDDocument} */
+  let parsedContent = {};
+  let topLevelType = '';
+  let topLevelName = '';
+  try {
+    parsedContent = JSON.parse(content);
+  } catch (err) {}
+  if (parsedContent['@type']) {
+    topLevelType = parsedContent['@type'];
+  }
+  if (typeof parsedContent.name === 'string') {
+    topLevelName = parsedContent.name.toString();
+  }
+
+  let title = '';
+  if (topLevelName && topLevelType) {
+    title = `${topLevelType}: ${topLevelName}`;
+  } else if (topLevelType) {
+    title = `@type ${topLevelType}`;
+  } else {
+    title = 'Invalid JSON-LD element';
+  }
+  // No 18n here, because it's tricky to do because of the if statement above. The
+  // entity type and error messages are in English anyway.
+  title += ` (${errors.length} Error${errors.length !== 1 ? 's' : ''})`;
+
+  /** @type LH.Audit.Details.NodeValue */
+  const node = {
+    type: 'node',
+    path: devtoolsNodePath,
+    snippet: `<script type="application/ld+json">`,
+  };
+
+  const {lineMessages, generalMessages} = getErrorMessages(errors);
+
+  return Audit.makeSnippetDetails({
+    content: parsedContent ? JSON.stringify(parsedContent, null, 2) : content,
+    title,
+    lineMessages,
+    generalMessages,
+    node,
+  });
+}
+
+/**
+ * @param {Array<LH.StructuredData.ValidationError>} errors
+ */
+function getErrorMessages(errors) {
+  /** @type {LH.Audit.Details.SnippetValue['lineMessages']} */
+  const lineMessages = [];
+  /** @type {LH.Audit.Details.SnippetValue['generalMessages']} */
+  const generalMessages = [];
+  errors.forEach(({
+    message, lineNumber, validTypes, validator,
+  }) => {
+    if (validTypes && validator === 'schema-org') {
+      const typeStrings = validTypes.map(type => {
+        return `[${type.name}](${type.uri})`;
+      });
+      message = `Invalid ${typeStrings.join('/')}: ${message}`;
+    }
+
+    if (lineNumber) {
+      lineMessages.push({lineNumber, message});
+    } else {
+      generalMessages.push({
+        message,
+      });
+    }
+  });
+
+  return {lineMessages, generalMessages};
+}
+
+module.exports = StructuredDataAutomatic;
+module.exports.UIStrings = UIStrings;
diff --git a/lighthouse-core/audits/seo/manual/structured-data.js b/lighthouse-core/audits/seo/manual/structured-data.js
@@ -10,7 +10,7 @@ const i18n = require('../../../lib/i18n/i18n.js');
 
 const UIStrings = {
   /** Description of a Lighthouse audit that provides detail on the structured data in a page. "Structured data" is a standardized data format on a page that helps a search engine categorize and understand its contents. This description is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
-  description: 'Run the [Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool/) and the [Structured Data Linter](http://linter.structured-data.org/) to validate structured data. [Learn more](https://developers.google.com/search/docs/guides/mark-up-content).',
+  description: 'Run the [Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool/) to validate structured data. [Learn more](https://developers.google.com/search/docs/guides/mark-up-content).',
   /** Title of a Lighthouse audit that prompts users to manually check their page for valid structured data. "Structured data" is a standardized data format on a page that helps a search engine categorize and understand its contents. */
   title: 'Structured data is valid',
 };

diff --git a/lighthouse-core/config/default-config.js b/lighthouse-core/config/default-config.js
@@ -285,6 +285,7 @@ const defaultConfig = {
     'seo/hreflang',
     'seo/plugins',
     'seo/canonical',
+    'seo/json-ld',
     'seo/manual/structured-data',
   ],
 
@@ -499,6 +500,7 @@ const defaultConfig = {
         {id: 'image-alt', weight: 1, group: 'seo-content'},
         {id: 'hreflang', weight: 1, group: 'seo-content'},
         {id: 'canonical', weight: 1, group: 'seo-content'},
+        {id: 'json-ld', weight: 1, group: 'seo-content'},
         {id: 'font-size', weight: 1, group: 'seo-mobile'},
         {id: 'plugins', weight: 1, group: 'seo-content'},
         {id: 'tap-targets', weight: 1, group: 'seo-mobile'},

diff --git a/lighthouse-core/lib/i18n/locales/en-US.json b/lighthouse-core/lib/i18n/locales/en-US.json
@@ -893,6 +893,18 @@
   "lighthouse-core/audits/seo/is-crawlable.js | title": {
     "message": "Page isn’t blocked from indexing"
   },
+  "lighthouse-core/audits/seo/json-ld.js | description": {
+    "message": "Structured data contains rich metadata about a web page. The data is used in search results and social sharing. Invalid metadata will affect how the page appears in these contexts. This audit currently validates a subset of JSON-LD rules. See also the [Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool/) to validate other types of structured data."
+  },
+  "lighthouse-core/audits/seo/json-ld.js | displayValue": {
+    "message": "{invalidSnippetCount, plural,\n    =1 {# invalid snippet}\n    other {# invalid snippets}\n    }"
+  },
+  "lighthouse-core/audits/seo/json-ld.js | failureTitle": {
+    "message": "JSON-LD structured data syntax is invalid"
+  },
+  "lighthouse-core/audits/seo/json-ld.js | title": {
+    "message": "JSON-LD structured data syntax is valid"
+  },
   "lighthouse-core/audits/seo/link-text.js | description": {
     "message": "Descriptive link text helps search engines understand your content. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/descriptive-link-text)."
   },
@@ -906,7 +918,7 @@
     "message": "Links have descriptive text"
   },
   "lighthouse-core/audits/seo/manual/structured-data.js | description": {
-    "message": "Run the [Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool/) and the [Structured Data Linter](http://linter.structured-data.org/) to validate structured data. [Learn more](https://developers.google.com/search/docs/guides/mark-up-content)."
+    "message": "Run the [Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool/) to validate structured data. [Learn more](https://developers.google.com/search/docs/guides/mark-up-content)."
   },
   "lighthouse-core/audits/seo/manual/structured-data.js | title": {
     "message": "Structured data is valid"

diff --git a/lighthouse-core/lib/i18n/locales/en-XL.json b/lighthouse-core/lib/i18n/locales/en-XL.json
@@ -893,6 +893,18 @@
   "lighthouse-core/audits/seo/is-crawlable.js | title": {
     "message": "P̂áĝé îśn̂’t́ b̂ĺôćk̂éd̂ f́r̂óm̂ ín̂d́êx́îńĝ"
   },
+  "lighthouse-core/audits/seo/json-ld.js | description": {
+    "message": "Ŝt́r̂úĉt́ûŕêd́ d̂át̂á ĉón̂t́âín̂ś r̂íĉh́ m̂ét̂ád̂át̂á âb́ôút̂ á ŵéb̂ ṕâǵê. T́ĥé d̂át̂á îś ûśêd́ îń ŝéâŕĉh́ r̂éŝúl̂t́ŝ án̂d́ ŝóĉíâĺ ŝh́âŕîńĝ. Ín̂v́âĺîd́ m̂ét̂ád̂át̂á ŵíl̂ĺ âf́f̂éĉt́ ĥóŵ t́ĥé p̂áĝé âṕp̂éâŕŝ ín̂ t́ĥéŝé ĉón̂t́êx́t̂ś. T̂h́îś âúd̂ít̂ ćûŕr̂én̂t́l̂ý v̂ál̂íd̂át̂éŝ á ŝúb̂śêt́ ôf́ ĴŚÔŃ-L̂D́ r̂úl̂éŝ. Śêé âĺŝó t̂h́ê [Śt̂ŕûćt̂úr̂éd̂ D́ât́â T́êśt̂ín̂ǵ T̂óôĺ](https://search.google.com/structured-data/testing-tool/) t̂ó v̂ál̂íd̂át̂é ôt́ĥér̂ t́ŷṕêś ôf́ ŝt́r̂úĉt́ûŕêd́ d̂át̂á."
+  },
+  "lighthouse-core/audits/seo/json-ld.js | displayValue": {
+    "message": "{invalidSnippetCount, plural,\n    =1 {# îńv̂ál̂íd̂ śn̂íp̂ṕêt́}\n    other {# îńv̂ál̂íd̂ śn̂íp̂ṕêt́ŝ}\n    }"
+  },
+  "lighthouse-core/audits/seo/json-ld.js | failureTitle": {
+    "message": "ĴŚÔŃ-L̂D́ ŝt́r̂úĉt́ûŕêd́ d̂át̂á ŝýn̂t́âx́ îś îńv̂ál̂íd̂"
+  },
+  "lighthouse-core/audits/seo/json-ld.js | title": {
+    "message": "ĴŚÔŃ-L̂D́ ŝt́r̂úĉt́ûŕêd́ d̂át̂á ŝýn̂t́âx́ îś v̂ál̂íd̂"
+  },
   "lighthouse-core/audits/seo/link-text.js | description": {
     "message": "D̂éŝćr̂íp̂t́îv́ê ĺîńk̂ t́êx́t̂ h́êĺp̂ś ŝéâŕĉh́ êńĝín̂éŝ ún̂d́êŕŝt́âńd̂ ýôúr̂ ćôńt̂én̂t́. [L̂éâŕn̂ ḿôŕê](https://developers.google.com/web/tools/lighthouse/audits/descriptive-link-text)."
   },
@@ -906,7 +918,7 @@
     "message": "L̂ín̂ḱŝ h́âv́ê d́êśĉŕîṕt̂ív̂é t̂éx̂t́"
   },
   "lighthouse-core/audits/seo/manual/structured-data.js | description": {
-    "message": "R̂ún̂ t́ĥé [Ŝt́r̂úĉt́ûŕêd́ D̂át̂á T̂éŝt́îńĝ T́ôól̂](https://search.google.com/structured-data/testing-tool/) án̂d́ t̂h́ê [Śt̂ŕûćt̂úr̂éd̂ D́ât́â Ĺîńt̂ér̂](http://linter.structured-data.org/) t́ô v́âĺîd́ât́ê śt̂ŕûćt̂úr̂éd̂ d́ât́â. [Ĺêár̂ń m̂ór̂é](https://developers.google.com/search/docs/guides/mark-up-content)."
+    "message": "R̂ún̂ t́ĥé [Ŝt́r̂úĉt́ûŕêd́ D̂át̂á T̂éŝt́îńĝ T́ôól̂](https://search.google.com/structured-data/testing-tool/) t́ô v́âĺîd́ât́ê śt̂ŕûćt̂úr̂éd̂ d́ât́â. [Ĺêár̂ń m̂ór̂é](https://developers.google.com/search/docs/guides/mark-up-content)."
   },
   "lighthouse-core/audits/seo/manual/structured-data.js | title": {
     "message": "Ŝt́r̂úĉt́ûŕêd́ d̂át̂á îś v̂ál̂íd̂"

diff --git a/lighthouse-core/lib/sd-validation/schema-validator.js b/lighthouse-core/lib/sd-validation/schema-validator.js
@@ -96,11 +96,18 @@ function validateObjectKeys(typeOrTypes, keys) {
     // remove Schema.org input/output constraints http://schema.org/docs/actions.html#part-4
     .map(key => key.replace(/-(input|output)$/, ''))
     .filter(key => !allKnownProps.has(key))
-    .map(key => ({
-      message: `Unexpected property "${key}"`,
-      key,
-      validTypes: types,
-    }));
+    .map(key => {
+      return ({
+        message: `Unexpected property "${key}"`,
+        key,
+        validTypes: types.map(typeUri => {
+          const typeNameMatch = typeUri.match(/[\w]+$/);
+          const name = typeNameMatch ? typeNameMatch[0] : typeUri;
+          const uri = typeUri.replace('http://', 'https://');
+          return {name, uri};
+        }),
+      });
+    });
 }
 
 /**