Isolate text keepalive from image generation

ad7958ed1cbe509a6ebeac4e41fb206b52a46942

permissionBRICK <40219477+permissionBRICK@users.noreply.github.com>

public/scripts/events.js+2 -0 Viewed

     ONLINE_STATUS_CHANGED: 'online_status_changed',
     IMAGE_SWIPED: 'image_swiped',
     CONNECTION_PROFILE_LOADED: 'connection_profile_loaded',
+    CONNECTION_PROFILE_TEMPORARY_STARTED: 'connection_profile_temporary_started',
+    CONNECTION_PROFILE_TEMPORARY_ENDED: 'connection_profile_temporary_ended',
     CONNECTION_PROFILE_CREATED: 'connection_profile_created',
     CONNECTION_PROFILE_DELETED: 'connection_profile_deleted',
     CONNECTION_PROFILE_UPDATED: 'connection_profile_updated',

public/scripts/extensions/keepalive/index.js+44 -7 Viewed

 let retryTimer = null;
 let preparingJob = false;
 let lifecycleVersion = 0;
+let foregroundGenerationActive = false;
+let temporaryConnectionDepth = 0;
+let refreshAfterTemporaryConnection = false;
 // Whether keepalive is "armed" for the CURRENT chat. It stays dormant until the user sends a new
 // message or starts another foreground generation in the open chat. Merely loading a chat does not
 // prove that its prompt is cached server-side. Reset on page reload and whenever the chat changes.

@@ -145,7 +148,7 @@ async function stopBackendJob() {
145	}	148	}
146		149
147	async function sendBackendHeartbeat(activity = false) {	150	async function sendBackendHeartbeat(activity = false) {
148	if (!armed \|\| !isKeepaliveEnabledForActive()) {	151	if (temporaryConnectionDepth > 0 \|\| !armed \|\| !isKeepaliveEnabledForActive()) {
149	return;	152	return;
150	}	153	}
151	// Registration is normally created as soon as a response finishes. If that one-shot event	154	// Registration is normally created as soon as a response finishes. If that one-shot event

@@ -182,7 +185,7 @@ async function sendBackendHeartbeat(activity = false) {
182	}	185	}
183		186
184	function markActivity() {	187	function markActivity() {
185	if (preparingJob) {	188	if (preparingJob \|\| temporaryConnectionDepth > 0) {
186	return;	189	return;
187	}	190	}
188	lastActivity[getActiveProfileKey()] = Date.now();	191	lastActivity[getActiveProfileKey()] = Date.now();

+}
 async function registerBackendJob() {
+    if (temporaryConnectionDepth > 0) {
+        refreshAfterTemporaryConnection = true;
+        return;
+    }
     if (!armed || !isKeepaliveEnabledForActive()) {
         await stopBackendJob();
         return;

+}
 function onGenerationStarted(type, _options, dryRun) {
-    if (dryRun) {
+    // Quiet/background generations (image prompts, summaries, helpers, etc.) use a different model
+    // or context and do not refresh the foreground text-chat cache.
+    if (dryRun || type === 'quiet') {
         return;
+    }
     // Regenerates, swipes, and continues send the current prompt to the provider without emitting
     // MESSAGE_SENT. They are just as valid proof of a warm prompt as a newly typed message.
-    if (type !== 'quiet') {
+    foregroundGenerationActive = true;
-        armed = true;
+    armed = true;
-    }
     markActivity();
+}
 function onGenerationEnded() {
+    if (!foregroundGenerationActive) {
+        return;
+    }
+    foregroundGenerationActive = false;
     markActivity();
     scheduleGenerationJobRefresh();
+}
-function onMessageReceived() {
+function onMessageReceived(_messageId, type) {
+    // Image-generation extensions add their results as chat messages. Those messages neither used
+    // nor refreshed the foreground text cache, so they must not move its keepalive deadline.
+    if (type === 'extension') {
+        return;
+    }
+    foregroundGenerationActive = false;
     markActivity();
     scheduleGenerationJobRefresh();
+}

+}
 async function onConnectionChanged() {
+    if (temporaryConnectionDepth > 0) {
+        return;
+    }
     // Remove the previous connection's request before assembling one with the new settings.
     await stopBackendJob();
     if (armed && isKeepaliveEnabledForActive()) {

+    }
+}
+function onTemporaryConnectionStarted() {
+    temporaryConnectionDepth++;
+}
+function onTemporaryConnectionEnded() {
+    temporaryConnectionDepth = Math.max(0, temporaryConnectionDepth - 1);
+    if (temporaryConnectionDepth === 0 && refreshAfterTemporaryConnection) {
+        refreshAfterTemporaryConnection = false;
+        queueJobRefresh();
+    }
+}
 async function init() {
     const settingsHtml = await renderExtensionTemplateAsync(MODULE, 'settings');
     $('#extensions_settings2').append(settingsHtml);

     eventSource.on(event_types.MESSAGE_RECEIVED, onMessageReceived);
     eventSource.on(event_types.GENERATION_STARTED, onGenerationStarted);
     eventSource.on(event_types.GENERATION_ENDED, onGenerationEnded);
+    eventSource.on(event_types.GENERATION_STOPPED, () => { foregroundGenerationActive = false; });
     eventSource.on(event_types.MESSAGE_EDITED, onChatContentChanged);
     eventSource.on(event_types.MESSAGE_DELETED, onChatContentChanged);
     eventSource.on(event_types.MESSAGE_UPDATED, onChatContentChanged);

     eventSource.on(event_types.CHAT_CHANGED, onChatChanged);
     // When the active profile changes, replace the backend job without marking it as activity.
+    // Temporary profile switches used by background image-prompt generation are explicitly ignored.
+    eventSource.on(event_types.CONNECTION_PROFILE_TEMPORARY_STARTED, onTemporaryConnectionStarted);
+    eventSource.on(event_types.CONNECTION_PROFILE_TEMPORARY_ENDED, onTemporaryConnectionEnded);
     eventSource.on(event_types.CONNECTION_PROFILE_LOADED, onConnectionChanged);
     eventSource.on(event_types.MAIN_API_CHANGED, onConnectionChanged);
     eventSource.on(event_types.CHATCOMPLETION_SOURCE_CHANGED, onConnectionChanged);

public/scripts/extensions/keepalive/manifest.json+1 -1 Viewed

     "js": "index.js",
     "css": "",
     "author": "SillyTavern",
-    "version": "1.1.3",
+    "version": "1.1.4",
     "homePage": "https://github.com/SillyTavern/SillyTavern",
     "hooks": {
         "activate": "init"

public/scripts/extensions/stable-diffusion/index.js+6 -1 Viewed

         await waitUntilCondition(() => online_status !== 'no_connection', 10000, 100, { rejectOnTimeout: false });
     };
-    await switchToProfile(targetProfileId);
+    // Background image-prompt work must not disturb foreground features that follow the user's
+    // active connection profile (notably text prompt-cache keepalives).
+    await eventSource.emit(event_types.CONNECTION_PROFILE_TEMPORARY_STARTED);
     try {
+        await switchToProfile(targetProfileId);
         return await callback();
     } finally {
         try {
             await switchToProfile(currentProfileId);
         } catch (err) {
             console.error('SD: failed to restore the previous connection profile after image-prompt generation', err);
+        } finally {
+            await eventSource.emit(event_types.CONNECTION_PROFILE_TEMPORARY_ENDED);
+        }
+    }
+}