feat(messagestore): async background FTS5 bulk-insert with progress notification
Adds the worker that fills the messages_fts virtual table after Migrate4. The bulk-insert runs off the framework thread on its own SqliteConnection opened via OpenSecondaryConnection -- WAL lets the live UpsertMessage path on the primary Connection keep flowing, and the worker's writer lock yields every 500 rows with a 5ms breather so PendingMessageThread does not hit "database is locked" after DefaultTimeout=5s. InitFtsReadyCache runs in the ctor and short-circuits to ready=true when the index is already populated or when the messages table is empty. The DbViewer (Task 4.4) reads IsFtsIndexBuilt per frame as a single volatile field read. Plugin.cs LoadAsync kicks the worker after FilterAllTabsAsync, gated on IsFtsIndexBuilt and a CancellationTokenSource that DisposeAsync cancels before MessageManager tears down. Progress reports back via IActiveNotification, marshalled onto the framework thread via Framework.RunOnTick. Success path finishes the notification as Success with a 5s linger; cancellation dismisses it; an error swaps the type to Error with a fallback hint.
This commit is contained in:
@@ -14,6 +14,7 @@ using HellionChat.Ipc;
|
||||
using HellionChat.Resources;
|
||||
using HellionChat.Ui;
|
||||
using HellionChat.Util;
|
||||
using Microsoft.Data.Sqlite;
|
||||
|
||||
namespace HellionChat;
|
||||
|
||||
@@ -127,6 +128,12 @@ public sealed class Plugin : IAsyncDalamudPlugin
|
||||
|
||||
internal int DeferredSaveFrames = -1;
|
||||
|
||||
// Cancels the v1.4.8 FTS5 bulk-insert worker on plugin teardown. The
|
||||
// worker runs off the framework thread on its own SqliteConnection, so a
|
||||
// Dispose mid-rebuild must signal cancellation before MessageManager
|
||||
// tears down (the worker logs "rebuild failed" via Log on error paths).
|
||||
private CancellationTokenSource? _ftsRebuildCts;
|
||||
|
||||
// Serialises retention sweeps so a manual trigger and the 24h auto-sweep
|
||||
// can't run in parallel. Volatile because the ImGui thread reads it outside
|
||||
// the lock to gate the manual button.
|
||||
@@ -282,6 +289,113 @@ public sealed class Plugin : IAsyncDalamudPlugin
|
||||
if (Interface.Reason is not PluginLoadReason.Boot)
|
||||
MessageManager.FilterAllTabsAsync();
|
||||
|
||||
// Kick the FTS5 rebuild worker if Migrate4 just added the schema or
|
||||
// a previous run was cut short (InitFtsReadyCache leaves _ftsReady
|
||||
// false in that case). Runs off the framework thread on its own
|
||||
// SqliteConnection so the live UpsertMessage path keeps flowing
|
||||
// through the chunked-commit windows.
|
||||
_ftsRebuildCts = new CancellationTokenSource();
|
||||
if (!MessageManager.Store.IsFtsIndexBuilt)
|
||||
{
|
||||
var token = _ftsRebuildCts.Token;
|
||||
_ = Task.Run(
|
||||
async () =>
|
||||
{
|
||||
// FQN: Plugin.Notification (Z.74) shadows the type name.
|
||||
Dalamud.Interface.ImGuiNotification.IActiveNotification? notif = null;
|
||||
try
|
||||
{
|
||||
notif = Notification.AddNotification(
|
||||
new Dalamud.Interface.ImGuiNotification.Notification
|
||||
{
|
||||
Title = "Hellion Chat",
|
||||
Content = "Indexing chat history for full-text search...",
|
||||
Type = Dalamud
|
||||
.Interface
|
||||
.ImGuiNotification
|
||||
.NotificationType
|
||||
.Info,
|
||||
Minimized = false,
|
||||
InitialDuration = TimeSpan.FromMinutes(10),
|
||||
}
|
||||
);
|
||||
|
||||
// Progress<T> raises this callback on the captured
|
||||
// sync-context (Task.Run worker pool). IActiveNotification
|
||||
// is ImGui-backed and mutates the UI, so marshal the
|
||||
// mutation onto the framework thread via RunOnTick.
|
||||
var progress = new Progress<long>(done =>
|
||||
{
|
||||
Framework.RunOnTick(() =>
|
||||
{
|
||||
if (notif is { } n)
|
||||
n.Content = $"Indexing chat history: {done:N0} messages...";
|
||||
});
|
||||
});
|
||||
|
||||
// Worker-owned connection. Closed+disposed before we
|
||||
// flip the readiness flag so the DbViewer never sees
|
||||
// IsFtsIndexBuilt=true while the worker connection
|
||||
// is still alive.
|
||||
SqliteConnection? workerConn = null;
|
||||
try
|
||||
{
|
||||
workerConn = MessageManager.Store.OpenSecondaryConnection();
|
||||
var total = await Task.Run(
|
||||
() =>
|
||||
MessageManager.Store.RebuildFtsIndex(
|
||||
workerConn,
|
||||
progress,
|
||||
token
|
||||
),
|
||||
token
|
||||
)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
workerConn.Close();
|
||||
workerConn.Dispose();
|
||||
workerConn = null;
|
||||
MessageManager.Store.MarkFtsIndexBuilt();
|
||||
|
||||
if (notif is { } final)
|
||||
{
|
||||
final.Content = $"Indexed {total:N0} messages.";
|
||||
final.Type = Dalamud
|
||||
.Interface
|
||||
.ImGuiNotification
|
||||
.NotificationType
|
||||
.Success;
|
||||
final.InitialDuration = TimeSpan.FromSeconds(5);
|
||||
}
|
||||
}
|
||||
finally
|
||||
{
|
||||
workerConn?.Dispose();
|
||||
}
|
||||
}
|
||||
catch (OperationCanceledException)
|
||||
{
|
||||
notif?.DismissNow();
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Log.Error(ex, "FTS index rebuild failed");
|
||||
if (notif is { } err)
|
||||
{
|
||||
err.Content =
|
||||
"Full-text indexing failed -- search will use local filter only.";
|
||||
err.Type = Dalamud
|
||||
.Interface
|
||||
.ImGuiNotification
|
||||
.NotificationType
|
||||
.Error;
|
||||
}
|
||||
}
|
||||
},
|
||||
_ftsRebuildCts.Token
|
||||
);
|
||||
}
|
||||
|
||||
Interface.UiBuilder.DisableCutsceneUiHide = true;
|
||||
Interface.UiBuilder.DisableGposeUiHide = true;
|
||||
|
||||
@@ -328,6 +442,19 @@ public sealed class Plugin : IAsyncDalamudPlugin
|
||||
failure = CaptureFailure(failure, () => Interface.UiBuilder.Draw -= Draw);
|
||||
failure = CaptureFailure(failure, () => Framework.Update -= FrameworkUpdate);
|
||||
|
||||
// Signal the FTS rebuild worker to bail. Runs before MessageManager
|
||||
// tears down so the worker's "rebuild failed" log path still finds
|
||||
// a live Log static. Worker owns its own SqliteConnection and disposes
|
||||
// it itself; we only flip the cancellation flag here.
|
||||
failure = CaptureFailure(
|
||||
failure,
|
||||
() =>
|
||||
{
|
||||
_ftsRebuildCts?.Cancel();
|
||||
_ftsRebuildCts?.Dispose();
|
||||
}
|
||||
);
|
||||
|
||||
// Flush a pending DeferredSave — FrameworkUpdate won't fire it anymore.
|
||||
failure = CaptureFailure(
|
||||
failure,
|
||||
|
||||
Reference in New Issue
Block a user