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.

Sign up for GitHub

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

Jump to bottom

fix: allow timeouts in the client methods that make API call #3964

Merged
merged 1 commit into from
May 8, 2024
Merged

fix: allow timeouts in the client methods that make API call #3964

merged 1 commit into from
May 8, 2024

Conversation

frrist
Copy link
Member

@frrist frrist commented Apr 29, 2024

Allows bacalhau version to fail quickly if the server is offline.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 29, 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.

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.

frrist
frrist commented Apr 29, 2024
View reviewed changes
cmd/cli/version/version.go
Comment on lines +104 to +109
// NB(forrest): since `GetAllVersions` is an API call - in the event the server is un-reachable
// we timeout after 3 seconds to avoid waiting on an unavailable server to return its version information.
vctx, cancel := context.WithTimeout(ctx, time.Second*3)
defer cancel()
var err error
versions, err = util.GetAllVersions(ctx)
versions, err = util.GetAllVersions(vctx)
Copy link
Member Author

Choose a reason for hiding this comment

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

this change will cause the bacalhau version command to return quickly if the server (requester) is unreachable.

frrist
frrist commented Apr 29, 2024
View reviewed changes
cmd/util/api.go
Comment on lines +62 to +63
Authenticate: func(ctx context.Context, a *clientv2.Auth) (*apimodels.HTTPCredential, error) {
return auth.RunAuthenticationFlow(ctx, cmd, a)
Copy link
Member Author

Choose a reason for hiding this comment

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

This change allows calls to the authentication API to respect context cancellation in the event the server (requester) serving the /api/v1/auth endpoint is unreachable. Previously we used the less explicit command context for this method

@frrist frrist self-assigned this Apr 29, 2024
wdbaruni
wdbaruni reviewed Apr 30, 2024
View reviewed changes
cmd/cli/version/version.go
Comment on lines +104 to +106
// NB(forrest): since `GetAllVersions` is an API call - in the event the server is un-reachable
// we timeout after 3 seconds to avoid waiting on an unavailable server to return its version information.
vctx, cancel := context.WithTimeout(ctx, time.Second*3)
Copy link
Member

Choose a reason for hiding this comment

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

what do we log or return to the user after the 3 seconds timeout?

Copy link
Member Author

Choose a reason for hiding this comment

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

We only return the client version in that case:

> export BACALHAU_API_HOST=1.1.1.1
> bacalhau version
 CLIENT                UPDATE MESSAGE 
 v1.3.0-43-g9debb92e9                 

> export BACALHAU_API_HOST=bootstrap.production.bacalhau.org
> bacalhau version
 CLIENT                SERVER  LATEST  UPDATE MESSAGE 
 v1.3.0-43-g9debb92e9  v1.3.0  v1.3.0

The log message below this comment on line 112 isn't returned to the user on the CLI since we only log Fatal for CLI calls.

@frrist frrist requested a review from wdbaruni May 2, 2024 01:29
@wdbaruni wdbaruni mentioned this pull request May 2, 2024
Closed
@frrist frrist force-pushed the frrist/fix-api-request-timeouts branch from 9debb92 to 38b82d7 Compare May 2, 2024 17:14
@frrist frrist enabled auto-merge (rebase) May 2, 2024 17:14
@frrist frrist force-pushed the frrist/fix-api-request-timeouts branch from 38b82d7 to e2da450 Compare May 8, 2024 21:22
@frrist frrist merged commit 1c62d0f into main May 8, 2024
12 checks passed
@frrist frrist deleted the frrist/fix-api-request-timeouts branch May 8, 2024 21:37
This was referenced Jun 26, 2024
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wdbaruni wdbaruni wdbaruni approved these changes

@aronchick aronchick Awaiting requested review from aronchick

Assignees

@frrist frrist

Labels
None yet
Projects
Engineering Planning
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@frrist @wdbaruni