From b32922dfc81d54bf844028ea58110cd8f786d63c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20Lys=C3=BD?= <jan.lysy@automattic.com>
Date: Thu, 22 Feb 2024 17:08:32 +0100
Subject: [PATCH] Save active tab in email editor store

[MAILPOET-5638]
---
 .../engine/components/sidebar/header.tsx      | 43 ++++++++++---------
 .../engine/components/sidebar/sidebar.tsx     | 27 ++++++------
 .../src/email-editor/engine/store/actions.ts  | 11 ++++-
 .../email-editor/engine/store/constants.ts    |  4 +-
 .../engine/store/initial-state.ts             |  4 ++
 .../src/email-editor/engine/store/reducer.ts  |  8 ++++
 .../email-editor/engine/store/selectors.ts    |  4 ++
 .../js/src/email-editor/engine/store/types.ts |  3 ++
 8 files changed, 65 insertions(+), 39 deletions(-)

diff --git a/mailpoet/assets/js/src/email-editor/engine/components/sidebar/header.tsx b/mailpoet/assets/js/src/email-editor/engine/components/sidebar/header.tsx
index 511fc14e01..51a8ae762a 100644
--- a/mailpoet/assets/js/src/email-editor/engine/components/sidebar/header.tsx
+++ b/mailpoet/assets/js/src/email-editor/engine/components/sidebar/header.tsx
@@ -1,32 +1,35 @@
-import classnames from 'classnames';
-import { __ } from '@wordpress/i18n';
-import { useEffect } from '@wordpress/element';
-import { useDispatch, useSelect } from '@wordpress/data';
 import { store as blockEditorStore } from '@wordpress/block-editor';
+import { useDispatch, useSelect } from '@wordpress/data';
+import { useEffect } from '@wordpress/element';
+import { __ } from '@wordpress/i18n';
+import classnames from 'classnames';
 import {
-  mainSidebarEmailKey,
-  mainSidebarBlockKey,
+  mainSidebarBlockTab,
+  mainSidebarEmailTab,
   storeName,
 } from '../../store';
 
-type Props = {
-  sidebarKey: string;
-};
-
-export function Header({ sidebarKey }: Props) {
-  const { openSidebar } = useDispatch(storeName);
+export function Header() {
+  const { toggleSettingsSidebarActiveTab } = useDispatch(storeName);
 
   const selectedBlockId = useSelect(
     (select) => select(blockEditorStore).getSelectedBlockClientId(),
     [],
   );
 
+  const activeTab = useSelect(
+    (select) => select(storeName).getSettingsSidebarActiveTab(),
+    [],
+  );
+
   // Switch tab based on selected block.
   useEffect(() => {
-    void openSidebar(
-      selectedBlockId ? mainSidebarBlockKey : mainSidebarEmailKey,
-    );
-  }, [selectedBlockId, openSidebar]);
+    if (selectedBlockId) {
+      void toggleSettingsSidebarActiveTab(mainSidebarBlockTab);
+    } else {
+      void toggleSettingsSidebarActiveTab(mainSidebarEmailTab);
+    }
+  }, [selectedBlockId, toggleSettingsSidebarActiveTab]);
 
   return (
     <div className="components-panel__header interface-complementary-area-header edit-post-sidebar__panel-tabs">
@@ -34,11 +37,11 @@ export function Header({ sidebarKey }: Props) {
         <li>
           <button
             onClick={() => {
-              void openSidebar(mainSidebarEmailKey);
+              void toggleSettingsSidebarActiveTab(mainSidebarEmailTab);
             }}
             className={classnames(
               'components-button edit-post-sidebar__panel-tab',
-              { 'is-active': sidebarKey === mainSidebarEmailKey },
+              { 'is-active': activeTab === mainSidebarEmailTab },
             )}
             data-automation-id="email_settings_tab"
             type="button"
@@ -49,11 +52,11 @@ export function Header({ sidebarKey }: Props) {
         <li>
           <button
             onClick={() => {
-              void openSidebar(mainSidebarBlockKey);
+              void toggleSettingsSidebarActiveTab(mainSidebarBlockTab);
             }}
             className={classnames(
               'components-button edit-post-sidebar__panel-tab',
-              { 'is-active': sidebarKey === mainSidebarBlockKey },
+              { 'is-active': activeTab === mainSidebarBlockTab },
             )}
             data-automation-id="mailpoet_block_settings_tab"
             type="button"
diff --git a/mailpoet/assets/js/src/email-editor/engine/components/sidebar/sidebar.tsx b/mailpoet/assets/js/src/email-editor/engine/components/sidebar/sidebar.tsx
index eb8dcbbe10..f91dbf73d7 100644
--- a/mailpoet/assets/js/src/email-editor/engine/components/sidebar/sidebar.tsx
+++ b/mailpoet/assets/js/src/email-editor/engine/components/sidebar/sidebar.tsx
@@ -2,16 +2,14 @@ import { Panel } from '@wordpress/components';
 import { __ } from '@wordpress/i18n';
 import { useSelect } from '@wordpress/data';
 import { BlockInspector } from '@wordpress/block-editor';
-import {
-  ComplementaryArea,
-  store as interfaceStore,
-} from '@wordpress/interface';
+import { ComplementaryArea } from '@wordpress/interface';
 import { ComponentProps } from 'react';
 import { drawerRight } from '@wordpress/icons';
 import {
   storeName,
-  mainSidebarEmailKey,
-  mainSidebarBlockKey,
+  mainSidebarEmailTab,
+  mainSidebarBlockTab,
+  mainSidebarId,
 } from '../../store';
 import { Header } from './header';
 import { EmailSettings } from './email-settings';
@@ -19,25 +17,24 @@ import { EmailSettings } from './email-settings';
 type Props = ComponentProps<typeof ComplementaryArea>;
 
 export function Sidebar(props: Props): JSX.Element {
-  const { sidebarKey } = useSelect((select) => ({
-    sidebarKey:
-      select(interfaceStore).getActiveComplementaryArea(storeName) ??
-      mainSidebarEmailKey,
-  }));
+  const activeTab = useSelect(
+    (select) => select(storeName).getSettingsSidebarActiveTab(),
+    [],
+  );
 
   return (
     <ComplementaryArea
-      identifier={sidebarKey}
+      identifier={mainSidebarId}
       className="edit-post-sidebar"
-      header={<Header sidebarKey={sidebarKey} />}
+      header={<Header />}
       icon={drawerRight}
       scope={storeName}
       smallScreenTitle={__('No title', 'mailpoet')}
       isActiveByDefault
       {...props}
     >
-      {sidebarKey === mainSidebarEmailKey && <EmailSettings />}
-      {sidebarKey === mainSidebarBlockKey && (
+      {activeTab === mainSidebarEmailTab && <EmailSettings />}
+      {activeTab === mainSidebarBlockTab && (
         <Panel>
           <BlockInspector />
         </Panel>
diff --git a/mailpoet/assets/js/src/email-editor/engine/store/actions.ts b/mailpoet/assets/js/src/email-editor/engine/store/actions.ts
index 1baffd04c0..13d34ad91f 100644
--- a/mailpoet/assets/js/src/email-editor/engine/store/actions.ts
+++ b/mailpoet/assets/js/src/email-editor/engine/store/actions.ts
@@ -5,7 +5,7 @@ import { store as preferencesStore } from '@wordpress/preferences';
 import { store as noticesStore } from '@wordpress/notices';
 import { __ } from '@wordpress/i18n';
 import { apiFetch } from '@wordpress/data-controls';
-import { storeName, mainSidebarEmailKey } from './constants';
+import { storeName, mainSidebarEmailTab } from './constants';
 import { SendingPreviewStatus, State, Feature } from './types';
 
 export const toggleFeature =
@@ -47,7 +47,7 @@ export function updateSendPreviewEmail(toEmail: string) {
 }
 
 export const openSidebar =
-  (key = mainSidebarEmailKey) =>
+  (key = mainSidebarEmailTab) =>
   ({ registry }): unknown =>
     registry.dispatch(interfaceStore).enableComplementaryArea(storeName, key);
 
@@ -56,6 +56,13 @@ export const closeSidebar =
   ({ registry }): unknown =>
     registry.dispatch(interfaceStore).disableComplementaryArea(storeName);
 
+export function toggleSettingsSidebarActiveTab(activeTab: string) {
+  return {
+    type: 'TOGGLE_SETTINGS_SIDEBAR_ACTIVE_TAB',
+    state: { activeTab } as Partial<State['settingsSidebar']>,
+  } as const;
+}
+
 export function* saveEditedEmail() {
   const postId = select(storeName).getEmailPostId();
   // This returns a promise
diff --git a/mailpoet/assets/js/src/email-editor/engine/store/constants.ts b/mailpoet/assets/js/src/email-editor/engine/store/constants.ts
index c331bfd6a7..d54cc6626c 100644
--- a/mailpoet/assets/js/src/email-editor/engine/store/constants.ts
+++ b/mailpoet/assets/js/src/email-editor/engine/store/constants.ts
@@ -1,5 +1,5 @@
 export const storeName = 'email-editor/editor';
 
 export const mainSidebarId = 'email-editor/editor/main';
-export const mainSidebarEmailKey = 'email-editor/editor/main/email';
-export const mainSidebarBlockKey = 'email-editor/editor/main/block';
+export const mainSidebarEmailTab = 'email';
+export const mainSidebarBlockTab = 'block';
diff --git a/mailpoet/assets/js/src/email-editor/engine/store/initial-state.ts b/mailpoet/assets/js/src/email-editor/engine/store/initial-state.ts
index 9a90bcbce0..3ad77df056 100644
--- a/mailpoet/assets/js/src/email-editor/engine/store/initial-state.ts
+++ b/mailpoet/assets/js/src/email-editor/engine/store/initial-state.ts
@@ -1,3 +1,4 @@
+import { mainSidebarEmailTab } from './constants';
 import { State } from './types';
 import {
   getEditorLayout,
@@ -15,6 +16,9 @@ export function getInitialState(): State {
     listviewSidebar: {
       isOpened: false,
     },
+    settingsSidebar: {
+      activeTab: mainSidebarEmailTab,
+    },
     postId,
     editorSettings: getEditorSettings(),
     layoutStyles: getEmailLayoutStyles(),
diff --git a/mailpoet/assets/js/src/email-editor/engine/store/reducer.ts b/mailpoet/assets/js/src/email-editor/engine/store/reducer.ts
index b36a5c2fcc..b61d63a052 100644
--- a/mailpoet/assets/js/src/email-editor/engine/store/reducer.ts
+++ b/mailpoet/assets/js/src/email-editor/engine/store/reducer.ts
@@ -31,6 +31,14 @@ export function reducer(state: State, action): State {
         ...state,
         preview: { ...state.preview, ...action.state },
       };
+    case 'TOGGLE_SETTINGS_SIDEBAR_ACTIVE_TAB':
+      return {
+        ...state,
+        settingsSidebar: {
+          ...state.settingsSidebar,
+          activeTab: action.state.activeTab,
+        },
+      };
     default:
       return state;
   }
diff --git a/mailpoet/assets/js/src/email-editor/engine/store/selectors.ts b/mailpoet/assets/js/src/email-editor/engine/store/selectors.ts
index 3e40258f80..21c1a59a86 100644
--- a/mailpoet/assets/js/src/email-editor/engine/store/selectors.ts
+++ b/mailpoet/assets/js/src/email-editor/engine/store/selectors.ts
@@ -111,6 +111,10 @@ export function isListviewSidebarOpened(state: State): boolean {
   return state.listviewSidebar.isOpened;
 }
 
+export function getSettingsSidebarActiveTab(state: State): string {
+  return state.settingsSidebar.activeTab;
+}
+
 export function getInitialEditorSettings(
   state: State,
 ): State['editorSettings'] {
diff --git a/mailpoet/assets/js/src/email-editor/engine/store/types.ts b/mailpoet/assets/js/src/email-editor/engine/store/types.ts
index 084facfd5b..e39b809dd1 100644
--- a/mailpoet/assets/js/src/email-editor/engine/store/types.ts
+++ b/mailpoet/assets/js/src/email-editor/engine/store/types.ts
@@ -48,6 +48,9 @@ export type State = {
   listviewSidebar: {
     isOpened: boolean;
   };
+  settingsSidebar: {
+    activeTab: string;
+  };
   postId: number;
   editorSettings: EmailEditorSettings;
   layoutStyles: EmailLayoutStyles;