Release v0.6.18: verify conversion results and log problems only

This commit is contained in:
2026-10-31 01:36:56 +02:00
parent 4eb9f6c671
commit 0d3b2acae9
18 changed files with 915 additions and 291 deletions
+66 -16
View File
@@ -2,6 +2,8 @@
#include "../resources/resource.h"
#include "ocr.h"
#include "configuration.h"
#include "diagnostics.h"
#include "paste_probe.h"
#include "screenshot_notifications.h"
#include <algorithm>
#include <commctrl.h>
@@ -12,6 +14,12 @@ namespace ks
App *App::current = nullptr;
namespace
{
const char *transformCommandName(int command)
{
return command == Toggle ? "Convert / cycle" : command >= Direct ? "Convert / direct" :
command == Case ? "Change case" : command == Translit ? "Transliterate" :
command == Undo ? "Undo" : "Automatic / snippet";
}
ULONG_PTR snippetReplayMarker()
{
static const char marker{};
@@ -854,7 +862,18 @@ void App::transform(int command, int snippet)
if (busy.exchange(true) && !preDeferred)
{
if (manual)
diagnosticEvent(L"Transform outcome id=" + std::to_wstring(attempt) + L" reason=busy", true);
{
diagnosticEvent(L"Transform outcome id=" + std::to_wstring(attempt) + L" reason=busy");
try
{
DiagnosticJson record{{"attempt", std::to_string(attempt)}, {"process", utf8(processName(target))},
{"command", transformCommandName(command)}, {"source", "Unknown"}, {"target", "Unknown"},
{"outcome", "busy"}, {"verification", "not-attempted"}, {"problem", true},
{"elapsedMs", GetTickCount64() - requestedAt}};
diagnosticOperation(record.dump());
}
catch (...) {}
}
return;
}
if (preDeferred)
@@ -893,7 +912,7 @@ void App::transform(int command, int snippet)
} reset{busy, window, preDeferred};
auto start = GetTickCount64();
std::wstring reason = L"cancelled-before-selection";
std::wstring text, result, expected;
std::wstring text, result, expected, actual, verification = L"not-attempted";
int hint = -1, to = command >= Direct ? command - Direct : -1;
if (manual)
{
@@ -918,21 +937,34 @@ void App::transform(int command, int snippet)
bool enabled;
std::wstring &reason;
std::wstring &text, &result, &expected;
std::wstring &actual, &verification;
int &hint, &to;
int command;
const std::vector<Layout> &layouts;
~Audit()
{
if (enabled)
diagnosticEvent(L"Transform outcome id=" + std::to_wstring(attempt) + L" reason=" + reason +
L" foregroundSame=" + std::to_wstring(GetForegroundWindow() == target) +
L" inputSame=" + std::to_wstring(app.inputVersion.load() == version) +
L" elapsedMs=" + std::to_wstring(GetTickCount64() - start) +
L" source=" + std::to_wstring(hint) + L" target=" + std::to_wstring(to) +
L" expected=" + diagnosticText(expected) + L" copied=" + diagnosticText(text) +
L" result=" + diagnosticText(result),
reason != L"paste-sent-unverified" && reason != L"layout-only" &&
reason != L"unchanged-expected");
try
{
auto layout = [&](int index) { return index >= 0 && index < (int)layouts.size()
? utf8(layouts[index].name + L" (" + layouts[index].id + L")") : std::string("Unknown"); };
auto bounded = [](const std::wstring &value) { return utf8(value.substr(0, 4096)); };
DiagnosticJson record{{"attempt", std::to_string(attempt)}, {"process", utf8(processName(target))},
{"command", transformCommandName(command)}, {"source", layout(text.empty() ? hint : detect(text, layouts, hint))}, {"target", layout(to)},
{"outcome", utf8(reason)}, {"verification", utf8(verification)},
{"problem", reason != L"Paste verified" && reason != L"layout-only" &&
!(command == 0 && reason == L"paste-sent-unverified")},
{"elapsedMs", GetTickCount64() - start}, {"foregroundSame", GetForegroundWindow() == target},
{"inputSame", app.inputVersion.load() == version}, {"original", bounded(text)},
{"expected", bounded(result)}, {"actual", bounded(actual)},
{"originalUnits", text.size()}, {"expectedUnits", result.size()}, {"actualUnits", actual.size()},
{"textTruncated", text.size() > 4096 || result.size() > 4096 || actual.size() > 4096}};
diagnosticOperation(record.dump(-1, ' ', true, DiagnosticJson::error_handler_t::replace));
}
catch (...) {} // Logging must never abort a completed input transaction.
}
} audit{*this, target, version, attempt, requestedAt, manual || snippet >= 0, reason, text, result, expected, hint, to};
} audit{*this, target, version, attempt, requestedAt, manual || snippet >= 0, reason, text, result, expected,
actual, verification, hint, to, command, available};
try
{
auto valid = [&]
@@ -1157,6 +1189,7 @@ void App::transform(int command, int snippet)
}
}
bool sent = false;
PasteProbe probe(config.writeLog && manual && result != text, text);
diagnosticEvent(L"Conversion source=" + std::to_wstring(hint) + L" target=" + std::to_wstring(to) +
L" changed=" + std::to_wstring(result != text));
if (result != text)
@@ -1167,10 +1200,27 @@ void App::transform(int command, int snippet)
autoSelected = false;
reason = result == text ? L"conversion-unchanged" :
sent ? L"paste-sent-unverified" : L"paste-cancelled";
if (result == text &&
(std::none_of(text.begin(), text.end(), letter) ||
(command >= Direct && detect(text, available, hint) == to)))
reason = L"unchanged-expected";
if (manual && result == text)
{
reason = L"Conversion unchanged";
verification = L"calculated-result-equals-original";
}
if (sent && manual && config.writeLog)
{
verification = probe.status;
if (tx.valid())
{
auto observed = probe.read((int)caretSteps(result));
verification = probe.status;
if (observed && tx.valid())
{
actual = *observed;
reason = conversionReadbackOutcome(newlines(actual), newlines(text), newlines(result));
}
else reason = L"Paste not verified";
}
else verification = L"context-changed-after-paste";
}
if (sent && !tx.valid())
reason = L"context-changed-after-paste";
if (sent && command == Undo && previous && previous->autoCorrected)