Add OnExit function for interactive text inputs

[lammel]

Description

For interactive programs a Ctrl-C might immediatly trigger an os.Exit() in the current implementation which will not allow for cleanup functions or defer code to run.

To avoid this a dedicated "OnExit" function can be configured using OnExitFunc or using .OnExit() when calling an interactive text input.

Naming can be adjusted of course.

Scope

What is affected by this pull request?

• Bug Fix
• New Feature
• Documentation
• Other

Related Issue

none yet

To-Do Checklist

• I tested my changes
• I have commented every method that I created/changed
• I updated the examples to fit with my changes
• I have added tests for my newly created methods

[codecov]

Codecov Report

Merging #507 (fbe253b) into master (9279c3e) will increase coverage by 0.06%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #507      +/-   ##
==========================================
+ Coverage   82.28%   82.34%   +0.06%     
==========================================
  Files          30       30              
  Lines        3482     3494      +12     
==========================================
+ Hits         2865     2877      +12     
  Misses        560      560              
  Partials       57       57              

Impacted Files	Coverage Δ
interactive_confirm_printer.go	92.39% <100.00%> (+0.25%)	⬆️
interactive_multiselect_printer.go	56.22% <100.00%> (+0.50%)	⬆️
interactive_select_printer.go	53.92% <100.00%> (+0.68%)	⬆️
interactive_textinput_printer.go	48.53% <100.00%> (+0.91%)	⬆️

[MarvinJWendt]

Thanks! I'll take a look soon.

[lammel]

It seems like bug #509 describes quite a similar scenario.

Maybe it would be preferable to not exit by default but rather abort the interactive input.
In that case we can adjust this PR or just drop it.

[MarvinJWendt]

but rather abort the interactive input

We can do this, and in combination add a OnInterrupt function (renaming the OnExit). So the developer can decide what to do next. I like the idea. Do you want to make those changes to this PR?

[MarvinJWendt]

Btw, you don't have to add tests, I am currently rewriting the whole testing system in #505.

[lammel]

We can do this, and in combination add a OnInterrupt function (renaming the OnExit). So the developer can decide what to do next. I like the idea. Do you want to make those changes to this PR?

Yes, I'll give it a try in the next few days.

[lammel]

Renamed to OnInterrupt() to allow providing a function to execute in case input is canceled.
By default canceling the input with Ctrl-C will not exit anymore. This could also lead to unexpected behavior though

[MarvinJWendt]

Looks good to me! I just noted a small change.

[lammel]

Guess testing was a little confused by the merge request. Please rerun the tests to be sure.

[lammel]

@MarvinJWendt Is there something left to do, before we can merge this?

[MarvinJWendt]

I am trying to fix the linter, as it falsely reports that there are errors here, which doesn't let me merge the PR.

[MarvinJWendt]

I have no clue why this is crashing, maybe it's an issue with reviewdog itself. Tracking in: reviewdog/action-golangci-lint#556

[lammel]

I am trying to fix the linter, as it falsely reports that there are errors here, which doesn't let me merge the PR.

I found a similar issue by another project that might fix the issue.

env:
  REVIEWDOG_GITHUB_API_TOKEN: ${{secrets.REVIEWDOG_GITHUB_API_TOKEN}}

See reviewdog/reviewdog#1403 (comment)

You could check the Secrets configuration for the project on github. Maybe ACCESS_TOKEN is not provisioned or the name changed. Maybe you could change the secret to a more descriptive name like REVIEWDOG_GITHUB_API_TOKEN

[MarvinJWendt]

Maybe ACCESS_TOKEN is not provisioned or the name changed.

We use that token for our other CIs too, which all work fine.

[lammel]

Maybe ACCESS_TOKEN is not provisioned or the name changed.

We use that token for our other CIs too, which all work fine.

Ok, than it there is probably some misconfiguration how reviewdog looks for the env variable.

My last attempt also failed. I'll leave it that way for now.
Hope you'll get some feedback in the reviewdog ticket.

[MarvinJWendt]

Okay seems like reviewdog isn't working as I thought it would. GitHub Actions triggered by an external PR don't receive secrets for security reasons. So there is no way for me to give secrets to reviewdog. I will migrate PTerm and all the AtomicGo libraries to the classic golangci-lint action again.

[MarvinJWendt]

LGTM! Thanks for the contribution 🚀