add context with timeout timeout to github api call issue#38

[frankie-mur]

Add a 5-second context with a timeout to GitHub Pull Request API call. #38

cool project btw, would love to contribute :)

Summary by CodeRabbit

• Refactor
  • Improved the GetPullRequest function with a timeout for better performance and reliability when fetching pull request data.
• New Features
  • Added a search functionality to the app.

[coderabbitai[bot]]

Walkthrough

The codebase update focuses on improving the GetPullRequest function's time management. By importing the "time" package and using context.WithTimeout, the function now incorporates a five-second timeout for operations, ensuring avoidance of indefinite hangs. This proactive step enhances the function's robustness and reliability.

Changes

File Path	Change Summary
internal/github.go internal/config.go internal/config_test.go	Imported "time" package; added timeout to GetPullRequest function; Added ContextTimeout field to Config struct; Modified test suite to handle CONTEXT_TIMEOUT_ENV_NAME

🐇✨ To code that once would wait and sit, A timer's set to avoid a pit. Five seconds count, then take a bow, GetPullRequest, efficient now. 🎉 ✨🐇

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 X ?

---

Tips

### Chat with CodeRabbit Bot (`@coderabbitai`) - You can reply to a review comment made by CodeRabbit. - You can tag CodeRabbit on specific lines of code or files in the PR by tagging `@coderabbitai` in a comment. - You can tag `@coderabbitai` in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions. ### 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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json`

[frankie-mur]

Hi there,

First off, I really appreciate your contribution to our project and thanks for submitting this PR!

I've taken a look and everything seems excellent. I do have a small suggestion for improvement. It might be beneficial to make the timeout configurable, possibly through an environment variable, with a fallback to 5 seconds. This could add flexibility to the functionality.

Additionally, if you decide to implement this change, it would be great to define the default value as a constant. This can help in maintaining clarity and consistency in our codebase.

I'd love to hear your thoughts on these suggestions. Thanks again for your valuable input!

Best regards, Kevin

Hey @kmesiab this is a great suggestion! I will look into implementing this, what do you think is a good default value? I have put 5 seconds at the moment but am open to suggestions, thanks again.

[kmesiab]

I have put 5 seconds at the moment

I think that's fine.

[frankie-mur]

squashed 👍