Skip to content

refactor: Use time.Duration for timeout instead of int.#57

Merged
iFurySt merged 1 commit into
mainfrom
refactor/use-time-duration-for-timeout
May 12, 2025
Merged

refactor: Use time.Duration for timeout instead of int.#57
iFurySt merged 1 commit into
mainfrom
refactor/use-time-duration-for-timeout

Conversation

@iFurySt
Copy link
Copy Markdown
Member

@iFurySt iFurySt commented May 12, 2025

Summary by Sourcery

Refactor HTTP request timeout handling to use time.Duration instead of raw integer seconds.

Enhancements:

  • Refactor APIStorageConfig and NewAPIStore to use time.Duration for timeout fields, updating imports and function signatures accordingly
  • Use the duration value directly for the HTTP client Timeout instead of multiplying seconds
  • Update mcp-gateway YAML configuration to accept duration strings and set a default of "30s" for the API timeout

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 12, 2025

Reviewer's Guide

This PR refactors HTTP timeout parameters to use Go’s time.Duration instead of int across configuration, store implementation, and default YAML settings.

File-Level Changes

Change Details Files
APIStorageConfig.Timeout now uses time.Duration
  • Imported the time package
  • Replaced int Timeout field with time.Duration
internal/common/config/storage.go
APIStore timeout handling converted to time.Duration
  • Changed timeout field type to time.Duration
  • Updated NewAPIStore signature to accept time.Duration
  • Assigned HTTP client Timeout directly using s.timeout
internal/mcp/storage/api.go
Default timeout specified as duration string in YAML config
  • Updated default timeout value to “30s”
configs/mcp-gateway.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@iFurySt iFurySt marked this pull request as ready for review May 12, 2025 11:30
@iFurySt iFurySt merged commit e8312c5 into main May 12, 2025
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @iFurySt - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Timeout int `yaml:"timeout"` // timeout(seconds) for http request
Url string `yaml:"url"` // http url for api
ConfigJSONPath string `yaml:"configJSONPath"` // configJSONPath for config in http response
Timeout time.Duration `yaml:"timeout"` // timeout for http request
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

suggestion: Clarify Timeout field comment to specify expected duration format

Specify that timeout expects a YAML duration string (e.g., "30s") to avoid unit confusion.

Suggested change
Timeout time.Duration `yaml:"timeout"` // timeout for http request
Timeout time.Duration `yaml:"timeout"` // timeout for HTTP request (YAML duration string, e.g., "30s")

@iFurySt iFurySt deleted the refactor/use-time-duration-for-timeout branch May 13, 2025 06:44
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.

1 participant