[7.x] [kbn/optimizer] exclude "cache" config from cache key, diff actually compared values (#67232) (#67542)

Co-authored-by: spalger <spalger@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

packages/kbn-optimizer/src/common/worker_config.ts

@@ -31,7 +31,7 @@ export interface WorkerConfig {
   readonly optimizerCacheKey: unknown;
 }
 
-export type CacheableWorkerConfig = Omit<WorkerConfig, 'watch' | 'profileWebpack'>;
+export type CacheableWorkerConfig = Omit<WorkerConfig, 'watch' | 'profileWebpack' | 'cache'>;
 
 export function parseWorkerConfig(json: string): WorkerConfig {
   try {

packages/kbn-optimizer/src/integration_tests/bundle_cache.test.ts

@@ -208,8 +208,8 @@ it('emits "bundle not cached" event when optimizerCacheKey is outdated, includes
         "diff": "- Expected
     + Received
 
-    - old
+    - \\"old\\"
-    + optimizerCacheKey",
+    + \\"optimizerCacheKey\\"",
         "reason": "optimizer cache key mismatch",
         "type": "bundle not cached",
       },
@@ -291,8 +291,8 @@ it('emits "bundle not cached" event when cacheKey is outdated', async () => {
         "diff": "- Expected
     + Received
 
-    - old
+    - \\"old\\"
-    + new",
+    + \\"new\\"",
         "reason": "cache key mismatch",
         "type": "bundle not cached",
       },

packages/kbn-optimizer/src/optimizer/cache_keys.test.ts

@@ -100,7 +100,6 @@ describe('getOptimizerCacheKey()', () => {
               },
               "workerConfig": Object {
                 "browserslistEnv": "dev",
-                "cache": true,
                 "dist": false,
                 "optimizerCacheKey": "♻",
                 "repoRoot": <absolute path>,
@@ -134,13 +133,13 @@ describe('diffCacheKey()', () => {
       "- Expected
       + Received
 
-        Array [
+        [
           \\"1\\",
           \\"2\\",
-          Object {
+          {
-      -     \\"a\\": \\"b\\",
+      -     \\"a\\": \\"b\\"
-      +     \\"b\\": \\"a\\",
+      +     \\"b\\": \\"a\\"
-          },
+          }
         ]"
     `);
     expect(
@@ -158,11 +157,11 @@ describe('diffCacheKey()', () => {
       "- Expected
       + Received
 
-        Object {
+        {
       -   \\"a\\": \\"1\\",
-      -   \\"b\\": \\"1\\",
+      -   \\"b\\": \\"1\\"
       +   \\"a\\": \\"2\\",
-      +   \\"b\\": \\"2\\",
+      +   \\"b\\": \\"2\\"
         }"
     `);
   });

packages/kbn-optimizer/src/optimizer/cache_keys.ts

@@ -48,11 +48,18 @@ function omit<T, K extends keyof T>(obj: T, keys: K[]): Omit<T, K> {
 }
 
 export function diffCacheKey(expected?: unknown, actual?: unknown) {
-  if (jsonStable(expected) === jsonStable(actual)) {
+  const expectedJson = jsonStable(expected, {
+    space: '  ',
+  });
+  const actualJson = jsonStable(actual, {
+    space: '  ',
+  });
+
+  if (expectedJson === actualJson) {
     return;
   }
 
-  return reformatJestDiff(jestDiff(expected, actual));
+  return reformatJestDiff(jestDiff(expectedJson, actualJson));
 }
 
 export function reformatJestDiff(diff: string | null) {
@@ -178,7 +185,7 @@ export async function getOptimizerCacheKey(config: OptimizerConfig) {
     bootstrap,
     deletedPaths,
     modifiedTimes: {} as Record<string, number>,
-    workerConfig: omit(config.getWorkerConfig('♻'), ['watch', 'profileWebpack']),
+    workerConfig: omit(config.getWorkerConfig('♻'), ['watch', 'profileWebpack', 'cache']),
   };
 
   const mtimes = await getMtimes(modifiedPaths);