Getting RecursionError when Jira servers return 401 #681

pkkid · 2018-08-31T13:01:37Z

Getting RecursionError: maximum recursion depth exceeded in comparison when getting 401 error codes from Jira using JiraCookieAuth. This looks due to the handle_401 register_hook being passed to the request module in client.py:221. The handle looks like it simply retries the request, but has no mechanism in place to prevent it from retying indefinitely, thus the recursion error.

Commenting out the line request.register_hook('response', self.handle_401) in the JiraAuthCookie class still shows 3 retires to occuring with a pause between each retry. It also stops the RecursionError error from happening, and I assume thrashes the Jira servers much less.

Python 3.5.3
Jira Client: jira-2.0.1.dev17
Communicating with Jira Cloud

Stack Trace

... (many many iterations of the following) ...
  File "/usr/local/lib/python3.5/dist-packages/requests/sessions.py", line 559, in post
    return self.request('POST', url, data=data, json=json, **kwargs)
  File "/usr/local/lib/python3.5/dist-packages/requests/sessions.py", line 512, in request
    resp = self.send(prep, **send_kwargs)
  File "/usr/local/lib/python3.5/dist-packages/requests/sessions.py", line 629, in send
    r = dispatch_hook('response', hooks, r, **kwargs)
  File "/usr/local/lib/python3.5/dist-packages/requests/hooks.py", line 31, in dispatch_hook
    _hook_data = hook(hook_data, **kwargs)
  File "/usr/local/lib/python3.5/dist-packages/jira/client.py", line 202, in handle_401
    self.init_session()
  File "/usr/local/lib/python3.5/dist-packages/jira/client.py", line 218, in init_session
    self.start_session()
  File "/usr/local/lib/python3.5/dist-packages/jira/client.py", line 232, in start_session
    self._get_session(self.__auth)
  File "/usr/local/lib/python3.5/dist-packages/jira/client.py", line 2459, in session
    r = self._session.post(url, data=json.dumps(authentication_data))
  File "/usr/local/lib/python3.5/dist-packages/jira/resilientsession.py", line 154, in post
    return self.__verb('POST', url, **kwargs)
  File "/usr/local/lib/python3.5/dist-packages/jira/resilientsession.py", line 125, in __verb
    response = method(url, timeout=self.timeout, **kwargs)
  File "/usr/local/lib/python3.5/dist-packages/requests/sessions.py", line 559, in post
    return self.request('POST', url, data=data, json=json, **kwargs)
  File "/usr/local/lib/python3.5/dist-packages/requests/sessions.py", line 512, in request
    resp = self.send(prep, **send_kwargs)
  File "/usr/local/lib/python3.5/dist-packages/requests/sessions.py", line 629, in send
    r = dispatch_hook('response', hooks, r, **kwargs)
  File "/usr/local/lib/python3.5/dist-packages/requests/hooks.py", line 31, in dispatch_hook
    _hook_data = hook(hook_data, **kwargs)
  File "/usr/local/lib/python3.5/dist-packages/jira/client.py", line 202, in handle_401
    self.init_session()
  File "/usr/local/lib/python3.5/dist-packages/jira/client.py", line 218, in init_session
    self.start_session()
  File "/usr/local/lib/python3.5/dist-packages/jira/client.py", line 232, in start_session
    self._get_session(self.__auth)
  File "/usr/local/lib/python3.5/dist-packages/jira/client.py", line 2459, in session
    r = self._session.post(url, data=json.dumps(authentication_data))
  File "/usr/local/lib/python3.5/dist-packages/jira/resilientsession.py", line 154, in post
    return self.__verb('POST', url, **kwargs)
  File "/usr/local/lib/python3.5/dist-packages/jira/resilientsession.py", line 125, in __verb
...SNIP...

The text was updated successfully, but these errors were encountered:

ssorgl · 2018-09-26T18:55:14Z

I am seeing the same issue communicating with a JIRA Server instance (instead of Jira Cloud).

But it only goes into this for me when I call

jira = JIRA(server=server, auth=(user, pw))

if instead I call

jira = JIRA(server=server)
issue = jira.issue('VALID-1')

The 401 is flagged as Got recoverable error and it tries again (which fails as it is not logged in)

pkkid · 2018-09-26T20:22:13Z

When I stopped using basic auth and switched to using oAuth, all these issues went away. It was a pain to setup authentication the first time, but it helped 100%.

ssorgl · 2018-09-26T22:21:56Z

I figured out my 401 error - so no longer imacted by this. But it is still a bug ;)

rsvancara · 2018-09-28T18:41:55Z

I figured out my 401 error - so no longer imacted by this. But it is still a bug ;)

Can you elaborate on your solution to the 401 issue more @ssorgl

ssorgl · 2018-09-28T22:47:27Z

@rsvancara - that was easy: provide the correct credentials! :) Once I realized that it was getting a valid 401, I re-examined my credentials and realized I had not provided the correct string for the user!

LatvianPython · 2019-01-04T13:22:52Z

Getting the same error when providing incorrect credentials in a similar way as ssorgl did.
jira = JIRA(server=server, auth=(user, pw))

Right now one has to handle a RecursionError when providing incorrect credentials.

Could this be changed to return a JIRAError with the appropriate 401 status code?

ZbigniewRA · 2019-08-30T10:02:28Z

Please note that cookie-based authentication is now being removed from Jira API.
See here: https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-basic-auth-and-cookie-based-auth/

So instead of fixing this bug this feature could be removed altogether (if backwards compatibility is not a concern).

ssorgl · 2019-09-02T14:18:35Z

I will have to try it out to verify that this is not going to be an issue using and API Token (one of the recommended replacement methods). If I read correctly, the client call will go from:
jira = JIRA(server=server, auth=(user, pw))
to
jira = JIRA(server=server, auth=(user, token))

Has someone tested that not providing the correct credentials (which would still result in the same 401 error from the server I believe) does not just end up in the same recursion error? I suspect it would (same method call, and I believe the same error response from server), but have not had time to test yet.

ZbigniewRA · 2019-09-02T14:35:49Z

Actually I think that basic auth should be used instead.
I have verified that changing:

jira = JIRA(server=server, auth=(user, pw))

to:

jira = JIRA(server=server, basic_auth=(user, token))

works fine.
(I use that only through HTTPS.)

stale · 2019-12-01T15:26:58Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. You way want to consider using the Sponsor button in order to persuade someone to address it.

Markimedes · 2019-12-04T01:09:54Z

I've noted this issue in the latest version. It is causing an issue because the plugin attempts to login hundreds of times until the account is locked.

rsvancara · 2020-01-26T14:11:30Z

Thanks!

suederat · 2020-05-12T21:40:26Z

recursion restriction needs to be added to handle_401, because simply resending w/o reservation is bad. I would suggest we get a sha of the request and cache it with a count, clear the retry_cache before sending new requests and all should be good

init

`
def __init__():
    self.retry_cache = collections.Counter()
`

verification/usage:

`
def handle_401(self, request):
    retry_key = id(request)
    if retry_key in self.retry_cache and self.retry_cache[retry_key] > defaults.max_retries:
        raise NotAuthorized('please check credentials')
    self.retry_cache[retry_key] += 1
    ...
`

smathema · 2020-11-14T00:03:36Z

The fix could be to passing 'self._session.max_retries' to JIRA._create_cookie_auth() function that could be used by JiraCookieAuth(), so JiraCookieAuth.handle_401() doesn't happen forever like it does now until we see 'RecursionError: maximum recursion depth exceeded in comparison', which is same concept as @suederat is suggesting

ssbarnea added bug help wanted labels Sep 27, 2018

stale bot added the stale Ticket that is likely to go nowhere and that will be closed soon label Dec 1, 2019

stale bot removed the stale Ticket that is likely to go nowhere and that will be closed soon label Dec 4, 2019

adehad mentioned this issue Nov 1, 2021

Bugfix/restore cookie auth #1201

Merged

adehad linked a pull request Nov 4, 2021 that will close this issue

Bugfix/restore cookie auth #1201

Merged

adehad closed this as completed in #1201 Nov 6, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Getting RecursionError when Jira servers return 401 #681

Getting RecursionError when Jira servers return 401 #681

pkkid commented Aug 31, 2018

ssorgl commented Sep 26, 2018 •

edited

Loading

pkkid commented Sep 26, 2018

ssorgl commented Sep 26, 2018

rsvancara commented Sep 28, 2018

ssorgl commented Sep 28, 2018

LatvianPython commented Jan 4, 2019

ZbigniewRA commented Aug 30, 2019

ssorgl commented Sep 2, 2019

ZbigniewRA commented Sep 2, 2019

stale bot commented Dec 1, 2019

Markimedes commented Dec 4, 2019

rsvancara commented Jan 26, 2020

suederat commented May 12, 2020 •

edited

Loading

smathema commented Nov 14, 2020 •

edited

Loading

Getting RecursionError when Jira servers return 401 #681

Getting RecursionError when Jira servers return 401 #681

Comments

pkkid commented Aug 31, 2018

ssorgl commented Sep 26, 2018 • edited Loading

pkkid commented Sep 26, 2018

ssorgl commented Sep 26, 2018

rsvancara commented Sep 28, 2018

ssorgl commented Sep 28, 2018

LatvianPython commented Jan 4, 2019

ZbigniewRA commented Aug 30, 2019

ssorgl commented Sep 2, 2019

ZbigniewRA commented Sep 2, 2019

stale bot commented Dec 1, 2019

Markimedes commented Dec 4, 2019

rsvancara commented Jan 26, 2020

suederat commented May 12, 2020 • edited Loading

smathema commented Nov 14, 2020 • edited Loading

ssorgl commented Sep 26, 2018 •

edited

Loading

suederat commented May 12, 2020 •

edited

Loading

smathema commented Nov 14, 2020 •

edited

Loading