depNameSanitized contains spurious characters

[reitzig]

What would you like help with?

I think I found a bug

How are you running Renovate?

Self-hosted

If you're self-hosting Renovate, tell us which platform (GitHub, GitLab, etc) and which version of Renovate.

Bitbucket Data Center v8.19.6; Renovate 38.82.1

Reproduced on Github with Mend Renovate 39.107.0

Please tell us more about your question or problem

With the copier manager, depName is the full Git URL:

"depName": "https://bitbucket.some.org/scm/some-project/some-repo.git",

Without special handling (which seems finicky given different URL schemas for diferent platforms) and no further information (I'm not aware of a "template name" in copier template metadata, unfortunately), Renovate can not do a whole lot better; it create:

DEBUG: branches info extended (repository=some-project/some-test-repo)
       "branchesInformation": [
         {
           "branchName": "renovate/doc/bounded-contexts-https-bitbucket.some.org-scm-scm-some-project-some-repo.git-2.x",
           "prNo": 5,
           "prTitle": "chore(deps): update dependency https://some.org/scm/some-project/some-repo.git to v2.2.0 (doc/bounded-contexts)",

Needless to say, those are not very nice and hard to read, let alone parse at a glance. So I tried to improve them, expecting the following package rule to produce nicer output:

{
    matchManagers: [
        "copier",
    ],
    branchTopic: "copier-template-{{{replace 'https-.*?-scm-([^.]+)\\.git' '$1' depNameSanitized}}}-{{{newVersion}}}",
    commitMessageTopic: "copier template {{{replace 'https:.*?/scm/([^.]+)\\.git' '$1' depName}}}",
},

In particular, the pattern for branchTopic was informed by observing that {{{depNameSanitized}}} (as seen in the default of branchTopic seems to expand to

https-bitbucket.some.org-scm-some-project-some-repo.git

✅ The pattern for commitMessageTopic works as expected
❌ The one for branchTopic does not

DEBUG: branches info extended (repository=some-project/some-test-repo)
       "branchesInformation": [
         {
           "branchName": "renovate/copier-template-https-bitbucket.some.org-scm-some-project-some-repo.git-v2.2.0",
           "prNo": null,
           "prTitle": "chore(deps): update copier template some-project/some-repo to v2.2.0",

➡️ Reproducing MWE at reitzig/reproduction-renovate-31555

Extensive trial and error led to us inspecting {{{depNameSanitized}}} (the value of which doesn't seem to be included in the log by itself) through commitMessageTopic, which results in:

"prTitle": "chore(deps): update copier template https:-bitbucket.some.org-scm-some-project-some-repo.git to v2.2.0",

🚨 Note https:- -- that's not good, the colon has no business appearing in depNameSanitized¹! Apparently, it's stripped away before final assembly of branchName.

Workaround:

branchTopic: "copier-template-{{{replace 'https:?-.*?-scm-([^.]+)\\.git' '$1' depNameSanitized}}}-{{{newVersion}}}"

To me, this seems like a "just needs a unit test"-kind-of-issue. Please let me know if you require a full-blown reproduction repo. :)

---

1. The docs say:

   The depName field sanitized for use in branches after removing spaces and special characters

   I assume the intent is to limit the content to what Git allows, which does not include colons (docs, rule 4)

Logs (if relevant)

Logs

Replace this text with your logs, between the starting and ending triple backticks

[github-actions[bot]]

Hi there,

Get your discussion fixed faster by creating a minimal reproduction. This means a repository dedicated to reproducing this issue with the minimal dependencies and config possible.

Before we start working on your issue we need to know exactly what's causing the current behavior. A minimal reproduction helps us with this. Discussions without reproductions are less likely to be converted to Issues.

Please follow these steps:

1. Read our guide on creating a minimal reproduction.
2. Go to our minimal reproduction template repository.
3. Select the Use this template button to create a new repository based on the template.
4. Work on the minimal reproduction in your own repository.
5. Fill out the information in your repository's README.md.
6. Add the link to your reproduction to the first post of your Discussion. If you are not the original author, you can post a new comment with the link.

If you need help with running renovate on your minimal reproduction repository, please refer to our Running Renovate guide.
Good luck,

The Renovate team

[reitzig]

At long last, I got around to creating an MWE: reitzig/reproduction-renovate-31555

[rarkins]

The purpose of sanitization is to remove special characters, not pretty up or shorten a depName. I think we could/should strip out the : bit from depNameSanitized, and you're welcome to submit a PR for that, but that doesn't seem like enough to satisfy your desire to have it shorter too.

https://docs.renovatebot.com/configuration-options/#overridedepname allows you to override depName, including a moderate level of template replacing (see the example). I don't think this is something which copier could reliably know to do on its own, unless we think that "using the last two segments before any .git will produce a reliable depName every time" can be relied on.

[reitzig]

I think we could/should strip out the : bit from depNameSanitized

That's indeed my only concern here.

The problem is, "the regex doesn't match when it should", not "I want the manager to behave like my replacement". Sorry if that wasn't clear.

I'm fine with custom config for, well, customization. The problem here was that the content of depNameSanitized was surprising and debugging that was hard.

[rarkins]

#33672