fix(cache): Store cache with sorted object keys (#17607)

lib/util/cache/repository/impl/base.ts

@@ -4,6 +4,7 @@ import is from '@sindresorhus/is';
 import hasha from 'hasha';
 import { GlobalConfig } from '../../../../config/global';
 import { logger } from '../../../../logger';
+import { safeStringify } from '../../../stringify';
 import {
   CACHE_REVISION,
   isValidRev10,
@@ -106,7 +107,7 @@ export abstract class RepoCacheBase implements RepoCache {
   }
 
   async save(): Promise<void> {
-    const jsonStr = JSON.stringify(this.data);
+    const jsonStr = safeStringify(this.data);
     const hash = await hasha.async(jsonStr);
     if (hash === this.oldHash) {
       return;
@@ -133,10 +134,10 @@ export abstract class RepoCacheBase implements RepoCache {
   }
 
   isModified(): boolean | undefined {
-    const jsonStr = JSON.stringify(this.data);
     if (!this.oldHash) {
       return undefined;
     }
+    const jsonStr = safeStringify(this.data);
     return hasha(jsonStr) !== this.oldHash;
   }
 }

lib/util/cache/repository/impl/local.spec.ts

@@ -313,4 +313,31 @@ describe('util/cache/repository/impl/local', () => {
 
     expect(fs.outputCacheFile).not.toHaveBeenCalledWith();
   });
+
+  it('does not write cache when only key order has changed', async () => {
+    const oldCacheRecord = await createCacheRecord({
+      configFileName: 'renovate.json',
+      semanticCommits: 'enabled',
+    });
+    const cacheType = 'protocol://domain/path';
+    fs.readCacheFile.mockResolvedValueOnce(JSON.stringify(oldCacheRecord));
+    const localRepoCache = CacheFactory.get(
+      'some/repo',
+      '0123456789abcdef',
+      cacheType
+    );
+
+    await localRepoCache.load();
+    const data = localRepoCache.getData();
+    delete data.configFileName;
+    delete data.semanticCommits;
+    data.semanticCommits = 'enabled';
+    data.configFileName = 'renovate.json';
+
+    expect(localRepoCache.isModified()).toBeFalse();
+
+    await localRepoCache.save();
+
+    expect(fs.outputCacheFile).not.toHaveBeenCalledWith();
+  });
 });

lib/util/clone.ts

@@ -1,9 +1,5 @@
-import { configure } from 'safe-stable-stringify';
-
-const stringify = configure({
-  deterministic: false,
-});
+import { quickStringify } from './stringify';
 
 export function clone<T>(input: T | null = null): T {
-  return JSON.parse(stringify(input));
+  return JSON.parse(quickStringify(input));
 }

lib/util/stringify.ts

@@ -0,0 +1,9 @@
+import { configure } from 'safe-stable-stringify';
+
+export const quickStringify = configure({
+  deterministic: false,
+});
+
+export const safeStringify = configure({
+  deterministic: true,
+});