fix(util/git): Skip PR update on "force-with-lease" errors #14228

zharinov · 2022-02-15T05:24:40Z

Changes:

Wrap to ExternalHostError and re-throw, which will lead processBranch() to skip the branch updating for this run.

Context:

Closes: PR gets auto-merged with changed version in title, but not changed contents #12124

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 · 2022-02-15T05:27:42Z

lib/util/git/error.ts

@@ -124,7 +124,7 @@ export function handleCommitError(
    logger.info(
      'Branch update was rejected because local copy is not up-to-date.'
    );
-    return null;
+    throw new ExternalHostError(err, 'git');


'[rejected] (stale info)' can be added to externalHostFailureStrings instead, but log message would be too verbose IMO.

Anyway, please suggest better alternative if the solution is okay in general.

How does it look in the logs with your current suggestion?

How does it look in the logs with your current suggestion?

Please, take a look here: #14228 (comment)

zharinov · 2022-02-15T05:30:13Z

Log messages from reproduction repo (no PRs were updated):

DEBUG: Pushing branch renovate/yarn-1.x (repository=renovate-testing/test-12124-pr-title-and-body-failure, branch=renovate/yarn-1.x)
 INFO: Branch update was rejected because local copy is not up-to-date. (repository=renovate-testing/test-12124-pr-title-and-body-failure, branch=renovate/yarn-1.x)
DEBUG: Closing Dependency Dashboard (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: Retrieving issueList (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: Retrieved 0 issues (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: Removing any stale branches (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: config.repoIsOnboarded=true (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: Branch lists (repository=renovate-testing/test-12124-pr-title-and-body-failure)
       "branchList": ["renovate/yarn-1.x"],
       "renovateBranches": ["renovate/yarn-1.x"]
DEBUG: remainingBranches= (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: No branches to clean up (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: Repository timing splits (milliseconds) (repository=renovate-testing/test-12124-pr-title-and-body-failure)
       "splits": {"init": 2194, "extract": 1561, "lookup": 187, "update": 16636},
       "total": 20941
DEBUG: http statistics (repository=renovate-testing/test-12124-pr-title-and-body-failure)
       "urls": {
         "https://api.github.com/graphql (POST)": 4,
         "https://api.github.com/repos/renovate-testing/test-12124-pr-title-and-body-failure/contents/renovate.json (GET)": 1,
         "https://api.github.com/repos/renovate-testing/test-12124-pr-title-and-body-failure/pulls (GET)": 1
       },
       "hostStats": {"api.github.com": {"requestCount": 6, "requestAvgMs": 331, "queueAvgMs": 0}},
       "totalRequests": 6
 INFO: Repository finished (repository=renovate-testing/test-12124-pr-title-and-body-failure)
       "durationMs": 20941
DEBUG: Renovate exiting

rarkins · 2022-02-15T06:35:40Z

I was expecting to see an err logged somehow. Do we swallow it all now? It's ok if so

…orce-with-lease-error

zharinov · 2022-02-15T06:54:05Z

DEBUG: Pushing branch renovate/yarn-1.x (repository=renovate-testing/test-12124-pr-title-and-body-failure, branch=renovate/yarn-1.x)
DEBUG: Converting git error to ExternalHostError (repository=renovate-testing/test-12124-pr-title-and-body-failure, branch=renovate/yarn-1.x)
       "err": {
         "task": {
           "commands": [
             "push",
             "origin",
             "renovate/yarn-1.x:renovate/yarn-1.x",
             "--force-with-lease",
             "-u",
             "--no-verify",
             "--verbose",
             "--porcelain"
           ],
           "format": "utf-8",
           "parser": "[function]"
         },
         "message": "To https://github.com/renovate-testing/test-12124-pr-title-and-body-failure.git\n!\trefs/heads/renovate/yarn-1.x:refs/heads/renovate/yarn-1.x\t[rejected] (stale info)\nDone\nPushing to https://github.com/renovate-testing/test-12124-pr-title-and-body-failure.git\nerror: failed to push some refs to 'https://github.com/renovate-testing/test-12124-pr-title-and-body-failure.git'\n",
         "stack": "Error: To https://github.com/renovate-testing/test-12124-pr-title-and-body-failure.git\n!\trefs/heads/renovate/yarn-1.x:refs/heads/renovate/yarn-1.x\t[rejected] (stale info)\nDone\nPushing to https://github.com/renovate-testing/test-12124-pr-title-and-body-failure.git\nerror: failed to push some refs to 'https://github.com/renovate-testing/test-12124-pr-title-and-body-failure.git'\n\n    at Object.action (/Users/sergio/Work/renovate/node_modules/src/lib/plugins/error-detection.plugin.ts:38:28)\n    at PluginStore.exec (/Users/sergio/Work/renovate/node_modules/src/lib/plugins/plugin-store.ts:24:29)\n    at /Users/sergio/Work/renovate/node_modules/src/lib/runners/git-executor-chain.ts:114:40\n    at new Promise (<anonymous>)\n    at GitExecutorChain.handleTaskData (/Users/sergio/Work/renovate/node_modules/src/lib/runners/git-executor-chain.ts:111:14)\n    at GitExecutorChain.<anonymous> (/Users/sergio/Work/renovate/node_modules/src/lib/runners/git-executor-chain.ts:88:40)\n    at Generator.next (<anonymous>)\n    at fulfilled (/Users/sergio/Work/renovate/node_modules/simple-git/cjs/index.js:55:24)"
       }
DEBUG: Closing Dependency Dashboard (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: Retrieving issueList (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: Retrieved 0 issues (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: Removing any stale branches (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: config.repoIsOnboarded=true (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: Branch lists (repository=renovate-testing/test-12124-pr-title-and-body-failure)
       "branchList": ["renovate/yarn-1.x"],
       "renovateBranches": ["renovate/yarn-1.x"]
DEBUG: remainingBranches= (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: No branches to clean up (repository=renovate-testing/test-12124-pr-title-and-body-failure)
DEBUG: Repository timing splits (milliseconds) (repository=renovate-testing/test-12124-pr-title-and-body-failure)
       "splits": {"init": 2242, "extract": 1583, "lookup": 121, "update": 13675},
       "total": 17962
DEBUG: http statistics (repository=renovate-testing/test-12124-pr-title-and-body-failure)
       "urls": {
         "https://api.github.com/graphql (POST)": 4,
         "https://api.github.com/repos/renovate-testing/test-12124-pr-title-and-body-failure/contents/renovate.json (GET)": 1,
         "https://api.github.com/repos/renovate-testing/test-12124-pr-title-and-body-failure/pulls (GET)": 1
       },
       "hostStats": {"api.github.com": {"requestCount": 6, "requestAvgMs": 313, "queueAvgMs": 0}},
       "totalRequests": 6
 INFO: Repository finished (repository=renovate-testing/test-12124-pr-title-and-body-failure)
       "durationMs": 17962
DEBUG: Renovate exiting

zharinov · 2022-02-15T06:55:59Z

Ah, haven't noticed you're okay with swallowing. So yes, at first I decided we don't need to log error as we handle it now explicitly.
Which approach would you like to be released?

renovate-release · 2022-02-15T07:48:27Z

🎉 This PR is included in version 31.82.1 🎉

The release is available on:

GitHub release
31.82.1

Your semantic-release bot 📦🚀

zharinov added 2 commits February 15, 2022 08:18

fix(util/git): Skip PR update on --force-with-lease errors

2bddbad

Don't change error message for now

c98f5df

zharinov commented Feb 15, 2022

View reviewed changes

zharinov changed the title ~~fix(util/git): Skip PR update on --force-with-lease errors~~ fix(util/git): Skip PR update on "force-with-lease" errors Feb 15, 2022

zharinov requested a review from rarkins February 15, 2022 05:28

zharinov added 2 commits February 15, 2022 09:49

Merge branch 'main' of github.com:renovatebot/renovate into fix/git-f…

ee84718

…orce-with-lease-error

Log error

34252d5

viceice approved these changes Feb 15, 2022

View reviewed changes

viceice enabled auto-merge (squash) February 15, 2022 07:01

viceice disabled auto-merge February 15, 2022 07:02

Merge branch 'main' into fix/git-force-with-lease-error

b3fb288

rarkins enabled auto-merge (squash) February 15, 2022 07:16

rarkins merged commit 1f79f22 into renovatebot:main Feb 15, 2022

github-actions bot locked as resolved and limited conversation to collaborators Mar 18, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(util/git): Skip PR update on "force-with-lease" errors #14228

fix(util/git): Skip PR update on "force-with-lease" errors #14228

zharinov commented Feb 15, 2022

zharinov Feb 15, 2022

rarkins Feb 15, 2022

zharinov Feb 15, 2022

zharinov commented Feb 15, 2022 •

edited

rarkins commented Feb 15, 2022 •

edited

zharinov commented Feb 15, 2022

zharinov commented Feb 15, 2022 •

edited

renovate-release commented Feb 15, 2022

fix(util/git): Skip PR update on "force-with-lease" errors #14228

fix(util/git): Skip PR update on "force-with-lease" errors #14228

Conversation

zharinov commented Feb 15, 2022

Changes:

Context:

Documentation (please check one with an [x])

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

zharinov Feb 15, 2022

Choose a reason for hiding this comment

rarkins Feb 15, 2022

Choose a reason for hiding this comment

zharinov Feb 15, 2022

Choose a reason for hiding this comment

zharinov commented Feb 15, 2022 • edited

rarkins commented Feb 15, 2022 • edited

zharinov commented Feb 15, 2022

zharinov commented Feb 15, 2022 • edited

renovate-release commented Feb 15, 2022

zharinov commented Feb 15, 2022 •

edited

rarkins commented Feb 15, 2022 •

edited

zharinov commented Feb 15, 2022 •

edited