diff --git a/app/android/app/build.gradle.kts b/app/android/app/build.gradle.kts index 5a16f7f3..054302b1 100644 --- a/app/android/app/build.gradle.kts +++ b/app/android/app/build.gradle.kts @@ -55,6 +55,8 @@ dependencies { coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:2.1.4") // The background notification socket (notify/NotificationService). implementation("com.squareup.okhttp3:okhttp:4.12.0") + // NotificationCompat.MessagingStyle for the per-chat/run conversations (notify/NotificationPresenter). + implementation("androidx.core:core:1.15.0") // JVM tests for the notification protocol and ledger (`gradlew :app:testDebugUnitTest`). testImplementation("junit:junit:4.13.2") // Android's org.json is a stub on the JVM; tests use the real implementation. diff --git a/app/android/app/src/main/kotlin/net/awan/pipelines_app/notify/NotificationDismissReceiver.kt b/app/android/app/src/main/kotlin/net/awan/pipelines_app/notify/NotificationDismissReceiver.kt index 1d223c4d..f5bd713c 100644 --- a/app/android/app/src/main/kotlin/net/awan/pipelines_app/notify/NotificationDismissReceiver.kt +++ b/app/android/app/src/main/kotlin/net/awan/pipelines_app/notify/NotificationDismissReceiver.kt @@ -11,16 +11,20 @@ import android.content.Intent class NotificationDismissReceiver : BroadcastReceiver() { override fun onReceive(context: Context, intent: Intent) { if (intent.action != ACTION) return - val id = intent.getStringExtra(NotificationPresenter.EXTRA_NOTIFICATION_ID) ?: return - queueClear(context, id) + val ids = intent.getStringExtra(NotificationPresenter.EXTRA_NOTIFICATION_ID) ?: return + queueClear(context, ids) } companion object { const val ACTION = "net.awan.pipelines.notify.DISMISSED" - /** Shared by dismissals and taps (see MainActivity). */ - fun queueClear(context: Context, id: String) { - DeliveryLedger(ServiceSettings(context)).queueClear(listOf(id)) + /** + * Shared by dismissals and taps (see MainActivity). [ids] is one server + * id or several separated by newlines, as a thread notification carries. + */ + fun queueClear(context: Context, ids: String) { + DeliveryLedger(ServiceSettings(context)) + .queueClear(ids.split('\n').filter { it.isNotEmpty() }) // Only nudge a running service; a stopped one sends the queue on // its next connection. if (NotificationService.running != null) { diff --git a/app/android/app/src/main/kotlin/net/awan/pipelines_app/notify/NotificationPresenter.kt b/app/android/app/src/main/kotlin/net/awan/pipelines_app/notify/NotificationPresenter.kt index ab2cddc1..35a234a8 100644 --- a/app/android/app/src/main/kotlin/net/awan/pipelines_app/notify/NotificationPresenter.kt +++ b/app/android/app/src/main/kotlin/net/awan/pipelines_app/notify/NotificationPresenter.kt @@ -9,17 +9,22 @@ import android.content.Context import android.content.Intent import android.net.Uri import android.os.Build +import androidx.core.app.NotificationCompat +import androidx.core.app.Person import net.awan.pipelines_app.MainActivity import net.awan.pipelines_app.R /** - * Posts server notifications in the system tray: one channel per kind and - * priority (created lazily, grouped by kind), Android groups by the server's - * `group`, a tap opens the app at the `click` deep link, and a dismissal is - * reported back so the server clears it everywhere. + * Posts server notifications in the system tray. Each chat or run is one + * conversation notification (a MessagingStyle thread with the latest lines and + * the unread count), keyed by its server group. Thread notifications share a + * group per namespace, so Android bundles them under a summary ("N chats", + * "N runs"). A tap opens the app at the `click` deep link and clears the + * thread; a dismissal is reported back so the server clears it everywhere. */ class NotificationPresenter(private val context: Context) { private val manager = context.getSystemService(NotificationManager::class.java) + private val history = ThreadHistory(ServiceSettings(context)) fun connectionNotification(status: DeliveryStatus): Notification { ensureChannel(CONNECTION_CHANNEL, "Connection", NotificationManager.IMPORTANCE_MIN, null) @@ -37,7 +42,7 @@ class NotificationPresenter(private val context: Context) { .setOngoing(true) .setShowWhen(false) .setContentIntent(openApp()) - .setCategory(Notification.CATEGORY_SERVICE) + .setCategory(NotificationCompat.CATEGORY_SERVICE) .build() } @@ -69,86 +74,143 @@ class NotificationPresenter(private val context: Context) { PendingIntent.FLAG_IMMUTABLE or PendingIntent.FLAG_UPDATE_CURRENT, ) + /** A notification without a group is posted on its own; otherwise it joins its thread. */ fun show(notification: ServerNotification) { - val id = DeliveryLedger.notificationId(notification.id) - val channel = channelFor(notification) - val title = notification.title.ifEmpty { "Pipelines" } - val builder = builder(channel) - .setSmallIcon(R.drawable.ic_stat_pipelines) - .setContentTitle(title) - .setContentText(notification.message) - .setStyle(Notification.BigTextStyle().bigText(notification.message)) - .setAutoCancel(true) - .setContentIntent(openIntent(notification, id)) - .setDeleteIntent(dismissIntent(notification.id, id)) - createdMillis(notification.createdAt)?.let { builder.setWhen(it).setShowWhen(true) } - if (notification.group.isNotEmpty()) builder.setGroup(notification.group) - if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) { - @Suppress("DEPRECATION") - builder.setPriority(effectivePriority(notification.kind, notification.priority) - 3) - } - manager.notify(id, builder.build()) - if (notification.group.isNotEmpty()) updateSummary(notification.group, channel) + if (notification.group.isEmpty()) return showAlone(notification) + val thread = notification.group + history.append(thread, NotificationThreads.entryOf(notification, System.currentTimeMillis())) + val channel = postThread(thread) ?: return + updateSummary(NotificationThreads.namespaceOf(thread), channel) } - /** Removes notifications cleared on this or another device. */ + /** Removes notifications cleared on this or another device, updating their threads. */ fun cancel(ids: Collection) { - val groups = mutableSetOf() - val active = manager.activeNotifications - for (id in ids) { - val notificationId = DeliveryLedger.notificationId(id) - active.firstOrNull { it.id == notificationId }?.notification?.group?.let(groups::add) - manager.cancel(notificationId) + for (id in ids) manager.cancel(DeliveryLedger.notificationId(id)) + val namespaces = mutableSetOf() + for (thread in history.remove(ids)) { + if (history.entries(thread).isEmpty()) manager.cancel(threadNotificationId(thread)) + else postThread(thread) + namespaces.add(NotificationThreads.namespaceOf(thread)) } - groups.forEach { updateSummary(it, null) } + namespaces.forEach { updateSummary(it, null) } } - /** Removes every server notification, keeping the connection one. */ + /** Removes every server notification and thread, keeping the connection one. */ fun cancelAll() { + history.clear() manager.activeNotifications .filter { it.id != CONNECTION_ID } .forEach { manager.cancel(it.tag, it.id) } } - private fun updateSummary(group: String, channel: String?) { - val summaryId = DeliveryLedger.notificationId("group:$group") - val members = manager.activeNotifications.count { - it.notification.group == group && it.id != summaryId + private fun showAlone(notification: ServerNotification) { + val id = DeliveryLedger.notificationId(notification.id) + val channel = channelFor(notification.kind, notification.priority) + val title = notification.title.ifEmpty { "Pipelines" } + val builder = builder(channel) + .setSmallIcon(R.drawable.ic_stat_pipelines) + .setContentTitle(title) + .setContentText(notification.message) + .setStyle(NotificationCompat.BigTextStyle().bigText(notification.message)) + .setAutoCancel(true) + .setContentIntent(openIntent(listOf(notification.id), notification.click, id)) + .setDeleteIntent(dismissIntent(listOf(notification.id), id)) + createdMillis(notification.createdAt)?.let { builder.setWhen(it).setShowWhen(true) } + applyLegacyPriority(builder, notification.kind, notification.priority) + manager.notify(id, builder.build()) + } + + /** + * Posts the thread's notification from its stored entries, so a restart or + * a partial clear rebuilds the same conversation. Returns the channel it + * used, or null when the thread has no entries left. + */ + private fun postThread(thread: String): String? { + val entries = history.entries(thread) + val latest = entries.lastOrNull() ?: return null + val channel = channelFor(latest.kind, latest.priority) + val id = threadNotificationId(thread) + val ids = entries.map { it.id } + val builder = builder(channel) + .setSmallIcon(R.drawable.ic_stat_pipelines) + .setNumber(entries.size) + .setGroup(NotificationThreads.groupKey(NotificationThreads.namespaceOf(thread))) + .setAutoCancel(true) + .setWhen(latest.whenMillis) + .setShowWhen(true) + .setContentIntent(openIntent(ids, latest.click, id)) + .setDeleteIntent(dismissIntent(ids, id)) + builder.setStyle(conversationStyle(entries)) + applyLegacyPriority(builder, latest.kind, latest.priority) + manager.notify(id, builder.build()) + return channel + } + + /** + * The shown lines of a thread, most recent last, as a messaging conversation. + * NotificationCompat renders it on every API level the app supports. + */ + private fun conversationStyle(entries: List): NotificationCompat.MessagingStyle { + val style = NotificationCompat.MessagingStyle(Person.Builder().setName("You").build()) + .setConversationTitle(entries.last().sender) + .setGroupConversation(false) + for (entry in entries.takeLast(SHOWN_LINES)) { + val sender = Person.Builder().setName(entry.sender).build() + style.addMessage(NotificationCompat.MessagingStyle.Message(entry.text, entry.whenMillis, sender)) } + return style + } + + /** + * Posts the namespace's group summary when two or more of its threads are + * shown, and removes it otherwise. A null [channel] reuses the summary's own. + */ + private fun updateSummary(namespace: String, channel: String?) { + val group = NotificationThreads.groupKey(namespace) + val summaryId = DeliveryLedger.notificationId("group:$group") + val active = manager.activeNotifications + val members = active.count { it.notification.group == group && it.id != summaryId } if (members < 2) { - if (members == 0) manager.cancel(summaryId) + manager.cancel(summaryId) return } - val existing = manager.activeNotifications.firstOrNull { it.id == summaryId } - val summaryChannel = channel ?: existing?.notification?.channelIdCompat() ?: return + val summaryChannel = channel + ?: active.firstOrNull { it.id == summaryId }?.notification?.channelIdCompat() + ?: return manager.notify( summaryId, builder(summaryChannel) .setSmallIcon(R.drawable.ic_stat_pipelines) .setContentTitle("Pipelines") - .setContentText("$members notifications") + .setContentText("$members $namespace") .setGroup(group) .setGroupSummary(true) - .setGroupAlertBehavior(Notification.GROUP_ALERT_CHILDREN) + .setGroupAlertBehavior(NotificationCompat.GROUP_ALERT_CHILDREN) .setAutoCancel(true) .build(), ) } + private fun threadNotificationId(thread: String): Int = DeliveryLedger.notificationId("thread:$thread") + private fun Notification.channelIdCompat(): String? = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) channelId else CONNECTION_CHANNEL - private fun openIntent(notification: ServerNotification, requestCode: Int): PendingIntent { + /** + * A tap opens the deep link and clears every id in [ids] (newline-separated + * in the extra), so the server marks the whole thread seen. + */ + private fun openIntent(ids: List, click: String, requestCode: Int): PendingIntent { val intent = Intent(context, MainActivity::class.java) .addFlags( Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_CLEAR_TOP, ) - .putExtra(EXTRA_NOTIFICATION_ID, notification.id) + .putExtra(EXTRA_NOTIFICATION_ID, ids.joinToString("\n")) // Only the app's own links are routed; Flutter's deep-link handling // turns pipelines://run/ and pipelines://chat/ into a route. - val click = Uri.parse(notification.click) - if (click.scheme == "pipelines") intent.setAction(Intent.ACTION_VIEW).setData(click) + val link = Uri.parse(click) + if (link.scheme == "pipelines") intent.setAction(Intent.ACTION_VIEW).setData(link) return PendingIntent.getActivity( context, requestCode, @@ -157,25 +219,31 @@ class NotificationPresenter(private val context: Context) { ) } - private fun dismissIntent(serverId: String, requestCode: Int): PendingIntent = + private fun dismissIntent(serverIds: List, requestCode: Int): PendingIntent = PendingIntent.getBroadcast( context, requestCode, Intent(context, NotificationDismissReceiver::class.java) .setAction(NotificationDismissReceiver.ACTION) - .putExtra(EXTRA_NOTIFICATION_ID, serverId), + .putExtra(EXTRA_NOTIFICATION_ID, serverIds.joinToString("\n")), PendingIntent.FLAG_IMMUTABLE or PendingIntent.FLAG_UPDATE_CURRENT, ) - private fun channelFor(notification: ServerNotification): String { - val kind = notification.kind.replace(Regex("[^A-Za-z0-9_.-]"), "_") - val priority = effectivePriority(kind, notification.priority) - val id = "pipelines.$kind.p$priority" + private fun applyLegacyPriority(builder: NotificationCompat.Builder, kind: String, priority: Int) { + if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) { + builder.setPriority(effectivePriority(kind, priority) - 3) + } + } + + private fun channelFor(kind: String, priorityValue: Int): String { + val kindName = kind.replace(Regex("[^A-Za-z0-9_.-]"), "_") + val priority = effectivePriority(kindName, priorityValue) + val id = "pipelines.$kindName.p$priority" if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) { - val groupId = "pipelines.kind.$kind" - manager.createNotificationChannelGroup(NotificationChannelGroup(groupId, kindLabel(kind))) - val name = if (priority == kindPriority(kind)) kindLabel(kind) - else "${kindLabel(kind)} (${priorityLabel(priority)})" + val groupId = "pipelines.kind.$kindName" + manager.createNotificationChannelGroup(NotificationChannelGroup(groupId, kindLabel(kindName))) + val name = if (priority == kindPriority(kindName)) kindLabel(kindName) + else "${kindLabel(kindName)} (${priorityLabel(priority)})" ensureChannel(id, name, importance(priority), groupId) } return id @@ -193,10 +261,9 @@ class NotificationPresenter(private val context: Context) { manager.createNotificationChannel(channel) } - @Suppress("DEPRECATION") - private fun builder(channel: String): Notification.Builder = - if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) Notification.Builder(context, channel) - else Notification.Builder(context) + /** NotificationCompat ignores the channel below API 26, so one builder serves every level. */ + private fun builder(channel: String): NotificationCompat.Builder = + NotificationCompat.Builder(context, channel) companion object { const val CONNECTION_ID = 1 @@ -204,7 +271,10 @@ class NotificationPresenter(private val context: Context) { /** The "sign in again" notice; ids up to RESERVED_IDS are the service's own. */ const val SIGN_IN_ID = 2 const val ACCOUNT_CHANNEL = "pipelines.account" + /** Holds the server id(s) a tap or dismissal clears, newline-separated. */ const val EXTRA_NOTIFICATION_ID = "net.awan.pipelines.notification_id" + /** Lines of a thread shown in its conversation; the unread count still counts all. */ + const val SHOWN_LINES = 5 private val KIND_LABELS = mapOf( "run_waiting" to "Run waiting for you", diff --git a/app/android/app/src/main/kotlin/net/awan/pipelines_app/notify/NotificationThreads.kt b/app/android/app/src/main/kotlin/net/awan/pipelines_app/notify/NotificationThreads.kt new file mode 100644 index 00000000..dcbab0b5 --- /dev/null +++ b/app/android/app/src/main/kotlin/net/awan/pipelines_app/notify/NotificationThreads.kt @@ -0,0 +1,167 @@ +package net.awan.pipelines_app.notify + +import org.json.JSONArray +import org.json.JSONObject + +/** + * One server notification kept as a message line in its thread (a chat or a + * run). [sender] names the line in the conversation view; [whenMillis] is the + * server's creation time, or the arrival time when the server sent none. + */ +data class ThreadEntry( + val id: String, + val kind: String, + val priority: Int, + val sender: String, + val text: String, + val click: String, + val whenMillis: Long, +) + +/** + * The per-thread message history that rebuilds a thread's notification after a + * service restart. Keyed by the server's `group` (`chat:` or `run:`); + * the count of entries is the unread count. Both the entries per thread and + * the threads kept are bounded, oldest first, so the store cannot grow without + * limit. Threads are kept in most-recently-active order. + */ +class ThreadHistory( + private val store: LedgerStore, + private val maxEntries: Int = MAX_ENTRIES, + private val maxThreads: Int = MAX_THREADS, +) { + /** The entries of [thread], oldest first; empty when the thread is unknown. */ + fun entries(thread: String): List = load()[thread].orEmpty() + + /** The thread holding [id], if any. */ + fun threadOf(id: String): String? = load().entries.firstOrNull { (_, list) -> + list.any { it.id == id } + }?.key + + /** Adds [entry] to the end of [thread], which becomes the most recent thread. */ + fun append(thread: String, entry: ThreadEntry) { + val threads = load() + val list = threads.remove(thread).orEmpty().toMutableList() + list.add(entry) + while (list.size > maxEntries) list.removeAt(0) + threads[thread] = list + while (threads.size > maxThreads) threads.remove(threads.keys.first()) + save(threads) + } + + /** + * Removes the entries with [ids]. Returns the threads whose entries changed; + * a thread left empty is dropped from the store. + */ + fun remove(ids: Collection): Set { + val wanted = ids.toSet() + val threads = load() + val touched = mutableSetOf() + for ((thread, list) in threads) { + if (list.removeAll { it.id in wanted }) touched.add(thread) + } + threads.entries.removeAll { it.value.isEmpty() } + if (touched.isNotEmpty()) save(threads) + return touched + } + + /** Forgets every thread, for example when the server changes. */ + fun clear() = store.putString(KEY, null) + + private fun load(): LinkedHashMap> { + val threads = LinkedHashMap>() + val raw = store.getString(KEY) ?: return threads + try { + val array = JSONArray(raw) + for (index in 0 until array.length()) { + val thread = array.getJSONObject(index) + val entries = thread.getJSONArray("entries") + threads[thread.getString("thread")] = (0 until entries.length()) + .map { entryFrom(entries.getJSONObject(it)) } + .toMutableList() + } + } catch (_: Exception) { + // A corrupt store starts again empty rather than failing every post. + threads.clear() + } + return threads + } + + private fun save(threads: Map>) { + if (threads.isEmpty()) return store.putString(KEY, null) + val array = JSONArray() + for ((thread, list) in threads) { + array.put( + JSONObject() + .put("thread", thread) + .put("entries", JSONArray(list.map(::entryJson))), + ) + } + store.putString(KEY, array.toString()) + } + + private fun entryJson(entry: ThreadEntry): JSONObject = JSONObject() + .put("id", entry.id) + .put("kind", entry.kind) + .put("priority", entry.priority) + .put("sender", entry.sender) + .put("text", entry.text) + .put("click", entry.click) + .put("whenMillis", entry.whenMillis) + + private fun entryFrom(json: JSONObject) = ThreadEntry( + id = json.optString("id"), + kind = json.optString("kind"), + priority = json.optInt("priority", 3), + sender = json.optString("sender"), + text = json.optString("text"), + click = json.optString("click"), + whenMillis = json.optLong("whenMillis"), + ) + + companion object { + const val KEY = "threads.history" + /** Unread entries kept per thread; the count shown is at most this. */ + const val MAX_ENTRIES = 100 + /** Threads kept; the oldest thread is forgotten first. */ + const val MAX_THREADS = 50 + } +} + +/** Naming rules for threads, shared by the presenter and its tests. */ +object NotificationThreads { + /** `chat:` and `run:` map to their own group; any other group is generic. */ + fun namespaceOf(group: String): String = when (group.substringBefore(':')) { + "chat" -> "chats" + "run" -> "runs" + else -> "notifications" + } + + /** The Android group key that bundles one namespace's thread notifications. */ + fun groupKey(namespace: String): String = "pipelines.$namespace" + + /** + * The chat's own title. The server titles a chat question or approval + * " needs your answer" (or "... needs your approval"); the chat title + * is what names the message. Run titles are used as they are. + */ + fun senderOf(kind: String, title: String): String { + val plain = title.trim() + if (!kind.startsWith("chat_")) return plain.ifEmpty { "Pipelines" } + return plain.removeSuffix(" needs your answer") + .removeSuffix(" needs your approval") + .trim() + .ifEmpty { "Chat" } + } + + /** Builds the entry for a server notification that arrived at [receivedMillis]. */ + fun entryOf(notification: ServerNotification, receivedMillis: Long): ThreadEntry = ThreadEntry( + id = notification.id, + kind = notification.kind, + priority = notification.priority, + sender = senderOf(notification.kind, notification.title), + text = notification.message.ifEmpty { notification.title }, + click = notification.click, + whenMillis = NotificationPresenter.createdMillis(notification.createdAt) ?: receivedMillis, + ) +} diff --git a/app/android/app/src/test/kotlin/net/awan/pipelines_app/notify/ThreadHistoryTest.kt b/app/android/app/src/test/kotlin/net/awan/pipelines_app/notify/ThreadHistoryTest.kt new file mode 100644 index 00000000..a487acb0 --- /dev/null +++ b/app/android/app/src/test/kotlin/net/awan/pipelines_app/notify/ThreadHistoryTest.kt @@ -0,0 +1,118 @@ +package net.awan.pipelines_app.notify + +import org.junit.Assert.assertEquals +import org.junit.Assert.assertNull +import org.junit.Assert.assertTrue +import org.junit.Test + +class ThreadHistoryTest { + private class MemoryStore : LedgerStore { + val values = mutableMapOf() + override fun getString(key: String) = values[key] + override fun putString(key: String, value: String?) { + if (value == null) values.remove(key) else values[key] = value + } + } + + private fun entry(id: String, sender: String = "Chat A", text: String = "text $id") = ThreadEntry( + id = id, + kind = "chat_reply", + priority = 3, + sender = sender, + text = text, + click = "pipelines://chat/a", + whenMillis = 1_000L, + ) + + @Test + fun entriesAreKeptPerThreadInArrivalOrder() { + val history = ThreadHistory(MemoryStore()) + history.append("chat:a", entry("1")) + history.append("run:7", entry("2")) + history.append("chat:a", entry("3")) + assertEquals(listOf("1", "3"), history.entries("chat:a").map { it.id }) + assertEquals(listOf("2"), history.entries("run:7").map { it.id }) + assertEquals("chat:a", history.threadOf("3")) + assertNull(history.threadOf("missing")) + } + + @Test + fun entriesPerThreadAreBoundedOldestFirst() { + val history = ThreadHistory(MemoryStore(), maxEntries = 3) + (1..5).forEach { history.append("chat:a", entry("$it")) } + assertEquals(listOf("3", "4", "5"), history.entries("chat:a").map { it.id }) + } + + @Test + fun threadsAreBoundedAndTheOldestIsForgottenFirst() { + val history = ThreadHistory(MemoryStore(), maxThreads = 2) + history.append("chat:a", entry("1")) + history.append("chat:b", entry("2")) + history.append("chat:a", entry("3")) + history.append("chat:c", entry("4")) + assertTrue(history.entries("chat:b").isEmpty()) + assertEquals(listOf("1", "3"), history.entries("chat:a").map { it.id }) + assertEquals(listOf("4"), history.entries("chat:c").map { it.id }) + } + + @Test + fun historySurvivesANewInstanceOnTheSameStore() { + val store = MemoryStore() + ThreadHistory(store).append("chat:a", entry("1", sender = "Build bot", text = "done")) + val reopened = ThreadHistory(store).entries("chat:a") + assertEquals(1, reopened.size) + assertEquals("Build bot", reopened[0].sender) + assertEquals("done", reopened[0].text) + assertEquals("pipelines://chat/a", reopened[0].click) + assertEquals(1_000L, reopened[0].whenMillis) + } + + @Test + fun corruptStoreStartsEmpty() { + val store = MemoryStore().apply { values[ThreadHistory.KEY] = "not json" } + val history = ThreadHistory(store) + assertTrue(history.entries("chat:a").isEmpty()) + history.append("chat:a", entry("1")) + assertEquals(listOf("1"), history.entries("chat:a").map { it.id }) + } + + @Test + fun removeReturnsTouchedThreadsAndDropsEmptyOnes() { + val history = ThreadHistory(MemoryStore()) + history.append("chat:a", entry("1")) + history.append("chat:a", entry("2")) + history.append("run:7", entry("3")) + val touched = history.remove(listOf("1", "3", "unknown")) + assertEquals(setOf("chat:a", "run:7"), touched) + assertEquals(listOf("2"), history.entries("chat:a").map { it.id }) + assertTrue(history.entries("run:7").isEmpty()) + assertEquals(emptySet(), history.remove(listOf("unknown"))) + } + + @Test + fun clearForgetsEveryThread() { + val store = MemoryStore() + val history = ThreadHistory(store) + history.append("chat:a", entry("1")) + history.clear() + assertTrue(history.entries("chat:a").isEmpty()) + assertNull(store.getString(ThreadHistory.KEY)) + } + + @Test + fun chatTitlesDropTheQuestionSuffix() { + assertEquals("Deploy review", NotificationThreads.senderOf("chat_question", "Deploy review needs your answer")) + assertEquals("Deploy review", NotificationThreads.senderOf("chat_approval", "Deploy review needs your approval")) + assertEquals("Chat", NotificationThreads.senderOf("chat_question", "Chat needs your answer")) + assertEquals("Pipelines", NotificationThreads.senderOf("run_failed", " ")) + assertEquals("Run needs your decision", NotificationThreads.senderOf("run_waiting", "Run needs your decision")) + } + + @Test + fun namespacesSeparateChatsFromRuns() { + assertEquals("chats", NotificationThreads.namespaceOf("chat:s1")) + assertEquals("runs", NotificationThreads.namespaceOf("run:7")) + assertEquals("pipelines.chats", NotificationThreads.groupKey("chats")) + assertEquals("pipelines.runs", NotificationThreads.groupKey("runs")) + } +} diff --git a/app/lib/features/chat/chat_screen_float.dart b/app/lib/features/chat/chat_screen_float.dart index a138957b..56e9638b 100644 --- a/app/lib/features/chat/chat_screen_float.dart +++ b/app/lib/features/chat/chat_screen_float.dart @@ -46,6 +46,7 @@ mixin _ChatScreenFloat on State, _ChatScreenWorkspace { final pane = _workspace.detach(paneId); if (pane == null) return; widget.windows?.float(pane.sessionId); + _syncOpenWorkspace(); // Floating the last tiled chat leaves the list, as closing it does. if (_workspace.paneCount == 0) _back(); } @@ -61,6 +62,7 @@ mixin _ChatScreenFloat on State, _ChatScreenWorkspace { _floatPane(pane.id); } else { windows.float(id); + _syncOpenWorkspace(); } } @@ -69,6 +71,7 @@ mixin _ChatScreenFloat on State, _ChatScreenWorkspace { _workspaceVisible = true; if (!_pageOpen && showsListBesideDetail(context)) _usedWorkspace = true; _workspace.dock(sessionId); + _syncOpenWorkspace(); _composerFocus.request(sessionId); } diff --git a/app/lib/features/chat/chat_screen_workspace.dart b/app/lib/features/chat/chat_screen_workspace.dart index faf1f847..65cea8d2 100644 --- a/app/lib/features/chat/chat_screen_workspace.dart +++ b/app/lib/features/chat/chat_screen_workspace.dart @@ -80,11 +80,61 @@ mixin _ChatScreenWorkspace on State { void _openSidebarSession(JsonMap session); final ChatWorkspaceController _workspace = ChatWorkspaceController(); + ChatOpenWorkspaceController? _openWorkspace; + bool _applyingServerWorkspace = false; ChatWorkspaceBinding? _workspaceBinding; String? _workspaceScope; + Iterable _serverWorkspaceEntries() sync* { + final floating = + widget.windows?.floatingSessionIds.toSet() ?? const {}; + for (final pane in _workspace.panes) { + yield ChatOpenWorkspaceEntry( + pane.sessionId, + floating: floating.contains(pane.sessionId), + ); + } + for (final sessionId in floating) { + if (!_workspace.holdsSession(sessionId)) { + yield ChatOpenWorkspaceEntry(sessionId, floating: true); + } + } + } + + /// Sends this device's open chats to the server, unless the change is the + /// server's own snapshot being applied. + void _syncOpenWorkspace() { + if (_applyingServerWorkspace) return; + _openWorkspace?.replace(_serverWorkspaceEntries()); + } + + /// Binds the server's open-chat set for [widget.gateway], disposing the + /// previous binding (its subscription and queued writes) first. A + /// federated list spans several servers, so it keeps its local layout. + void _bindOpenWorkspace({required Future after}) { + _openWorkspace?.dispose(); + _openWorkspace = null; + _openWorkspaceApplied = false; + if (!widget.persistWorkspace || widget.gateway is FederatedChatGateway) { + return; + } + final open = ChatOpenWorkspaceController(gateway: widget.gateway) + ..onChanged = _applyOpenWorkspace; + _openWorkspace = open; + // Seed from the restored local layout once it is restored. + unawaited( + after.then((_) async { + if (!mounted || open.disposed) return; + await open.start(local: _serverWorkspaceEntries()); + }), + ); + } + void _bindWorkspacePersistence() { - if (!widget.persistWorkspace) return; + if (!widget.persistWorkspace) { + _bindOpenWorkspace(after: Future.value()); + return; + } final scope = serverStorageScope(serverIdentity(widget.gateway)); _workspaceScope = scope; _workspaceBinding = ChatWorkspaceBinding( @@ -112,19 +162,105 @@ mixin _ChatScreenWorkspace on State { _publishWorkspaceRoute(); }, ); - unawaited( - _workspaceBinding!.start(initialSessionId: widget.initialSessionId), + _bindOpenWorkspace( + after: _workspaceBinding!.start( + initialSessionId: widget.initialSessionId, + ), ); } + /// Whether a server snapshot was applied since binding. The first one keeps + /// the chat this visit was opened on (a deep link) and adds it if absent. + bool _openWorkspaceApplied = false; + + /// Applies the server's membership: windows and panes for chats it no + /// longer lists close, floating state follows it, and tiled chats take its + /// order while this device's split geometry stays. + void _applyOpenWorkspace(ChatOpenWorkspaceSnapshot snapshot) { + if (!mounted) return; + final initial = widget.initialSessionId ?? ''; + final first = !_openWorkspaceApplied; + final keepInitial = + first && + initial.isNotEmpty && + !snapshot.entries.any((entry) => entry.sessionId == initial); + _openWorkspaceApplied = true; + if (keepInitial) { + snapshot = ChatOpenWorkspaceSnapshot(snapshot.revision, [ + ...snapshot.entries, + ChatOpenWorkspaceEntry(initial), + ]); + } + _applyingServerWorkspace = true; + try { + final windows = widget.windows; + if (windows != null) { + final entriesBySession = { + for (final entry in snapshot.entries) entry.sessionId: entry, + }; + for (final window in windows.windows.toList()) { + if (!entriesBySession.containsKey(window.contentId)) { + windows.manager.close(window.id); + } + } + for (final entry in snapshot.entries) { + final localWindow = windows.windows + .where((window) => window.contentId == entry.sessionId) + .firstOrNull; + if (entry.floating && localWindow == null) { + final pane = _workspace.panes + .where((pane) => pane.sessionId == entry.sessionId) + .firstOrNull; + if (pane != null) _workspace.close(pane.id); + windows.float(entry.sessionId); + } else if (!entry.floating && localWindow != null) { + windows.dock(localWindow); + } + } + } + _workspace.reconcileSessions( + snapshot.entries + .where((entry) => !entry.floating) + .map((entry) => entry.sessionId), + ); + if (keepInitial) { + final pane = _workspace.panes + .where((pane) => pane.sessionId == initial) + .firstOrNull; + if (pane != null) _workspace.activate(pane.id); + } + if (_workspace.paneCount == 0 && _workspaceVisible) _back(); + } finally { + _applyingServerWorkspace = false; + } + // The first snapshot shows the server's chats as a restored layout does; + // later ones never pull this device into a chat another one opened. + if (first && _workspace.paneCount > 0 && !_workspaceVisible) { + setState(() { + _usedWorkspace = true; + _workspaceVisible = true; + }); + _publishWorkspaceRoute(); + } + if (keepInitial) _syncOpenWorkspace(); + } + bool _updateWorkspacePersistence(ChatScreen oldWidget) { final scope = serverStorageScope(serverIdentity(widget.gateway)); if (oldWidget.persistWorkspace == widget.persistWorkspace && (!widget.persistWorkspace || scope == _workspaceScope)) { + // Another connection to the same server: only the open-chat sync + // follows the gateway. + if (widget.persistWorkspace && + !identical(oldWidget.gateway, widget.gateway)) { + _bindOpenWorkspace(after: Future.value()); + } return false; } _workspaceBinding?.dispose(); _workspaceBinding = null; + _openWorkspace?.dispose(); + _openWorkspace = null; if (_workspaceScope != null && scope != _workspaceScope) { _workspace.restoreLayout(ChatWorkspaceSnapshot.fromLayout(null, null)!); _workspaceVisible = false; @@ -200,6 +336,7 @@ mixin _ChatScreenWorkspace on State { '${_workspace.activePaneId}:${_workspace.panes.map((p) => '${p.id}=${p.sessionId}').join(',')}'; if (_workspaceSignature == signature) return; _workspaceSignature = signature; + _syncOpenWorkspace(); void update() { if (!mounted) return; setState(() {}); diff --git a/app/lib/features/chat/screen.dart b/app/lib/features/chat/screen.dart index 1cb25567..e8095ff1 100644 --- a/app/lib/features/chat/screen.dart +++ b/app/lib/features/chat/screen.dart @@ -31,6 +31,8 @@ import 'workspace/chat_float_shortcut.dart'; import 'workspace/chat_workspace_binding.dart'; import 'workspace/chat_workspace_snapshot.dart'; import 'workspace/chat_workspace_store.dart'; +import 'workspace/chat_open_workspace_controller.dart'; +import 'workspace/chat_open_workspace_gateway.dart'; import 'conversation/chat_bar_tint.dart'; import 'conversation/chat_pane_picker.dart'; import 'conversation/chat_add_pane_picker.dart'; @@ -383,6 +385,7 @@ class _ChatScreenState extends State HardwareKeyboard.instance.removeHandler(_slashFocusKey); _page.dispose(); _workspaceBinding?.dispose(); + _openWorkspace?.dispose(); _unbindWindows(); _workspace.removeListener(_workspaceChanged); _workspace.dispose(); diff --git a/app/lib/features/chat/windows/chat_windows.dart b/app/lib/features/chat/windows/chat_windows.dart index 683332d7..0a57fa51 100644 --- a/app/lib/features/chat/windows/chat_windows.dart +++ b/app/lib/features/chat/windows/chat_windows.dart @@ -75,6 +75,9 @@ class ChatWindows { Iterable get windows => manager.windows.where((w) => w.kind == chatWindowKind); + Iterable get floatingSessionIds => + windows.map((window) => window.contentId); + /// Registers the kind and starts answering the chord. Call before the /// manager restores, so saved chat windows are kept. void start() { diff --git a/app/lib/features/chat/workspace/chat_open_workspace_controller.dart b/app/lib/features/chat/workspace/chat_open_workspace_controller.dart new file mode 100644 index 00000000..3448b9fa --- /dev/null +++ b/app/lib/features/chat/workspace/chat_open_workspace_controller.dart @@ -0,0 +1,115 @@ +import 'dart:async'; +import '../../../core/api_gateway.dart'; +import 'chat_open_workspace_gateway.dart'; + +/// Keeps one device's open chats in step with the server's open-chat set. +/// +/// Writes are serialized: one is in flight at a time, and changes made while +/// it is pending coalesce into the latest full snapshot, sent next from the +/// revision the reply reported. Every reply and push is reconciled by server +/// revision, so a late or reordered one never overwrites newer state. A +/// snapshot from another device (or a refused stale write) wins over local +/// changes not yet sent, and reaches [onChanged]. +class ChatOpenWorkspaceController { + ChatOpenWorkspaceController({required ApiGateway gateway}) + : _gateway = ChatOpenWorkspaceGateway(gateway); + final ChatOpenWorkspaceGateway _gateway; + StreamSubscription? _subscription; + bool _disposed = false; + bool _writing = false; + List? _pending; + ChatOpenWorkspaceSnapshot? _current; + + /// Applies a server snapshot to the device's panes and windows. + void Function(ChatOpenWorkspaceSnapshot snapshot)? onChanged; + + /// The latest server revision this device has seen; 0 before any. + int get revision => _current?.revision ?? 0; + + /// Whether the server answered, so local changes are sent. Before that (or + /// against a server without the request) the device keeps its own layout. + bool get ready => _current != null; + + bool get disposed => _disposed; + + /// Subscribes to pushes, then seeds the server from [local] (the device's + /// restored layout, migrated once from the old local snapshot) or, with no + /// local chats, reads the server's set. The server's answer is applied. + Future start({ + Iterable local = const [], + }) async { + if (_subscription != null || _disposed) return; + _subscription = _gateway.changes.listen(_accept); + final entries = local.toList(growable: false); + ChatOpenWorkspaceSnapshot? snapshot; + try { + snapshot = entries.isEmpty + ? await _gateway.read() + : await _gateway.replace(entries, seed: true); + } on Object { + return; + } + if (snapshot != null) _accept(snapshot, force: true); + } + + /// Sends the device's full open-chat set. Ignored until [ready]; coalesced + /// while a write is in flight. + void replace(Iterable entries) { + if (_disposed || !ready) return; + _pending = entries.toList(growable: false); + if (!_writing) unawaited(_drain()); + } + + Future _drain() async { + _writing = true; + try { + while (!_disposed) { + final sent = _pending; + _pending = null; + if (sent == null) return; + final current = _current; + if (current != null && current.sameEntries(sent)) continue; + ChatOpenWorkspaceSnapshot? reply; + try { + reply = await _gateway.replace(sent, baseRevision: revision); + } on Object { + reply = null; + } + if (_disposed || reply == null || reply.revision < revision) continue; + if (reply.rejected) { + // Another change landed first: the server's state wins over this + // write and anything queued behind it. + _accept(reply, force: true); + } else { + // The server may have left out closed or unknown chats. This device + // keeps showing them (a closed chat can still be read here); the + // other devices never receive them. + _current = reply; + } + } + } finally { + _writing = false; + } + } + + void _accept(ChatOpenWorkspaceSnapshot snapshot, {bool force = false}) { + if (_disposed) return; + final current = _current; + if (current != null && + (snapshot.revision < current.revision || + (!force && snapshot.revision == current.revision))) { + return; + } + _current = snapshot; + _pending = null; + onChanged?.call(snapshot); + } + + void dispose() { + _disposed = true; + _pending = null; + onChanged = null; + unawaited(_subscription?.cancel()); + _subscription = null; + } +} diff --git a/app/lib/features/chat/workspace/chat_open_workspace_gateway.dart b/app/lib/features/chat/workspace/chat_open_workspace_gateway.dart new file mode 100644 index 00000000..b5bf1df1 --- /dev/null +++ b/app/lib/features/chat/workspace/chat_open_workspace_gateway.dart @@ -0,0 +1,107 @@ +import '../../../core/api_gateway.dart'; + +/// One chat in the server-owned open-chat set: its session and whether it is +/// floating. Geometry stays on the device. +class ChatOpenWorkspaceEntry { + const ChatOpenWorkspaceEntry(this.sessionId, {this.floating = false}); + final String sessionId; + final bool floating; + Map toJson() => { + 'session_id': sessionId, + if (floating) 'floating': true, + }; + static ChatOpenWorkspaceEntry? fromJson(Object? value) { + if (value is! Map) return null; + final id = '${value['session_id'] ?? ''}'.trim(); + return id.isEmpty + ? null + : ChatOpenWorkspaceEntry(id, floating: value['floating'] == true); + } +} + +/// The complete open-chat set at one server revision. [rejected] marks the +/// reply to a write from a stale base: the write was not applied and this is +/// the current state. +class ChatOpenWorkspaceSnapshot { + const ChatOpenWorkspaceSnapshot( + this.revision, + this.entries, { + this.rejected = false, + }); + final int revision; + final List entries; + final bool rejected; + + bool sameEntries(Iterable other) { + final list = other.toList(growable: false); + if (list.length != entries.length) return false; + for (var i = 0; i < list.length; i++) { + if (list[i].sessionId != entries[i].sessionId || + list[i].floating != entries[i].floating) { + return false; + } + } + return true; + } + + static ChatOpenWorkspaceSnapshot? fromJson(Object? value) { + if (value is! Map || value['entries'] is! List) return null; + final entries = []; + for (final item in value['entries'] as List) { + final entry = ChatOpenWorkspaceEntry.fromJson(item); + if (entry == null || + entries.any((old) => old.sessionId == entry.sessionId)) { + return null; + } + entries.add(entry); + } + if (entries.length > 64) return null; + return ChatOpenWorkspaceSnapshot( + (value['revision'] as num?)?.toInt() ?? 0, + List.unmodifiable(entries), + rejected: value['rejected'] == true, + ); + } +} + +/// The `chat_open_workspace` request and its `chat_open_workspace_changed` +/// push, decoded. +class ChatOpenWorkspaceGateway { + ChatOpenWorkspaceGateway(this.gateway); + final ApiGateway gateway; + + /// The current snapshot, without changing it. + Future read() async { + final response = await gateway.call('chat_open_workspace'); + return ChatOpenWorkspaceSnapshot.fromJson(response['chat_open_workspace']); + } + + /// Replaces the set, derived from [baseRevision]. A [seed] applies only + /// when the server never stored a set and otherwise returns the stored one. + Future replace( + Iterable entries, { + int baseRevision = 0, + bool seed = false, + }) async { + final response = await gateway.call('chat_open_workspace', { + 'chat_open_workspace_request': { + 'entries': entries + .map((entry) => entry.toJson()) + .toList(growable: false), + 'base_revision': baseRevision, + if (seed) 'seed': true, + }, + }); + return ChatOpenWorkspaceSnapshot.fromJson(response['chat_open_workspace']); + } + + Stream get changes async* { + await for (final frame in gateway.frames) { + if (frame['type'] != 'chat_open_workspace_changed') continue; + final snapshot = ChatOpenWorkspaceSnapshot.fromJson( + frame['chat_open_workspace'], + ); + if (snapshot != null) yield snapshot; + } + } +} diff --git a/app/lib/features/chat/workspace/chat_workspace_controller.dart b/app/lib/features/chat/workspace/chat_workspace_controller.dart index a3e5d7c8..fdc825a5 100644 --- a/app/lib/features/chat/workspace/chat_workspace_controller.dart +++ b/app/lib/features/chat/workspace/chat_workspace_controller.dart @@ -1,6 +1,7 @@ import 'package:flutter/foundation.dart'; import 'chat_workspace_nodes.dart'; +import 'chat_workspace_reconcile.dart'; import 'chat_workspace_snapshot.dart'; export 'chat_workspace_nodes.dart'; @@ -203,6 +204,23 @@ class ChatWorkspaceController extends ChangeNotifier { _changed(); } + /// Tiles exactly [sessionIds] in order, as the server's open-chat set + /// names them, keeping this device's geometry (see + /// [reconcileChatWorkspaceTree]). Floating membership is the window host's. + void reconcileSessions(Iterable sessionIds) { + final wanted = []; + final seen = {}; + for (final id in sessionIds) { + if (id.isNotEmpty && seen.add(id)) wanted.add(id); + } + final next = reconcileChatWorkspaceTree(_root, wanted, _id); + if (identical(next, _root)) return; + _root = next; + final ids = panes.map((pane) => pane.id).toSet(); + if (!ids.contains(_active)) _active = ids.firstOrNull; + _changed(); + } + void replaceSession(String oldId, String newId) { if (oldId == newId || newId.isEmpty || _replaceFloating(oldId, newId)) { return; diff --git a/app/lib/features/chat/workspace/chat_workspace_reconcile.dart b/app/lib/features/chat/workspace/chat_workspace_reconcile.dart new file mode 100644 index 00000000..537cccf9 --- /dev/null +++ b/app/lib/features/chat/workspace/chat_workspace_reconcile.dart @@ -0,0 +1,118 @@ +import 'chat_workspace_nodes.dart'; + +/// Returns [root] tiled with exactly [wanted] (distinct session ids) in +/// order, keeping the local geometry: panes whose chat left are removed with +/// their splits, surviving panes keep their ids and split sizes and move +/// between slots to follow the order, and new chats split off the last pane. +/// Returns [root] itself when it already matches. +ChatWorkspaceNode? reconcileChatWorkspaceTree( + ChatWorkspaceNode? root, + List wanted, + String Function(String kind) newId, +) { + if (wanted.isEmpty) return null; + final keep = wanted.toSet(); + final seen = {}; + var node = root == null ? null : _retain(root, keep, seen); + final leaves = node == null ? [] : _leaves(node).toList(); + final bySession = {for (final pane in leaves) pane.sessionId: pane}; + final order = wanted.where(bySession.containsKey).toList(); + var slot = 0; + if (node != null) { + node = _reorder(node, () => bySession[order[slot++]]!); + } + for (final id in wanted.where((id) => !bySession.containsKey(id))) { + final added = ChatWorkspacePane(newId('pane'), id); + if (node == null) { + node = added; + continue; + } + final last = _leaves(node).last; + node = _swapLeaf( + node, + last.id, + ChatWorkspaceSplit(newId('split'), ChatSplitAxis.horizontal, last, added), + ); + } + return _same(node, root) ? root : node; +} + +Iterable _leaves(ChatWorkspaceNode node) sync* { + if (node is ChatWorkspacePane) yield node; + if (node is ChatWorkspaceSplit) { + yield* _leaves(node.first); + yield* _leaves(node.second); + } +} + +/// Drops panes outside [keep] and repeats of a session already kept. +ChatWorkspaceNode? _retain( + ChatWorkspaceNode node, + Set keep, + Set seen, +) { + if (node is ChatWorkspacePane) { + return keep.contains(node.sessionId) && seen.add(node.sessionId) + ? node + : null; + } + final split = node as ChatWorkspaceSplit; + final first = _retain(split.first, keep, seen); + final second = _retain(split.second, keep, seen); + if (first == null) return second; + if (second == null) return first; + return ChatWorkspaceSplit( + split.id, + split.axis, + first, + second, + ratio: split.ratio, + ); +} + +ChatWorkspaceNode _reorder( + ChatWorkspaceNode node, + ChatWorkspacePane Function() next, +) { + if (node is ChatWorkspacePane) return next(); + final split = node as ChatWorkspaceSplit; + final first = _reorder(split.first, next); + return ChatWorkspaceSplit( + split.id, + split.axis, + first, + _reorder(split.second, next), + ratio: split.ratio, + ); +} + +ChatWorkspaceNode _swapLeaf( + ChatWorkspaceNode node, + String id, + ChatWorkspaceNode replacement, +) { + if (node.id == id) return replacement; + if (node is! ChatWorkspaceSplit) return node; + return ChatWorkspaceSplit( + node.id, + node.axis, + _swapLeaf(node.first, id, replacement), + _swapLeaf(node.second, id, replacement), + ratio: node.ratio, + ); +} + +bool _same(ChatWorkspaceNode? a, ChatWorkspaceNode? b) { + if (a == null || b == null) return a == b; + if (a is ChatWorkspacePane && b is ChatWorkspacePane) { + return a.id == b.id && a.sessionId == b.sessionId; + } + if (a is ChatWorkspaceSplit && b is ChatWorkspaceSplit) { + return a.id == b.id && + a.axis == b.axis && + a.ratio == b.ratio && + _same(a.first, b.first) && + _same(a.second, b.second); + } + return false; +} diff --git a/app/notes/chat-open-workspace-sync.md b/app/notes/chat-open-workspace-sync.md new file mode 100644 index 00000000..cd21250a --- /dev/null +++ b/app/notes/chat-open-workspace-sync.md @@ -0,0 +1,63 @@ +# Server-authoritative open chat workspace + +## Behaviour + +The authenticated `/connect` protocol stores one bounded ordered open-chat set +per server scope (`default`). Entries hold only an operator session id and a +floating bit; split ratios, pane ids and window rectangles stay on the device. + +* `chat_open_workspace` without `chat_open_workspace_request` reads the set. + With a request it replaces the set as a compare-and-swap on `base_revision`: + a write from a stale base is not applied and the reply carries the current + set with `rejected: true`. Each stored change increments `revision`; an + identical write stores nothing. +* `seed: true` applies only when the server never stored a set (even an + emptied set wins over an old device-local snapshot), so the migration from + the old local layout happens once. +* Stored changes are pushed to every other connection as + `chat_open_workspace_changed`. Pushes run on separate goroutines and can + arrive out of order; clients keep the highest revision. +* Only recorded, not-closed operator chats are kept (registry check; the broker + is not asked, so validation never starts a harness). `chat_close` drops the + chat and pushes the new revision to every connection. A new connection + prunes stale entries and pushes the result to all connections, else sends + the current set to the new connection only (reconnect catch-up). + +App (`ChatOpenWorkspaceController`): one write in flight at a time; later +changes coalesce into the newest full set, sent from the revision of the last +reply. Pushes and replies with a lower (or, for pushes, equal) revision are +ignored. A push or a rejected reply wins over unsent local changes. After the +local layout is restored, the device seeds (or, with no chats, reads) and +applies the answer; the first answer keeps a deep-linked chat. Server drops in +a successful reply are not applied locally, so a closed chat can still be read +on the device that opened it, but no other device receives it. Remote +membership is applied with `reconcileChatWorkspaceTree`: removed chats' panes +go, survivors keep pane ids and split sizes and move to follow the order, new +chats split off the last pane. The controller is disposed on a server or +gateway rebind. A federated (all-servers) list keeps its local layout. + +Ctrl+Tab: main's behaviour (floating chats when shown, else visible panes) is +kept; the single-pane recent-chat swap is removed there. + +## Verification + +* Go: `internal/pipeline` `TestChatOpenWorkspace*` (seed once, stale revision, + remove, bounds); `internal/server` `TestChatOpenWorkspaceSyncsEveryConnection` + (two connections get the same snapshot, stale write rejected, reorder, + close pruned and pushed to both, closed chat not restorable) and + `TestChatOpenWorkspacePrunesOnConnectForEveryone`. +* App: `test/features/chat/workspace/chat_open_workspace_controller_test.dart` + (serialized writes, late reply vs newer push, rejected write, dispose), + `chat_workspace_reconcile_test.dart`, and + `test/features/chat/chat_open_workspace_sync_test.dart` (seed migration, + remote removal drops the pane, server set wins over an old local snapshot, + rebind disposes the old sync). +* Live two-client check (2026-11-12): server built from this worktree, run on + an OS-assigned loopback port with a scratch HOME/XDG and database, three + scratch operator rows; a Node script drove two websocket clients through + read, open, reorder, stale write, float, pane close, `chat_close`, write-back + of the closed chat, and an out-of-band close pruned on a third connection. + All 16 checks passed (`RESULT: PASS`); every connection received the same + revisions. The scratch server and its own OpenCode child were stopped. + +Not verified: rendered UI captures and on-device behaviour. diff --git a/app/notes/notification-thread-grouping.md b/app/notes/notification-thread-grouping.md new file mode 100644 index 00000000..353570bc --- /dev/null +++ b/app/notes/notification-thread-grouping.md @@ -0,0 +1,71 @@ +# Android notifications grouped per chat and run + +## What changed (native service only; Flutter unchanged) + +- `android/.../notify/NotificationThreads.kt` (new): `ThreadEntry`, `ThreadHistory` + (bounded per-thread entries, bounded thread count, persisted through the + ledger's `LedgerStore` under `threads.history`), and naming helpers. Threads are + keyed by the server `group` (`chat:` or `run:`, per `docs/ntfy.md`). +- `NotificationPresenter.kt`: a grouped notification posts one conversation + notification per thread with a stable id (`thread:`), the latest 5 lines + (sender = chat title, run title for runs), the unread count (`setNumber`), and a + shared group per namespace (`pipelines.chats`, `pipelines.runs`). The group + summary reads "N chats" / "N runs" and is removed when fewer than two are shown. + Empty-group notifications keep the old standalone path. Channels and importance + are unchanged (`channelFor` takes kind and priority, same rules). +- `cancel(ids)` removes the cleared entries from history, drops a thread whose + entries are all gone, and reposts a partially cleared thread with its new count. + `cancelAll()` also clears the history. +- `NotificationDismissReceiver.kt`: `EXTRA_NOTIFICATION_ID` may carry several + newline-separated ids, so a tap or swipe on a thread clears every entry it shows. +- `NotificationService.kt`, the ledger and the protocol are untouched, so run 405's + reconnect/wakelock work is not affected. + +## Review fix (visit 2) + +- The thread notification now uses `androidx.core.app.NotificationCompat.MessagingStyle` + with `androidx.core.app.Person`, built by `NotificationCompat.Builder` (the presenter's + builder is compat throughout). Platform `Notification.MessagingStyle` and its API 28 + BigTextStyle fallback are gone; the compat style renders on every supported API level. +- `app/android/app/build.gradle.kts` adds `implementation("androidx.core:core:1.15.0")` + (already in the offline Gradle cache). + +## Focused results + +- Gradle 9.1.0 (cached), `--offline`, JDK 17 (`/opt/homebrew/opt/openjdk@17`): + `:app:testDebugUnitTest --tests 'net.awan.pipelines_app.notify.*'` → BUILD SUCCESSFUL. + JUnit XML: ThreadHistoryTest 9 tests / 0 failures, DeliveryLedgerTest 8 / 0, + NotificationProtocolTest 12 / 0. +- `tool/analyze.sh` (run from `app/`, after the Kotlin tests): clean, exit 0. +- No Flutter test was run: no Dart source changed. +- JDK 27 fails the Android JDK image transform (`jlink`) in a plugin, so builds here + need JDK 17 (environment issue, unrelated to this change). + +## Affected states + +- No Flutter UI changed. Native states not exercised on a device: a second chat + appearing as a thread, a summary at 2 and 1 chats, tap/swipe on a multi-line + thread, and the restart rebuild from persisted history. + +## Merge with main (land re-entry) + +- main moved `NotificationPresenter.kt` (sign-in notice, `openApp()` helper, + `SIGN_IN_ID`, `ACCOUNT_CHANNEL`). Resolved by keeping both sides: the + connection notification uses `openApp()`, and the sign-in block, constants and + thread code all remain. The merge is staged with `--no-commit`; land concludes it. +- Gradle, JDK 17, offline: `:app:compileDebugUnitTestKotlin` succeeds. +- Gradle, JDK 17, offline: `:app:testDebugUnitTest --tests 'net.awan.pipelines_app.notify.*'` + passes 37 of 37 (ConnectionLog 5, DeliveryLedger 8, NotificationProtocol 12, + ReconnectPolicy 3, ThreadHistory 9). +- No Dart changed in this stage, so no Flutter tests or analyze were run. + +## Limitations + +- Android posting (MessagingStyle, summary, PendingIntent extras) is not covered by + JVM tests and has not been run on a device. Mobile behaviour is unverified. +- The new androidx.core dependency is compiled offline but not run through a full + APK build or on a device in this stage. +- History is capped: 100 unread entries per thread (count is capped there) and 50 + threads; the oldest thread is forgotten first when the cap is hit. +- Swipe-dismissal of a thread clears its ids on the server, but the local history + is trimmed only when the server confirms (`notifications_cleared`). diff --git a/app/test/features/chat/chat_open_workspace_sync_test.dart b/app/test/features/chat/chat_open_workspace_sync_test.dart new file mode 100644 index 00000000..8b7c1379 --- /dev/null +++ b/app/test/features/chat/chat_open_workspace_sync_test.dart @@ -0,0 +1,205 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:shared_preferences/shared_preferences.dart'; +import 'package:pipelines_app/core/api_gateway.dart'; +import 'package:pipelines_app/core/servers/server_scope.dart'; +import 'package:pipelines_app/features/chat/screen.dart'; +import 'package:pipelines_app/features/chat/workspace/chat_workspace.dart'; +import 'package:pipelines_app/features/chat/workspace/chat_workspace_store.dart'; +import 'package:pipelines_app/shell/adaptive_shell.dart'; +import 'package:pipelines_app/shell/destination.dart'; + +import 'conversation/chat_thread_fixtures.dart'; + +/// A chat server that keeps the open-chat set with the real revision rules: +/// a seed applies only to a never-stored set, a write from a stale base is +/// refused with the current set. +class _Server extends FakeChatGateway { + _Server({this.revision = 0, List open = const []}) + : open = List.of(open); + int revision; + List open; + final writes = >[]; + + @override + Future call(String type, [JsonMap fields = const {}]) { + if (type == 'chat_sessions') { + return Future.value({ + 'chat_sessions': [ + for (final id in ['a', 'b', 'c', 'd']) + {'id': id, 'title': 'Chat $id'}, + ], + }); + } + if (type == 'chat_shells') return Future.value({'chat_shells': []}); + if (type == 'chat_open_workspace') return Future.value(_workspace(fields)); + return super.call(type, fields); + } + + JsonMap _workspace(JsonMap fields) { + final request = fields['chat_open_workspace_request'] as Map?; + var rejected = false; + if (request != null) { + final ids = [ + for (final entry in request['entries'] as List) + '${entry['session_id']}', + ]; + writes.add(ids); + if (request['seed'] == true) { + if (revision == 0) { + open = ids; + revision = 1; + } + } else if (request['base_revision'] != revision) { + rejected = true; + } else { + open = ids; + revision++; + } + } + return { + 'type': 'chat_open_workspace', + 'chat_open_workspace': _body(rejected), + }; + } + + JsonMap _body([bool rejected = false]) => { + 'revision': revision, + 'entries': [ + for (final id in open) {'session_id': id}, + ], + if (rejected) 'rejected': true, + }; + + /// Another device (or the server) changed the set. + void change(List ids) { + open = List.of(ids); + revision++; + emitRaw({ + 'type': 'chat_open_workspace_changed', + 'chat_open_workspace': _body(), + }); + } +} + +ChatWorkspaceController _workspace(WidgetTester tester) => + tester.widget(find.byType(ChatWorkspace)).controller; + +List _open(WidgetTester tester) => + _workspace(tester).panes.map((pane) => pane.sessionId).toList(); + +Future _mount(WidgetTester tester, _Server server) async { + await tester.pumpWidget( + MaterialApp( + home: AdaptiveShell( + destination: AppDestination.chat, + destinationBodies: { + AppDestination.chat: (_) => + ChatScreen(gateway: server, persistWorkspace: true), + }, + ), + ), + ); + await tester.pumpAndSettle(); +} + +_Server _server( + String identity, { + int revision = 0, + List open = const [], +}) { + final server = _Server(revision: revision, open: open) + ..history = (_) async => chatPage([]); + bindServerIdentity(server, identity); + addTearDown(server.close); + return server; +} + +void _saveLocal(String identity, List ids) { + final saved = ChatWorkspaceController()..open(ids.first); + for (final id in ids.skip(1)) { + saved.splitActive(id, ChatSplitAxis.horizontal); + } + SharedPreferences.setMockInitialValues({ + scopedServerKey(chatWorkspacePreferenceKey, identity): saved + .snapshot()! + .encode(), + }); +} + +void main() { + testWidgets( + 'the local layout seeds a new server and remote removal drops its pane', + (tester) async { + tester.view.physicalSize = const Size(1800, 1000); + tester.view.devicePixelRatio = 1; + addTearDown(tester.view.reset); + _saveLocal('server-a', ['a', 'b']); + final server = _server('server-a'); + await _mount(tester, server); + expect(server.revision, 1); + expect(server.open, ['a', 'b']); + expect(_open(tester), ['a', 'b']); + + server.change(['b']); + await tester.pumpAndSettle(); + expect(_open(tester), ['b']); + // Applying the server's change is not written back. + expect(server.writes, hasLength(1)); + await tester.pumpWidget(const SizedBox.shrink()); + await tester.pumpAndSettle(); + }, + ); + + testWidgets('an existing server set wins over an old local snapshot', ( + tester, + ) async { + tester.view.physicalSize = const Size(1800, 1000); + tester.view.devicePixelRatio = 1; + addTearDown(tester.view.reset); + _saveLocal('server-a', ['a']); + final server = _server('server-a', revision: 3, open: ['b', 'c']); + await _mount(tester, server); + expect(_open(tester), ['b', 'c']); + expect(server.open, ['b', 'c']); + expect(server.revision, 3); + // A local change is sent from the server's revision and accepted. + _workspace(tester).close(_workspace(tester).panes.first.id); + await tester.pumpAndSettle(); + expect(server.open, ['c']); + expect(server.revision, 4); + await tester.pumpWidget(const SizedBox.shrink()); + await tester.pumpAndSettle(); + }); + + testWidgets('rebinding to another server disposes the old sync', ( + tester, + ) async { + tester.view.physicalSize = const Size(1800, 1000); + tester.view.devicePixelRatio = 1; + addTearDown(tester.view.reset); + SharedPreferences.setMockInitialValues({}); + final first = _server('server-a', revision: 1, open: ['a']); + final second = _server('server-b', revision: 1, open: ['c']); + await _mount(tester, first); + expect(_open(tester), ['a']); + await _mount(tester, second); + expect(_open(tester), ['c']); + + // The old server's pushes no longer reach this screen. + first.change(['a', 'b', 'd']); + await tester.pumpAndSettle(); + expect(_open(tester), ['c']); + // The new server's do, and local changes go only to it. + second.change(['c', 'd']); + await tester.pumpAndSettle(); + expect(_open(tester), ['c', 'd']); + final firstWrites = first.writes.length; + _workspace(tester).close(_workspace(tester).panes.last.id); + await tester.pumpAndSettle(); + expect(second.open, ['c']); + expect(first.writes, hasLength(firstWrites)); + await tester.pumpWidget(const SizedBox.shrink()); + await tester.pumpAndSettle(); + }); +} diff --git a/app/test/features/chat/workspace/chat_open_workspace_controller_test.dart b/app/test/features/chat/workspace/chat_open_workspace_controller_test.dart new file mode 100644 index 00000000..d3d33438 --- /dev/null +++ b/app/test/features/chat/workspace/chat_open_workspace_controller_test.dart @@ -0,0 +1,211 @@ +import 'dart:async'; + +import 'package:flutter_test/flutter_test.dart'; +import 'package:pipelines_app/core/api_gateway.dart'; +import 'package:pipelines_app/features/chat/workspace/chat_open_workspace_controller.dart'; +import 'package:pipelines_app/features/chat/workspace/chat_open_workspace_gateway.dart'; + +/// Answers each chat_open_workspace call only when the test completes it. +class _Gateway implements ApiGateway { + final requests = <({JsonMap fields, Completer reply})>[]; + final _frames = StreamController.broadcast(); + + @override + Future call(String type, [JsonMap fields = const {}]) { + final reply = Completer(); + requests.add((fields: fields, reply: reply)); + return reply.future; + } + + @override + Stream get frames => _frames.stream; + + void push(int revision, List ids) => _frames.add({ + 'type': 'chat_open_workspace_changed', + 'chat_open_workspace': _snapshot(revision, ids), + }); + + void answer( + int index, + int revision, + List ids, { + bool rejected = false, + }) => requests[index].reply.complete({ + 'type': 'chat_open_workspace', + 'chat_open_workspace': _snapshot(revision, ids, rejected: rejected), + }); + + List sentIds(int index) => [ + for (final entry + in (requests[index].fields['chat_open_workspace_request'] + as Map)['entries'] + as List) + '${entry['session_id']}', + ]; + + int base(int index) => + (requests[index].fields['chat_open_workspace_request'] + as Map)['base_revision']; +} + +JsonMap _snapshot(int revision, List ids, {bool rejected = false}) => { + 'revision': revision, + 'entries': [ + for (final id in ids) {'session_id': id}, + ], + if (rejected) 'rejected': true, +}; + +List _entries(List ids) => [ + for (final id in ids) ChatOpenWorkspaceEntry(id), +]; + +Future<(ChatOpenWorkspaceController, _Gateway, List>)> _started({ + int revision = 1, + List ids = const ['a'], +}) async { + final gateway = _Gateway(); + final applied = >[]; + final controller = ChatOpenWorkspaceController(gateway: gateway) + ..onChanged = (snapshot) => + applied.add(snapshot.entries.map((e) => e.sessionId).toList()); + final started = controller.start(local: _entries(ids)); + await pumpEventQueue(); + expect(gateway.requests.single.fields['chat_open_workspace_request'], { + 'entries': [ + for (final id in ids) {'session_id': id}, + ], + 'base_revision': 0, + 'seed': true, + }); + gateway.answer(0, revision, ids); + await started; + return (controller, gateway, applied); +} + +void main() { + test('reads instead of seeding when the device has no chats', () async { + final gateway = _Gateway(); + final controller = ChatOpenWorkspaceController(gateway: gateway); + final started = controller.start(); + await pumpEventQueue(); + expect(gateway.requests.single.fields, isEmpty); + gateway.answer(0, 4, ['x']); + await started; + expect(controller.revision, 4); + expect(controller.ready, isTrue); + }); + + test( + 'serializes writes and sends the latest from the replied revision', + () async { + final (controller, gateway, _) = await _started(); + controller.replace(_entries(['a', 'b'])); + controller.replace(_entries(['a', 'b', 'c'])); + controller.replace(_entries(['c', 'a', 'b'])); + await pumpEventQueue(); + // One write in flight; the two later ones coalesced behind it. + expect(gateway.requests, hasLength(2)); + expect(gateway.sentIds(1), ['a', 'b']); + expect(gateway.base(1), 1); + gateway.answer(1, 2, ['a', 'b']); + await pumpEventQueue(); + expect(gateway.requests, hasLength(3)); + expect(gateway.sentIds(2), ['c', 'a', 'b']); + expect(gateway.base(2), 2); + gateway.answer(2, 3, ['c', 'a', 'b']); + await pumpEventQueue(); + expect(controller.revision, 3); + // An unchanged set is not sent again. + controller.replace(_entries(['c', 'a', 'b'])); + await pumpEventQueue(); + expect(gateway.requests, hasLength(3)); + }, + ); + + test('a late reply never overwrites a newer pushed revision', () async { + final (controller, gateway, applied) = await _started(); + controller.replace(_entries(['a', 'b'])); + await pumpEventQueue(); + // Another device's change (revision 3) is pushed before this write's + // reply (revision 2) arrives. + gateway.push(3, ['z']); + await pumpEventQueue(); + gateway.answer(1, 2, ['a', 'b']); + await pumpEventQueue(); + expect(controller.revision, 3); + expect(applied.last, ['z']); + // Older and repeated pushes are ignored. + gateway.push(2, ['a', 'b']); + gateway.push(3, ['z']); + await pumpEventQueue(); + expect(applied, [ + ['a'], + ['z'], + ]); + }); + + test( + 'a refused stale write applies the server state and drops queued ones', + () async { + final (controller, gateway, applied) = await _started(); + controller.replace(_entries(['a', 'b'])); + await pumpEventQueue(); + controller.replace(_entries(['a', 'b', 'c'])); + gateway.answer(1, 5, ['q'], rejected: true); + await pumpEventQueue(); + expect(applied.last, ['q']); + expect(controller.revision, 5); + expect(gateway.requests, hasLength(2)); + // The next change is derived from the server's state. + controller.replace(_entries(['q', 'r'])); + await pumpEventQueue(); + expect(gateway.base(2), 5); + }, + ); + + test('a push applied while writing replaces the queued write', () async { + final (controller, gateway, applied) = await _started(); + controller.replace(_entries(['a', 'b'])); + await pumpEventQueue(); + controller.replace(_entries(['a', 'b', 'c'])); + gateway.push(4, ['b']); + await pumpEventQueue(); + expect(applied.last, ['b']); + gateway.answer(1, 4, ['b'], rejected: true); + await pumpEventQueue(); + expect(gateway.requests, hasLength(2)); + }); + + test('dispose stops pushes and writes', () async { + final (controller, gateway, applied) = await _started(); + controller.dispose(); + gateway.push(9, ['late']); + controller.replace(_entries(['x'])); + await pumpEventQueue(); + expect(applied, [ + ['a'], + ]); + expect(gateway.requests, hasLength(1)); + }); + + test( + 'stays local-only when the server does not answer the request', + () async { + final gateway = _Gateway(); + final controller = ChatOpenWorkspaceController(gateway: gateway); + final started = controller.start(local: _entries(['a'])); + await pumpEventQueue(); + gateway.requests.single.reply.completeError(StateError('unknown type')); + await started; + expect(controller.ready, isFalse); + controller.replace(_entries(['a', 'b'])); + await pumpEventQueue(); + expect(gateway.requests, hasLength(1)); + // A server push (a reconnect) brings it up to date and enables writes. + gateway.push(2, ['a']); + await pumpEventQueue(); + expect(controller.ready, isTrue); + }, + ); +} diff --git a/app/test/features/chat/workspace/chat_open_workspace_gateway_test.dart b/app/test/features/chat/workspace/chat_open_workspace_gateway_test.dart new file mode 100644 index 00000000..6d54ee9a --- /dev/null +++ b/app/test/features/chat/workspace/chat_open_workspace_gateway_test.dart @@ -0,0 +1,38 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:pipelines_app/features/chat/workspace/chat_open_workspace_gateway.dart'; + +void main() { + test('decodes bounded ordered membership and floating state', () { + final snapshot = ChatOpenWorkspaceSnapshot.fromJson({ + 'revision': 7, + 'entries': [ + {'session_id': 'ses_a', 'floating': true}, + {'session_id': 'ses_b'}, + ], + }); + expect(snapshot?.revision, 7); + expect(snapshot?.entries.map((entry) => entry.sessionId), [ + 'ses_a', + 'ses_b', + ]); + expect(snapshot?.entries.first.floating, isTrue); + }); + + test('rejects duplicate and oversized snapshots', () { + expect( + ChatOpenWorkspaceSnapshot.fromJson({ + 'entries': [ + {'session_id': 'ses_a'}, + {'session_id': 'ses_a'}, + ], + }), + isNull, + ); + expect( + ChatOpenWorkspaceSnapshot.fromJson({ + 'entries': List.generate(65, (index) => {'session_id': 'ses_$index'}), + }), + isNull, + ); + }); +} diff --git a/app/test/features/chat/workspace/chat_workspace_reconcile_test.dart b/app/test/features/chat/workspace/chat_workspace_reconcile_test.dart new file mode 100644 index 00000000..4ee23320 --- /dev/null +++ b/app/test/features/chat/workspace/chat_workspace_reconcile_test.dart @@ -0,0 +1,56 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:pipelines_app/features/chat/workspace/chat_workspace_controller.dart'; + +List _sessions(ChatWorkspaceController c) => + c.panes.map((pane) => pane.sessionId).toList(); + +ChatWorkspaceController _three() { + final c = ChatWorkspaceController()..open('a'); + c.splitActive('b', ChatSplitAxis.vertical); + c.splitActive('c', ChatSplitAxis.horizontal); + c.resize(c.root!.id, .3); + return c; +} + +void main() { + test('a remote removal drops only that pane and keeps the geometry', () { + final c = _three(); + final paneA = c.panes.first.id; + final paneC = c.panes.last.id; + c.reconcileSessions(['a', 'c']); + expect(_sessions(c), ['a', 'c']); + expect(c.panes.map((pane) => pane.id), [paneA, paneC]); + expect((c.root as ChatWorkspaceSplit).ratio, .3); + }); + + test('a reorder moves panes with their ids and keeps the splits', () { + final c = _three(); + final ids = {for (final pane in c.panes) pane.sessionId: pane.id}; + final splitId = c.root!.id; + c.reconcileSessions(['c', 'a', 'b']); + expect(_sessions(c), ['c', 'a', 'b']); + expect(c.panes.map((pane) => pane.id), [ids['c'], ids['a'], ids['b']]); + expect(c.root!.id, splitId); + expect((c.root as ChatWorkspaceSplit).ratio, .3); + }); + + test('new chats split off and an unchanged set notifies nothing', () { + final c = ChatWorkspaceController()..open('a'); + c.reconcileSessions(['a', 'b']); + expect(_sessions(c), ['a', 'b']); + var notified = 0; + c.addListener(() => notified++); + c.reconcileSessions(['a', 'b']); + expect(notified, 0); + c.reconcileSessions(const []); + expect(c.panes, isEmpty); + expect(c.activePane, isNull); + }); + + test('the active pane moves on when its chat is removed', () { + final c = _three(); + expect(c.activePane?.sessionId, 'c'); + c.reconcileSessions(['b']); + expect(c.activePane?.sessionId, 'b'); + }); +} diff --git a/internal/pipeline/chat_open_workspace.go b/internal/pipeline/chat_open_workspace.go new file mode 100644 index 00000000..8ee73fab --- /dev/null +++ b/internal/pipeline/chat_open_workspace.go @@ -0,0 +1,179 @@ +package pipeline + +import ( + "context" + "database/sql" + "encoding/json" + "fmt" + "strings" + "time" + + "git.a-wan.net/alan/pipelines/internal/protocol" +) + +// ChatOpenWorkspaceLimit bounds the open-chat set. +const ChatOpenWorkspaceLimit = 64 + +func (s *Store) initChatOpenWorkspace() error { + _, err := s.db.Exec(`CREATE TABLE IF NOT EXISTS chat_open_workspaces ( +scope TEXT PRIMARY KEY, entries_json TEXT NOT NULL, revision INTEGER NOT NULL DEFAULT 0, +updated_at INTEGER NOT NULL DEFAULT 0 +);`) + return err +} + +func validateOpenWorkspace(entries []protocol.ChatOpenWorkspaceEntry) error { + if len(entries) > ChatOpenWorkspaceLimit { + return fmt.Errorf("too many open chats") + } + seen := make(map[string]struct{}, len(entries)) + for _, entry := range entries { + id := strings.TrimSpace(entry.SessionID) + if id == "" || id != entry.SessionID || len(id) > 200 { + return fmt.Errorf("invalid open chat session id") + } + if _, ok := seen[id]; ok { + return fmt.Errorf("duplicate open chat session id %q", id) + } + seen[id] = struct{}{} + } + return nil +} + +func decodeOpenWorkspace(raw string) ([]protocol.ChatOpenWorkspaceEntry, error) { + var entries []protocol.ChatOpenWorkspaceEntry + if err := json.Unmarshal([]byte(raw), &entries); err != nil { + return nil, err + } + if err := validateOpenWorkspace(entries); err != nil { + return nil, err + } + return entries, nil +} + +func sameOpenWorkspace(a, b []protocol.ChatOpenWorkspaceEntry) bool { + if len(a) != len(b) { + return false + } + for i := range a { + if a[i] != b[i] { + return false + } + } + return true +} + +// ChatOpenWorkspace reads the stored snapshot; revision 0 means none was ever +// stored. +func (s *Store) ChatOpenWorkspace(ctx context.Context, scope string) (protocol.ChatOpenWorkspaceSnapshot, error) { + return readOpenWorkspace(ctx, s.db, scope) +} + +type rowQuerier interface { + QueryRowContext(context.Context, string, ...any) *sql.Row +} + +func readOpenWorkspace(ctx context.Context, db rowQuerier, scope string) (protocol.ChatOpenWorkspaceSnapshot, error) { + var raw string + snapshot := protocol.ChatOpenWorkspaceSnapshot{Entries: []protocol.ChatOpenWorkspaceEntry{}} + err := db.QueryRowContext(ctx, `SELECT entries_json,revision FROM chat_open_workspaces WHERE scope=?`, scope).Scan(&raw, &snapshot.Revision) + if err == sql.ErrNoRows { + return snapshot, nil + } + if err != nil { + return snapshot, err + } + snapshot.Entries, err = decodeOpenWorkspace(raw) + return snapshot, err +} + +func writeOpenWorkspace(ctx context.Context, tx *sql.Tx, scope string, revision int64, entries []protocol.ChatOpenWorkspaceEntry) error { + raw, err := json.Marshal(entries) + if err != nil { + return err + } + _, err = tx.ExecContext(ctx, `INSERT INTO chat_open_workspaces(scope,entries_json,revision,updated_at) VALUES(?,?,?,?) +ON CONFLICT(scope) DO UPDATE SET entries_json=excluded.entries_json,revision=excluded.revision,updated_at=excluded.updated_at`, + scope, string(raw), revision, time.Now().UnixMilli()) + return err +} + +// SaveChatOpenWorkspace applies a full snapshot as one compare-and-swap. A +// write whose baseRevision is not the stored revision is not applied: the +// current snapshot is returned with Rejected set. A seed applies only when no +// workspace was ever stored and otherwise returns the stored one. changed +// reports whether a new revision was stored; an identical write stores none. +func (s *Store) SaveChatOpenWorkspace(ctx context.Context, scope string, entries []protocol.ChatOpenWorkspaceEntry, seed bool, baseRevision int64) (snapshot protocol.ChatOpenWorkspaceSnapshot, changed bool, err error) { + if strings.TrimSpace(scope) == "" { + return snapshot, false, fmt.Errorf("workspace scope is required") + } + if entries == nil { + entries = []protocol.ChatOpenWorkspaceEntry{} + } + if err := validateOpenWorkspace(entries); err != nil { + return snapshot, false, err + } + tx, err := s.db.BeginTx(ctx, nil) + if err != nil { + return snapshot, false, err + } + defer tx.Rollback() + current, err := readOpenWorkspace(ctx, tx, scope) + if err != nil { + return snapshot, false, err + } + if seed && current.Revision > 0 { + return current, false, nil + } + if !seed && baseRevision != current.Revision { + current.Rejected = true + return current, false, nil + } + if current.Revision > 0 && sameOpenWorkspace(current.Entries, entries) { + return current, false, nil + } + next := protocol.ChatOpenWorkspaceSnapshot{Revision: current.Revision + 1, Entries: entries} + if err := writeOpenWorkspace(ctx, tx, scope, next.Revision, entries); err != nil { + return snapshot, false, err + } + if err := tx.Commit(); err != nil { + return snapshot, false, err + } + return next, true, nil +} + +// RemoveChatOpenWorkspaceSessions drops the named sessions from the stored +// snapshot in one transaction, storing a new revision only when one was +// present. The server uses it for closed and no-longer-valid chats. +func (s *Store) RemoveChatOpenWorkspaceSessions(ctx context.Context, scope string, sessionIDs []string) (snapshot protocol.ChatOpenWorkspaceSnapshot, changed bool, err error) { + drop := make(map[string]bool, len(sessionIDs)) + for _, id := range sessionIDs { + drop[id] = true + } + tx, err := s.db.BeginTx(ctx, nil) + if err != nil { + return snapshot, false, err + } + defer tx.Rollback() + current, err := readOpenWorkspace(ctx, tx, scope) + if err != nil || current.Revision == 0 { + return current, false, err + } + kept := make([]protocol.ChatOpenWorkspaceEntry, 0, len(current.Entries)) + for _, entry := range current.Entries { + if !drop[entry.SessionID] { + kept = append(kept, entry) + } + } + if len(kept) == len(current.Entries) { + return current, false, nil + } + next := protocol.ChatOpenWorkspaceSnapshot{Revision: current.Revision + 1, Entries: kept} + if err := writeOpenWorkspace(ctx, tx, scope, next.Revision, kept); err != nil { + return snapshot, false, err + } + if err := tx.Commit(); err != nil { + return snapshot, false, err + } + return next, true, nil +} diff --git a/internal/pipeline/chat_open_workspace_test.go b/internal/pipeline/chat_open_workspace_test.go new file mode 100644 index 00000000..877ca1e9 --- /dev/null +++ b/internal/pipeline/chat_open_workspace_test.go @@ -0,0 +1,105 @@ +package pipeline + +import ( + "context" + "fmt" + "testing" + + "git.a-wan.net/alan/pipelines/internal/protocol" +) + +func openWorkspaceStore(t *testing.T, path string) *Store { + t.Helper() + store, err := Open(path) + if err != nil { + t.Fatal(err) + } + return store +} + +func TestChatOpenWorkspacePersistsAndSeedsOnce(t *testing.T) { + path := t.TempDir() + "/workspace.db" + ctx := context.Background() + store := openWorkspaceStore(t, path) + first := []protocol.ChatOpenWorkspaceEntry{{SessionID: "ses_a", Floating: true}} + snapshot, changed, err := store.SaveChatOpenWorkspace(ctx, "default", first, true, 0) + if err != nil || !changed { + t.Fatalf("seed: changed=%v err=%v", changed, err) + } + if snapshot.Revision != 1 || len(snapshot.Entries) != 1 || !snapshot.Entries[0].Floating { + t.Fatalf("unexpected snapshot: %+v", snapshot) + } + second, changed, err := store.SaveChatOpenWorkspace(ctx, "default", []protocol.ChatOpenWorkspaceEntry{{SessionID: "ses_b"}}, true, 0) + if err != nil || changed || second.Rejected { + t.Fatalf("second seed: changed=%v rejected=%v err=%v", changed, second.Rejected, err) + } + if len(second.Entries) != 1 || second.Entries[0].SessionID != "ses_a" { + t.Fatalf("seed replaced existing workspace: %+v", second) + } + // An emptied workspace is still a stored workspace: an old device-local + // snapshot must not seed its chats back. + if _, _, err := store.SaveChatOpenWorkspace(ctx, "default", nil, false, 1); err != nil { + t.Fatal(err) + } + reseed, changed, err := store.SaveChatOpenWorkspace(ctx, "default", first, true, 0) + if err != nil || changed || len(reseed.Entries) != 0 || reseed.Revision != 2 { + t.Fatalf("seed restored an emptied workspace: %+v changed=%v err=%v", reseed, changed, err) + } + if err := store.Close(); err != nil { + t.Fatal(err) + } + store = openWorkspaceStore(t, path) + defer store.Close() + loaded, err := store.ChatOpenWorkspace(ctx, "default") + if err != nil { + t.Fatal(err) + } + if loaded.Revision != 2 || len(loaded.Entries) != 0 { + t.Fatalf("workspace did not survive restart: %+v", loaded) + } +} + +func TestChatOpenWorkspaceRejectsStaleRevision(t *testing.T) { + store := openWorkspaceStore(t, t.TempDir()+"/workspace.db") + defer store.Close() + ctx := context.Background() + a := []protocol.ChatOpenWorkspaceEntry{{SessionID: "ses_a"}} + ab := []protocol.ChatOpenWorkspaceEntry{{SessionID: "ses_a"}, {SessionID: "ses_b"}} + if s, _, err := store.SaveChatOpenWorkspace(ctx, "default", a, false, 0); err != nil || s.Revision != 1 { + t.Fatalf("first write: %+v %v", s, err) + } + if s, _, err := store.SaveChatOpenWorkspace(ctx, "default", ab, false, 1); err != nil || s.Revision != 2 { + t.Fatalf("second write: %+v %v", s, err) + } + stale, changed, err := store.SaveChatOpenWorkspace(ctx, "default", nil, false, 1) + if err != nil || changed || !stale.Rejected || stale.Revision != 2 || len(stale.Entries) != 2 { + t.Fatalf("stale write = %+v changed=%v err=%v", stale, changed, err) + } + same, changed, err := store.SaveChatOpenWorkspace(ctx, "default", ab, false, 2) + if err != nil || changed || same.Revision != 2 { + t.Fatalf("identical write stored a revision: %+v changed=%v", same, changed) + } + removed, changed, err := store.RemoveChatOpenWorkspaceSessions(ctx, "default", []string{"ses_a", "ses_x"}) + if err != nil || !changed || removed.Revision != 3 || len(removed.Entries) != 1 || removed.Entries[0].SessionID != "ses_b" { + t.Fatalf("remove = %+v changed=%v err=%v", removed, changed, err) + } + if _, changed, _ := store.RemoveChatOpenWorkspaceSessions(ctx, "default", []string{"ses_a"}); changed { + t.Fatal("removing an absent chat stored a revision") + } +} + +func TestChatOpenWorkspaceRejectsDuplicatesAndBounds(t *testing.T) { + store := openWorkspaceStore(t, t.TempDir()+"/workspace.db") + defer store.Close() + entries := []protocol.ChatOpenWorkspaceEntry{{SessionID: "ses_a"}, {SessionID: "ses_a"}} + if _, _, err := store.SaveChatOpenWorkspace(context.Background(), "default", entries, false, 0); err == nil { + t.Fatal("duplicate workspace entries accepted") + } + many := make([]protocol.ChatOpenWorkspaceEntry, ChatOpenWorkspaceLimit+1) + for i := range many { + many[i].SessionID = fmt.Sprintf("ses_%d", i) + } + if _, _, err := store.SaveChatOpenWorkspace(context.Background(), "default", many, false, 0); err == nil { + t.Fatal("oversized workspace accepted") + } +} diff --git a/internal/pipeline/store.go b/internal/pipeline/store.go index 75493470..ef977dce 100644 --- a/internal/pipeline/store.go +++ b/internal/pipeline/store.go @@ -85,6 +85,10 @@ CREATE TABLE IF NOT EXISTS submissions (id INTEGER PRIMARY KEY, name TEXT NOT NU db.Close() return nil, err } + if err := s.initChatOpenWorkspace(); err != nil { + db.Close() + return nil, err + } if err := s.initServerSettings(); err != nil { db.Close() return nil, err diff --git a/internal/protocol/chat.go b/internal/protocol/chat.go index 3218a75f..9bc30673 100644 --- a/internal/protocol/chat.go +++ b/internal/protocol/chat.go @@ -81,6 +81,10 @@ const ( // takes a ChatQuery with SessionID and Color (a ChatColors name; null or "" // clears it) and echoes the updated session like chat_star. ChatColor = "chat_color" + // ChatOpenWorkspace replaces the bounded, server-authoritative ordered set + // of open operator chats. The reply and push carry the complete snapshot. + ChatOpenWorkspace = "chat_open_workspace" + ChatOpenWorkspaceChanged = "chat_open_workspace_changed" // ChatSessionChanged is pushed to every other open connection when a chat's // shared list metadata (colour, star, title) changes, carrying the updated // registry row in ChatSession, so each device's list updates live. diff --git a/internal/protocol/chat_open_workspace.go b/internal/protocol/chat_open_workspace.go new file mode 100644 index 00000000..4a30096b --- /dev/null +++ b/internal/protocol/chat_open_workspace.go @@ -0,0 +1,33 @@ +package protocol + +// ChatOpenWorkspaceEntry is the server-owned part of one workspace pane. Layout +// geometry and pane ids deliberately do not cross the wire. +type ChatOpenWorkspaceEntry struct { + SessionID string `json:"session_id"` + Floating bool `json:"floating,omitempty"` +} + +// ChatOpenWorkspaceRequest replaces the open-chat set. A chat_open_workspace +// without a request only reads the current snapshot. +type ChatOpenWorkspaceRequest struct { + Entries []ChatOpenWorkspaceEntry `json:"entries"` + // BaseRevision is the snapshot revision the client's entries were derived + // from. A write whose base is not the current revision is refused, and the + // reply carries the current snapshot with Rejected set, so a late write + // can never overwrite a newer change. + BaseRevision int64 `json:"base_revision"` + // Seed is honored only when the server has never stored a workspace. It + // makes migration from the old device-local snapshot race-safe; otherwise + // the reply is the existing snapshot, unchanged. + Seed bool `json:"seed,omitempty"` +} + +// ChatOpenWorkspaceSnapshot is the complete open-chat set. Revision grows by +// one with every stored change. +type ChatOpenWorkspaceSnapshot struct { + Revision int64 `json:"revision"` + Entries []ChatOpenWorkspaceEntry `json:"entries"` + // Rejected marks a reply to a write whose base revision was stale: the + // write was not applied and the snapshot is the current state. + Rejected bool `json:"rejected,omitempty"` +} diff --git a/internal/protocol/message.go b/internal/protocol/message.go index 66c0920d..c5236536 100644 --- a/internal/protocol/message.go +++ b/internal/protocol/message.go @@ -200,17 +200,19 @@ type Message struct { SearchResults *SearchResponse `json:"search_results,omitempty"` // Chat is the brokered OpenCode chat traffic (route B). See chat.go for the // per-type payload structs and the wire shapes they mirror. - ChatSessions []ChatSession `json:"chat_sessions,omitempty"` - ChatSession *ChatSession `json:"chat_session,omitempty"` - ChatCreate *ChatCreateRequest `json:"chat_create,omitempty"` - ChatAdopt *ChatAdoptRequest `json:"chat_adopt,omitempty"` - ChatQuery *ChatQuery `json:"chat_query,omitempty"` - ChatPrompt *ChatPromptRequest `json:"chat_prompt,omitempty"` - ChatMessages []ChatMessage `json:"chat_messages,omitempty"` - ChatHistory *ChatHistoryPage `json:"chat_history,omitempty"` - ChatEvent *ChatEventFrame `json:"chat_event,omitempty"` - ChatPermission *ChatPermissionFrame `json:"chat_permission,omitempty"` - ChatReply *ChatReplyRequest `json:"chat_reply,omitempty"` + ChatSessions []ChatSession `json:"chat_sessions,omitempty"` + ChatSession *ChatSession `json:"chat_session,omitempty"` + ChatOpenWorkspaceRequest *ChatOpenWorkspaceRequest `json:"chat_open_workspace_request,omitempty"` + ChatOpenWorkspace *ChatOpenWorkspaceSnapshot `json:"chat_open_workspace,omitempty"` + ChatCreate *ChatCreateRequest `json:"chat_create,omitempty"` + ChatAdopt *ChatAdoptRequest `json:"chat_adopt,omitempty"` + ChatQuery *ChatQuery `json:"chat_query,omitempty"` + ChatPrompt *ChatPromptRequest `json:"chat_prompt,omitempty"` + ChatMessages []ChatMessage `json:"chat_messages,omitempty"` + ChatHistory *ChatHistoryPage `json:"chat_history,omitempty"` + ChatEvent *ChatEventFrame `json:"chat_event,omitempty"` + ChatPermission *ChatPermissionFrame `json:"chat_permission,omitempty"` + ChatReply *ChatReplyRequest `json:"chat_reply,omitempty"` // ChatClose carries the outcome of a chat_close; the close and reopen // requests themselves ride on ChatQuery (the session id), matching // chat_messages/chat_interrupt. diff --git a/internal/server/chat.go b/internal/server/chat.go index b3d9b528..6ae310b0 100644 --- a/internal/server/chat.go +++ b/internal/server/chat.go @@ -225,6 +225,9 @@ func handleChat(ctx context.Context, request protocol.Message, broker chatBroker case protocol.ChatColor: handleChatColor(ctx, request, registry, hub.changes(), clientID, write) return true + case protocol.ChatOpenWorkspace: + handleChatOpenWorkspace(ctx, request, registry, hub.changes(), clientID, write) + return true case protocol.ChatRename: handleChatRename(ctx, request, broker, registry, hub.changes(), clientID, write) return true diff --git a/internal/server/chat_close.go b/internal/server/chat_close.go index f69dde2d..d5eb98c6 100644 --- a/internal/server/chat_close.go +++ b/internal/server/chat_close.go @@ -92,6 +92,9 @@ func handleChatClose(ctx context.Context, request protocol.Message, broker chatB // chat_sessions without a re-list. response.ChatSessions = []protocol.ChatSession{wire} _ = write(response) + // A closed chat leaves every device's open-chat set, so no client can keep + // or restore it. + dropFromChatWorkspace(ctx, registry, hub.changes(), sessionID) } // handleChatReopen clears the closed state of an operator chat session so it diff --git a/internal/server/chat_open_workspace.go b/internal/server/chat_open_workspace.go new file mode 100644 index 00000000..dc707809 --- /dev/null +++ b/internal/server/chat_open_workspace.go @@ -0,0 +1,164 @@ +package server + +import ( + "context" + "fmt" + "log" + "strings" + + "git.a-wan.net/alan/pipelines/internal/pipeline" + "git.a-wan.net/alan/pipelines/internal/protocol" +) + +// chatWorkspaceScope keys the one operator's open-chat set: the authenticated +// local server has a single operator. +const chatWorkspaceScope = "default" + +// chatOpenWorkspaceStore persists the server-authoritative open-chat set (see +// pipeline.Store.SaveChatOpenWorkspace for the revision rules). +type chatOpenWorkspaceStore interface { + ChatOpenWorkspace(context.Context, string) (protocol.ChatOpenWorkspaceSnapshot, error) + SaveChatOpenWorkspace(ctx context.Context, scope string, entries []protocol.ChatOpenWorkspaceEntry, seed bool, baseRevision int64) (protocol.ChatOpenWorkspaceSnapshot, bool, error) + RemoveChatOpenWorkspaceSessions(ctx context.Context, scope string, sessionIDs []string) (protocol.ChatOpenWorkspaceSnapshot, bool, error) +} + +func openWorkspaceStoreOf(registry operatorRegistry) chatOpenWorkspaceStore { + store, _ := registry.(chatOpenWorkspaceStore) + return store +} + +// openOperatorChat reports whether id is a recorded operator chat that is not +// closed. Only those may be in the open-chat set, so a pipeline-owned run +// session, a closed chat or an unknown id is never kept. The registry is the +// authority; the broker is not asked, so validation never starts a harness. +func openOperatorChat(ctx context.Context, registry operatorRegistry, id string) (bool, error) { + row, found, err := registry.OperatorSession(ctx, id) + if err != nil { + return false, err + } + return found && row.ClosedAt == 0, nil +} + +// pruneChatWorkspace drops every stored entry that is no longer an open +// operator chat. changed reports a new stored revision, which the caller +// broadcasts to every connection. +func pruneChatWorkspace(ctx context.Context, registry operatorRegistry, store chatOpenWorkspaceStore) (protocol.ChatOpenWorkspaceSnapshot, bool, error) { + snapshot, err := store.ChatOpenWorkspace(ctx, chatWorkspaceScope) + if err != nil || snapshot.Revision == 0 { + return snapshot, false, err + } + var stale []string + for _, entry := range snapshot.Entries { + open, err := openOperatorChat(ctx, registry, entry.SessionID) + if err != nil { + return snapshot, false, err + } + if !open { + stale = append(stale, entry.SessionID) + } + } + if len(stale) == 0 { + return snapshot, false, nil + } + return store.RemoveChatOpenWorkspaceSessions(ctx, chatWorkspaceScope, stale) +} + +// announceChatWorkspace runs when a connection opens: it prunes stale entries +// and, when that stored a new revision, pushes it to every connection; +// otherwise it sends the current snapshot to the new connection alone, so a +// reconnecting client catches up with changes it missed. +func announceChatWorkspace(ctx context.Context, registry operatorRegistry, changes *chatSessionChanges, write func(protocol.Message) error) { + store := openWorkspaceStoreOf(registry) + if store == nil { + return + } + snapshot, changed, err := pruneChatWorkspace(ctx, registry, store) + if err != nil { + log.Printf("reconcile open chat workspace: %v", err) + return + } + if changed { + changes.broadcastWorkspace("", snapshot) + } else if snapshot.Revision > 0 { + _ = write(protocol.Message{Type: protocol.ChatOpenWorkspaceChanged, ChatOpenWorkspace: &snapshot}) + } +} + +// dropFromChatWorkspace removes a closed chat from the open-chat set and pushes +// the new revision to every connection, the closing one included. +func dropFromChatWorkspace(ctx context.Context, registry operatorRegistry, changes *chatSessionChanges, sessionID string) { + store := openWorkspaceStoreOf(registry) + if store == nil { + return + } + snapshot, changed, err := store.RemoveChatOpenWorkspaceSessions(ctx, chatWorkspaceScope, []string{sessionID}) + if err != nil { + log.Printf("drop closed chat %s from open workspace: %v", sessionID, err) + return + } + if changed { + changes.broadcastWorkspace("", snapshot) + } +} + +// validChatWorkspaceEntries checks a client's snapshot and keeps only its open +// operator chats. Malformed or duplicate ids are refused; closed or unknown +// chats are dropped, so a stale client can never restore them. +func validChatWorkspaceEntries(ctx context.Context, request protocol.ChatOpenWorkspaceRequest, registry operatorRegistry) ([]protocol.ChatOpenWorkspaceEntry, error) { + if len(request.Entries) > pipeline.ChatOpenWorkspaceLimit { + return nil, fmt.Errorf("too many open chats") + } + seen := map[string]bool{} + valid := make([]protocol.ChatOpenWorkspaceEntry, 0, len(request.Entries)) + for _, entry := range request.Entries { + id := strings.TrimSpace(entry.SessionID) + if !validChatSessionID(id) || seen[id] { + return nil, fmt.Errorf("invalid or duplicate open chat session %q", id) + } + seen[id] = true + open, err := openOperatorChat(ctx, registry, id) + if err != nil { + return nil, err + } + if open { + valid = append(valid, protocol.ChatOpenWorkspaceEntry{SessionID: id, Floating: entry.Floating}) + } + } + return valid, nil +} + +// handleChatOpenWorkspace reads (no request) or replaces the open-chat set. +// The reply always carries the resulting snapshot; a stored change is pushed +// to every other connection as chat_open_workspace_changed. +func handleChatOpenWorkspace(ctx context.Context, request protocol.Message, registry operatorRegistry, changes *chatSessionChanges, clientID string, write func(protocol.Message) error) { + fail := func(err error) { + _ = write(protocol.Message{Type: protocol.Error, ID: request.ID, Error: err.Error()}) + } + store := openWorkspaceStoreOf(registry) + if registry == nil || store == nil { + fail(fmt.Errorf("chat workspace persistence unavailable")) + return + } + var ( + snapshot protocol.ChatOpenWorkspaceSnapshot + changed bool + err error + ) + if request.ChatOpenWorkspaceRequest == nil { + snapshot, changed, err = pruneChatWorkspace(ctx, registry, store) + } else { + var entries []protocol.ChatOpenWorkspaceEntry + entries, err = validChatWorkspaceEntries(ctx, *request.ChatOpenWorkspaceRequest, registry) + if err == nil { + snapshot, changed, err = store.SaveChatOpenWorkspace(ctx, chatWorkspaceScope, entries, request.ChatOpenWorkspaceRequest.Seed, request.ChatOpenWorkspaceRequest.BaseRevision) + } + } + if err != nil { + fail(err) + return + } + _ = write(protocol.Message{Type: protocol.ChatOpenWorkspace, ID: request.ID, ChatOpenWorkspace: &snapshot}) + if changed { + changes.broadcastWorkspace(clientID, snapshot) + } +} diff --git a/internal/server/chat_open_workspace_test.go b/internal/server/chat_open_workspace_test.go new file mode 100644 index 00000000..96818c11 --- /dev/null +++ b/internal/server/chat_open_workspace_test.go @@ -0,0 +1,147 @@ +package server + +import ( + "context" + "testing" + + "github.com/coder/websocket" + + "git.a-wan.net/alan/pipelines/internal/protocol" +) + +func workspaceWrite(id string, base int64, entries ...protocol.ChatOpenWorkspaceEntry) protocol.Message { + return protocol.Message{Type: protocol.ChatOpenWorkspace, ID: id, ChatOpenWorkspaceRequest: &protocol.ChatOpenWorkspaceRequest{Entries: entries, BaseRevision: base}} +} + +func workspaceIDs(snapshot *protocol.ChatOpenWorkspaceSnapshot) []string { + ids := []string{} + for _, entry := range snapshot.Entries { + id := entry.SessionID + if entry.Floating { + id += "*" + } + ids = append(ids, id) + } + return ids +} + +func sameIDs(a []string, b ...string) bool { + if len(a) != len(b) { + return false + } + for i := range a { + if a[i] != b[i] { + return false + } + } + return true +} + +// readWorkspacePush reads chat_open_workspace_changed pushes until one carries +// revision; lower revisions (pushed out of order) are skipped. +func readWorkspacePush(t *testing.T, ctx context.Context, conn *websocket.Conn, revision int64) *protocol.ChatOpenWorkspaceSnapshot { + t.Helper() + for { + message := readUntil(t, ctx, conn, protocol.ChatOpenWorkspaceChanged) + got := message.ChatOpenWorkspace + if got == nil { + t.Fatal("push without a snapshot") + } + if got.Revision == revision { + return got + } + if got.Revision > revision { + t.Fatalf("push revision %d, want %d", got.Revision, revision) + } + } +} + +// TestChatOpenWorkspaceSyncsEveryConnection is the fan-out evidence: a write +// from one connection is stored at the next revision and pushed to the other; +// a write from a stale base is refused with the current snapshot; closing a +// chat drops it and pushes the result to both connections; and a later write +// cannot put the closed chat back. +func TestChatOpenWorkspaceSyncsEveryConnection(t *testing.T) { + store := newOperatorStore(t) + ctx, _, conns := dialChatConns(t, Options{Chat: scriptedChat(), OperatorRegistry: store}, 2) + for _, id := range []string{"ses_a", "ses_b"} { + if err := store.RecordOperatorSession(ctx, id, "/work", id, protocol.ChatSessionTagOperator); err != nil { + t.Fatal(err) + } + } + a, b := protocol.ChatOpenWorkspaceEntry{SessionID: "ses_a"}, protocol.ChatOpenWorkspaceEntry{SessionID: "ses_b", Floating: true} + + writeChat(t, ctx, conns[0], workspaceWrite("w1", 0, a, b, protocol.ChatOpenWorkspaceEntry{SessionID: "ses_unknown"})) + reply := readUntil(t, ctx, conns[0], protocol.ChatOpenWorkspace).ChatOpenWorkspace + if reply.Revision != 1 || reply.Rejected || !sameIDs(workspaceIDs(reply), "ses_a", "ses_b*") { + t.Fatalf("first write reply = %+v", reply) + } + if push := readWorkspacePush(t, ctx, conns[1], 1); !sameIDs(workspaceIDs(push), "ses_a", "ses_b*") { + t.Fatalf("second connection got %v", workspaceIDs(push)) + } + writeChat(t, ctx, conns[1], protocol.Message{Type: protocol.ChatOpenWorkspace, ID: "r1"}) + if read := readUntil(t, ctx, conns[1], protocol.ChatOpenWorkspace).ChatOpenWorkspace; read.Revision != 1 || !sameIDs(workspaceIDs(read), "ses_a", "ses_b*") { + t.Fatalf("read = %+v", read) + } + + // A write derived from revision 0 lands after revision 1: refused. + writeChat(t, ctx, conns[1], workspaceWrite("w2", 0, b)) + stale := readUntil(t, ctx, conns[1], protocol.ChatOpenWorkspace).ChatOpenWorkspace + if !stale.Rejected || stale.Revision != 1 || !sameIDs(workspaceIDs(stale), "ses_a", "ses_b*") { + t.Fatalf("stale write reply = %+v", stale) + } + + // Reorder from the second connection reaches the first. + b.Floating = false + writeChat(t, ctx, conns[1], workspaceWrite("w3", 1, b, a)) + if got := readUntil(t, ctx, conns[1], protocol.ChatOpenWorkspace).ChatOpenWorkspace; got.Revision != 2 { + t.Fatalf("reorder reply = %+v", got) + } + if push := readWorkspacePush(t, ctx, conns[0], 2); !sameIDs(workspaceIDs(push), "ses_b", "ses_a") { + t.Fatalf("reorder push = %v", workspaceIDs(push)) + } + + // Closing ses_a drops it and pushes revision 3 to both connections. + writeChat(t, ctx, conns[0], protocol.Message{Type: protocol.ChatClose, ID: "c1", ChatQuery: &protocol.ChatQuery{SessionID: "ses_a"}}) + readUntil(t, ctx, conns[0], protocol.ChatClose) + for i, conn := range conns { + if push := readWorkspacePush(t, ctx, conn, 3); !sameIDs(workspaceIDs(push), "ses_b") { + t.Fatalf("connection %d close push = %v", i, workspaceIDs(push)) + } + } + + // A client still showing the closed chat cannot restore it. + writeChat(t, ctx, conns[1], workspaceWrite("w4", 3, a, b)) + if got := readUntil(t, ctx, conns[1], protocol.ChatOpenWorkspace).ChatOpenWorkspace; got.Revision != 3 || !sameIDs(workspaceIDs(got), "ses_b") { + t.Fatalf("closed chat restored: %+v", got) + } +} + +// TestChatOpenWorkspacePrunesOnConnectForEveryone pins that a chat closed +// behind the workspace's back is pruned when a connection opens, and that the +// pruned snapshot reaches the connections already open, not only the new one. +func TestChatOpenWorkspacePrunesOnConnectForEveryone(t *testing.T) { + store := newOperatorStore(t) + ctx, _, srv, conns := dialChatServer(t, Options{Chat: scriptedChat(), OperatorRegistry: store}, 1) + for _, id := range []string{"ses_a", "ses_b"} { + if err := store.RecordOperatorSession(ctx, id, "/work", id, protocol.ChatSessionTagOperator); err != nil { + t.Fatal(err) + } + } + writeChat(t, ctx, conns[0], workspaceWrite("w1", 0, protocol.ChatOpenWorkspaceEntry{SessionID: "ses_a"}, protocol.ChatOpenWorkspaceEntry{SessionID: "ses_b"})) + readUntil(t, ctx, conns[0], protocol.ChatOpenWorkspace) + if err := store.CloseOperatorSession(ctx, "ses_a"); err != nil { + t.Fatal(err) + } + late := dialChatConn(t, ctx, srv) + for i, conn := range []*websocket.Conn{conns[0], late} { + if push := readWorkspacePush(t, ctx, conn, 2); !sameIDs(workspaceIDs(push), "ses_b") { + t.Fatalf("connection %d prune push = %v", i, workspaceIDs(push)) + } + } + // With nothing to prune, a new connection alone is brought up to date. + third := dialChatConn(t, ctx, srv) + if push := readWorkspacePush(t, ctx, third, 2); !sameIDs(workspaceIDs(push), "ses_b") { + t.Fatalf("catch-up push = %v", workspaceIDs(push)) + } +} diff --git a/internal/server/chat_session_changes.go b/internal/server/chat_session_changes.go index 114c7dcb..0b2cba75 100644 --- a/internal/server/chat_session_changes.go +++ b/internal/server/chat_session_changes.go @@ -62,6 +62,28 @@ func (c *chatSessionChanges) broadcast(sender string, session protocol.ChatSessi } } +// broadcastWorkspace pushes an open-chat snapshot to every connection except +// sender ("" reaches all of them). Writes run on their own goroutines, so they +// may arrive out of order; clients keep only the highest revision. +func (c *chatSessionChanges) broadcastWorkspace(sender string, snapshot protocol.ChatOpenWorkspaceSnapshot) { + if c == nil { + return + } + c.mu.Lock() + targets := make([]func(protocol.Message) error, 0, len(c.clients)) + for id, write := range c.clients { + if id != sender { + targets = append(targets, write) + } + } + c.mu.Unlock() + for _, write := range targets { + copy := snapshot + copy.Entries = append([]protocol.ChatOpenWorkspaceEntry(nil), snapshot.Entries...) + go func() { _ = write(protocol.Message{Type: protocol.ChatOpenWorkspaceChanged, ChatOpenWorkspace: ©}) }() + } +} + // echoOperatorSession answers a metadata change with the updated registry row // and pushes the same row to every other connection. func echoOperatorSession(ctx context.Context, request protocol.Message, sessionID, reply string, registry operatorRegistry, changes *chatSessionChanges, clientID string, write func(protocol.Message) error) { diff --git a/internal/server/websocket.go b/internal/server/websocket.go index fe0ca6cc..2fa57fe8 100644 --- a/internal/server/websocket.go +++ b/internal/server/websocket.go @@ -261,6 +261,9 @@ func HandlerWithOptions(ctx context.Context, options Options, stores ...*pipelin // connection the same way. hub.sessionChanges.attach(clientID, write) defer hub.sessionChanges.detach(clientID) + // The open-chat set: prune entries that are no longer open chats and + // push the result to every connection, else bring this one up to date. + announceChatWorkspace(connCtx, registry, hub.changes(), write) // Terminal lifecycle changes reach every connection; output only the // connections that opened or read that terminal. terminals.clients.attach(clientID, write)