Add OnInterrupt to run function code on CTRL+C

[infalmo]

No description provided.

[infalmo]

@AlecAivazis I'm interested in managing this repository.
Would it be fine if you added me as a collaborator?

[AlecAivazis]

Hey @infixint943!

Thanks for submitting this. Do you mind adding tests and some documentation to go with the new feature?

Also, I appreciate the offer to help maintain this library. For now, the best way to help is to answer questions that pop up on issues and keep submitting PRs.

[AlecAivazis]

Thinking about this API more i think its important that we don't just add something to the top-level API. we probably want to have a survey.Option which lets us provide a handler for specific calls to Ask/AskOne. We could still provide a global default handler if you think that's important

[infalmo]

Thinking about this API more i think its important that we don't just add something to the top-level API. we probably want to have a survey.Option which lets us provide a handler for specific calls to Ask/AskOne. We could still provide a global default handler if you think that's important

Usually, I end up terminating the process when I encounter a CTRL+C, so I found a global configuration more viable (rather than configuring the function every time I do Ask/AskOne).
However, a better alternative would be to add an option in the survey.Option that allows for overriding the global configured function.

How good would this inclusion be?

[AlecAivazis]

I think having both is the right move 👍

[AlecAivazis]

@infixint943 any progress on adding the option?

[infalmo]

Hey!
I was caught up in some school work, and I forgot about it. I'll work on it tonight.
Thanks for the reminder!

[infalmo]

Should I rename the global OnSIGINTFunc to something different?

[AlecAivazis]

I think something simply like OnSigint is probably good enough

[infalmo]

Done!
If the current method is alright, shall I proceed with writing tests?

[AlecAivazis]

Thinking about this name some more, i think OnInterrupt is probably more clear. and to answer your question, yea it looks good!

[infalmo]

@AlecAivazis Can you please investigate why tests keep timing out randomly, in my PR?

[AlecAivazis]

Hey @infinitepr0, sorry you are running into timeout issues with the tests. Unforunately, i dont have a lot of free time to hunt this down right now :(

[infalmo]

This may sound stupid, but how do I make the tests send a SIGINT to the prompt?
Here's what I've done so far

func TestOnInterruptFunc(t *testing.T) {
	// Test global function.
	OnInterrupt = func() {
		fmt.Println("The end!")
	}

	RunPromptTest(t, PromptTest{
		name: "Test global OnInterrupt Func.",
		prompt: &Input{
			Message: "What is your name?",
		},
		procedure: func(e *expect.Console) {
			e.ExpectString("What is your name?")
			// How do I send a SIGINT next?
		},
	})
}

[AlecAivazis]

@infinitepr0 any progress?

[infalmo]

Sorry for the delay (and thanks for the reminder).

[infalmo]

Requesting you to review this PR @AlecAivazis

[AlecAivazis]

Do you mind explaining why you changed the way errors are handled in tests?

[AlecAivazis]

was this intentionally removed? If so, can you explain why?

[infalmo]

Yes, because, L#30 would return an error when SIGINT was encountered, and the tests would fail (due to the assert). So I shifted the error assertion to the helper functions (RunPromptTest and the other one).

I could revert this, but that would mean rewriting another RunTest function exclusively for the OnInterrupt test, which isn't a very good idea imo.

[infalmo]

@AlecAivazis Sorry for disturbing, but can you please review the PR and merge it is all's well.

Thanks.

[AlecAivazis]

Sure thing! Thanks for the reminder 👍

[infalmo]

Thanks a lot!