List merge requests using specific approver_ids regression #1698

Activity

1. JohnVillalovos commented on Nov 18, 2021

   

   JohnVillalovos

   on Nov 18, 2021

   Member

   More actions

   Related issue: #1419

   My guess is because there is only one item in the list it doesn't like it.

   Likely we need to add support for doing approver_ids[]=423 (which is adding []).
2. skycaptain commented on Nov 18, 2021

   

   skycaptain

   on Nov 18, 2021

   Author

   More actions

   Likely we need to add support for doing approver_ids[]=423 (which is adding []).

   Unfortunatly, I havn't found an example on in the Gitlab docs on how to encode the array, but guessing from this post, the URL argument may be approver_ids[]=423 just like you wrote.

   My guess is because there is only one item in the list it doesn't like it.

   Hmm, having the same issue with two user ids:

   group_mrs = group.mergerequests.list(
       all=True,
       state="opened",
       author_id=423,
       approver_ids=[11, 423],
   )

   [22:37:00] DEBUG    Starting new HTTPS connection (1): *redacted*:443                                connectionpool.py:971
              DEBUG    https://*redacted*:443 "GET /api/v4/user HTTP/1.1" 200 None                      connectionpool.py:452
   [22:37:01] DEBUG    https://*redacted*:443 "GET /api/v4/groups/475 HTTP/1.1" 200 None                connectionpool.py:452
              DEBUG    https://*redacted*:443 "GET                                                      connectionpool.py:452
                       /api/v4/groups/475/merge_requests?state=opened&author_id=423&approver_ids=11%2C423                      
                       HTTP/1.1" 400 60  
   Traceback (most recent call last):
     File "/usr/local/lib/python3.9/site-packages/gitlab/exceptions.py", line 304, in wrapped_f
       return f(*args, **kwargs)
     File "/usr/local/lib/python3.9/site-packages/gitlab/mixins.py", line 242, in list
       obj = self.gitlab.http_list(path, **data)
     File "/usr/local/lib/python3.9/site-packages/gitlab/client.py", line 718, in http_list
       return list(GitlabList(self, url, query_data, **kwargs))
     File "/usr/local/lib/python3.9/site-packages/gitlab/client.py", line 881, in __init__
       self._query(url, query_data, **self._kwargs)
     File "/usr/local/lib/python3.9/site-packages/gitlab/client.py", line 891, in _query
       result = self._gl.http_request("get", url, query_data=query_data, **kwargs)
     File "/usr/local/lib/python3.9/site-packages/gitlab/client.py", line 628, in http_request
       raise gitlab.exceptions.GitlabHttpError(
   gitlab.exceptions.GitlabHttpError: 400: approver_ids should be an array, 'None' or 'Any'
   
   The above exception was the direct cause of the following exception:
   
   Traceback (most recent call last):
     File "*redacted*.py", line 30, in <module>
       group_mrs = group.mergerequests.list(
     File "/usr/local/lib/python3.9/site-packages/gitlab/exceptions.py", line 306, in wrapped_f
       raise error(e.error_message, e.response_code, e.response_body) from e
   gitlab.exceptions.GitlabListError: 400: approver_ids should be an array, 'None' or 'Any'
   
3. JohnVillalovos commented on Nov 18, 2021

   

   JohnVillalovos

   on Nov 18, 2021

   Member

   More actions

   Unfortunatly, I havn't found an example on in the Gitlab docs on how to encode the array, but guessing from this post, the URL argument may be approver_ids[]=423 just like you wrote.

   https://docs.gitlab.com/ee/api/#array

   So if approver_ids=[11, 423]

   It is supposed to be something like: approver_ids[]=11&approver_ids[]=423 in the actual HTTP request. Though currently it will also work as approver_ids=11,423 as it understands a comma separated string is a list.
4. JohnVillalovos commented on Nov 18, 2021

   

   JohnVillalovos

   on Nov 18, 2021

   Last edited by JohnVillalovos

   Member

   More actions

   I dug into this a bit more:

   • merge_requests for approver_ids and approved_by_ids is the only one to use the validator: https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/api/validations/validators/array_none_any.rb which is what generates that error message.
   • Pretty much everything else uses the the array type CommaSeparatedToArray which accepts the comma-separated values.

   So to fix this we need to send the arrays in the proper way.

   ❤️React with ❤️1Reacted by Nejc Habjan
5. JohnVillalovos commented on Nov 18, 2021

   

   JohnVillalovos

   on Nov 18, 2021

   Member

   More actions

   Ah, looks like the comma gets URL-encoded there so that might be related to #1356 and similar. Or, maybe it's meant to be encoded I should probably check first :D

   I believe the URL encoding there is correct. I dug into it a bit and it is done by requests.
6. JohnVillalovos commented on Nov 19, 2021

   

   JohnVillalovos

   on Nov 19, 2021

   Member

   More actions

   I have a draft PR that might fix this: #1699

   I think it should work for 1 ID in the list but unsure if 2 or more IDs were in the approver_ids list. Not sure how the GitLab server will react to that...
7. JohnVillalovos

   added 2 commits that reference this issue on Nov 20, 2021

   fix: use the [] after key names for array variables

   ...

   This issue will close once commit e3c2e95 is merged into the 'main' branch.

   e3c2e95

   fix: use the [] after key names for array variables

   ...

   This issue will close once commit fdc854a is merged into the 'main' branch.

   fdc854a
8. JohnVillalovos commented on Nov 20, 2021

   

   JohnVillalovos

   on Nov 20, 2021

   Member

   More actions

   @skycaptain #1699 is available which should resolve the issue. In my testing it is working to fix this issue.

   🎉React with 🎉1Reacted by Manuel Leonhardt
9. skycaptain commented on Nov 21, 2021

   

   skycaptain

   on Nov 21, 2021

   Author

   More actions

   @JohnVillalovos works!

   👍React with 👍1Reacted by John Villalovos
10. JohnVillalovos commented on Nov 21, 2021

    

    JohnVillalovos

    on Nov 21, 2021

    Last edited by JohnVillalovos

    Member

    More actions

    @JohnVillalovos works!

    Awesome. Thank you for testing it @skycaptain !
11. JohnVillalovos

    added 4 commits that reference this issue on Nov 27, 2021

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit 7b2ade3 is merged into the 'main' branch.

    7b2ade3

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit b44cef7 is merged into the 'main' branch.

    b44cef7

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit 902d9f6 is merged into the 'main' branch.

    902d9f6

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit ec91760 is merged into the 'main' branch.

    ec91760
12. 26 remaining items

    Load more
13. JohnVillalovos

    added 2 commits that reference this issue on Feb 14, 2022

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit 215e0c6 is merged into the 'main' branch.

    215e0c6

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit 3244596 is merged into the 'main' branch.

    3244596
14. JohnVillalovos

    added a commit that references this issue on Mar 10, 2022

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit 2bc7fad is merged into the 'main' branch.

    2bc7fad
15. JohnVillalovos

    added 2 commits that reference this issue on Mar 26, 2022

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit 81d8c46 is merged into the 'main' branch.

    81d8c46

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit f7e0842 is merged into the 'main' branch.

    f7e0842
16. JohnVillalovos

    added 7 commits that reference this issue on Jul 24, 2022

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit a939db1 is merged into the 'main' branch.

    a939db1

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit 7f6a8c2 is merged into the 'main' branch.

    7f6a8c2

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit 50b1f12 is merged into the 'main' branch.

    50b1f12

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit 2ca7ddb is merged into the 'main' branch.

    2ca7ddb

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit ba084c6 is merged into the 'main' branch.

    ba084c6

    fix: use the [] after key names for array variables

    ...

    This issue will close once commit bc6ddf2 is merged into the 'main' branch.

    bc6ddf2

    fix: use the [] after key names for array variables in `params`

    ...

    This issue will close once commit 1af44ce is merged into the 'main' branch.

    1af44ce
17. nejch

    closed this as completedin #1699on Jul 27, 2022
18. JohnVillalovos

    added a commit that references this issue on Jul 28, 2022

    test: add test to show issue fixed

    ...

    75bec7d
19. github-actions

    locked as resolved and limited conversation to collaborators on Jul 31, 2023