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
@@ -64,7 +64,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
@@ -369,6 +369,9 @@ Object {
     Object {
       "path": "seo/canonical",
     },
+    Object {
+      "path": "seo/structured-data-automatic",
+    },
     Object {
       "path": "seo/manual/structured-data",
     },
@@ -972,6 +975,11 @@ Object {
           "id": "canonical",
           "weight": 1,
         },
+        Object {
+          "group": "seo-content",
+          "id": "structured-data-automatic",
+          "weight": 1,
+        },
         Object {
           "group": "seo-mobile",
           "id": "font-size",

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(structured-data-automatic): 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(structured-data-automatic): 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
@@ -80,6 +80,9 @@ module.exports = [
           score: null,
           scoreDisplayMode: 'notApplicable',
         },
+        'structured-data-automatic': {
+          score: 1,
+        },
       },
     }},
   {
@@ -141,6 +144,9 @@ module.exports = [
           score: 0,
           explanation: 'Multiple conflicting URLs (https://example.com/other, https://example.com/)',
         },
+        'structured-data-automatic': {
+          score: 0,
+        },
       },
     },
   },

diff --git a/lighthouse-core/audits/seo/structured-data-automatic.js b/lighthouse-core/audits/seo/structured-data-automatic.js
@@ -0,0 +1,165 @@
+/**
+ * @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: '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 manual audit below to learn how to validate other types of structured data.',
+  /** Explanatory message stating what percentage of JSON-LD structured data snippets are invalid */
+  displayValue: '{validSnippetProportion, number, percent} valid snippets',
+};
+
+const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
+
+class StructuredDataAutomatic extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'structured-data-automatic',
+      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 validatedSnippets = await Promise.all(jsonLDElements.map(async (element) => {
+      // We don't want to show empty lines around the snippet
+      const content = /** @type string */ (element.content).trim();
+
+      return {
+        devtoolsNodePath: element.devtoolsNodePath,
+        content,
+        errors: await validateJsonLD(content),
+      };
+    }));
+    // Show invalid snippets at the top
+    validatedSnippets.sort((a, b) => {
+      return b.errors.length - a.errors.length;
+    });
+
+    const renderedSnippets = validatedSnippets.map(
+      snippetWithErrors => renderValidatedSnippet(snippetWithErrors)
+    );
+    const details = Audit.makeListDetails(renderedSnippets);
+
+    const invalidSnippets = validatedSnippets.filter(vs => vs.errors.length > 0);
+    const validSnippets = validatedSnippets.filter(vs => vs.errors.length === 0);
+    const displayValue = str_(UIStrings.displayValue, {
+      validSnippetProportion: validSnippets.length / jsonLDElements.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;
+
+  let parsedContent;
+  let topLevelType;
+  let topLevelName;
+  try {
+    parsedContent = JSON.parse(content);
+    topLevelType = parsedContent['@type'];
+    topLevelName = parsedContent['name'];
+  } catch (err) {}
+
+  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/config/default-config.js b/lighthouse-core/config/default-config.js
@@ -262,6 +262,7 @@ const defaultConfig = {
     'seo/hreflang',
     'seo/plugins',
     'seo/canonical',
+    'seo/structured-data-automatic',
     'seo/manual/structured-data',
   ],
 
@@ -465,6 +466,7 @@ const defaultConfig = {
         {id: 'robots-txt', weight: 1, group: 'seo-crawl'},
         {id: 'hreflang', weight: 1, group: 'seo-content'},
         {id: 'canonical', weight: 1, group: 'seo-content'},
+        {id: 'structured-data-automatic', 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/en-US.json b/lighthouse-core/lib/i18n/en-US.json
@@ -927,6 +927,22 @@
     "message": "robots.txt is valid",
     "description": "Title of a Lighthouse audit that provides detail on the site's robots.txt file. Note: \"robots.txt\" is a canonical filename and should not be translated. This descriptive title is shown when the robots.txt file is present and configured correctly."
   },
+  "lighthouse-core/audits/seo/structured-data-automatic.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 manual audit below to learn how to validate other types of structured data.",
+    "description": "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."
+  },
+  "lighthouse-core/audits/seo/structured-data-automatic.js | displayValue": {
+    "message": "{validSnippetProportion, number, percent} valid snippets",
+    "description": "Explanatory message stating what percentage of JSON-LD structured data snippets are invalid"
+  },
+  "lighthouse-core/audits/seo/structured-data-automatic.js | failureTitle": {
+    "message": "JSON-LD structured data syntax is invalid",
+    "description": "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."
+  },
+  "lighthouse-core/audits/seo/structured-data-automatic.js | title": {
+    "message": "JSON-LD structured data syntax is valid",
+    "description": "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."
+  },
   "lighthouse-core/audits/seo/tap-targets.js | description": {
     "message": "Interactive elements like buttons and links should be large enough (48x48px), and have enough space around them, to be easy enough to tap without overlapping onto other elements. [Learn more](https://developers.google.com/web/fundamentals/accessibility/accessible-styles#multi-device_responsive_design).",
     "description": "Description of a Lighthouse audit that tells the user why buttons and links need to be big enough and what 'big enough' means. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation."

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};
+        }),
+      });
+    });
 }
 
 /**