@govtechsg/oobee 0.10.42 → 0.10.45

package/REPORTS.md

@@ -242,7 +242,9 @@ This file contains a summary of pages affected by accessibility issues.
     {
       "url": "<string>",
       "pageTitle": "<string>",
-      "actualUrl": "about:blank"
+      "actualUrl": "<string>",
+      "metadata": "<string>",
+      "httpStatusCode": number
     },
   ],
   "pagesNotScannedCount": <number>
@@ -340,7 +342,9 @@ This file contains a summary of accessibility issues found in a scan, categorize
     {
       "url": "<string>",
       "pageTitle": "<string>",
-      "actualUrl": "about:blank"
+      "actualUrl": "<string>",
+      "metadata": "<string>",
+      "httpStatusCode": number
     },
   ],
   "pagesNotScannedCount": <number>
@@ -360,3 +364,68 @@ To deflate the .json.gz.b64, use the following with `pako` library installed:
   // Parse and return the JSON object
   return JSON.parse(jsonString);
 ```
+
+## HTTP Status Codes Returned for Skipped Pages
+In scanPagesSummary.json and scanPagesDetail,json, within each `pagesNotScanned`, the following HTTP and Metadata is stored to provide a reason why the apge could not be scanned.
+
+| httpStatusCode | metadata                                    |
+|------|------------------------------------------------|
+| 0    | Page Excluded                                  |
+| 1    | Not A Supported Document                       |
+| 2    | Web Crawler Errored                            |
+| 100  | 100 – Continue                                 |
+| 101  | 101 – Switching Protocols                      |
+| 102  | 102 – Processing                               |
+| 103  | 103 – Early Hints                              |
+| 200  | 200 – However Page Could Not Be Scanned        |
+| 204  | 204 – No Content                               |
+| 205  | 205 – Reset Content                            |
+| 300  | 300 – Multiple Choices                         |
+| 301  | 301 – Moved Permanently                        |
+| 302  | 302 – Found                                    |
+| 303  | 303 – See Other                                |
+| 304  | 304 – Not Modified                             |
+| 305  | 305 – Use Proxy                                |
+| 307  | 307 – Temporary Redirect                       |
+| 308  | 308 – Permanent Redirect                       |
+| 400  | 400 – Bad Request                              |
+| 401  | 401 – Unauthorized                             |
+| 402  | 402 – Payment Required                         |
+| 403  | 403 – Forbidden                                |
+| 404  | 404 – Not Found                                |
+| 405  | 405 – Method Not Allowed                       |
+| 406  | 406 – Not Acceptable                           |
+| 407  | 407 – Proxy Authentication Required            |
+| 408  | 408 – Request Timeout                          |
+| 409  | 409 – Conflict                                 |
+| 410  | 410 – Gone                                     |
+| 411  | 411 – Length Required                          |
+| 412  | 412 – Precondition Failed                      |
+| 413  | 413 – Payload Too Large                        |
+| 414  | 414 – URI Too Long                             |
+| 415  | 415 – Unsupported Media Type                   |
+| 416  | 416 – Range Not Satisfiable                    |
+| 417  | 417 – Expectation Failed                       |
+| 418  | 418 – I’m a teapot                             |
+| 421  | 421 – Misdirected Request                      |
+| 422  | 422 – Unprocessable Content                    |
+| 423  | 423 – Locked                                   |
+| 424  | 424 – Failed Dependency                        |
+| 425  | 425 – Too Early                                |
+| 426  | 426 – Upgrade Required                         |
+| 428  | 428 – Precondition Required                    |
+| 429  | 429 – Too Many Requests                        |
+| 431  | 431 – Request Header Fields Too Large          |
+| 451  | 451 – Unavailable For Legal Reasons            |
+| 500  | 500 – Internal Server Error                    |
+| 501  | 501 – Not Implemented                          |
+| 502  | 502 – Bad Gateway                              |
+| 503  | 503 – Service Unavailable                      |
+| 504  | 504 – Gateway Timeout                          |
+| 505  | 505 – HTTP Version Not Supported               |
+| 506  | 506 – Variant Also Negotiates                  |
+| 507  | 507 – Insufficient Storage                     |
+| 508  | 508 – Loop Detected                            |
+| 510  | 510 – Not Extended                             |
+| 511  | 511 – Network Authentication Required          |
+| 599  | Uncommon Response Code Received                |

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@govtechsg/oobee",
   "main": "dist/npmIndex.js",
-  "version": "0.10.42",
+  "version": "0.10.45",
   "type": "module",
   "author": "Government Technology Agency <info@tech.gov.sg>",
   "dependencies": {
     "@json2csv/node": "^7.0.3",
     "@napi-rs/canvas": "^0.1.53",
+    "@sentry/node": "^9.13.0",
     "axe-core": "^4.10.2",
     "axios": "^1.8.2",
     "base64-stream": "^1.0.0",
@@ -46,6 +47,7 @@
     "@types/fs-extra": "^11.0.4",
     "@types/inquirer": "^9.0.7",
     "@types/lodash": "^4.17.7",
+    "@types/mime-types": "^2.1.4",
     "@types/safe-regex": "^1.1.6",
     "@types/validator": "^13.11.10",
     "@types/which": "^3.0.4",
@@ -97,4 +99,4 @@
     "url": "https://github.com/GovTechSG/oobee/issues"
   },
   "homepage": "https://github.com/GovTechSG/oobee#readme"
-}
+}

package/src/cli.ts

@@ -137,9 +137,6 @@ Usage: npm run cli -- -c <crawler> -d <device> -w <viewport> -u <url> OPTIONS`,
       printMessage([`Invalid blacklistedPatternsFilename file path. ${err}`], messageOptions);
       process.exit(1);
     }
-
-    // eslint-disable-next-line no-unreachable
-    return null;
   })
   .coerce('i', option => {
     const { choices } = cliOptions.i;
@@ -241,7 +238,7 @@ const scanInit = async (argvs: Answers): Promise<string> => {
     clonedDataDir,
     updatedArgvs.playwrightDeviceDetailsObject,
     isCustomFlow,
-    updatedArgvs.header,
+    parseHeaders(updatedArgvs.header),
   );
   switch (res.status) {
     case statuses.success.code: {
@@ -255,17 +252,14 @@ const scanInit = async (argvs: Answers): Promise<string> => {
     case statuses.unauthorised.code: {
       printMessage([statuses.unauthorised.message], messageOptions);
       process.exit(res.status);
-      break;
     }
     case statuses.cannotBeResolved.code: {
       printMessage([statuses.cannotBeResolved.message], messageOptions);
       process.exit(res.status);
-      break;
     }
     case statuses.systemError.code: {
       printMessage([statuses.systemError.message], messageOptions);
       process.exit(res.status);
-      break;
     }
     case statuses.invalidUrl.code: {
       if (
@@ -296,17 +290,14 @@ const scanInit = async (argvs: Answers): Promise<string> => {
     case statuses.notASitemap.code: {
       printMessage([statuses.notASitemap.message], messageOptions);
       process.exit(res.status);
-      break;
     }
     case statuses.notALocalFile.code: {
       printMessage([statuses.notALocalFile.message], messageOptions);
       process.exit(res.status);
-      break;
     }
     case statuses.browserError.code: {
       printMessage([statuses.browserError.message], messageOptions);
       process.exit(res.status);
-      break;
     }
     default:
       break;
@@ -362,7 +353,7 @@ const scanInit = async (argvs: Answers): Promise<string> => {
   }
 
   // Delete dataset and request queues
-  await cleanUp(data.randomToken);
+  cleanUp(data.randomToken);
 
   return getStoragePath(data.randomToken);
 };