From 9ab5b9d79136b6e71b269ab0f5525cff414294b0 Mon Sep 17 00:00:00 2001
From: Pavel Djundik <github@xpaw.me>
Date: Mon, 9 Jul 2018 15:14:44 +0300
Subject: [PATCH] Implement condensed messages in Vue

---
 client/components/Message.vue          |  1 -
 client/components/MessageCondensed.vue | 92 ++++++++++++++++++++++++++
 client/components/MessageList.vue      | 44 +++++++++++-
 client/js/condensed.js                 | 72 --------------------
 client/js/lounge.js                    |  4 --
 client/js/render.js                    |  7 +-
 client/js/socket-events/more.js        | 18 -----
 client/views/msg_condensed.tpl         |  7 --
 client/views/msg_condensed_toggle.tpl  |  1 -
 9 files changed, 137 insertions(+), 109 deletions(-)
 create mode 100644 client/components/MessageCondensed.vue
 delete mode 100644 client/js/condensed.js
 delete mode 100644 client/views/msg_condensed.tpl
 delete mode 100644 client/views/msg_condensed_toggle.tpl

diff --git a/client/components/Message.vue b/client/components/Message.vue
index 70774e7b..36719165 100644
--- a/client/components/Message.vue
+++ b/client/components/Message.vue
@@ -2,7 +2,6 @@
 	<div
 		:id="'msg-' + message.id"
 		:class="['msg', message.type, {self: message.self, highlight: message.highlight}]"
-		:data-time="message.time"
 		:data-from="message.from && message.from.nick"
 	>
 		<span
diff --git a/client/components/MessageCondensed.vue b/client/components/MessageCondensed.vue
new file mode 100644
index 00000000..1b40bd99
--- /dev/null
+++ b/client/components/MessageCondensed.vue
@@ -0,0 +1,92 @@
+<template>
+	<div class="msg condensed closed" ref="condensedContainer">
+		<div class="condensed-summary">
+			<span class="time"></span>
+			<span class="from"></span>
+			<span class="content">
+				{{condensedText}}
+				<button class="toggle-button" aria-label="Toggle status messages" @click="onExpandClick"></button>
+			</span>
+		</div>
+		<Message
+			v-for="message in messages"
+			:message="message"
+			:key="message.id"/>
+	</div>
+</template>
+
+<script>
+const constants = require("../js/constants");
+import Message from "./Message.vue";
+
+export default {
+	name: "MessageCondensed",
+	components: {
+		Message
+	},
+	props: {
+		messages: Array,
+	},
+	computed: {
+		condensedText() {
+			const obj = {};
+
+			constants.condensedTypes.forEach((type) => {
+				obj[type] = 0;
+			});
+
+			for (const message of this.messages) {
+				obj[message.type]++;
+			}
+
+			// Count quits as parts in condensed messages to reduce information density
+			obj.part += obj.quit;
+
+			const strings = [];
+			constants.condensedTypes.forEach((type) => {
+				if (obj[type]) {
+					switch (type) {
+					case "away":
+						strings.push(obj[type] + (obj[type] > 1 ? " users have gone away" : " user has gone away"));
+						break;
+					case "back":
+						strings.push(obj[type] + (obj[type] > 1 ? " users have come back" : " user has come back"));
+						break;
+					case "chghost":
+						strings.push(obj[type] + (obj[type] > 1 ? " users have changed hostname" : " user has changed hostname"));
+						break;
+					case "join":
+						strings.push(obj[type] + (obj[type] > 1 ? " users have joined" : " user has joined"));
+						break;
+					case "part":
+						strings.push(obj[type] + (obj[type] > 1 ? " users have left" : " user has left"));
+						break;
+					case "nick":
+						strings.push(obj[type] + (obj[type] > 1 ? " users have changed nick" : " user has changed nick"));
+						break;
+					case "kick":
+						strings.push(obj[type] + (obj[type] > 1 ? " users were kicked" : " user was kicked"));
+						break;
+					case "mode":
+						strings.push(obj[type] + (obj[type] > 1 ? " modes were set" : " mode was set"));
+						break;
+					}
+				}
+			});
+
+			let text = strings.pop();
+
+			if (strings.length) {
+				text = strings.join(", ") + ", and " + text;
+			}
+
+			return text;
+		},
+	},
+	methods: {
+		onExpandClick() {
+			this.$refs.condensedContainer.classList.toggle("closed");
+		},
+	},
+};
+</script>
diff --git a/client/components/MessageList.vue b/client/components/MessageList.vue
index ff6dd311..e1a04062 100644
--- a/client/components/MessageList.vue
+++ b/client/components/MessageList.vue
@@ -5,7 +5,7 @@
 		aria-live="polite"
 		aria-relevant="additions"
 	>
-		<template v-for="(message, id) in channel.messages">
+		<template v-for="(message, id) in getCondensedMessages">
 			<div
 				v-if="shouldDisplayDateMarker(id)"
 				:key="message.id + '-date'"
@@ -26,7 +26,10 @@
 			>
 				<span class="unread-marker-text"/>
 			</div>
+
+			<MessageCondensed v-if="message.type === 'condensed'" :key="message.id" :messages="message.messages"/>
 			<Message
+				v-else
 				:message="message"
 				:key="message.id"/>
 		</template>
@@ -34,16 +37,55 @@
 </template>
 
 <script>
+const constants = require("../js/constants");
 import Message from "./Message.vue";
+import MessageCondensed from "./MessageCondensed.vue";
 
 export default {
 	name: "MessageList",
 	components: {
 		Message,
+		MessageCondensed,
 	},
 	props: {
 		channel: Object,
 	},
+	computed: {
+		getCondensedMessages() {
+			if (this.channel.type !== "channel") {
+				return this.channel.messages;
+			}
+
+			const condensed = [];
+			let lastCondensedContainer = null;
+
+			for (const message of this.channel.messages) {
+				// If this message is not condensable, or its an action affecting our user,
+				// then just append the message to container and be done with it
+				if (message.self || message.highlight || !constants.condensedTypes.includes(message.type)) {
+					lastCondensedContainer = null;
+
+					condensed.push(message);
+
+					continue;
+				}
+
+				if (lastCondensedContainer === null) {
+					lastCondensedContainer = {
+						type: "condensed",
+						messages: [],
+					};
+
+					condensed.push(lastCondensedContainer);
+				}
+
+				lastCondensedContainer.id = message.id; // TODO
+				lastCondensedContainer.messages.push(message);
+			}
+
+			return condensed;
+		},
+	},
 	methods: {
 		shouldDisplayDateMarker(id) {
 			const previousTime = this.channel.messages[id - 1];
diff --git a/client/js/condensed.js b/client/js/condensed.js
deleted file mode 100644
index a7de2402..00000000
--- a/client/js/condensed.js
+++ /dev/null
@@ -1,72 +0,0 @@
-"use strict";
-
-const constants = require("./constants");
-const templates = require("../views");
-
-module.exports = {
-	updateText,
-	getStoredTypes,
-};
-
-function getStoredTypes(condensed) {
-	const obj = {};
-
-	constants.condensedTypes.forEach((type) => {
-		obj[type] = condensed.data(type) || 0;
-	});
-
-	return obj;
-}
-
-function updateText(condensed, addedTypes) {
-	const obj = getStoredTypes(condensed);
-
-	Object.keys(addedTypes).map((type) => {
-		obj[type] += addedTypes[type];
-		condensed.data(type, obj[type]);
-	});
-
-	// Count quits as parts in condensed messages to reduce information density
-	obj.part += obj.quit;
-
-	const strings = [];
-	constants.condensedTypes.forEach((type) => {
-		if (obj[type]) {
-			switch (type) {
-			case "away":
-				strings.push(obj[type] + (obj[type] > 1 ? " users have gone away" : " user has gone away"));
-				break;
-			case "back":
-				strings.push(obj[type] + (obj[type] > 1 ? " users have come back" : " user has come back"));
-				break;
-			case "chghost":
-				strings.push(obj[type] + (obj[type] > 1 ? " users have changed hostname" : " user has changed hostname"));
-				break;
-			case "join":
-				strings.push(obj[type] + (obj[type] > 1 ? " users have joined" : " user has joined"));
-				break;
-			case "part":
-				strings.push(obj[type] + (obj[type] > 1 ? " users have left" : " user has left"));
-				break;
-			case "nick":
-				strings.push(obj[type] + (obj[type] > 1 ? " users have changed nick" : " user has changed nick"));
-				break;
-			case "kick":
-				strings.push(obj[type] + (obj[type] > 1 ? " users were kicked" : " user was kicked"));
-				break;
-			case "mode":
-				strings.push(obj[type] + (obj[type] > 1 ? " modes were set" : " mode was set"));
-				break;
-			}
-		}
-	});
-
-	let text = strings.pop();
-
-	if (strings.length) {
-		text = strings.join(", ") + ", and " + text;
-	}
-
-	condensed.find(".condensed-summary .content")
-		.html(text + templates.msg_condensed_toggle());
-}
diff --git a/client/js/lounge.js b/client/js/lounge.js
index a592ee4d..70047606 100644
--- a/client/js/lounge.js
+++ b/client/js/lounge.js
@@ -119,10 +119,6 @@ window.vueMounted = () => {
 		});
 	});
 
-	chat.on("click", ".condensed-summary .content", function() {
-		$(this).closest(".msg.condensed").toggleClass("closed");
-	});
-
 	const openWindow = function openWindow(e, {keepSidebarOpen, pushState, replaceHistory} = {}) {
 		const self = $(this);
 		const target = self.attr("data-target");
diff --git a/client/js/render.js b/client/js/render.js
index 5b5e04fc..89bffd47 100644
--- a/client/js/render.js
+++ b/client/js/render.js
@@ -1,12 +1,7 @@
 "use strict";
 
 const $ = require("jquery");
-const templates = require("../views");
-const options = require("./options");
-const renderPreview = require("./renderPreview");
 const utils = require("./utils");
-const constants = require("./constants");
-const condensed = require("./condensed");
 const JoinChannel = require("./join-channel");
 const {vueApp} = require("./vue");
 
@@ -15,6 +10,7 @@ module.exports = {
 	trimMessageInChannel,
 };
 
+/*
 function appendMessage(container, chanId, chanType, msg) {
 	if (utils.lastMessageId < msg.id) {
 		utils.lastMessageId = msg.id;
@@ -109,6 +105,7 @@ function buildChatMessage(msg) {
 
 	return renderedMessage;
 }
+*/
 
 function renderNetworks(data, singleNetwork) {
 	// Add keyboard handlers to the "Join a channel…" form inputs/button
diff --git a/client/js/socket-events/more.js b/client/js/socket-events/more.js
index 6c510a7a..cbb8ba1e 100644
--- a/client/js/socket-events/more.js
+++ b/client/js/socket-events/more.js
@@ -2,7 +2,6 @@
 
 const $ = require("jquery");
 const socket = require("../socket");
-const condensed = require("../condensed");
 const {vueApp, findChannel} = require("../vue");
 
 socket.on("more", function(data) {
@@ -31,21 +30,4 @@ socket.on("more", function(data) {
 	if (data.messages.length !== 100) {
 		scrollable.find(".show-more").removeClass("show");
 	}
-
-	return;
-
-	// Join duplicate condensed messages together
-	const condensedDuplicate = chan.find(".msg.condensed + .msg.condensed");
-
-	if (condensedDuplicate) {
-		const condensedCorrect = condensedDuplicate.prev();
-
-		condensed.updateText(condensedCorrect, condensed.getStoredTypes(condensedDuplicate));
-
-		condensedCorrect
-			.append(condensedDuplicate.find(".msg"))
-			.toggleClass("closed", condensedDuplicate.hasClass("closed"));
-
-		condensedDuplicate.remove();
-	}
 });
diff --git a/client/views/msg_condensed.tpl b/client/views/msg_condensed.tpl
deleted file mode 100644
index 8be740cf..00000000
--- a/client/views/msg_condensed.tpl
+++ /dev/null
@@ -1,7 +0,0 @@
-<div class="msg condensed closed" data-time="{{time}}">
-	<div class="condensed-summary">
-		<span class="time">{{tz time}}</span>
-		<span class="from"></span>
-		<span class="content"></span>
-	</div>
-</div>
diff --git a/client/views/msg_condensed_toggle.tpl b/client/views/msg_condensed_toggle.tpl
deleted file mode 100644
index 2c740773..00000000
--- a/client/views/msg_condensed_toggle.tpl
+++ /dev/null
@@ -1 +0,0 @@
-<button class="toggle-button" aria-label="Toggle status messages"></button>