fix(cache): Store cache with sorted object keys

[zharinov]

Changes

Deep sort objects keys before JSON.stringify. This should help to avoid unnecessary disk writes of the essentially same data. Arrays are left unsorted as it may be unsafe.

Context

• Fixes: prCache within repo cache is written while being out of date #17603

Documentation (please check one with an [x])

• I have updated the documentation, or
• No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

• Code inspection only, or
• Newly added/modified unit tests, or
• No unit tests but ran on a real repository, or
• Both unit tests + ran on a real repository

[zharinov]

I've chosen sortobject over json-stable-sort since it's zero-dependency library and it was updated recently. Please object if you have a better choice.

[Gabriel-Ladzaretti]

Ill just note that the prCahce issue is unrelated to the sorting problem of objects, although this sorting issue was also observed, so this is very welcome.

By looking at the source code for sortObject it seems that it does sort arrays as well.

https://github.com/bevry/sortobject/blob/f8202dc8735030fc82b6840e8cca80502aa3d694/source/index.ts#L53-L58

Otherwise, code LGTM.

EDIT: This indeed doesnt sort Arrays if no comparator function is provided.

[renovate-release]

🎉 This PR is included in version 32.190.2 🎉

The release is available on:

• GitHub release
• 32.190.2

Your semantic-release bot 📦🚀