refactor(renderer): remove StoreProvider

Use explicit prop threading to pass the MainStore to components, which
makes the data dependencies more explicit and enables better
testability.

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

9 files changed, 123 insertions, 139 deletions

diff --git a/packages/renderer/src/components/App.tsx b/packages/renderer/src/components/App.tsx
index 2f728e7..b0686a9 100644
--- a/packages/renderer/src/components/App.tsx
+++ b/packages/renderer/src/components/App.tsx
@@ -23,18 +23,25 @@ import { observer } from 'mobx-react-lite';
 import React, { useCallback, useEffect } from 'react';
 import { useTranslation } from 'react-i18next';
 
+import type RendererStore from '../stores/RendererStore';
+
 import ServicePanel from './ServicePanel';
-import { useStore } from './StoreProvider';
 import Sidebar from './sidebar/Sidebar';
 
-function App({ devMode }: { devMode: boolean }): JSX.Element {
+function App({
+  store,
+  devMode,
+}: {
+  store: RendererStore;
+  devMode: boolean;
+}): JSX.Element {
   const { ready, t } = useTranslation(undefined, {
     useSuspense: false,
   });
   const {
     settings: { selectedService },
     shared: { services },
-  } = useStore();
+  } = store;
   const {
     settings: { name: serviceName },
     title: serviceTitle,
@@ -88,7 +95,7 @@ function App({ devMode }: { devMode: boolean }): JSX.Element {
         width: '100vw',
       }}
     >
-      <Sidebar />
+      <Sidebar store={store} />
       <Box
         sx={{
           flex: 1,
@@ -97,7 +104,7 @@ function App({ devMode }: { devMode: boolean }): JSX.Element {
         }}
       >
         {services.map((service) => (
-          <ServicePanel key={service.id} service={service} />
+          <ServicePanel key={service.id} store={store} service={service} />
         ))}
       </Box>
     </Box>
diff --git a/packages/renderer/src/components/ServicePanel.tsx b/packages/renderer/src/components/ServicePanel.tsx
index de58d24..2c79d99 100644
--- a/packages/renderer/src/components/ServicePanel.tsx
+++ b/packages/renderer/src/components/ServicePanel.tsx
@@ -19,57 +19,66 @@
  */
 
 import Box from '@mui/material/Box';
+import { styled } from '@mui/material/styles';
 import { observer } from 'mobx-react-lite';
 import React from 'react';
 
+import type RendererStore from '../stores/RendererStore';
 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';
 
+const ServicePanelRoot = styled(Box, {
+  shouldForwardProp: (prop) => prop !== 'hidden',
+})(({ hidden }) => ({
+  position: 'absolute',
+  top: 0,
+  left: 0,
+  bottom: 0,
+  right: 0,
+  display: 'flex',
+  overflow: 'hidden',
+  visibility: hidden ? 'hidden' : 'visible',
+  flexDirection: 'column',
+  alignItems: 'stretch',
+}));
+
 export function getServicePanelID(service: Service): string {
   return `Sophie-${service.id}-ServicePanel`;
 }
 
-function ServicePanel({ service }: { service: Service }): JSX.Element {
+function ServicePanel({
+  store,
+  service,
+}: {
+  store: RendererStore;
+  service: Service;
+}): JSX.Element {
   const {
     settings: { selectedService },
-  } = useStore();
-
+  } = store;
   const {
     settings: { name },
   } = service;
-  const visible = service === selectedService;
 
   return (
-    <Box
+    <ServicePanelRoot
       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',
-      }}
+      hidden={service !== selectedService}
     >
-      <LocationBar service={service} />
+      <LocationBar store={store} service={service} />
       <InsecureConnectionBanner service={service} />
       <NewWindowBanner service={service} />
       <BrowserViewPlaceholder service={service}>
         <ErrorPage service={service} />
       </BrowserViewPlaceholder>
-    </Box>
+    </ServicePanelRoot>
   );
 }
 
diff --git a/packages/renderer/src/components/StoreProvider.tsx b/packages/renderer/src/components/StoreProvider.tsx
deleted file mode 100644
index de63083..0000000
--- a/packages/renderer/src/components/StoreProvider.tsx
+++ /dev/null
@@ -1,45 +0,0 @@
-/*
- * 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 React, { createContext, useContext } from 'react';
-
-import type RendererStore from '../stores/RendererStore';
-
-const StoreContext = createContext<RendererStore | undefined>(undefined);
-
-export function useStore(): RendererStore {
-  const store = useContext(StoreContext);
-  if (store === undefined) {
-    throw new Error('useStore can only be called inside of StoreProvider');
-  }
-  return store;
-}
-
-export default function StoreProvider({
-  children,
-  store,
-}: {
-  children: JSX.Element | JSX.Element[];
-  store: RendererStore;
-}): JSX.Element {
-  return (
-    <StoreContext.Provider value={store}>{children}</StoreContext.Provider>
-  );
-}
diff --git a/packages/renderer/src/components/locationBar/LocationBar.tsx b/packages/renderer/src/components/locationBar/LocationBar.tsx
index c290722..11981e9 100644
--- a/packages/renderer/src/components/locationBar/LocationBar.tsx
+++ b/packages/renderer/src/components/locationBar/LocationBar.tsx
@@ -22,8 +22,8 @@ import { styled } from '@mui/material/styles';
 import { observer } from 'mobx-react-lite';
 import React from 'react';
 
+import type RendererStore from '../../stores/RendererStore';
 import type Service from '../../stores/Service';
-import { useStore } from '../StoreProvider';
 
 import ExtraButtons from './ExtraButtons';
 import LocationTextField from './LocationTextField';
@@ -44,11 +44,15 @@ const LocationBarRoot = styled('header', {
   borderBottom: `1px solid ${theme.palette.divider}`,
 }));
 
-function LocationBar({ service }: { service: Service }): JSX.Element {
-  const {
+function LocationBar({
+  store: {
     settings: { showLocationBar },
-  } = useStore();
-
+  },
+  service,
+}: {
+  store: RendererStore;
+  service: Service;
+}): JSX.Element {
   const { alwaysShowLocationBar } = service;
   const locationBarVisible = showLocationBar || alwaysShowLocationBar;
 
diff --git a/packages/renderer/src/components/sidebar/ServiceSwitcher.tsx b/packages/renderer/src/components/sidebar/ServiceSwitcher.tsx
index 24cfd0c..7aa9124 100644
--- a/packages/renderer/src/components/sidebar/ServiceSwitcher.tsx
+++ b/packages/renderer/src/components/sidebar/ServiceSwitcher.tsx
@@ -26,9 +26,9 @@ import { observer } from 'mobx-react-lite';
 import React from 'react';
 import { useTranslation } from 'react-i18next';
 
+import type RendererStore from '../../stores/RendererStore';
 import type Service from '../../stores/Service';
 import { getServicePanelID } from '../ServicePanel';
-import { useStore } from '../StoreProvider';
 
 import ServiceIcon from './ServiceIcon';
 
@@ -88,14 +88,13 @@ function getServiceTitle(service: Service, t: TFunction) {
   return t('service.title.nameWithMessages', { name, messages: messagesText });
 }
 
-function ServiceSwitcher(): JSX.Element {
-  // This needs to be here even if we don't use any translations in this component,
-  // because the component must stay suspended until the translations are loaded.
-  // See: https://github.com/mui/material-ui/issues/14077
-  // TODO Try and remove this once mui and mobx-react-lite have updated to react 18.
+function ServiceSwitcher({
+  store: { settings, services },
+}: {
+  store: RendererStore;
+}): JSX.Element {
   const { t } = useTranslation();
 
-  const { settings, services } = useStore();
   const { selectedService } = settings;
 
   return (
diff --git a/packages/renderer/src/components/sidebar/Sidebar.tsx b/packages/renderer/src/components/sidebar/Sidebar.tsx
index fc57302..6c802ac 100644
--- a/packages/renderer/src/components/sidebar/Sidebar.tsx
+++ b/packages/renderer/src/components/sidebar/Sidebar.tsx
@@ -19,54 +19,60 @@
  */
 
 import Box from '@mui/material/Box';
+import { styled } from '@mui/material/styles';
 import React from 'react';
 
+import RendererStore from '../../stores/RendererStore';
+
 import ServiceSwitcher from './ServiceSwitcher';
 import ToggleDarkModeButton from './ToggleDarkModeButton';
 import ToggleLocationBarButton from './ToggleLocationBarButton';
 
-export default function Sidebar(): JSX.Element {
+const SidebarRoot = styled(Box)(({ theme }) => ({
+  flex: 0,
+  display: 'flex',
+  position: 'relative',
+  overflow: 'hidden',
+  flexDirection: 'column',
+  alignItems: 'center',
+  padding: `${theme.spacing(1)} 0`,
+  gap: theme.spacing(1),
+  backgroundColor:
+    theme.palette.mode === 'dark'
+      ? 'rgba(255, 255, 255, 0.09)'
+      : 'rgba(0, 0, 0, 0.06)',
+  minWidth: `calc(${theme.spacing(4)} + 36px)`,
+  '::after': {
+    content: '" "',
+    position: 'absolute',
+    top: '-20px',
+    bottom: '-20px',
+    right: '-20px',
+    zIndex: 100,
+    width: '20px',
+    boxShadow: theme.shadows[4],
+  },
+}));
+
+const SidebarFill = styled(Box)({
+  flex: 1,
+  display: 'flex',
+  flexDirection: 'column',
+  justifyContent: 'flex-start',
+});
+
+export default function Sidebar({
+  store,
+}: {
+  store: RendererStore;
+}): JSX.Element {
   return (
-    <Box
-      component="aside"
-      sx={(theme) => ({
-        flex: 0,
-        display: 'flex',
-        position: 'relative',
-        overflow: 'hidden',
-        flexDirection: 'column',
-        alignItems: 'center',
-        paddingY: 1,
-        gap: 1,
-        backgroundColor:
-          theme.palette.mode === 'dark'
-            ? 'rgba(255, 255, 255, 0.09)'
-            : 'rgba(0, 0, 0, 0.06)',
-        minWidth: `calc(${theme.spacing(4)} + 36px)`,
-        '::after': {
-          content: '" "',
-          position: 'absolute',
-          top: '-20px',
-          bottom: '-20px',
-          right: '-20px',
-          zIndex: 100,
-          width: '20px',
-          boxShadow: theme.shadows[4],
-        },
-      })}
-    >
-      <ToggleLocationBarButton />
-      <Box
-        sx={{
-          flex: 1,
-          display: 'flex',
-          flexDirection: 'column',
-          justifyContent: 'flex-start',
-        }}
-      >
-        <ServiceSwitcher />
-      </Box>
-      <ToggleDarkModeButton />
-    </Box>
+    <SidebarRoot component="aside">
+      <ToggleLocationBarButton store={store} />
+      <SidebarFill>
+        <ServiceSwitcher store={store} />
+      </SidebarFill>
+      <ToggleDarkModeButton store={store} />
+    </SidebarRoot>
   );
 }
diff --git a/packages/renderer/src/components/sidebar/ToggleDarkModeButton.tsx b/packages/renderer/src/components/sidebar/ToggleDarkModeButton.tsx
index 51c3b18..a922389 100644
--- a/packages/renderer/src/components/sidebar/ToggleDarkModeButton.tsx
+++ b/packages/renderer/src/components/sidebar/ToggleDarkModeButton.tsx
@@ -25,19 +25,23 @@ import { observer } from 'mobx-react-lite';
 import React from 'react';
 import { useTranslation } from 'react-i18next';
 
-import { useStore } from '../StoreProvider';
+import type RendererStore from '../../stores/RendererStore';
 
-export default observer(() => {
+function ToggleDarkModeButton({
+  store: { shared },
+}: {
+  store: RendererStore;
+}): JSX.Element {
   const { t } = useTranslation();
-  const { shared } = useStore();
-  const { shouldUseDarkColors } = shared;
 
   return (
     <IconButton
       aria-label={t('toolbar.toggleDarkMode')}
       onClick={() => shared.toggleDarkMode()}
     >
-      {shouldUseDarkColors ? <LightModeIcon /> : <DarkModeIcon />}
+      {shared.shouldUseDarkColors ? <LightModeIcon /> : <DarkModeIcon />}
     </IconButton>
   );
-});
+}
+
+export default observer(ToggleDarkModeButton);
diff --git a/packages/renderer/src/components/sidebar/ToggleLocationBarButton.tsx b/packages/renderer/src/components/sidebar/ToggleLocationBarButton.tsx
index c697170..b6644a3 100644
--- a/packages/renderer/src/components/sidebar/ToggleLocationBarButton.tsx
+++ b/packages/renderer/src/components/sidebar/ToggleLocationBarButton.tsx
@@ -27,7 +27,7 @@ import { observer } from 'mobx-react-lite';
 import React from 'react';
 import { useTranslation } from 'react-i18next';
 
-import { useStore } from '../StoreProvider';
+import type RendererStore from '../../stores/RendererStore';
 import { getLocaltionBarID } from '../locationBar/LocationBar';
 
 function ToggleLocationBarIcon({
@@ -45,12 +45,15 @@ function ToggleLocationBarIcon({
   return left ? <IconChevronLeft /> : <IconChevronRight />;
 }
 
-function ToggleLocationBarButton(): JSX.Element {
-  const { t } = useTranslation();
-  const {
+function ToggleLocationBarButton({
+  store: {
     shared: { locationBarVisible, canToggleLocationBar },
     settings,
-  } = useStore();
+  },
+}: {
+  store: RendererStore;
+}): JSX.Element {
+  const { t } = useTranslation();
   const { selectedService } = settings;
 
   return (
diff --git a/packages/renderer/src/index.tsx b/packages/renderer/src/index.tsx
index 9971469..09b9b74 100644
--- a/packages/renderer/src/index.tsx
+++ b/packages/renderer/src/index.tsx
@@ -29,7 +29,6 @@ import React, { Suspense, lazy } from 'react';
 import { createRoot } from 'react-dom/client';
 
 import Loading from './components/Loading';
-import StoreProvider from './components/StoreProvider';
 import ThemeProvider from './components/ThemeProvider';
 import { exposeToReduxDevtools, hotReload } from './devTools';
 import RtlCacheProvider from './i18n/RtlCacheProvider';
@@ -78,9 +77,7 @@ function Root(): JSX.Element {
         <ThemeProvider store={store}>
           <CssBaseline enableColorScheme />
           <Suspense fallback={<Loading />}>
-            <StoreProvider store={store}>
-              <App devMode={isDevelopment} />
-            </StoreProvider>
+            <App store={store} devMode={isDevelopment} />
           </Suspense>
         </ThemeProvider>
       </RtlCacheProvider>