Pull Request generator not working for Bitbucket Cloud

[mpitt]

Checklist:

• I've searched in the docs and FAQ for my answer: https://bit.ly/argocd-faq.
• I've included steps to reproduce the bug.
• I've pasted the output of argocd version.

Describe the bug

Using the Pull Request generator with Bitbucket Cloud results in the error

error listing repos: error unmarshalling json to type '[]BitbucketCloudPullRequest': json: cannot unmarshal object into Go struct field BitbucketCloudPullRequest.author of type string

It looks like the error can be traced to adding the author field with the wrong type in [1]: it was added as a string but in the Bitbucket Cloud API it's an object [2]

To Reproduce

Create an ApplicationSet with the Pull Request generator:

spec:
  generators:
    - pullRequest:
        bitbucket:
          basicAuth:
            passwordRef:
              key: password
              secretName: argocd-controller-secret
            username: Srv-CICD-Robot
          owner: REDACTED
          repo: REDACTED
        filters:
          - branchMatch: .*/.*REDACTED.*/.*
        requeueAfterSeconds: 60

Expected behavior

The PR generator can parse the Bitbucket API response, where the author field is an object and not a string.

Screenshots

N/A

Version

argocd: v2.13.0+347f221
  BuildDate: 2024-11-04T12:09:06Z
  GitCommit: 347f221adba5599ef4d5f12ee572b2c17d01db4d
  GitTreeState: clean
  GoVersion: go1.23.1
  Compiler: gc
  Platform: linux/amd64
argocd-server: v2.13.0+347f221

Logs

error listing repos: error unmarshalling json to type '[]BitbucketCloudPullRequest': json: cannot unmarshal object into Go struct field BitbucketCloudPullRequest.author of type string

[andrii-korotkov-verkada]

I see the object is

      "author": {
        "type": "<string>"
      },

[andrii-korotkov-verkada]

Do you know what the type means here? In ArgoCD the data is passed to the Author field of the PullRequest, which expects an author of the PR. Should I just pass the type value?

[andrii-korotkov-verkada]

Also, did Bitbucket Cloud always have author as an object?

[mpitt]

Do you know what the type means here? In ArgoCD the data is passed to the Author field of the PullRequest, which expects an author of the PR. Should I just pass the type value?

The API documentation is indeed a bit confusing. You have to click "Show child properties" multiple times to see all the fields but in the end you get this:

The type field seems to be supporting some form of "typed JSON" convention, it's always "user".

There are 3 possible fields I see in the API:

• author.display_name (can contain spaces etc., seems to be the "Full name" of the Atlassian profile)
• author.uuid (meaningless, but unique and has a well defined format)
• author.nickname (undocumented, seems to correspond to the "Public name" of the Atlassian profile)

Weirdly, there is no field for the Bitbucket username.

[andrii-korotkov-verkada]

Which field should we use in your opinion? display_name, nickname, or some combination of all 3 fields?

[mpitt]

Without knowing a lot on how the Author field of PullRequest is intended to be used (is it documented? I can't find it here), and guessing at what other SCMs might return:

I would go with a lightly sanitised version of nickname (spaces and some special characters replaced with -), with a fallback on display_name, sanitised the same way, if nickname is not present (being an undocumented field). Or if the fallback logic is too much of a hassle, just the sanitised display_name would be fine too, I suppose.

That's on the assumption that the Author field might be used to template some values, that e.g. might expose an app under a certain subdomain, so the sanitisation should produce a suitable value. But that might not be a strict requirement, and maybe something to implement at a higher level for all the SCMs?

[andrii-korotkov-verkada]

I've taken a look. Seems like it's used for revision metadata, e.g. for displaying in the UI. Various other places seem to use username for this field.

[andrii-korotkov-verkada]

Is nickname the closest to username? Why does it need to be sanitized?

[mpitt]

Yes, I think nickname is the closest. If it's only used in the UI and as a bit of metadata, no need to sanitise it.