usebruno/bruno

[Feature] More configurable request timeouts

Open

#1249 opened on Dec 19, 2023

View on GitHub
 (11 comments) (2 reactions) (0 assignees)JavaScript (43,787 stars) (2,403 forks)batch import
P2enhancementgood first issuehelp wanted

Description

Previously there was some work done in #557 to add configuration for request timeouts, however, the code addressed only some of what was discussed in that issue. I think it would be nice to:

  1. Add support to the .bru / collection.bru files to specify a timeout
  2. Handle the timeout settings in the bruno CLI
  3. Allow a --timeout override option on the CLI (useful for CI environments where you might have different timing parameters than in local dev, for instance)
  4. Add UI support for setting these timeout values

I have code done for 1-3, wondering about the UI though. Maybe "timeout" could go under the Presets tab in collection settings? I'm not sure where a good place would be for this config in the request settings though. Vars might be the closest tab for something like this but even then it's not great, and adding another tab just for the timeout seems a little much. Any thoughts on what would make sense here? Is this feature useful? I could also punt on making the UI changes but I assume it's best to ship support for stuff like this with UI at the same time as it's enabled by the underlying system / config files.

#557 also mentioned being able to configure this on the environment level, but I'm not sure how that would work because the environment configuration is all substitution variables, there's not something like a direct config override. Maybe that could work if the timeout settings in collection + request accepted variable substitution? Wondering if that's worth pursuing or not as well.

Contributor guide

Tech stack
javascripttypescriptreactelectronnodejs
Domain
apidesktopdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Knowledge of Bruno config structureFamiliarity with .bru formatUnderstanding of Electron UIBasic React/JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Review the existing PR #557 and the current timeout implementation. Examine the .bru file parser and CLI source to integrate timeout settings. For the UI, explore the 'Presets' tab in collection settings or the 'Vars' tab as discussed in comments. Consider whether environment level timeout configuration is feasible via variable substitution.