feat(report): add 404 report (#54)

* feat(report): handle 404.json

* fix

* fix

* feat(report): add 404

* fix: tests

* fix 404 summary

* fix: add 404 info to intro + wordings

report/src/__snapshots__/generateUrlReport.test.js.snap

@@ -2,6 +2,7 @@
 
 exports[`generateUrlReport should allow empty/invalid reports 1`] = `
 Object {
+  "404": null,
   "codescan": Object {
     "report": "codescanalerts.json",
     "totalCount": 42,
@@ -30,6 +31,11 @@ Object {
 
 exports[`generateUrlReport should generate latest report for a valid url 1`] = `
 Object {
+  "404": Array [
+    1,
+    2,
+    3,
+  ],
   "codescan": Object {
     "report": "codescanalerts.json",
     "totalCount": 42,
@@ -61,6 +67,7 @@ Object {
     "report": "stats.json",
   },
   "summary": Object {
+    "404": 3,
     "codescanCount": 42,
     "codescanGrade": undefined,
   },

report/src/generateUrlReport.js

@@ -108,6 +108,12 @@ const lhrCleanup = (result) => {
   };
 };
 
+/**
+ * Minify wget spider report
+ */
+const wget404Cleanup = (result) => result && result.broken
+
+
 //@ts-expect-error
 const requireToolData = (filename) => (basePath) =>
   requireJson(path.join(basePath, filename));
@@ -128,7 +134,8 @@ const tools = {
     /** @param {string} basePath scan directory */
     data: (basePath) => fs.existsSync(path.join(basePath, "screenshot.jpeg")),
   },
-  stats: { data: requireToolData("stats.json") }
+  stats: { data: requireToolData("stats.json") },
+  404: { data: requireToolData("404.json"), cleanup: wget404Cleanup },
 };
 
 //@ts-expect-error

report/src/generateUrlReport.test.js

@@ -57,6 +57,7 @@ describe("generateUrlReport", () => {
     mockJson("wappalyzer.json", {report: "wappalyzer.json"});
     mockJson("zap.json", {report: "zap.json"});
     mockJson("stats.json", {report: "stats.json"});
+    mockJson("404.json", {broken: [1, 2, 3]});
 
     expect(
       generateUrlReport({
@@ -77,6 +78,7 @@ describe("generateUrlReport", () => {
     unMockJson("wappalyzer.json");
     unMockJson("zap.json");
     unMockJson("stats.json");
+    unMockJson("404.json");
   });
   test(`should allow empty/invalid reports`, () => {
     fs.existsSync.mockImplementationOnce(() => true); // check url folder

report/src/summary/__snapshots__/index.test.js.snap

@@ -0,0 +1,31 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`should compute summary for some URL report 1`] = `
+Object {
+  "404": 5,
+  "apdex": 1,
+  "apdexGrade": "A",
+  "codescanCount": 0,
+  "codescanGrade": "A",
+  "cookiesCount": 2,
+  "cookiesGrade": "B",
+  "dependabotCount": 4,
+  "dependabotGrade": "D",
+  "httpGrade": "A+",
+  "lighthouse_accessibility": 0.96,
+  "lighthouse_accessibilityGrade": "A",
+  "lighthouse_best-practices": 0.93,
+  "lighthouse_best-practicesGrade": "A",
+  "lighthouse_performance": 0.45,
+  "lighthouse_performanceGrade": "D",
+  "lighthouse_pwa": 0.42,
+  "lighthouse_pwaGrade": "D",
+  "lighthouse_seo": 0.9,
+  "lighthouse_seoGrade": "A",
+  "testsslGrade": "A+",
+  "trackersCount": 0,
+  "trackersGrade": "A",
+  "uptime": 99.909,
+  "uptimeGrade": "A",
+}
+`;

report/src/summary/index.js

@@ -19,6 +19,8 @@ const tools = {
   updownio: (report) => require("./updownio")(report),
   /** @param {StatsReport} report */
   stats: (report) => require("./stats")(report),
+  /** @param {Error404Report} report */
+  404: report => report && report.length && ({ 404: report.length })
 };
 
 /**