Merge pull request #23 from Sheldenburg/chore/add-linting-and-test-automation

Chore/add linting and test automation

Author: Sheldenburg

.github/workflows/db-migration.yml

@@ -32,4 +32,4 @@ jobs:
           POSTGRES_SERVER: ${{ secrets.POSTGRES_SERVER }}
           POSTGRES_PORT: ${{ secrets.POSTGRES_PORT }}
         run: |
-          alembic upgrade head
+          alembic upgrade head

.github/workflows/fastapi-to-gcr.yml

@@ -45,4 +45,4 @@ jobs:
             --platform managed \
             --set-env-vars POSTGRES_SERVER=${{ secrets.POSTGRES_SERVER }},POSTGRES_PORT=${{ secrets.POSTGRES_PORT }},POSTGRES_DB=${{ secrets.POSTGRES_DB }},POSTGRES_USER=${{ secrets.POSTGRES_USER }},POSTGRES_PASSWORD=${{ secrets.POSTGRES_PASSWORD }},ENCRYPTION_KEY=${{ secrets.ENCRYPTION_KEY }},PROJECT_NAME=${{ env.PROJECT_ID }},FIRST_SUPERUSER=${{ secrets.FIRST_SUPERUSER }},FIRST_SUPERUSER_PASSWORD=${{ secrets.FIRST_SUPERUSER_PASSWORD }} \
             --region australia-southeast1 \
-            --allow-unauthenticated
+            --allow-unauthenticated

.github/workflows/nextjs-preview.yml

@@ -21,4 +21,4 @@ jobs:
         working-directory: frontend
       - name: Deploy Project Artifacts to Vercel
         run: vercel deploy --prebuilt --token=${{ secrets.VERCEL_TOKEN }}
-        working-directory: frontend
+        working-directory: frontend

.github/workflows/nextjs-production.yml

@@ -21,4 +21,4 @@ jobs:
         working-directory: frontend
       - name: Deploy Project Artifacts to Vercel
         run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}
-        working-directory: frontend
+        working-directory: frontend

.gitignore

@@ -1,2 +1,2 @@
 .vscode
-.env
+.env

README.md

@@ -9,7 +9,7 @@
 ### Demo video
 https://drive.google.com/file/d/1QfZvzOnOeBvtoDMlBb4IxDx3DoC-GC4Q/view?usp=sharing
 
-### Tech stack 
+### Tech stack
 The backend code in this repository originated from the [FastAPI full stack template](https://github.com/fastapi/full-stack-fastapi-template) and includes AI components that make this AI engineer template unique.
 
 To fast-track the MVP building process, which is crucial for most AI products, we have chosen a simple tech stack. This allows people to focus more on iterating through product features rather than on DevOps from the outset.
@@ -21,7 +21,7 @@ To fast-track the MVP building process, which is crucial for most AI products, w
 ```bash
 git clone https://github.com/Sheldenburg/nextjs-fastapi-template.git
 ```
-2. Follow the original [README]('README-original.md') to docker compose and set up Postgres, reverse proxy and Fastapi server. You can leave the original React fronend running if you'd like. Or, you can just comment out the frontend bit in the docker compose file. 
+2. Follow the original [README]('README-original.md') to docker compose and set up Postgres, reverse proxy and Fastapi server. You can leave the original React fronend running if you'd like. Or, you can just comment out the frontend bit in the docker compose file.
 3. Run nextjs app in local
 ```bash
 cd frontend
@@ -33,25 +33,25 @@ npm install
 npm run dev
 ```
 
-Note: This is a fork from the original [Full Stack FastAPI Template](https://github.com/tiangolo/full-stack-fastapi-template "Full Stack FastAPI Template"). Instead of the original Reactjs frontend, we used Nextjs14 in this repository. 
+Note: This is a fork from the original [Full Stack FastAPI Template](https://github.com/tiangolo/full-stack-fastapi-template "Full Stack FastAPI Template"). Instead of the original Reactjs frontend, we used Nextjs14 in this repository.
 
-Here are the reasons why we wanted to build with Nextjs (a full stack framework built on top of React) over React. 
+Here are the reasons why we wanted to build with Nextjs (a full stack framework built on top of React) over React.
 - Dependencies reduction
-A barebone Reactjs application would require installation of dependency packages to achieve multi-page routing, managing API requests, caching etc. There are a number of solutions out there, e.g. in the original repo, @tanstack/react-router is used for routing, @tanstack/react-query + axios are used for managing API requests and caching. 
-In a Nextjs application, all these functions are built in without the need for third-party libraries. Also, Nextjs14 (app router) uses file-based routing which means the routing is automatically done via the folder structure. 
+A barebone Reactjs application would require installation of dependency packages to achieve multi-page routing, managing API requests, caching etc. There are a number of solutions out there, e.g. in the original repo, @tanstack/react-router is used for routing, @tanstack/react-query + axios are used for managing API requests and caching.
+In a Nextjs application, all these functions are built in without the need for third-party libraries. Also, Nextjs14 (app router) uses file-based routing which means the routing is automatically done via the folder structure.
 
-- Server side rendering 
+- Server side rendering
 Data fetching and mutation in a Nextjs application is mostly dealt in server side while client side data fetching is also allowed. This offers advantages to get away with 'useEffect' and other cumbersome boiler plate codes in order to do data fetching at client side. Server side rendering also offers performance benefit.
 
-- Popularity 
-Nextjs is getting more and more popular. There are good amount of frontend projects and Youtube tutorials based on Nextjs, which are beginner friendly. 
+- Popularity
+Nextjs is getting more and more popular. There are good amount of frontend projects and Youtube tutorials based on Nextjs, which are beginner friendly.
 
 [![Openapi-fetch](https://openapi-ts.pages.dev/assets/openapi-fetch.svg "Openapi-fetch")](https://openapi-ts.pages.dev/openapi-fetch/ "Openapi-fetch")
 
-Since Nextjs offers caching out-of-box (more caching details refer to [Nextjs caching](http://https://nextjs.org/docs/app/building-your-application/caching "Nextjs caching")), we don't have to use React Query, which is an awesome library to manage client side API requests but it has a little bit learning curve for beginners. Rather, the API requests can just be made via fetch (Nextjs added some improvement on the original javascript fetch function). We chose a very light-weight OpenAPI client library just to read the openapi specification file (saved as 'openapi.json') and make sure we have consistent and clearn code. 
+Since Nextjs offers caching out-of-box (more caching details refer to [Nextjs caching](http://https://nextjs.org/docs/app/building-your-application/caching "Nextjs caching")), we don't have to use React Query, which is an awesome library to manage client side API requests but it has a little bit learning curve for beginners. Rather, the API requests can just be made via fetch (Nextjs added some improvement on the original javascript fetch function). We chose a very light-weight OpenAPI client library just to read the openapi specification file (saved as 'openapi.json') and make sure we have consistent and clearn code.
 
-Here is an example. 
-First, in '/frontend/lib/api/index.ts' we initiate the API client. 
+Here is an example.
+First, in '/frontend/lib/api/index.ts' we initiate the API client.
 
 ```javascript
 import createClient from "openapi-fetch";
@@ -75,25 +75,25 @@ async function getItems() {
   return data;
 }
 ```
-This is as cleanest as it can possibly get, in my personal opinion, for handling frontend API requests. 
+This is as cleanest as it can possibly get, in my personal opinion, for handling frontend API requests.
 
-### UI library 
-We use [Shadcn](https://ui.shadcn.com/ "Shadcn"). It's light-weight, all the UI components are imported as plain javascript code for transparency. So, you can modify to suit your need. 
+### UI library
+We use [Shadcn](https://ui.shadcn.com/ "Shadcn"). It's light-weight, all the UI components are imported as plain javascript code for transparency. So, you can modify to suit your need.
 
 ### Deployment
 Docker compose is up to date now with nextjs frontend. You can just deploy through docker compose on a remote server.
 A friendly warning is this code was recently written (in 3-4 days), so there are still bugs. All pull requests are welcome!
 
 ### Roadmap
-- Tidy up the error handling bit 
+- Tidy up the error handling bit
 - Add task queue for long last jobs (Celery + Redis)
 - AI chat interface
 
 ### Backend
 We did not change the backend code, all the other details remain valid from the original [README](README-original.md)
 
 ### EuclideanAI
-Who the hell is EuclideanAI? we are a boutique AI & Data consultancy who provide purpose-built AI, data, machine learning solutions for our clients. [Feel free to reach out!](https://euclideanai.com/contactus/) 
+Who the hell is EuclideanAI? we are a boutique AI & Data consultancy who provide purpose-built AI, data, machine learning solutions for our clients. [Feel free to reach out!](https://euclideanai.com/contactus/)
 
 ### License
 

backend/docker-compose.yml

@@ -4,4 +4,4 @@ services:
     ports:
       - "8080:8000"
     volumes:
-      - ./src:/src
+      - ./src:/src

backend/src/app/alembic/README

@@ -1 +1 @@
-Generic single-database configuration.
+Generic single-database configuration.

backend/src/app/alembic/versions/ae5a34f2895e_add_chat_table.py

@@ -11,29 +11,41 @@
 
 
 # revision identifiers, used by Alembic.
-revision = 'ae5a34f2895e'
-down_revision = 'da90f41ddaa1'
+revision = "ae5a34f2895e"
+down_revision = "da90f41ddaa1"
 branch_labels = None
 depends_on = None
 
 
 def upgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.create_table('chat',
-    sa.Column('id', sqlmodel.sql.sqltypes.AutoString(), nullable=False),
-    sa.Column('chat_config_id', sa.Integer(), nullable=False),
-    sa.Column('messages', sa.JSON(), nullable=True),
-    sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.text('now()'), nullable=True),
-    sa.Column('updated_at', sa.DateTime(timezone=True), nullable=True),
-    sa.Column('owner_id', sa.Integer(), nullable=False),
-    sa.ForeignKeyConstraint(['chat_config_id'], ['chatconfig.id'], ),
-    sa.ForeignKeyConstraint(['owner_id'], ['user.id'], ),
-    sa.PrimaryKeyConstraint('id')
+    op.create_table(
+        "chat",
+        sa.Column("id", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+        sa.Column("chat_config_id", sa.Integer(), nullable=False),
+        sa.Column("messages", sa.JSON(), nullable=True),
+        sa.Column(
+            "created_at",
+            sa.DateTime(timezone=True),
+            server_default=sa.text("now()"),
+            nullable=True,
+        ),
+        sa.Column("updated_at", sa.DateTime(timezone=True), nullable=True),
+        sa.Column("owner_id", sa.Integer(), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["chat_config_id"],
+            ["chatconfig.id"],
+        ),
+        sa.ForeignKeyConstraint(
+            ["owner_id"],
+            ["user.id"],
+        ),
+        sa.PrimaryKeyConstraint("id"),
     )
     # ### end Alembic commands ###
 
 
 def downgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.drop_table('chat')
+    op.drop_table("chat")
     # ### end Alembic commands ###

backend/src/app/alembic/versions/da90f41ddaa1_add_chatconfig_table.py

@@ -11,30 +11,36 @@
 
 
 # revision identifiers, used by Alembic.
-revision = 'da90f41ddaa1'
-down_revision = 'e2412789c190'
+revision = "da90f41ddaa1"
+down_revision = "e2412789c190"
 branch_labels = None
 depends_on = None
 
 
 def upgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.create_table('chatconfig',
-    sa.Column('model', sqlmodel.sql.sqltypes.AutoString(), nullable=False),
-    sa.Column('temperature', sa.Float(), nullable=False),
-    sa.Column('top_p', sa.Float(), nullable=True),
-    sa.Column('top_k', sa.Integer(), nullable=True),
-    sa.Column('system_message', sqlmodel.sql.sqltypes.AutoString(), nullable=True),
-    sa.Column('id', sa.Integer(), nullable=False),
-    sa.Column('owner_id', sa.Integer(), nullable=False),
-    sa.Column('api_key_encrypted', sqlmodel.sql.sqltypes.AutoString(), nullable=True),
-    sa.ForeignKeyConstraint(['owner_id'], ['user.id'], ),
-    sa.PrimaryKeyConstraint('id')
+    op.create_table(
+        "chatconfig",
+        sa.Column("model", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+        sa.Column("temperature", sa.Float(), nullable=False),
+        sa.Column("top_p", sa.Float(), nullable=True),
+        sa.Column("top_k", sa.Integer(), nullable=True),
+        sa.Column("system_message", sqlmodel.sql.sqltypes.AutoString(), nullable=True),
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("owner_id", sa.Integer(), nullable=False),
+        sa.Column(
+            "api_key_encrypted", sqlmodel.sql.sqltypes.AutoString(), nullable=True
+        ),
+        sa.ForeignKeyConstraint(
+            ["owner_id"],
+            ["user.id"],
+        ),
+        sa.PrimaryKeyConstraint("id"),
     )
     # ### end Alembic commands ###
 
 
 def downgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.drop_table('chatconfig')
+    op.drop_table("chatconfig")
     # ### end Alembic commands ###

backend/src/app/api/main_route.py

@@ -1,6 +1,6 @@
 from fastapi import APIRouter
 
-from app.api.routes import items, login, users, utils, chat
+from app.api.routes import chat, items, login, users, utils
 
 api_router = APIRouter()
 api_router.include_router(login.router, tags=["login"])

backend/src/app/api/routes/chat.py

@@ -1,41 +1,25 @@
 from typing import Any
 
-from fastapi import APIRouter, HTTPException, Response, status
-from sqlmodel import func, select
-
-from app.api.deps import CurrentUser, SessionDep
-from app.models import (
-    Item,
-    ItemCreate,
-    ItemPublic,
-    ItemsPublic,
-    ItemUpdate,
-    Message,
-    MessageBase,
-)
-
-from pydantic import BaseModel
-
+from dotenv import load_dotenv
+from fastapi import APIRouter, HTTPException, status
 from fastapi.responses import StreamingResponse
-
 from openai import OpenAI
+from pydantic import BaseModel
+from sqlmodel import func, select
 
-import os
-
-from dotenv import load_dotenv
-
-from app.api.utils import get_streamed_response
+from app.api.deps import CurrentUser, SessionDep
+from app.core.security import decrypt_api_key, encrypt_api_key
 from app.models import (
+    Chat,
     ChatConfig,
     ChatConfigBase,
     ChatConfigCreate,
     ChatConfigPublic,
-    Chat,
     ChatPublic,
+    Message,
+    MessageBase,
 )
 
-from app.core.security import encrypt_api_key, decrypt_api_key
-
 router = APIRouter()
 
 load_dotenv()
@@ -196,11 +180,11 @@ def read_chat_config(
 
 
 @router.put("/config", response_model=ChatConfigPublic)
-def create_chat_config(
+def update_chat_config(
     *, session: SessionDep, current_user: CurrentUser, config_in: ChatConfigCreate
 ) -> Any:
     """
-    Create chat config.
+    Update chat config.
     """
     # check if the user already has a chat config
     statement = select(ChatConfig).where(ChatConfig.owner_id == current_user.id)
@@ -240,7 +224,6 @@ async def chat_handler(
 async def chat_stream_handler(
     chat_request: ChatRequest, session: SessionDep, current_user: CurrentUser
 ) -> StreamingResponse:
-    content = ""
     # get the chat config from the database if it exists
     chatConfig = get_chat_config(session, current_user)
     try:

backend/src/app/api/routes/shop.py

@@ -1,10 +1,9 @@
 # shop.py
-from typing import Any, Dict, List
+from typing import Any
 
-from fastapi import APIRouter, HTTPException
 import requests
 from bs4 import BeautifulSoup
-
+from fastapi import APIRouter, HTTPException
 from pydantic import BaseModel
 
 router = APIRouter()
@@ -20,11 +19,11 @@ class GoogleShoppingRequest(BaseModel):
 class ScrapedData(BaseModel):
     title: str
     description: str
-    links: List[str]
+    links: list[str]
 
 
 @router.get("/google_shopping")
-def google_shopping_search(request: GoogleShoppingRequest) -> Dict[str, Any]:
+def google_shopping_search(request: GoogleShoppingRequest) -> dict[str, Any]:
     """
     Fetches products from Google Shopping using SerpApi.
     """

backend/src/app/api/routes/users.py

@@ -12,6 +12,7 @@
 from app.core.config import settings
 from app.core.security import get_password_hash, verify_password
 from app.models import (
+    Chat,
     Item,
     Message,
     UpdatePassword,
@@ -22,7 +23,6 @@
     UsersPublic,
     UserUpdate,
     UserUpdateMe,
-    Chat,
 )
 from app.utils import generate_new_account_email, send_email
 

backend/src/app/core/config.py

@@ -43,9 +43,9 @@ def server_host(self) -> str:
             return f"http://{self.DOMAIN}"
         return f"https://{self.DOMAIN}"
 
-    BACKEND_CORS_ORIGINS: Annotated[list[AnyUrl] | str, BeforeValidator(parse_cors)] = (
-        []
-    )
+    BACKEND_CORS_ORIGINS: Annotated[
+        list[AnyUrl] | str, BeforeValidator(parse_cors)
+    ] = []
 
     PROJECT_NAME: str
     SENTRY_DSN: HttpUrl | None = None

backend/src/app/core/security.py

@@ -1,13 +1,12 @@
 from datetime import datetime, timedelta
 from typing import Any
 
+from cryptography.fernet import Fernet
 from jose import jwt
 from passlib.context import CryptContext
 
 from app.core.config import settings
 
-from cryptography.fernet import Fernet
-
 # Initialize Fernet with the key
 cipher_suite = Fernet(settings.ENCRYPTION_KEY)