login comp

Author: Jaysalgado

SetupApp/Setup/Setup.tsx

@@ -68,6 +68,7 @@
 
       <div class="buttons">
         <h1>Set Up Your Kubernetes Cluster with Docketeer!</h1>
+        <span>You only need to Install Prometheus Operator once!</span>
         <button id="prom">Install Prometheus Operator</button>
         <button id="metrics">Set Up Grafana</button>
         <button id="port">Launch Port Forwarding</button>

SetupApp/Setup/SetupDisplay.tsx

@@ -4,8 +4,8 @@ import { SetupController } from '../../types';
 
 /**
  * @description v12.0 implemented k8 cluster metrics! In order to set this up, run npm run dev, go to 
- * localhost:/3000 click the three buttons in sequence, this will run the necessary shell lines on your host terminal.
- *  Than you can compose up to see your k8 metrics. 
+ * http://localhost:4000/api/k8 click the three buttons in sequence, this will run the necessary shell lines on your host terminal.
+ *  Open up a new terminal, compose up and see your k8 metrics!
  */
 
 const setupController: SetupController = {

SetupApp/Setup/setup.css

@@ -1,13 +1,12 @@
 import React, { useEffect, useState } from 'react';
-import { Routes, Route, Navigate } from 'react-router-dom';
+import { Routes, Route, Navigate, useNavigate } from 'react-router-dom';
 import Login from './components/Login/Login';
 import SignUp from './components/SignUp/SignUp';
 import Home from './components/Home/Home';
 import Metrics from './components/Metrics/Metrics';
 import Images from './components/Images/Images';
 import Containers from './components/Containers/Containers';
 import Settings from './components/Settings/Settings';
-import Users from './components/Users/Users';
 import VolumeHistory from './components/VolumeHistory/VolumeHistory';
 import ProcessLogs from './components/ProcessLogs/ProcessLogs';
 import SharedLayout from './components/SharedLayout/SharedLayout';
@@ -20,29 +19,42 @@ const App = () => {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const { updateSession } = useSurvey();
   const { checkCookie } = useHelper();
-  const location = useLocation();
+  const navigate = useNavigate();
+
   const [loading, setLoading] = useState(true);
   const [session, setSession] = useState<boolean | undefined>(undefined);
-
-  useEffect(() => {
-    const checkLogin = async () => {
-      try {
-        const data = await checkCookie();
-        if (data) {
-          updateSession();
-          setSession(true);
-        } else {
-          setSession(false);
-        }
-        setLoading(false);
-      } catch (err) {
-        console.log('Cannot get uid key or API key:', err);
+  /**
+   * updates user session to check if user is logged in by invoking checkCookie
+   * @method
+   * @params none
+   * @returns {Promise<void>} returns a promise when successfully setting the session absed on cookies
+   */
+  const checkLogin = async () => {
+    try {  
+      const data = await checkCookie();
+      if (data) {
+        updateSession();
+        setSession(true);
+      
+      } else {
         setSession(false);
-        setLoading(false);
       }
-    };
+      setLoading(false);
+    } catch (err) {
+      console.log('Cannot get uid key or API key:', err);
+      setSession(false);
+      setLoading(false);
+    }
+  };
+
+  useEffect(() => {
     checkLogin();
-  }, [location.pathname, checkCookie, updateSession]);
+  }, [checkCookie, updateSession]);
+
+  const navigateToHome = async () => {
+    await checkLogin();
+    navigate('/home');
+  };
 
   if (loading) {
     return <div>Loading...</div>;
@@ -52,15 +64,20 @@ const App = () => {
       <Route
         path="/"
         element={session ? <Navigate to="/home" /> : <Navigate to="/login" />}
-      />: 
-      <Route path="/login" element={<Login />} />
+      />
+      :
+      <Route
+        path="/login"
+        element={<Login navigateToHome={navigateToHome} />}
+      />
       <Route path="/userSignup" element={<SignUp />} />
-      <Route path="/home" element={session ? <SharedLayout /> :
-        <Navigate to="/login" />}>
+      <Route
+        path="/home"
+        element={session ? <SharedLayout /> : <Navigate to="/login" />}
+      >
         <Route index element={<Home />} />
         <Route path="/home/volume" element={<VolumeHistory />} />
         <Route path="/home/metrics" element={<Metrics key={1} />} />
-        <Route path="/home/users" element={<Users />} />
         <Route path="/home/logs" element={<ProcessLogs key={1} />} />
         <Route path="/home/about" element={<About />} />
         <Route path="/home/images" element={<Images />} />

SetupApp/index.html

@@ -22,10 +22,10 @@ const About = () => {
           real-time tracking of metrics and logs is essential for staying ahead
           of potential issues and optimizing your workflows.<p></p>
           Our application provides you with the tools you need to take control
-          of your Docker images, containers, volumes, and logs. With an
-          intuitive interface and powerful administrative features, you can
-          easily make the necessary adjustments to ensure a smooth journey
-          through the cosmos of your Docker environment.
+          of your Docker images, containers, volumes, and logs, along with the
+          tools to view your Kubernetes cluster metrics. With an intuitive
+          interface, you can easily make the necessary adjustments to ensure a
+          smooth journey through the cosmos of your Docker environment.
         </p>
       </div>
       <div className={styles.section}>
@@ -72,14 +72,15 @@ const About = () => {
 
         <a className={styles.footerIcons} href="mailto:[email protected]">
           <svg
-            width="32"
-            height="32"
             xmlns="http://www.w3.org/2000/svg"
-            fillRule="evenodd"
-            clipRule="evenodd"
-            className="fill-current"
+            width="42"
+            height="42"
+            fill="white"
+            className="bi bi-envelope-at-fill"
+            viewBox="0 0 24 24"
           >
-            <path d="M22.288 21h-20.576c-.945 0-1.712-.767-1.712-1.712v-13.576c0-.945.767-1.712 1.712-1.712h20.576c.945 0 1.712.767 1.712 1.712v13.576c0 .945-.767 1.712-1.712 1.712zm-10.288-6.086l-9.342-6.483-.02 11.569h18.684v-11.569l-9.322 6.483zm8.869-9.914h-17.789l8.92 6.229s6.252-4.406 8.869-6.229z" />
+            <path d="M2 2A2 2 0 0 0 .05 3.555L8 8.414l7.95-4.859A2 2 0 0 0 14 2H2Zm-2 9.8V4.698l5.803 3.546L0 11.801Zm6.761-2.97-6.57 4.026A2 2 0 0 0 2 14h6.256A4.493 4.493 0 0 1 8 12.5a4.49 4.49 0 0 1 1.606-3.446l-.367-.225L8 9.586l-1.239-.757ZM16 9.671V4.697l-5.803 3.546.338.208A4.482 4.482 0 0 1 12.5 8c1.414 0 2.675.652 3.5 1.671Z" />
+            <path d="M15.834 12.244c0 1.168-.577 2.025-1.587 2.025-.503 0-1.002-.228-1.12-.648h-.043c-.118.416-.543.643-1.015.643-.77 0-1.259-.542-1.259-1.434v-.529c0-.844.481-1.4 1.26-1.4.585 0 .87.333.953.63h.03v-.568h.905v2.19c0 .272.18.42.411.42.315 0 .639-.415.639-1.39v-.118c0-1.277-.95-2.326-2.484-2.326h-.04c-1.582 0-2.64 1.067-2.64 2.724v.157c0 1.867 1.237 2.654 2.57 2.654h.045c.507 0 .935-.07 1.18-.18v.731c-.219.1-.643.175-1.237.175h-.044C10.438 16 9 14.82 9 12.646v-.214C9 10.36 10.421 9 12.485 9h.035c2.12 0 3.314 1.43 3.314 3.034v.21Zm-4.04.21v.227c0 .586.227.8.581.8.31 0 .564-.17.564-.743v-.367c0-.516-.275-.708-.572-.708-.346 0-.573.245-.573.791Z" />
           </svg>
         </a>
 

server/controllers/setupController.ts

@@ -15,8 +15,10 @@ import useHelper from '../../helpers/commands';
  * @module | Login
  * @description | Login component which renders a login page, and sign-up modal. This is the first component that users are routed to if there are no active sessions.
  **/
-
-const Login = (): JSX.Element => {
+interface loginProps{
+  navigateToHome: () => void;
+}
+const Login = (props: loginProps): JSX.Element => {
   const navigate = useNavigate();
   const { updateUser, updateSession } = useSurvey();
   const updateUserSession = () => updateSession();
@@ -26,14 +28,20 @@ const Login = (): JSX.Element => {
 
   const [username, setUsername] = useState<string>('');
   const [password, setPassword] = useState<string>('');
+  
 
   const handleLogin = (e: React.FormEvent<HTMLFormElement>): void => {
     // prevent default form submission action
     e.preventDefault();
     authenticateUser(username, password);
   };
 
-  // send a fetch request to the backend to login
+  /*
+  authenticates users username and password
+  @method
+  @async
+  @returns promise when sending a request to backend to login is successful, and updates users session and cookies
+  */
   const authenticateUser = async (
     username: string,
     password: string
@@ -70,8 +78,7 @@ const Login = (): JSX.Element => {
         )
       );
       // Navigate to root route
-      console.log(data);
-      navigate('/');
+      props.navigateToHome();
     } catch (err) {
       // Alert user upon wrong username or password entry using an alert.
       window.alert(

src/App.tsx

@@ -11,6 +11,12 @@ const Metrics = (): JSX.Element => {
   const button = kubernetesOrNah === 1 ? 'Containers' : 'Kubernetes Cluster';
 
   useEffect(() => {
+    /*
+    * Retrieves the API and UID key 
+    * @method
+    * @async
+    * @returns {promise} returns promise when api key and uid key is successfully set
+    */
     const fetchKey = async () => {
       try {
         const key = await getKey();
@@ -28,6 +34,13 @@ const Metrics = (): JSX.Element => {
     setFrame((prevFrame) => (prevFrame === 1 ? 2 : 1));
   };
 
+  /*
+    * Changes the container metrics dashboard to the kubernetes dashboard
+    * @method
+    * @params {string} dashboard, new dashboard page to set to as the current page
+    * @async
+    * @returns {promise} returns promise when dashboard and uid key is successfully set
+  */
   const changePage = async (dashboard) => {
     setCurrentPage(dashboard);
     const uid = await getUid(apiKey, dashboard);