Make unstable log output stable using explicit sorting

[Bananeweizen]

Tell us more.

When comparing the logs from different runs of renovate, I noticed that the following "managers" section has no stable sort order, therefore it always leads to unwanted deltas in log comparisons. These logs are from 2 runs with the same renovate version and config, but they differ in how "pip_requirements" and "pre-commit" are sorted.

 DEBUG: manager extract durations (ms) (repository=redacted)
        "managers": {
          "dockerfile": 14,
          "pip_requirements": 13,
          "pre-commit": 16,
          "renovate-config-presets": 17,
          "regex": 22
        }

 DEBUG: manager extract durations (ms) (repository=redacted)
        "managers": {
          "dockerfile": 19,
          "pre-commit": 23,
          "pip_requirements": 23,
          "renovate-config-presets": 22,
          "regex": 27
        }

I'm not sure but it might be related to the asynchronous code in

renovate/lib/workers/repository/extract/index.ts

Lines 56 to 76 in 478f46f

	const extractDurations: Record<string, number> = {};
	const extractResults = await Promise.all(
	extractList.map(async (managerConfig) => {
	const start = Date.now();
	const packageFiles = await instrument(
	managerConfig.manager,
	async () => await getManagerPackageFiles(managerConfig),
	);
	const durationMs = Math.round(Date.now() - start);
	extractDurations[managerConfig.manager] = durationMs;
	return { manager: managerConfig.manager, packageFiles };
	}),
	);
	// De-duplicate results using supersedesManagers
	processSupersedesManagers(extractResults);
	logger.debug(
	{ managers: extractDurations },
	'manager extract durations (ms)',
	);

creating that list. I'd suggest ordering the managers alphabetically to make the sort order reproducible and logs more easy to compare.

[jamietanna]

Sounds very reasonable and agreed. I wonder what other areas we've got that would make it simpler to diff

We probably don't want to always sort every object we're given in a stable way, due to increased performance impact, but @viceice @zharinov any thoughts?

[viceice]

I think it's ok to sort those objects before printing it to the log. so it's only done once

[jamietanna]

Just this object (and maybe i.e. packageFiles with updates, etc), or you mean all?

[viceice]

just those special objects known to be unstable

[jamietanna]

Apologies for the delay - #41509 should fix this!