refactor: reduce service switcher tearing

We render the location bar and notification banners separately for each
service and keep track of the BrowserView size separately for each
service to reduce the tearing that appears when people switch services.
The tearing cannot be eliminated completely, because it comes from the
separation between the main and renderer processes. But we can at least
try and reduce the IPC round-tripping and layout calculations required
to accurately position the services.

This approach has an overhead compared to the single
BrowserViewPlaceholder approach, because the renderer process has to
layout the location bar and notification for all services, not only the
selected one. The number of IPC messages during windows resize is also
increased. To compensate, we increase the throttle interval for resize
IPC messages and let electron itself resize the BrowserView between IPC
updates. (We must still keep pumping IPC messages during window resize,
because, e.g., changes in notification banner size due to re-layouting
will still affect the required BrowserView size).

If further reduction of IPC traffic is needed, we could implement
batching for resize IPC messages and more intelligent throttling via a
token bucker mechanism.

Signed-off-by: Kristóf Marussy <kristof@marussy.com>

1 files changed, 76 insertions, 0 deletions

diff --git a/packages/renderer/src/components/ServicePanel.tsx b/packages/renderer/src/components/ServicePanel.tsx
new file mode 100644
index 0000000..de58d24
--- /dev/null
+++ b/packages/renderer/src/components/ServicePanel.tsx
@@ -0,0 +1,76 @@
+/*
+ * Copyright (C)  2021-2022 Kristóf Marussy <kristof@marussy.com>
+ *
+ * This file is part of Sophie.
+ *
+ * Sophie is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+import Box from '@mui/material/Box';
+import { observer } from 'mobx-react-lite';
+import React from 'react';
+
+import Service from '../stores/Service';
+
+import BrowserViewPlaceholder from './BrowserViewPlaceholder';
+import { useStore } from './StoreProvider';
+import InsecureConnectionBanner from './banner/InsecureConnectionBanner';
+import NewWindowBanner from './banner/NewWindowBanner';
+import ErrorPage from './errorPage/ErrorPage';
+import LocationBar from './locationBar/LocationBar';
+
+export function getServicePanelID(service: Service): string {
+  return `Sophie-${service.id}-ServicePanel`;
+}
+
+function ServicePanel({ service }: { service: Service }): JSX.Element {
+  const {
+    settings: { selectedService },
+  } = useStore();
+
+  const {
+    settings: { name },
+  } = service;
+  const visible = service === selectedService;
+
+  return (
+    <Box
+      id={getServicePanelID(service)}
+      role="tabpanel"
+      aria-label={name}
+      sx={{
+        position: 'absolute',
+        top: 0,
+        left: 0,
+        bottom: 0,
+        right: 0,
+        display: 'flex',
+        overflow: 'hidden',
+        visibility: visible ? 'visible' : 'hidden',
+        flexDirection: 'column',
+        alignItems: 'stretch',
+      }}
+    >
+      <LocationBar service={service} />
+      <InsecureConnectionBanner service={service} />
+      <NewWindowBanner service={service} />
+      <BrowserViewPlaceholder service={service}>
+        <ErrorPage service={service} />
+      </BrowserViewPlaceholder>
+    </Box>
+  );
+}
+
+export default observer(ServicePanel);