[NEW] Introduce clearLocalStorageWhenChatEnded setting logic (#666)

Co-authored-by: Kevin Aleman <kevin.aleman@rocket.chat>
RocketChat · Dec 3, 2021 · 4c1777f · 4c1777f
1 parent 0b50f73
commit 4c1777f
Show file tree

Hide file tree

Showing 77 changed files with 15 additions and 5 deletions.
diff --git a/.loki/.gitignore b/.loki/.gitignore
@@ -0,0 +1,2 @@
+current
+difference
diff --git a/.loki/reference/chrome_Components_ButtonGroup_with_buttons_of_different_sizes.png b/.loki/reference/chrome_Components_ButtonGroup_with_buttons_of_different_sizes.png
diff --git a/.loki/reference/chrome_Components_ButtonGroup_with_buttons_of_same_size.png b/.loki/reference/chrome_Components_ButtonGroup_with_buttons_of_same_size.png
diff --git a/.loki/reference/chrome_Components_ButtonGroup_with_only_small_buttons.png b/.loki/reference/chrome_Components_ButtonGroup_with_only_small_buttons.png
diff --git a/.loki/reference/chrome_Components_Button_danger.png b/.loki/reference/chrome_Components_Button_danger.png
diff --git a/.loki/reference/chrome_Components_Button_disabled.png b/.loki/reference/chrome_Components_Button_disabled.png
diff --git a/.loki/reference/chrome_Components_Button_loading.png b/.loki/reference/chrome_Components_Button_loading.png
diff --git a/.loki/reference/chrome_Components_Button_normal.png b/.loki/reference/chrome_Components_Button_normal.png
diff --git a/.loki/reference/chrome_Components_Button_nude.png b/.loki/reference/chrome_Components_Button_nude.png
diff --git a/.loki/reference/chrome_Components_Button_outline.png b/.loki/reference/chrome_Components_Button_outline.png
diff --git a/.loki/reference/chrome_Components_Button_secondary.png b/.loki/reference/chrome_Components_Button_secondary.png
diff --git a/.loki/reference/chrome_Components_Button_small.png b/.loki/reference/chrome_Components_Button_small.png
diff --git a/.loki/reference/chrome_Components_Button_stack.png b/.loki/reference/chrome_Components_Button_stack.png
diff --git a/.loki/reference/chrome_Components_Button_with_badge.png b/.loki/reference/chrome_Components_Button_with_badge.png
diff --git a/.loki/reference/chrome_Components_Header_for_user_chat.png b/.loki/reference/chrome_Components_Header_for_user_chat.png
diff --git a/.loki/reference/chrome_Components_Header_with_custom_field.png b/.loki/reference/chrome_Components_Header_with_custom_field.png
diff --git a/.loki/reference/chrome_Components_Header_with_custom_field_and_alert.png b/.loki/reference/chrome_Components_Header_with_custom_field_and_alert.png
diff --git a/.loki/reference/chrome_Components_Header_with_theme.png b/.loki/reference/chrome_Components_Header_with_theme.png
diff --git a/.loki/reference/chrome_Components_Header_with_title_and_subtitle.png b/.loki/reference/chrome_Components_Header_with_title_and_subtitle.png
diff --git a/.loki/reference/chrome_Components_Icons_doc.png b/.loki/reference/chrome_Components_Icons_doc.png
diff --git a/.loki/reference/chrome_Components_Icons_file.png b/.loki/reference/chrome_Components_Icons_file.png
diff --git a/.loki/reference/chrome_Components_Icons_pdf.png b/.loki/reference/chrome_Components_Icons_pdf.png
diff --git a/.loki/reference/chrome_Components_Icons_ppt.png b/.loki/reference/chrome_Components_Icons_ppt.png
diff --git a/.loki/reference/chrome_Components_Icons_sheet.png b/.loki/reference/chrome_Components_Icons_sheet.png
diff --git a/.loki/reference/chrome_Components_Icons_zip.png b/.loki/reference/chrome_Components_Icons_zip.png
diff --git a/.loki/reference/chrome_Components_Menu_Item_disabled.png b/.loki/reference/chrome_Components_Menu_Item_disabled.png
diff --git a/.loki/reference/chrome_Components_Menu_Item_with_icon.png b/.loki/reference/chrome_Components_Menu_Item_with_icon.png
diff --git a/.loki/reference/chrome_Components_Modal_alert.png b/.loki/reference/chrome_Components_Modal_alert.png
diff --git a/.loki/reference/chrome_Components_Modal_animated.png b/.loki/reference/chrome_Components_Modal_animated.png
diff --git a/.loki/reference/chrome_Components_Modal_confirm.png b/.loki/reference/chrome_Components_Modal_confirm.png
diff --git a/.loki/reference/chrome_Components_Modal_disallow_dismiss_by_overlay.png b/.loki/reference/chrome_Components_Modal_disallow_dismiss_by_overlay.png
diff --git a/.loki/reference/chrome_Components_Modal_normal.png b/.loki/reference/chrome_Components_Modal_normal.png
diff --git a/.loki/reference/chrome_Components_Modal_timeout.png b/.loki/reference/chrome_Components_Modal_timeout.png
diff --git a/.loki/reference/chrome_Components_Screen_with_agent.png b/.loki/reference/chrome_Components_Screen_with_agent.png
diff --git a/.loki/reference/chrome_Components_Screen_with_agent_email.png b/.loki/reference/chrome_Components_Screen_with_agent_email.png
diff --git a/.loki/reference/chrome_Components_Screen_with_agent_phone.png b/.loki/reference/chrome_Components_Screen_with_agent_phone.png
diff --git a/.loki/reference/chrome_Forms_DateInput_default.png b/.loki/reference/chrome_Forms_DateInput_default.png
diff --git a/.loki/reference/chrome_Forms_DateInput_disabled.png b/.loki/reference/chrome_Forms_DateInput_disabled.png
diff --git a/.loki/reference/chrome_Forms_DateInput_filled.png b/.loki/reference/chrome_Forms_DateInput_filled.png
diff --git a/.loki/reference/chrome_Forms_DateInput_small.png b/.loki/reference/chrome_Forms_DateInput_small.png
diff --git a/.loki/reference/chrome_Forms_DateInput_with_error.png b/.loki/reference/chrome_Forms_DateInput_with_error.png
diff --git a/.loki/reference/chrome_Forms_Form_default.png b/.loki/reference/chrome_Forms_Form_default.png
diff --git a/.loki/reference/chrome_Forms_PasswordInput_disabled.png b/.loki/reference/chrome_Forms_PasswordInput_disabled.png
diff --git a/.loki/reference/chrome_Forms_SelectInput_disabled.png b/.loki/reference/chrome_Forms_SelectInput_disabled.png
diff --git a/.loki/reference/chrome_Forms_TextInput_disabled.png b/.loki/reference/chrome_Forms_TextInput_disabled.png
diff --git a/.loki/reference/chrome_Messages_MessageBlocks_with_blocks.png b/.loki/reference/chrome_Messages_MessageBlocks_with_blocks.png
diff --git a/.loki/reference/chrome_Messages_MessageList_normal.png b/.loki/reference/chrome_Messages_MessageList_normal.png
diff --git a/...reference/chrome_Messages_MessageList_with_hidden_agent_info_system_message.png b/...reference/chrome_Messages_MessageList_with_hidden_agent_info_system_message.png
diff --git a/.loki/reference/chrome_Messages_MessageList_with_system_message.png b/.loki/reference/chrome_Messages_MessageList_with_system_message.png
diff --git a/.loki/reference/chrome_Messages_MessageList_with_typing_users.png b/.loki/reference/chrome_Messages_MessageList_with_typing_users.png
diff --git a/.loki/reference/chrome_Messages_Message_default.png b/.loki/reference/chrome_Messages_Message_default.png
diff --git a/.loki/reference/chrome_Messages_Message_grouping.png b/.loki/reference/chrome_Messages_Message_grouping.png
diff --git a/.loki/reference/chrome_Messages_Message_markdown.png b/.loki/reference/chrome_Messages_Message_markdown.png
diff --git a/.loki/reference/chrome_Messages_Message_me.png b/.loki/reference/chrome_Messages_Message_me.png
diff --git a/.loki/reference/chrome_Messages_Message_with_files_attachments.png b/.loki/reference/chrome_Messages_Message_with_files_attachments.png
diff --git a/.loki/reference/chrome_Messages_Message_with_image_attachment.png b/.loki/reference/chrome_Messages_Message_with_image_attachment.png
diff --git a/.loki/reference/chrome_Messages_Message_with_quotation.png b/.loki/reference/chrome_Messages_Message_with_quotation.png
diff --git a/.loki/reference/chrome_Messages_TypingIndicator_with_avatars.png b/.loki/reference/chrome_Messages_TypingIndicator_with_avatars.png
diff --git a/.loki/reference/chrome_Routes_Chat_loading.png b/.loki/reference/chrome_Routes_Chat_loading.png
diff --git a/.loki/reference/chrome_Routes_Chat_normal.png b/.loki/reference/chrome_Routes_Chat_normal.png
diff --git a/.loki/reference/chrome_Routes_Chat_with_trigger_messages.png b/.loki/reference/chrome_Routes_Chat_with_trigger_messages.png
diff --git a/.loki/reference/chrome_Routes_Chat_with_typing_user.png b/.loki/reference/chrome_Routes_Chat_with_typing_user.png
diff --git a/.loki/reference/chrome_Routes_Leave_a_message_loading.png b/.loki/reference/chrome_Routes_Leave_a_message_loading.png
diff --git a/.loki/reference/chrome_Routes_Register_loading.png b/.loki/reference/chrome_Routes_Register_loading.png
diff --git a/.loki/reference/chrome_Routes_SwitchDepartment_loading.png b/.loki/reference/chrome_Routes_SwitchDepartment_loading.png
diff --git a/.loki/reference/chrome_Routes_SwitchDepartment_normal.png b/.loki/reference/chrome_Routes_SwitchDepartment_normal.png
diff --git a/.loki/reference/chrome_Routes_TriggerMessage_multiple.png b/.loki/reference/chrome_Routes_TriggerMessage_multiple.png
diff --git a/.loki/reference/chrome_UiKit_Message_Actions_block_button.png b/.loki/reference/chrome_UiKit_Message_Actions_block_button.png
diff --git a/.loki/reference/chrome_UiKit_Message_Actions_block_datepicker.png b/.loki/reference/chrome_UiKit_Message_Actions_block_datepicker.png
diff --git a/.loki/reference/chrome_UiKit_Message_Button_element_default.png b/.loki/reference/chrome_UiKit_Message_Button_element_default.png
diff --git a/.loki/reference/chrome_UiKit_Message_Context_block_mrkdwn.png b/.loki/reference/chrome_UiKit_Message_Context_block_mrkdwn.png
diff --git a/.loki/reference/chrome_UiKit_Message_Context_block_text_and_images.png b/.loki/reference/chrome_UiKit_Message_Context_block_text_and_images.png
diff --git a/.loki/reference/chrome_UiKit_Message_Section_block_accessory_as_button.png b/.loki/reference/chrome_UiKit_Message_Section_block_accessory_as_button.png
diff --git a/.loki/reference/chrome_UiKit_Message_Section_block_accessory_as_datepicker.png b/.loki/reference/chrome_UiKit_Message_Section_block_accessory_as_datepicker.png
diff --git a/.loki/reference/chrome_UiKit_Message_Section_block_text_as_mrkdwn.png b/.loki/reference/chrome_UiKit_Message_Section_block_text_as_mrkdwn.png
diff --git a/src/lib/room.js b/src/lib/room.js
@@ -4,7 +4,7 @@ import { Livechat } from '../api';
 import { CallStatus, isCallOngoing } from '../components/Calls/CallStatus';
 import { setCookies, upsert, canRenderMessage, createToken } from '../components/helpers';
 import I18n from '../i18n';
-import { store } from '../store';
+import { store, initialState } from '../store';
 import { normalizeAgent } from './api';
 import Commands from './commands';
 import constants from './constants';
@@ -21,6 +21,14 @@ export const closeChat = async ({ transcriptRequested } = {}) => {
 		await handleTranscript();
 	}
 
+	const { config: { settings: { clearLocalStorageWhenChatEnded } = {} } = {} } = store.state;
+
+	if (clearLocalStorageWhenChatEnded) {
+		// exclude UI-affecting flags
+		const { minimized, visible, undocked, expanded, ...initial } = initialState();
+		await store.setState(initial);
+	}
+
 	await loadConfig();
 	parentCall('callback', 'chat-ended');
 	route('/chat-finished');
@@ -127,7 +135,7 @@ const isAgentHidden = () => {
 
 const transformAgentInformationOnMessage = (message) => {
 	const { user } = store.state;
-	if (message.u && message.u._id !== user._id && isAgentHidden()) {
+	if (message && user && message.u && message.u._id !== user._id && isAgentHidden()) {
 		return { ...message, u: { _id: message.u._id } };
 	}
 

diff --git a/src/store/index.js b/src/store/index.js
@@ -4,7 +4,7 @@ import Store from './Store';
 
 const createToken = () => Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
 
-const initialState = {
+export const initialState = () => ({
 	token: createToken(),
 	typing: [],
 	config: {
@@ -36,10 +36,10 @@ const initialState = {
 	unread: null,
 	incomingCallAlert: null,
 	ongoingCall: null,	// TODO: store call info like url, startTime, timeout, etc here
-};
+});
 
 const dontPersist = ['messages', 'typing', 'loading', 'alerts', 'unread', 'noMoreMessages', 'modal', 'incomingCallAlert', 'ongoingCall'];
-export const store = new Store(initialState, { dontPersist });
+export const store = new Store(initialState(), { dontPersist });
 
 if (process.env.NODE_ENV === 'development') {
 	store.on('change', ([, , partialState]) => {