repl: log errors writing to history file

These errors are now logged and explicitly ignored, rather than
implicitly ignored.

Change-Id: Ia26015466a17f2b11952df5317a4d150d79dc184
This commit is contained in:
Qyriad 2024-05-19 12:57:14 -06:00
parent 79121e0c44
commit 677cf75473
2 changed files with 36 additions and 2 deletions

View file

@ -1,6 +1,8 @@
#include <cstdio> #include <cstdio>
#include <iostream> #include <iostream>
#include <string> #include <string>
#include <string_view>
#include <cerrno>
#ifdef READLINE #ifdef READLINE
#include <readline/history.h> #include <readline/history.h>
@ -176,15 +178,42 @@ bool ReadlineLikeInteracter::getLine(std::string & input, ReplPromptType promptT
if (!s) if (!s)
return false; return false;
write_history(historyFile.c_str()); this->writeHistory();
input += s; input += s;
input += '\n'; input += '\n';
return true; return true;
} }
void ReadlineLikeInteracter::writeHistory()
{
int ret = write_history(historyFile.c_str());
int writeHistErr = errno;
if (ret == 0) {
return;
}
// If the open fails, editline returns EOF. If the close fails, editline
// forwards the return value of fclose(), which is EOF on error.
// readline however, returns the errno.
// So if we didn't get exactly EOF, then consider the return value the error
// code; otherwise use the errno we saved above.
// https://github.com/troglobit/editline/issues/66
if (ret != EOF) {
writeHistErr = ret;
}
// In any of these cases, we should explicitly ignore the error, but log
// them so the user isn't confused why their history is getting eaten.
std::string_view const errMsg(std::strerror(writeHistErr));
warn("ignoring error writing repl history to %s: %s", this->historyFile, errMsg);
}
ReadlineLikeInteracter::~ReadlineLikeInteracter() ReadlineLikeInteracter::~ReadlineLikeInteracter()
{ {
write_history(historyFile.c_str()); this->writeHistory();
} }
AutomationInteracter::Guard AutomationInteracter::init(detail::ReplCompleterMixin *) AutomationInteracter::Guard AutomationInteracter::init(detail::ReplCompleterMixin *)

View file

@ -42,6 +42,11 @@ public:
} }
virtual Guard init(detail::ReplCompleterMixin * repl) override; virtual Guard init(detail::ReplCompleterMixin * repl) override;
virtual bool getLine(std::string & input, ReplPromptType promptType) override; virtual bool getLine(std::string & input, ReplPromptType promptType) override;
/** Writes the current history to the history file.
*
* This function logs but ignores errors from readline's write_history().
*/
virtual void writeHistory();
virtual ~ReadlineLikeInteracter() override; virtual ~ReadlineLikeInteracter() override;
}; };