Merge branch 'main' into dependabot/npm_and_yarn/frontend/main/bootstrap-5.3.3

Author: WillSams

.gitignore

@@ -157,6 +157,7 @@ cython_debug/
 
 # VS Code
 .vscode/
+.claude/
 
 .envrc
 serverless.yaml

README.md

@@ -2,12 +2,12 @@
 
 **JavaScript, Vite, Reactjs, Redux Toolkit, Redux Sagas, Python, FastAPI, GraphQL, AsyncPG, Postgres**
 
-[![Application Unit Tests](https://github.com/WillSams/example-js-react-with-python/actions/workflows/pr-validate.yml/badge.svg)](https://github.com/WillSams/eexample-js-react-with-python/actions/workflows/pr-validate.yml)
+[![Application Unit Tests](https://github.com/WillSams/example-js-react-with-python/actions/workflows/pr-validate.yml/badge.svg)](https://github.com/WillSams/example-js-react-with-python/actions/workflows/pr-validate.yml)
 
 This example contains a frontend and backend:
 
 - The frontend is a [React](https://react.dev) application using [Bootstrap4](https://getbootstrap.com/docs/4.6/getting-started/introduction/) for view designs.
-- The backend is a [GraphQL API](https://graphql.org) providing the ability to create, delete, and list reservatios plus available rooms for a given date range.
+- The backend is a [GraphQL API](https://graphql.org) providing the ability to create, delete, and list reservations plus available rooms for a given date range.
 
 React [Typescript](https://github.com/WillSams/example-ts-react-with-python) and [Express MVC](https://github.com/WillSams/example-mvc-expressjs-with-python) versions of this same idea are available.
 
@@ -17,7 +17,7 @@ An [abandoned](https://github.com/WillSams/example-mvc-expressjs-with-python/tre
 
 - When a room is reserved, it cannot be reserved by another guest on overlapping dates.
 - Whenever there are multiple available rooms for a request, the room with the lower final price is assigned.
-- Whenever a request is made for a single room, a double bed room may be assigned (if no single is available?).
+- Whenever a request is made for a single room, a double bed room may be assigned if no single is available.
 - Smokers are not placed in non-smoking rooms.
 - Non-smokers are not placed in allowed smoking rooms.
 - Final price for reservations are determined by daily price * num of days requested, plus the cleaning fee.
@@ -77,11 +77,12 @@ The below are optional but highly recommended:
 
 - [nvm](https://github.com/nvm-sh/nvm) - Used to manage NodeJS versions.
 - [Direnv](https://direnv.net/) - Used to manage environment variables.
-- Install [direnv](https://direnv.net) for persisting environment variables needed for development.
 
 ## Getting Started
 
-First, we'll need to set up our environment variables.  You can do this by either any of the methods mentioned in [/tools/ENV.md](./tools/ENV.md) but I recommend using [Direnv](https://direnv.net/).
+First, we'll need to set up our environment variables. You can do this by any of the methods mentioned in [/tools/ENV.md](./tools/ENV.md) but I recommend using [Direnv](https://direnv.net/).
+
+Key backend variables include `SECRET_KEY`, `REFRESH_SECRET_KEY`, `PG_URL`, and `ALLOWED_ORIGINS` (a comma-separated list of allowed frontend origins, e.g. `http://localhost:3000`).
 
 ### Install Python Packages
 
@@ -99,11 +100,11 @@ pip install -r requirements.txt
 Execute the following within your terminal:
 
 ```bash
-nvm use                  # To eliminate any issues, install/use the version listed in .nvmrc. 
-npm i                    # install the packages needed for project
-cd ../frontend && npm i  # install the packages needed for the frontend
-cd ../db && npm i        # install the packages needed for database migrations
-cd ..                    # navigate back to the root of the repostiory
+nvm use                 # To eliminate any issues, install/use the version listed in .nvmrc.
+npm i                   # install the packages needed for project
+cd frontend && npm i    # install the packages needed for the frontend
+cd ../db && npm i       # install the packages needed for database migrations
+cd ..                   # navigate back to the root of the repository
 ```
 
 ### Create the database
@@ -112,10 +113,11 @@ Finally, let's create and seed the databases and our Reservations and Rooms tabl
 
 ```bash
 # Create the databases and seed them
-NODE_ENV=development | npm run refresh && npm run seed
+cd db
+NODE_ENV=development npm run refresh && NODE_ENV=development npm run seed
 ```
 
-During development, you can just execute `npm run dev:db-baseline` to refresh the database back to the original seed data.
+During development, you can just execute `npm run dev:db-baseline` in the root of the project to refresh the database back to the original seed data.
 
 ## Development
 
@@ -126,17 +128,17 @@ docker-compose up -d  # runs the database in the background
 npm run dev
 ```
 
-Also, you just execute the backend via `npm run dev:backend`.  to verify the backend is working:
+Also, you can just execute the backend via `npm run dev:backend`. To verify the backend is working:
 
 ```bash
 curl http://localhost:$RESERVATION_PORT/$ENV/about
 ```
 
-You can also acces the Ariadne GraphiQL (interactive test playground) instance at [http://localhost:$RESERVATION_PORT/$ENV/graphql](http://localhost:$PLAYGROUND_PORT/$ENV/graphql).  
+You can also access the Ariadne GraphiQL (interactive test playground) instance at [http://localhost:$RESERVATION_PORT/$ENV/graphql](http://localhost:$RESERVATION_PORT/$ENV/graphql).
 
 ## Testing
 
-The backend uses [Pytest](https://docs.pytest.org) and the frontend uses [Jest](https://jestjs.io/).  To run these tests, simply execute `npm run test:backend` or `npm run test:frontend', respectively.
+The backend uses [Pytest](https://docs.pytest.org) and the frontend uses [Jest](https://jestjs.io/). To run these tests, simply execute `npm run test:backend` or `npm run test:frontend`, respectively.
 
 ## Containerization
 

backend/requirements-docker.txt

@@ -1,7 +1,7 @@
 ariadne==0.22
 asyncpg==0.29.0
 fastapi==0.109.2
-httpx==0.26.0
+httpx==0.27.0
 pydantic==2.6.1
 python-multipart==0.0.9
 python-jose==3.3.0

backend/schema.graphql

@@ -49,7 +49,7 @@ type RoomsResult {
 }
 
 type Query {
-  getReservation(roomId: String!): ReservationResult!
+  getReservation(id: ID!): ReservationResult!
   getAllReservations: ReservationsResult!
   getAllRooms: RoomsResult!
   getAvailableRooms(input: AvailableRoomInput!): RoomsResult!

backend/specs/resolvers/when_cancelling_reservations.py

@@ -10,13 +10,6 @@
 
 
 class DescribeDeleteReservationResolver:
-    def find_by_id(self, reservation_id):
-        return [
-            reservation
-            for reservation in self.reservations
-            if reservation.id != reservation_id
-        ]
-
     @pytest.mark.asyncio
     async def should_delete_existing_reservation(self, mocker):
         original_reservations = [
@@ -60,7 +53,7 @@ async def should_delete_existing_reservation(self, mocker):
         assert result["reservations"] == expected_reservations
 
     @pytest.mark.asyncio
-    async def test_should_give_reservation_not_found(self, mocker):
+    async def should_give_reservation_not_found(self, mocker):
         result = await delete_reservation_resolver(
             None, MOCK_EXECUTION_CONTEXT, reservationId=999
         )

backend/specs/resolvers/when_querying_for_available_rooms.py

@@ -31,7 +31,8 @@ async def should_get_available_rooms_all_available(self, mocker):
             mocker.AsyncMock(return_value=mock_pool),
         )
         mocker.patch(
-            "api.resolvers.data.fetch_all_rows", mocker.AsyncMock(return_value=rooms)
+            "api.resolvers.data.fetch_all_rows",
+            mocker.AsyncMock(return_value={"success": True, "rooms": rooms}),
         )
         mocker.patch(
             "api.resolvers.data.fetch_room",

backend/specs/when_authorizing.py

@@ -3,8 +3,8 @@
 import pytest
 from jose import jwt
 
-from auth import create_access_token, create_refresh_token
-from settings import ALGORITHM, REFRESH_SECRET_KEY, SECRET_KEY
+from auth import create_access_token
+from settings import ALGORITHM, SECRET_KEY
 
 
 class DescribeAuthorization:
@@ -22,12 +22,3 @@ def should_create_access_token(self, subject, expires_delta):
 
         decoded_token = jwt.decode(generated_token, SECRET_KEY, algorithms=[ALGORITHM])
         assert decoded_token["sub"] == subject
-
-    def should_create_refresh_token(self, subject, expires_delta):
-        generated_token = create_refresh_token(subject, expires_delta)
-        assert generated_token is not None
-
-        decoded_token = jwt.decode(
-            generated_token, REFRESH_SECRET_KEY, algorithms=[ALGORITHM]
-        )
-        assert decoded_token["sub"] == subject

backend/src/api/__init__.py

@@ -9,6 +9,9 @@ class DummyPool:
     async def close(self):
         pass
 
+    async def execute(self, *args, **kwargs):
+        pass
+
     async def fetch(self, *args, **kwargs):
         pass
 

backend/src/api/resolvers/data.py

@@ -36,14 +36,10 @@ async def create_reservation(
     return reservations
 
 
-async def delete_reservation(db, reservation_id: str) -> Dict[str, Any]:
-    reservation = await fetch_reservation(db, reservation_id)
-    if reservation:
-        await db.execute("DELETE FROM reservations WHERE id = $1", reservation_id)
-        return await fetch_all_rows(db, Reservation)
-    else:
-        errors = ["Reservation not found"]
-        return {"success": False, "errors": errors, "reservations": None}
+async def delete_reservation(db, reservation_id: int) -> Dict[str, Any]:
+    await fetch_reservation(db, reservation_id)
+    await db.execute("DELETE FROM reservations WHERE id = $1", reservation_id)
+    return await fetch_all_rows(db, Reservation)
 
 
 async def is_room_available(
@@ -80,11 +76,8 @@ async def fetch_all_rows(db, entity_type) -> Dict[str, Any]:
     table_name = entity_type.__name__.lower() + "s"
     query = f"SELECT * FROM {table_name}"
     rows = await db.fetch(query)
-    if rows:
-        entities = [entity_type(**dict(row)) for row in rows]
-        return {"success": True, f"{table_name}": entities}
-    else:
-        raise ValueError("No reserved rooms found")
+    entities = [entity_type(**dict(row)) for row in rows] if rows else []
+    return {"success": True, f"{table_name}": entities}
 
 
 async def fetch_by_id(db, entity_type, id) -> Dict[str, Any]:
@@ -99,11 +92,14 @@ async def fetch_by_id(db, entity_type, id) -> Dict[str, Any]:
 
 
 async def fetch_available_rooms(db, checkin_date, checkout_date) -> Dict[str, Any]:
-    rooms = await fetch_all_rows(db, Room)
+    result = await fetch_all_rows(db, Room)
+    rooms = result.get("rooms", [])
     available_rooms = [
         room
         for room in rooms
-        if await is_room_available(db, room.id, checkin_date, checkout_date)
+        if (await is_room_available(db, room.id, checkin_date, checkout_date))[
+            "success"
+        ]
     ]
     return {"success": True, "rooms": available_rooms}
 
@@ -116,7 +112,7 @@ async def fetch_room(db, room_id: str) -> Room:
         raise ValueError(f"Room with id {room_id} not found")
 
 
-async def fetch_reservation(db, reservation_id: id):
+async def fetch_reservation(db, reservation_id: int):
     result = await fetch_by_id(db, Reservation, id=reservation_id)
     if result["success"]:
         return result

backend/src/api/resolvers/queries.py

@@ -7,9 +7,8 @@
 
 
 async def get_reservation_resolver(obj, info, id) -> Dict[str, Any]:
+    db = await DbSession()
     try:
-        db = await DbSession()
-
         result = await fetch_reservation(db, id)
         return result
     except ValueError as error: