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

fix: partial response handling oauthv2 is enabled #4653

Closed
wants to merge 4 commits into from

Conversation

sanpj2292
Copy link
Contributor

@sanpj2292 sanpj2292 commented May 6, 2024

Description

When partial responses are to be handled for destinations that are on proxy v1, we are setting 200 status for all of them.
Through this PR, we are aiming to fix this.

Note: additionally info logging for checking oauthv2 flag has been moved to debug logging

Linear Ticket

Resolves INT-2100

Security

  • The code changed/added as part of this pull request won't create any security issues with how the software is being used.

- chore: propagate interceptor response to jobsdb
- chore: add documentation
- chore: add test-cases
@sanpj2292 sanpj2292 self-assigned this May 6, 2024
Copy link
Contributor

coderabbitai bot commented May 6, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented May 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.55%. Comparing base (c64dd3a) to head (1824428).
Report is 1 commits behind head on release/1.25.x.

❗ Current head 1824428 differs from pull request most recent head ff694f2. Consider uploading reports for the commit ff694f2 to get more accurate results

Additional details and impacted files
@@                Coverage Diff                 @@
##           release/1.25.x    #4653      +/-   ##
==================================================
- Coverage           74.61%   74.55%   -0.06%     
==================================================
  Files                 412      412              
  Lines               48699    48702       +3     
==================================================
- Hits                36335    36312      -23     
- Misses               9995    10011      +16     
- Partials             2369     2379      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@achettyiitr achettyiitr left a comment

Choose a reason for hiding this comment

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

Approved with minor changes.

router/transformer/transformer.go Outdated Show resolved Hide resolved
router/transformer/transformer_test.go Outdated Show resolved Hide resolved
router/transformer/transformer_test.go Outdated Show resolved Hide resolved
router/transformer/transformer_test.go Outdated Show resolved Hide resolved
Comment on lines -802 to -804
} else if oauthV2Enabled {
proxyRequestResponse.RespStatusCodes, proxyRequestResponse.RespBodys = w.prepareResponsesForJobs(&destinationJob, proxyRequestResponse.ProxyRequestStatusCode, proxyRequestResponse.ProxyRequestResponseBody)
proxyRequestResponse.RespContentType = http.DetectContentType([]byte(proxyRequestResponse.ProxyRequestResponseBody))
Copy link
Contributor

Choose a reason for hiding this comment

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

Didn't understood why we are removing this?

Copy link
Contributor

Choose a reason for hiding this comment

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

What if transportResponse.InterceptorResponse.StatusCode is 0 for a successful response here?

Copy link
Contributor Author

@sanpj2292 sanpj2292 May 21, 2024

Choose a reason for hiding this comment

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

Didn’t understood why we are removing this?

The response contract for /v1/<DEST_TYPE>/proxy endpoint in transformer is

200 OK
{
  “output”: {
    “message”: “”,
     “response”: [
           {“statusCode”: 400, “metadata”: {jobId: 1}},
           {“statusCode”: 502, “metadata”: {jobId: 2}},
      ],
     “authErrorCategory”: “”
  }
}

When there is no problem with LB, we would always get 200 from the endpoint. And based on the logic of prepareResponsesForJobs, we would set proxy response status-code(200) to all the jobs.
Before this change, jobId: 1 would be set with 200 instead of 400 & jobId: 2 would be set with 200 instead of 500

Such logic is unnecessary in this part. And we moved this logic into router/transformer.go when the interceptor receives erreneous status-code(due to OAuth / transformer)

This is the reason we are removing this part of source-code. Let me know if it makes sense

@achettyiitr achettyiitr deleted the branch release/1.25.x May 22, 2024 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants