From 444ea13dd5892cd85dd290b8ed3d373fb5b2de6a Mon Sep 17 00:00:00 2001
From: RahulGautamSingh <rahultesnik@gmail.com>
Date: Sat, 24 Jun 2023 15:17:50 +0545
Subject: [PATCH] refactor: remove string interpolations (#22840)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
---
lib/config-validator.ts | 22 ++++++++++++-------
lib/modules/manager/gomod/artifacts.ts | 5 ++++-
lib/modules/manager/pub/artifacts.ts | 2 +-
lib/modules/platform/gitea/index.ts | 2 +-
lib/modules/platform/github/index.ts | 7 ++++--
lib/modules/versioning/ruby/index.ts | 2 +-
lib/modules/versioning/ruby/range.ts | 4 ++--
.../versioning/ruby/strategies/replace.ts | 2 +-
lib/util/exec/docker/index.ts | 2 +-
lib/util/http/bitbucket.ts | 2 +-
.../config/parse/host-rules-from-env.ts | 2 +-
lib/workers/repository/update/branch/index.ts | 2 +-
.../update/pr/changelog/release-notes.ts | 5 ++++-
13 files changed, 37 insertions(+), 22 deletions(-)
diff --git a/lib/config-validator.ts b/lib/config-validator.ts
index 00d3176fc5..07bf4bbe4c 100644
--- a/lib/config-validator.ts
+++ b/lib/config-validator.ts
@@ -34,11 +34,17 @@ async function validate(
const massagedConfig = massageConfig(migratedConfig);
const res = await validateConfig(massagedConfig, isPreset);
if (res.errors.length) {
- logger.error({ errors: res.errors }, `${desc} contains errors`);
+ logger.error(
+ { file: desc, errors: res.errors },
+ 'Found errors in configuration'
+ );
returnVal = 1;
}
if (res.warnings.length) {
- logger.warn({ warnings: res.warnings }, `${desc} contains warnings`);
+ logger.warn(
+ { file: desc, warnings: res.warnings },
+ 'Found errors in configuration'
+ );
returnVal = 1;
}
}
@@ -54,7 +60,7 @@ type PackageJson = {
try {
if (!(await pathExists(file))) {
returnVal = 1;
- logger.error(`${file} does not exist`);
+ logger.error({ file }, 'File does not exist');
break;
}
const parsedContent = await getParsedContent(file);
@@ -62,11 +68,11 @@ type PackageJson = {
logger.info(`Validating ${file}`);
await validate(file, parsedContent);
} catch (err) {
- logger.warn({ err }, `${file} is not valid Renovate config`);
+ logger.warn({ file, err }, 'File is not valid Renovate config');
returnVal = 1;
}
} catch (err) {
- logger.warn({ err }, `${file} could not be parsed`);
+ logger.warn({ file, err }, 'File could not be parsed');
returnVal = 1;
}
}
@@ -83,11 +89,11 @@ type PackageJson = {
logger.info(`Validating ${file}`);
await validate(file, parsedContent);
} catch (err) {
- logger.warn({ err }, `${file} is not valid Renovate config`);
+ logger.warn({ file, err }, 'File is not valid Renovate config');
returnVal = 1;
}
} catch (err) {
- logger.warn({ err }, `${file} could not be parsed`);
+ logger.warn({ file, err }, 'File could not be parsed');
returnVal = 1;
}
}
@@ -116,7 +122,7 @@ type PackageJson = {
try {
await validate(file, fileConfig);
} catch (err) {
- logger.error({ err }, `${file} is not valid Renovate config`);
+ logger.error({ file, err }, 'File is not valid Renovate config');
returnVal = 1;
}
}
diff --git a/lib/modules/manager/gomod/artifacts.ts b/lib/modules/manager/gomod/artifacts.ts
index a5606467db..72ecb0f158 100644
--- a/lib/modules/manager/gomod/artifacts.ts
+++ b/lib/modules/manager/gomod/artifacts.ts
@@ -36,7 +36,10 @@ function getUpdateImportPathCmds(
);
if (invalidMajorDeps.length > 0) {
invalidMajorDeps.forEach(({ depName }) =>
- logger.warn(`Could not get major version of ${depName!}. Ignoring`)
+ logger.warn(
+ { depName },
+ 'Ignoring dependency: Could not get major version'
+ )
);
}
diff --git a/lib/modules/manager/pub/artifacts.ts b/lib/modules/manager/pub/artifacts.ts
index 16cdae0a8f..16b4de4b22 100644
--- a/lib/modules/manager/pub/artifacts.ts
+++ b/lib/modules/manager/pub/artifacts.ts
@@ -96,7 +96,7 @@ export async function updateArtifacts({
if (err.message === TEMPORARY_ERROR) {
throw err;
}
- logger.warn({ err }, `Failed to update ${lockFileName} file`);
+ logger.warn({ lockfile: lockFileName, err }, `Failed to update lock file`);
return [
{
artifactError: {
diff --git a/lib/modules/platform/gitea/index.ts b/lib/modules/platform/gitea/index.ts
index ecc8e64bfa..cc1fdfda04 100644
--- a/lib/modules/platform/gitea/index.ts
+++ b/lib/modules/platform/gitea/index.ts
@@ -737,7 +737,7 @@ const platform: Platform = {
for (const issue of issues) {
if (issue.state === 'open' && issue.number !== activeIssue.number) {
// TODO: types (#7154)
- logger.warn(`Closing duplicate Issue #${issue.number!}`);
+ logger.warn({ issueNo: issue.number! }, 'Closing duplicate issue');
// TODO #7154
await helper.closeIssue(config.repository, issue.number!);
}
diff --git a/lib/modules/platform/github/index.ts b/lib/modules/platform/github/index.ts
index 5370c458a7..1b935ecbb0 100644
--- a/lib/modules/platform/github/index.ts
+++ b/lib/modules/platform/github/index.ts
@@ -1192,7 +1192,7 @@ export async function ensureIssue({
}
for (const i of issues) {
if (i.state === 'open' && i.number !== issue.number) {
- logger.warn(`Closing duplicate issue ${i.number}`);
+ logger.warn({ issueNo: i.number }, 'Closing duplicate issue');
// TODO #7154
await closeIssue(i.number!);
}
@@ -1693,7 +1693,10 @@ export async function mergePr({
'GitHub blocking PR merge -- will keep trying'
);
} else {
- logger.warn({ err }, `Failed to ${config.mergeMethod} merge PR`);
+ logger.warn(
+ { mergeMethod: config.mergeMethod, err },
+ 'Failed to merge PR'
+ );
return false;
}
}
diff --git a/lib/modules/versioning/ruby/index.ts b/lib/modules/versioning/ruby/index.ts
index 8c95cdf876..b2cee80b2e 100644
--- a/lib/modules/versioning/ruby/index.ts
+++ b/lib/modules/versioning/ruby/index.ts
@@ -141,7 +141,7 @@ const getNewValue = ({
break;
// istanbul ignore next
default:
- logger.warn(`Unsupported strategy ${rangeStrategy}`);
+ logger.warn({ rangeStrategy }, 'Unsupported range strategy');
}
}
if (newValue && regEx(/^('|")/).exec(currentValue)) {
diff --git a/lib/modules/versioning/ruby/range.ts b/lib/modules/versioning/ruby/range.ts
index 02f8a0a1b7..a490d9c94c 100644
--- a/lib/modules/versioning/ruby/range.ts
+++ b/lib/modules/versioning/ruby/range.ts
@@ -98,7 +98,7 @@ type GemRequirement = [string, Version];
const ltr = (version: string, range: string): boolean => {
const gemVersion = create(version);
if (!gemVersion) {
- logger.warn(`Invalid ruby version '${version}'`);
+ logger.warn({ version }, `Invalid ruby version`);
return false;
}
const requirements: GemRequirement[] = range.split(',').map(_parse);
@@ -120,7 +120,7 @@ const ltr = (version: string, range: string): boolean => {
);
// istanbul ignore next
default:
- logger.warn(`Unsupported operator '${operator}'`);
+ logger.warn({ operator }, `Unsupported operator`);
return false;
}
});
diff --git a/lib/modules/versioning/ruby/strategies/replace.ts b/lib/modules/versioning/ruby/strategies/replace.ts
index 713e1d71db..29d32d859d 100644
--- a/lib/modules/versioning/ruby/strategies/replace.ts
+++ b/lib/modules/versioning/ruby/strategies/replace.ts
@@ -31,7 +31,7 @@ export function replacePart(part: Range, to: string): Range {
return part;
// istanbul ignore next
default:
- logger.warn(`Unsupported operator '${operator}'`);
+ logger.warn({ operator }, `Unsupported ruby versioning operator`);
return { operator: '', delimiter: ' ', version: '' };
}
}
diff --git a/lib/util/exec/docker/index.ts b/lib/util/exec/docker/index.ts
index bab2610a56..d20ccb9d02 100644
--- a/lib/util/exec/docker/index.ts
+++ b/lib/util/exec/docker/index.ts
@@ -123,7 +123,7 @@ export async function getDockerTag(
return version;
}
} else {
- logger.error(`No ${packageName} releases found`);
+ logger.error({ packageName }, `Docker exec: no releases found`);
return 'latest';
}
logger.warn(
diff --git a/lib/util/http/bitbucket.ts b/lib/util/http/bitbucket.ts
index 34c5166ca8..e99d855012 100644
--- a/lib/util/http/bitbucket.ts
+++ b/lib/util/http/bitbucket.ts
@@ -34,7 +34,7 @@ export class BitbucketHttp extends Http<BitbucketHttpOptions> {
// istanbul ignore if: this should never happen
if (is.nullOrUndefined(resolvedURL)) {
- logger.error(`Bitbucket: cannot parse path ${path}`);
+ logger.error({ path }, 'Bitbucket: cannot parse path');
throw new Error(`Bitbucket: cannot parse path ${path}`);
}
diff --git a/lib/workers/global/config/parse/host-rules-from-env.ts b/lib/workers/global/config/parse/host-rules-from-env.ts
index f4b85dab3f..2db3e81a71 100644
--- a/lib/workers/global/config/parse/host-rules-from-env.ts
+++ b/lib/workers/global/config/parse/host-rules-from-env.ts
@@ -32,7 +32,7 @@ export function hostRulesFromEnv(env: NodeJS.ProcessEnv): HostRule[] {
if (splitEnv.length === 0) {
// host-less rule
} else if (splitEnv.length === 1) {
- logger.warn(`Cannot parse ${envName} env`);
+ logger.warn({ env: envName }, 'Cannot parse env');
continue;
} else {
matchHost = splitEnv.join('.');
diff --git a/lib/workers/repository/update/branch/index.ts b/lib/workers/repository/update/branch/index.ts
index b66fd7850e..a7dafcec36 100644
--- a/lib/workers/repository/update/branch/index.ts
+++ b/lib/workers/repository/update/branch/index.ts
@@ -873,7 +873,7 @@ export async function processBranch(
throw err;
}
// Otherwise don't throw here - we don't want to stop the other renovations
- logger.error({ err }, `Error ensuring PR: ${String(err.message)}`);
+ logger.error({ err }, `Error ensuring PR`);
}
if (!branchExists) {
return {
diff --git a/lib/workers/repository/update/pr/changelog/release-notes.ts b/lib/workers/repository/update/pr/changelog/release-notes.ts
index cae6f67d65..fa9b565d03 100644
--- a/lib/workers/repository/update/pr/changelog/release-notes.ts
+++ b/lib/workers/repository/update/pr/changelog/release-notes.ts
@@ -364,7 +364,10 @@ export async function getReleaseNotesMd(
}
}
} catch (err) /* istanbul ignore next */ {
- logger.warn({ err }, `Error parsing ${changelogFile}`);
+ logger.warn(
+ { file: changelogFile, err },
+ `Error parsing changelog file`
+ );
}
}
}
--
GitLab