Skip to content

fix: Fix aborting a form returning a timeout error - #287

Merged
maaslalani merged 3 commits into
charmbracelet:mainfrom
Sculas:fix/timeout
Jul 2, 2024
Merged

maaslalani merged 3 commits into
charmbracelet:mainfrom
Sculas:fix/timeout

Conversation

@Sculas

@Sculas Sculas commented Jun 19, 2024 •

Copy link
Copy Markdown
Contributor

This PR fixes an issue caused by #276 where aborting a form would return ErrTimeout instead, because when f.timeout == 0, time.Since(startTime) >= f.timeout is always true. This was discussed here: #276 (comment)

This is fixed by simply checking if the error returned by bubbletea is ErrProgramKilled, which is already handled by tea.WithContext(ctx), making the (erroneous) check unnecessary anyway.

I've also added tests for handling timeouts, user aborts, and making sure ErrUserAborted is returned instead of ErrTimeout when a timeout error occurs (the issue mentioned above). This required an extra field program for testing to hold the tea.Program to send messages to the Form (batchUpdate cannot be used here because it's managed by tea.Program). RunWithContext(context.Context) has been added to support this.

Also added some tests for timeout, aborts and this issue.
@Sculas
Sculas requested a review from maaslalani as a code owner June 19, 2024 17:45
@Sculas

Sculas commented Jun 19, 2024 •

Copy link
Copy Markdown
Contributor Author

@maaslalani Are you sure you don't have a timeout set? As the PR mentions, this only occurs when f.timeout == 0 (so no timeout set).

Looks like tests are failing. I'll look into it when I'm back.

Comment thread form.go Resolved
Comment thread form.go Resolved
Comment thread huh_test.go Resolved
@maaslalani

Copy link
Copy Markdown
Contributor

Sorry you're totally right, I was on an incorrect branch!

@Sculas

Sculas commented Jun 19, 2024

Copy link
Copy Markdown
Contributor Author

I've applied the changes you requested and removed the program field by introducing RunWithContext(context.Context), which made sense anyway because the timeout used context.Background() instead of accepting an existing context.
Of course, Run() is kept and just calls RunWithContext(context.Background()) as it did previously as well.

I've fixed the data race as well and all tests now pass with -race.

@Sculas

Sculas commented Jul 2, 2024

Copy link
Copy Markdown
Contributor Author

@maaslalani Would you be able to look into this soon?

@maaslalani
maaslalani merged commit 34ae8b7 into charmbracelet:main Jul 2, 2024
@maaslalani

Copy link
Copy Markdown
Contributor

@Sculas This looks great! Thank you!

@Sculas
Sculas deleted the fix/timeout branch July 2, 2024 12:51
renovate Bot referenced this pull request in jippi/dottie Jul 10, 2024
….mod (#60)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/charmbracelet/huh](https://togithub.com/charmbracelet/huh)
| `v0.4.2` -> `v0.5.1` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fcharmbracelet%2fhuh/v0.5.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fcharmbracelet%2fhuh/v0.5.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fcharmbracelet%2fhuh/v0.4.2/v0.5.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fcharmbracelet%2fhuh/v0.4.2/v0.5.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>charmbracelet/huh (github.com/charmbracelet/huh)</summary>

###
[`v0.5.1`](https://togithub.com/charmbracelet/huh/compare/v0.5.0...v0.5.1)

[Compare
Source](https://togithub.com/charmbracelet/huh/compare/v0.5.0...v0.5.1)

###
[`v0.5.0`](https://togithub.com/charmbracelet/huh/releases/tag/v0.5.0)

[Compare
Source](https://togithub.com/charmbracelet/huh/compare/v0.4.2...v0.5.0)

### Dynamic Forms 🪄

<img width="600"
src="https://vhs.charm.sh/vhs-6FRmBjNi2aiRb4INPXwIjo.gif" alt="Country /
State form with dynamic inputs running.">

`huh?` forms can now react to changes in other parts of the form.
Replace properties such as `Options`, `Title`, `Description` with their
dynamic counterparts: `OptionsFunc`, `TitleFunc`, and `DescriptionFunc`
to recompute properties values on changes when watched variables change.

Let’s build a simple state / province picker.

```go
var country string
var state string
```

The `country` select will be static, we’ll use this value to recompute
the
options and title for the next input.

```go
huh.NewSelect[string]().
    Options(huh.NewOptions("United States", "Canada", "Mexico")...).
    Value(&country).
    Title("Country").
```

Define your `Select` with `TitleFunc` and `OptionsFunc` and bind them to
the
`&country` value from the previous field. Whenever the user chooses a
different
country, the `TitleFunc` and `OptionsFunc` will be recomputed.

> \[!IMPORTANT]
> We have to pass `&country` as the binding to recompute the function
only when
> `country` changes, otherwise we will hit the API too often.

```go
huh.NewSelect[string]().
    Value(&state).
    Height(8).
    TitleFunc(func() string {
        switch country {
        case "United States":
            return "State"
        case "Canada":
            return "Province"
        default:
            return "Territory"
        }
    }, &country).
    OptionsFunc(func() []huh.Option[string] {
        opts := fetchStatesForCountry(country)
        return huh.NewOptions(opts...)
    }, &country),
```

Lastly, run the `form` with these inputs.

```go
err := form.Run()
if err != nil {
    log.Fatal(err)
}
```

##### Other Changes

#### What's Changed

- Form Layouts by [@&#8203;adamdottv](https://togithub.com/adamdottv) in
[https://github.com/charmbracelet/huh/pull/274](https://togithub.com/charmbracelet/huh/pull/274)
- Resolve conflict between select and filter by
[@&#8203;MikaelFangel](https://togithub.com/MikaelFangel) in
[https://github.com/charmbracelet/huh/pull/252](https://togithub.com/charmbracelet/huh/pull/252)
- Add `CursorText` style by [@&#8203;nervo](https://togithub.com/nervo)
in
[https://github.com/charmbracelet/huh/pull/259](https://togithub.com/charmbracelet/huh/pull/259)
- Adjust input width to char limit by
[@&#8203;nervo](https://togithub.com/nervo) in
[https://github.com/charmbracelet/huh/pull/260](https://togithub.com/charmbracelet/huh/pull/260)
- Implement `WithInput` by
[@&#8203;Delta456](https://togithub.com/Delta456) in
[https://github.com/charmbracelet/huh/pull/271](https://togithub.com/charmbracelet/huh/pull/271)
- Implement WithTimeout by
[@&#8203;Delta456](https://togithub.com/Delta456) in
[https://github.com/charmbracelet/huh/pull/276](https://togithub.com/charmbracelet/huh/pull/276)
- Set filtering state of select by
[@&#8203;PJGaetan](https://togithub.com/PJGaetan) in
[https://github.com/charmbracelet/huh/pull/179](https://togithub.com/charmbracelet/huh/pull/179)
- `Filtering` on `Select` and `MultiSelect` fields by
[@&#8203;maaslalani](https://togithub.com/maaslalani) in
[https://github.com/charmbracelet/huh/pull/283](https://togithub.com/charmbracelet/huh/pull/283)
- Introduce `accessor` by [@&#8203;nervo](https://togithub.com/nervo) in
[https://github.com/charmbracelet/huh/pull/263](https://togithub.com/charmbracelet/huh/pull/263)
- fix: aborting a form returning a timeout error by
[@&#8203;Sculas](https://togithub.com/Sculas) in
[https://github.com/charmbracelet/huh/pull/287](https://togithub.com/charmbracelet/huh/pull/287)

#### New Contributors

- [@&#8203;MikaelFangel](https://togithub.com/MikaelFangel) made their
first contribution in
[https://github.com/charmbracelet/huh/pull/252](https://togithub.com/charmbracelet/huh/pull/252)
- [@&#8203;nervo](https://togithub.com/nervo) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/253](https://togithub.com/charmbracelet/huh/pull/253)
- [@&#8203;shedyfreak](https://togithub.com/shedyfreak) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/230](https://togithub.com/charmbracelet/huh/pull/230)
- [@&#8203;Delta456](https://togithub.com/Delta456) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/271](https://togithub.com/charmbracelet/huh/pull/271)
- [@&#8203;abradley2](https://togithub.com/abradley2) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/280](https://togithub.com/charmbracelet/huh/pull/280)
- [@&#8203;PJGaetan](https://togithub.com/PJGaetan) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/179](https://togithub.com/charmbracelet/huh/pull/179)
- [@&#8203;Sculas](https://togithub.com/Sculas) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/287](https://togithub.com/charmbracelet/huh/pull/287)

**Full Changelog**:
charmbracelet/huh@v0.4.2...v0.5.0

***

<a href="https://charm.sh/"><img alt="The Charm logo"
src="https://stuff.charm.sh/charm-badge.jpg" width="400"></a>

Thoughts? Questions? We love hearing from you. Feel free to reach out on
[Twitter](https://twitter.com/charmcli), [The
Fediverse](https://mastodon.technology/@&#8203;charm), or
[Slack](https://charm.sh/slack).

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "* */8 * * *" (UTC), Automerge - At
any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/jippi/dottie).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjUuMSIsInVwZGF0ZWRJblZlciI6IjM3LjQyNS4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiXX0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
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.

2 participants

⌂ 换网址