Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG]Java] Fix a race condition in RetryingOAuth.mustache #10087

Conversation

Dretch
Copy link
Contributor

@Dretch Dretch commented Aug 3, 2021

If there were multiple concurrent requests at a time at which the OAuth token had expired, only a single request would be retried. The other requests would fail because of the expired token, but not be retried and so the failures would be propagated to the caller.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.3.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request. CC @Zomzog @lwlee2608 @nmuesch

}
} catch (OAuthSystemException | OAuthProblemException e) {
throw new IOException(e);
}
}

return false;
return getAccessToken() == null || !getAccessToken().equals(requestAccessToken);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previously: only ever returned true if this thread got a new token.

Now: returns true if any thread got a new token.

}

@Test
public void testTwoConcurrentRequestsUnauthorized() throws Exception {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test fails with the previous version of RetryingOAuth.mustache

@wing328
Copy link
Member

wing328 commented Aug 3, 2021

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

If there were multiple concurrent requests at a time at which the OAuth token had expired, only a single request would be retried. The other requests would fail because of the expired token, but not be retried and so the failures would be propagated to the caller.
@Dretch Dretch force-pushed the fix-issue-9513-retrying-oauth-race-condition branch from 52c52ad to 44b414b Compare August 3, 2021 16:36
@Dretch
Copy link
Contributor Author

Dretch commented Aug 3, 2021

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

Thanks for pointing that out @wing328 -- I have now (I think) corrected the author on the commit so it matches my Github account.

@wing328
Copy link
Member

wing328 commented Aug 4, 2021

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @nmuesch (2021/01)

@wing328 wing328 added this to the 5.2.1 milestone Aug 4, 2021
@wing328
Copy link
Member

wing328 commented Aug 4, 2021

@Dretch thanks for the fix, which looks good to me.

@wing328 wing328 merged commit 98e4eb7 into OpenAPITools:master Aug 4, 2021
@Dretch Dretch deleted the fix-issue-9513-retrying-oauth-race-condition branch August 4, 2021 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants