From 76f8ff9f21bfc9bc081047ab7c528c5e2ed1a91d Mon Sep 17 00:00:00 2001
From: Presley Pizzo <1290996+presleyp@users.noreply.github.com>
Date: Thu, 14 Apr 2022 13:58:53 -0400
Subject: [PATCH] feat: Add Footer to every page with nav (#1009)

* Add Footer to AuthAndNav, rename

* Fix in preferences layout

* Remove double footer
---
 site/src/AppRouter.tsx                        | 27 ++++++++++---------
 .../components/AuthAndFrame/AuthAndFrame.tsx  | 21 +++++++++++++++
 site/src/components/Page/AuthAndNav.tsx       | 12 ---------
 site/src/components/Page/index.tsx            |  1 -
 site/src/components/Preferences/Layout.tsx    |  6 ++---
 .../[organization]/[template]/index.tsx       |  2 --
 site/src/pages/templates/index.tsx            |  2 --
 site/src/pages/workspaces/[workspace].tsx     |  3 ---
 8 files changed, 38 insertions(+), 36 deletions(-)
 create mode 100644 site/src/components/AuthAndFrame/AuthAndFrame.tsx
 delete mode 100644 site/src/components/Page/AuthAndNav.tsx

diff --git a/site/src/AppRouter.tsx b/site/src/AppRouter.tsx
index 79d3d1b580..fb1ab167e0 100644
--- a/site/src/AppRouter.tsx
+++ b/site/src/AppRouter.tsx
@@ -1,6 +1,7 @@
 import React from "react"
 import { Route, Routes } from "react-router-dom"
-import { AuthAndNav, RequireAuth } from "./components"
+import { RequireAuth } from "./components"
+import { AuthAndFrame } from "./components/AuthAndFrame/AuthAndFrame"
 import { PreferencesLayout } from "./components/Preferences/Layout"
 import { IndexPage } from "./pages"
 import { NotFoundPage } from "./pages/404"
@@ -39,18 +40,18 @@ export const AppRouter: React.FC = () => (
         <Route
           index
           element={
-            <AuthAndNav>
+            <AuthAndFrame>
               <TemplatesPage />
-            </AuthAndNav>
+            </AuthAndFrame>
           }
         />
         <Route path=":organization/:template">
           <Route
             index
             element={
-              <AuthAndNav>
+              <AuthAndFrame>
                 <TemplatePage />
-              </AuthAndNav>
+              </AuthAndFrame>
             }
           />
           <Route
@@ -68,9 +69,9 @@ export const AppRouter: React.FC = () => (
         <Route
           path=":workspace"
           element={
-            <AuthAndNav>
+            <AuthAndFrame>
               <WorkspacePage />
-            </AuthAndNav>
+            </AuthAndFrame>
           }
         />
       </Route>
@@ -78,25 +79,25 @@ export const AppRouter: React.FC = () => (
       <Route
         path="users"
         element={
-          <AuthAndNav>
+          <AuthAndFrame>
             <UsersPage />
-          </AuthAndNav>
+          </AuthAndFrame>
         }
       />
       <Route
         path="orgs"
         element={
-          <AuthAndNav>
+          <AuthAndFrame>
             <OrganizationsPage />
-          </AuthAndNav>
+          </AuthAndFrame>
         }
       />
       <Route
         path="settings"
         element={
-          <AuthAndNav>
+          <AuthAndFrame>
             <SettingsPage />
-          </AuthAndNav>
+          </AuthAndFrame>
         }
       />
 
diff --git a/site/src/components/AuthAndFrame/AuthAndFrame.tsx b/site/src/components/AuthAndFrame/AuthAndFrame.tsx
new file mode 100644
index 0000000000..d7e61e4d64
--- /dev/null
+++ b/site/src/components/AuthAndFrame/AuthAndFrame.tsx
@@ -0,0 +1,21 @@
+import React from "react"
+import { Navbar } from "../Navbar"
+import { Footer } from "../Page/Footer"
+import { RequireAuth } from "../Page/RequireAuth"
+
+interface AuthAndFrameProps {
+  children: JSX.Element
+}
+
+/**
+ * Wraps page in RequireAuth and renders it between Navbar and Footer
+ */
+export const AuthAndFrame: React.FC<AuthAndFrameProps> = ({ children }) => (
+  <RequireAuth>
+    <>
+      <Navbar />
+      {children}
+      <Footer />
+    </>
+  </RequireAuth>
+)
diff --git a/site/src/components/Page/AuthAndNav.tsx b/site/src/components/Page/AuthAndNav.tsx
deleted file mode 100644
index 9d400828d7..0000000000
--- a/site/src/components/Page/AuthAndNav.tsx
+++ /dev/null
@@ -1,12 +0,0 @@
-import React from "react"
-import { Navbar } from "../Navbar"
-import { RequireAuth, RequireAuthProps } from "./RequireAuth"
-
-export const AuthAndNav: React.FC<RequireAuthProps> = ({ children }) => (
-  <RequireAuth>
-    <>
-      <Navbar />
-      {children}
-    </>
-  </RequireAuth>
-)
diff --git a/site/src/components/Page/index.tsx b/site/src/components/Page/index.tsx
index 3d0429de63..d339834abc 100644
--- a/site/src/components/Page/index.tsx
+++ b/site/src/components/Page/index.tsx
@@ -1,3 +1,2 @@
-export * from "./AuthAndNav"
 export * from "./Footer"
 export * from "./RequireAuth"
diff --git a/site/src/components/Preferences/Layout.tsx b/site/src/components/Preferences/Layout.tsx
index fad3dbefe6..bf83154b30 100644
--- a/site/src/components/Preferences/Layout.tsx
+++ b/site/src/components/Preferences/Layout.tsx
@@ -1,7 +1,7 @@
 import Box from "@material-ui/core/Box"
 import React from "react"
 import { Outlet } from "react-router-dom"
-import { AuthAndNav } from "../Page"
+import { AuthAndFrame } from "../AuthAndFrame/AuthAndFrame"
 import { TabPanel } from "../TabPanel"
 
 export const Language = {
@@ -21,7 +21,7 @@ const menuItems = [
 
 export const PreferencesLayout: React.FC = () => {
   return (
-    <AuthAndNav>
+    <AuthAndFrame>
       <Box display="flex" flexDirection="column">
         <Box style={{ maxWidth: "1380px", margin: "1em auto" }}>
           <TabPanel title={Language.preferencesLabel} menuItems={menuItems}>
@@ -29,6 +29,6 @@ export const PreferencesLayout: React.FC = () => {
           </TabPanel>
         </Box>
       </Box>
-    </AuthAndNav>
+    </AuthAndFrame>
   )
 }
diff --git a/site/src/pages/templates/[organization]/[template]/index.tsx b/site/src/pages/templates/[organization]/[template]/index.tsx
index 9802378dc6..295275e14b 100644
--- a/site/src/pages/templates/[organization]/[template]/index.tsx
+++ b/site/src/pages/templates/[organization]/[template]/index.tsx
@@ -8,7 +8,6 @@ import { EmptyState } from "../../../../components/EmptyState"
 import { ErrorSummary } from "../../../../components/ErrorSummary"
 import { Header } from "../../../../components/Header"
 import { FullScreenLoader } from "../../../../components/Loader/FullScreenLoader"
-import { Footer } from "../../../../components/Page"
 import { Column, Table } from "../../../../components/Table"
 import { unsafeSWRArgument } from "../../../../util"
 import { firstOrItem } from "../../../../util/array"
@@ -98,7 +97,6 @@ export const TemplatePage: React.FC = () => {
       <Paper style={{ maxWidth: "1380px", margin: "1em auto", width: "100%" }}>
         <Table {...tableProps} />
       </Paper>
-      <Footer />
     </div>
   )
 }
diff --git a/site/src/pages/templates/index.tsx b/site/src/pages/templates/index.tsx
index 05ace20513..51d0166238 100644
--- a/site/src/pages/templates/index.tsx
+++ b/site/src/pages/templates/index.tsx
@@ -9,7 +9,6 @@ import { CodeExample } from "../../components/CodeExample/CodeExample"
 import { ErrorSummary } from "../../components/ErrorSummary"
 import { Header } from "../../components/Header"
 import { FullScreenLoader } from "../../components/Loader/FullScreenLoader"
-import { Footer } from "../../components/Page"
 import { Column, Table } from "../../components/Table"
 
 export const TemplatesPage: React.FC = () => {
@@ -74,7 +73,6 @@ export const TemplatesPage: React.FC = () => {
       <Paper style={{ maxWidth: "1380px", margin: "1em auto", width: "100%" }}>
         <Table {...tableProps} />
       </Paper>
-      <Footer />
     </div>
   )
 }
diff --git a/site/src/pages/workspaces/[workspace].tsx b/site/src/pages/workspaces/[workspace].tsx
index 6c64beb241..2cf95caed2 100644
--- a/site/src/pages/workspaces/[workspace].tsx
+++ b/site/src/pages/workspaces/[workspace].tsx
@@ -5,7 +5,6 @@ import useSWR from "swr"
 import * as Types from "../../api/types"
 import { ErrorSummary } from "../../components/ErrorSummary"
 import { FullScreenLoader } from "../../components/Loader/FullScreenLoader"
-import { Footer } from "../../components/Page"
 import { Workspace } from "../../components/Workspace"
 import { unsafeSWRArgument } from "../../util"
 import { firstOrItem } from "../../util/array"
@@ -50,8 +49,6 @@ export const WorkspacePage: React.FC = () => {
       <div className={styles.inner}>
         <Workspace organization={organization} template={template} workspace={workspace} />
       </div>
-
-      <Footer />
     </div>
   )
 }