Make Improvements to Onboarding 1 (UWOrbital#23)

# Purpose
Closes UWOrbital#15. 
Inspired by UWOrbital#4 for the frontend improvements. 

# New Changes
- Improve PR template
- Improve datetime check test in `test_api.py`
- Fix mismatch in `CommandRequest` on backend and frontend
- Refactor frontend to no longer need to reload the page to display
commands after delete or creation
- Improve error messages in frontend API calls
- Make frontend easier by removing some repetitive steps
- Make `createCommand` endpoint signature consistent with backend
`create_command` signature
- Update Python doc strings to match the main repo's style guide

# Testing
Implemented the GS onboarding frontend and backend on a private branch,
and the frontend worked properly.

# Outstanding Changes
None

Author: Yarik-Popov

.github/pull_request_template.md

@@ -1,12 +1,12 @@
 # Purpose
 Completed the GS on-boarding task. Include a screenshot of the front-end of the application.
 
+- [ ]  I have added my name to the onboarding title (required)
+- [ ]  I have added a screenshot of the logs printed by the logger middleware (required)
+- [ ]  I am interested to work on the frontend (optional)
+
 # New Changes
 - Explain new changes
 
 # Testing
 - Explain tests that you ran to verify code functionality.
-- Any functions that can be unit-tested should include a unit test in the PR. Otherwise, explain why it cannot be unit-tested.
-
-# Outstanding Changes
-- If there are non-critical changes (i.e. additional features) that can be made to this feature in the future, indicate them here.

README.md

@@ -13,11 +13,11 @@ All function and method parameters (except for the `self` and `cls` parameters)
 ```python
 def my_add(num1: int, num2: int) -> int:
 	"""
-	@brief Adds two numbers together
+	Adds two numbers together
 
-	@param num1 - The first number to add.
-	@param num2 - The second number to add.
-	@return Returns the sum of the two numbers.
+	:param num1: The first number to add.
+	:param num2: The second number to add.
+	:return: Returns the sum of the two numbers.
 	"""
 	return num1 + num2
 ```
@@ -72,21 +72,21 @@ Function and method comments using `""" """` should exist below the function dec
 ```python
 def my_add(num1: int, num2: int) -> int:
 	"""
-	@brief Adds two numbers together
+	Adds two numbers together
 
-	@param num1 - The first number to add.
-	@param num2 - The second number to add.
-	@return Returns the sum of the two numbers.
+	:param num1: The first number to add.
+	:param num2: The second number to add.
+	:return: Returns the sum of the two numbers.
 	"""
 	return num1 + num2
 ```
 
 ```python
 def increase_x(self, count: int) -> None:
 	"""
-	@brief Increases the x attribute by the count.
+	Increases the x attribute by the count.
 
-	@param count - Count to increase the x attribute by.
+	:param count: Count to increase the x attribute by.
 	"""
 	self.x += count
 ```
@@ -105,9 +105,11 @@ File comments are not required
 ```python
 class PointTwoDimension:
 	"""
-	@brief Class for storing a 2D point
-	@attribute x (int) - x coordinate of the point
-	@attribute y (int) - y coordinate of the point
+	Class for storing a 2D point
+	:param x: x coordinate of the point
+	:type x: int
+	:param y: y coordinate of the point
+	:type y: int
 	"""
 
 	def __init__(x: int, y: int):
@@ -117,9 +119,11 @@ class PointTwoDimension:
 @dataclasses.dataclass
 class PointTwoDimension:
 	"""
-	@brief Class for storing a 2D point
-	@attribute x (int) - x coordinate of the point
-	@attribute y (int) - y coordinate of the point
+	Class for storing a 2D point
+	:param x: x coordinate of the point
+	:type x: int
+	:param y: y coordinate of the point
+	:type y: int
 	"""
 
 	x: int

backend/api/endpoints/command.py

@@ -1,5 +1,4 @@
 from fastapi import APIRouter, Depends
-from fastapi.exceptions import HTTPException
 from sqlmodel import Session, select
 
 from backend.api.models.request_model import CommandRequest
@@ -16,7 +15,7 @@ def get_commands(db: Session = Depends(get_db)):
     """
     Gets all the items
 
-    @return Returns a list of commands
+    :return: Returns a list of commands
     """
     query = select(Command)
     items = db.exec(query).all()
@@ -28,8 +27,8 @@ def create_command(payload: CommandRequest):
     """
     Creates an item with the given payload in the database and returns this payload after pulling it from the database 
 
-    @param payload: The data used to create an item
-    @return returns a json object with field of "data" under which there is the payload now pulled from the database 
+    :param payload: The data used to create an item
+    :return: returns a json object with field of "data" under which there is the payload now pulled from the database 
     """
     # TODO:(Member) Implement this endpoint
 
@@ -40,7 +39,7 @@ def delete_command(id: int):
     """
     Deletes the item with the given id if it exists. Otherwise raises a 404 error.
 
-    @param id: The id of the item to delete
-    @return returns the list of commands after deleting the item
+    :param id: The id of the item to delete
+    :return: returns the list of commands after deleting the item
     """
     # TODO:(Member) Implement this endpoint

backend/api/endpoints/main_command.py

@@ -14,7 +14,7 @@ def get_main_commands(db: Session = Depends(get_db)):
     """
     Gets all the main commands that can be created.
 
-    @return Returns a list of main commands
+    :return: Returns a list of main commands
     """
     query = select(MainCommand)
     items = db.exec(query).all()

backend/api/middlewares/cors_middleware.py

@@ -6,7 +6,7 @@ def add_cors_middleware(app: FastAPI) -> None:
     """
     Adds the cors middleware to the FastAPI app
 
-    @param app: FastAPI app to add the middleware to
+    :param app: FastAPI app to add the middleware to
     """
     app.add_middleware(
         CORSMiddleware,

backend/api/middlewares/logger_middleware.py

@@ -13,9 +13,9 @@ async def dispatch(
         datetime of request, duration of execution. Logs should be printed using the custom logging module provided.
         Logs should be printed so that they are easily readable and understandable.
 
-        @param request: Request received to this middleware from client (it is supplied by FastAPI)
-        @param call_next: Endpoint or next middleware to be called (if any, this is the next middleware in the chain of middlewares, it is supplied by FastAPI)
-        @return Response from endpoint
+        :param request: Request received to this middleware from client (it is supplied by FastAPI)
+        :param call_next: Endpoint or next middleware to be called (if any, this is the next middleware in the chain of middlewares, it is supplied by FastAPI)
+        :return: Response from endpoint
         """
         # TODO:(Member) Finish implementing this method
         response = await call_next(request)

backend/data/base_model.py

@@ -4,7 +4,8 @@
 
 class BaseSQLModel(SQLModel):
     """
-    Base SQL Model class. It performs validation on the model unlike the default SQLModel class with table=True.
+    Base SQL Model class.
+    It performs validation on the model unlike the default SQLModel class with table=True.
     """
 
     def __init__(self, **data):

backend/data/enums.py

@@ -6,7 +6,7 @@ class CommandStatus(Enum):
     """
     Enum representing the command status.
 
-    @warning This enum shouldn't be modified
+    :warning: This enum shouldn't be modified
     """
 
     PENDING = auto()

backend/utils/logging.py

@@ -14,11 +14,10 @@
 
 def logger_setup(*, enqueue: bool = False, diagnose: bool = True) -> None:
     """
-    Set up the global logger 
+    Set up the global logger. It modifies the global logger object.
     The logger will log everything to a file, info to stdout, and warnings and above to stderr.
-    @param enqueue - Whether to enqueue messages for asynchronous processing.
-    @param diagnose - Whether to enable diagnostic mode.
-    @return None - Modifies the global logger object
+    :param enqueue: Whether to enqueue messages for asynchronous processing.
+    :param diagnose: Whether to enable diagnostic mode.
     """
     # Remove any existing sinks
     logger.remove()

frontend/src/app.tsx

@@ -1,13 +1,32 @@
+import { useEffect, useState } from 'react'
 import './app.css'
 import CommandTable from './display/table'
 import CommandInput from './input/command_input'
+import { CommandResponse } from './data/response'
+import { getCommands } from './display/command_api'
 
 function App() {
+  const [commands, setCommands] = useState<CommandResponse[]>([])
+
+  useEffect(() => {
+    const getCommandsFn = async () => {
+      try {
+        const data = await getCommands();
+        setCommands(data.data)
+      } catch (error) {
+        console.error(error)
+        alert("Error fetching commands")
+      }
+    }
+
+    getCommandsFn();
+  }, [])
+
   return (
     <>
-      <CommandInput />
+      <CommandInput setCommands={setCommands} />
       <p>Command List:</p>
-      <CommandTable />
+      <CommandTable commands={commands} setCommands={setCommands} />
     </>
   )
 }