lighthouse 9.5.0-dev.20220808 → 9.5.0-dev.20220809

package/cli/test/smokehouse/readme.md

@@ -64,9 +64,11 @@ Individual elements of an array can be asserted by using numeric properties in a
 
 However, if an array literal is used as the expectation, an extra condition is enforced that the actual array _must_ have the same length as the provided expected array.
 
-Arrays can be checked against a subset of elements using the special `_includes` property. The value of `_includes` _must_ be an array. Each assertion in `_includes` will remove the matching item from consideration for the rest.
+Arrays and objects can be checked against a subset of elements using the special `_includes` property. The value of `_includes` _must_ be an array. Each assertion in `_includes` will remove the matching item from consideration for the rest.
 
-Arrays can be asserted to not match any elements using the special `_excludes` property. The value of `_excludes` _must_ be an array. If an `_includes` check is defined before an `_excludes` check, only the element not matched under the previous will be considered.
+Arrays and objects can be asserted to not match any elements using the special `_excludes` property. The value of `_excludes` _must_ be an array. If an `_includes` check is defined before an `_excludes` check, only the element not matched under the previous will be considered.
+
+If an object is checked using `_includes` or `_excludes`, it will be checked against the `Object.entries` array.
 
 **Examples**:
 | Actual | Expected | Result |
@@ -79,6 +81,8 @@ Arrays can be asserted to not match any elements using the special `_excludes` p
 | `[{timeInMs: 5}, {timeInMs: 15}]` | `{_includes: [{timeInMs: 5}], _excludes: [{timeInMs: 15}]}` | ❌ FAIL |
 | `[{timeInMs: 5}, {timeInMs: 15}]` | `{_includes: [{timeInMs: 5}], _excludes: [{}]}` | ❌ FAIL |
 | `[{timeInMs: 5}, {timeInMs: 15}]` | `[{timeInMs: 5}]` | ❌ FAIL |
+| `{'foo': 1}` | `{_includes: [['foo', 1]]}` | ✅ PASS |
+| `{'foo': 1, 'bar': 2}` | `{_includes: [['foo', 1]], _excludes: [['bar', 2]]}` | ❌ FAIL |
 
 ### Special environment checks
 

package/cli/test/smokehouse/report-assert-test.js

@@ -133,6 +133,14 @@ describe('findDiffersences', () => {
       expected: {prices: {_includes: [/\d/, /\d/, /\d/, /\d/, /\d/, /\d/]}},
       diffs: null,
     },
+    '_includes (object)': {
+      actual: {'0-alpha': 1, '1-beta': 2, '3-gamma': 3},
+      expected: {_includes: [
+        ['0-alpha', '<2'],
+        [/[0-9]-beta/, 2],
+      ]},
+      diffs: null,
+    },
 
     '_excludes (1)': {
       actual: {prices: [0, 1, 2, 3, 4, 5]},
@@ -147,6 +155,16 @@ describe('findDiffersences', () => {
         message: 'Expected to not find matching entry via _excludes',
       }}],
     },
+    '_excludes (object)': {
+      actual: {'0-alpha': 1, '1-beta': 2, '3-gamma': 3},
+      expected: {_excludes: [
+        [/[0-9]-beta/, 2],
+      ]},
+      diffs: [{path: '', actual: ['1-beta', 2], expected: {
+        expectedExclusion: [/[0-9]-beta/, 2],
+        message: 'Expected to not find matching entry via _excludes',
+      }}],
+    },
 
     '_includes and _excludes (1)': {
       actual: {prices: [0, 1, 2, 3, 4, 5]},
@@ -170,6 +188,22 @@ describe('findDiffersences', () => {
         message: 'Expected to not find matching entry via _excludes',
       }}],
     },
+    '_includes and _excludes (object)': {
+      actual: {'0-alpha': 1, '1-beta': 2, '3-gamma': 3},
+      expected: {
+        _includes: [
+          ['0-alpha', '<2'],
+        ],
+        _excludes: [
+          [/[0-9]-alpha/, 1],
+          [/[0-9]-beta/, 2],
+        ],
+      },
+      diffs: [{path: '', actual: ['1-beta', 2], expected: {
+        expectedExclusion: [/[0-9]-beta/, 2],
+        message: 'Expected to not find matching entry via _excludes',
+      }}],
+    },
   };
 
   for (const [testName, {actual, expected, diffs}] of Object.entries(testCases)) {

package/cli/test/smokehouse/report-assert.js

@@ -105,6 +105,8 @@ function findDifferences(path, actual, expected) {
 
   /** @type {Difference[]} */
   const diffs = [];
+
+  /** @type {any[]|undefined} */
   let inclExclCopy;
 
   // We only care that all expected's own properties are on actual (and not the other way around).
@@ -116,15 +118,20 @@ function findDifferences(path, actual, expected) {
     const expectedValue = expected[key];
 
     if (key === '_includes') {
-      inclExclCopy = [...actual];
+      if (Array.isArray(actual)) {
+        inclExclCopy = [...actual];
+      } else if (typeof actual === 'object') {
+        inclExclCopy = Object.entries(actual);
+      }
 
       if (!Array.isArray(expectedValue)) throw new Error('Array subset must be array');
-      if (!Array.isArray(actual)) {
+      if (!inclExclCopy) {
         diffs.push({
           path,
-          actual: 'Actual value is not an array',
+          actual: 'Actual value is not an array or object',
           expected,
         });
+        continue;
       }
 
       for (const expectedEntry of expectedValue) {
@@ -148,20 +155,33 @@ function findDifferences(path, actual, expected) {
 
     if (key === '_excludes') {
       // Re-use state from `_includes` check, if there was one.
-      /** @type {any[]} */
-      const arrToCheckAgainst = inclExclCopy || actual;
+      if (!inclExclCopy) {
+        if (Array.isArray(actual)) {
+          // We won't be removing items, so we can just copy the reference.
+          inclExclCopy = actual;
+        } else if (typeof actual === 'object') {
+          inclExclCopy = Object.entries(actual);
+        }
+      }
 
       if (!Array.isArray(expectedValue)) throw new Error('Array subset must be array');
-      if (!Array.isArray(actual)) continue;
+      if (!inclExclCopy) {
+        diffs.push({
+          path,
+          actual: 'Actual value is not an array or object',
+          expected,
+        });
+        continue;
+      }
 
       const expectedExclusions = expectedValue;
       for (const expectedExclusion of expectedExclusions) {
-        const matchingIndex = arrToCheckAgainst.findIndex(actualEntry =>
+        const matchingIndex = inclExclCopy.findIndex(actualEntry =>
             !findDifferences(keyPath, actualEntry, expectedExclusion));
         if (matchingIndex !== -1) {
           diffs.push({
             path,
-            actual: arrToCheckAgainst[matchingIndex],
+            actual: inclExclCopy[matchingIndex],
             expected: {
               message: 'Expected to not find matching entry via _excludes',
               expectedExclusion,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lighthouse",
   "type": "module",
-  "version": "9.5.0-dev.20220808",
+  "version": "9.5.0-dev.20220809",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./core/index.js",
   "bin": {