Keep three crash-recovery snapshots instead of overwriting one

Discussion #598, reviving PR #654. The crash-recovery backup written
every 20 minutes went to a single file. If the project was already in a
bad state when a backup ran, that bad state replaced the only recovery
copy.

QETProject now writes the backups in turn to three KAutoSaveFile slots
(BackupGenerations), so one bad write only replaces the oldest
snapshot. Scope is crash recovery only; the opt-in autosave is
unchanged.

After a crash, the recovery prompt groups the snapshots by project and
offers one row per project with a list to pick the snapshot to reopen,
newest selected by default. The snapshots not picked are deleted.

Ported onto current master: writeBackup() keeps the "skip if nothing
changed" check (bugtracker #273) and offerBackupFiles() keeps its place
after the stale-file filter and before the crash report (#901).

Tested with the backup interval shortened to 4 s (test build only):
after three changes, master holds one recovery file, overwritten each
time; this branch holds three, with 4, 5 and 6 folios. After killing
QET, the prompt lists the project; picking the oldest snapshot reopens
4 folios, the default reopens 6. Twice each. ctest 34/34 with and
without KDE Frameworks; the carried-over KAutoSaveFile test passes in
the nokde build.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
ispyisail
2026-09-30 10:45:25 +13:00
parent bae336ef5b
commit 1dd56df048
7 changed files with 365 additions and 36 deletions
+105
View File
@@ -3,14 +3,18 @@
#include <catch2/catch.hpp>
#include <QCoreApplication>
#include <QDateTime>
#include <QFile>
#include <QFileInfo>
#include <QTemporaryDir>
#include <QUrl>
#include <algorithm>
#include <memory>
#include <vector>
#ifdef Q_OS_UNIX
#include <ctime>
#include <signal.h>
#include <sys/types.h>
#include <sys/wait.h>
@@ -106,3 +110,104 @@ TEST_CASE("Qt-only KAutoSaveFile recovers stale files", "[nokde][autosave]")
CHECK_FALSE(QFile::exists(lock_file_name));
#endif
}
TEST_CASE("Multiple KAutoSaveFile generations for one managed file are all "
"found stale after a crash", "[nokde][autosave]")
{
#ifndef Q_OS_UNIX
SUCCEED("crash-style stale lock test is Unix-only");
#else
//Simulates QETProject's rotating crash-recovery generations
//(BackupGenerations snapshots written round-robin): several
//KAutoSaveFile instances sharing one managed file, alive at once.
QTemporaryDir data_home;
REQUIRE(data_home.isValid());
qputenv("XDG_DATA_HOME", QFile::encodeName(data_home.path()));
QCoreApplication::setOrganizationName(QStringLiteral("QElectroTech"));
QCoreApplication::setApplicationName(
QStringLiteral("KAutoSaveFileGenerationsTest"));
const auto managed_path = data_home.filePath(QStringLiteral("project.qet"));
QFile managed_file(managed_path);
REQUIRE(managed_file.open(QIODevice::WriteOnly | QIODevice::Text));
REQUIRE(managed_file.write("<project/>\n") > 0);
managed_file.close();
constexpr int generations = 3;
int ready_pipe[2] = {-1, -1};
REQUIRE(pipe(ready_pipe) == 0);
const auto child_pid = fork();
REQUIRE(child_pid >= 0);
if (child_pid == 0) {
close(ready_pipe[0]);
std::vector<std::unique_ptr<KAutoSaveFile>> backups;
for (int i = 0; i < generations; ++i) {
auto backup = std::make_unique<KAutoSaveFile>(
QUrl::fromLocalFile(managed_path));
if (!backup->open(QIODevice::WriteOnly
| QIODevice::Truncate
| QIODevice::Text)) {
_exit(2);
}
const QByteArray payload =
"<project><generation n=\"" + QByteArray::number(i)
+ "\" /></project>\n";
if (backup->write(payload) != payload.size()) {
_exit(3);
}
if (!backup->flush()) {
_exit(4);
}
//Give each generation a distinct, increasing mtime.
struct timespec pause{0, 20 * 1000 * 1000};
nanosleep(&pause, nullptr);
backups.push_back(std::move(backup));
}
const char ready = '1';
if (write(ready_pipe[1], &ready, 1) != 1) {
_exit(5);
}
close(ready_pipe[1]);
for (;;) {
pause();
}
}
close(ready_pipe[1]);
char ready = 0;
REQUIRE(read(ready_pipe[0], &ready, 1) == 1);
close(ready_pipe[0]);
REQUIRE(ready == '1');
REQUIRE(kill(child_pid, SIGKILL) == 0);
int status = 0;
REQUIRE(waitpid(child_pid, &status, 0) == child_pid);
REQUIRE(WIFSIGNALED(status));
REQUIRE(WTERMSIG(status) == SIGKILL);
auto stale_files = KAutoSaveFile::allStaleFiles();
REQUIRE(stale_files.size() == generations);
std::sort(stale_files.begin(), stale_files.end(),
[](KAutoSaveFile *a, KAutoSaveFile *b) {
return QFileInfo(*a).lastModified() < QFileInfo(*b).lastModified();
});
for (int i = 0; i < generations; ++i) {
std::unique_ptr<KAutoSaveFile> stale_file(stale_files.at(i));
CHECK(stale_file->managedFile().path()
== QFileInfo(managed_path).absoluteFilePath());
REQUIRE(stale_file->open(QIODevice::ReadOnly | QIODevice::Text));
const QByteArray content = stale_file->readAll();
CHECK(content.contains(
"generation n=\"" + QByteArray::number(i) + "\""));
}
#endif
}