Merge pull request #37 from d4vidsha/d4vidsha/template-updates

chore: add template updates

Author: d4vidsha

.env.example

@@ -12,7 +12,6 @@ BACKEND_CORS_ORIGINS="http://localhost,http://localhost:5173,https://localhost,h
 SECRET_KEY=changethis
 FIRST_SUPERUSER=[email protected]
 FIRST_SUPERUSER_PASSWORD=changethis
-USERS_OPEN_REGISTRATION=False
 
 # emails
 SMTP_HOST=

.github/workflows/deploy-production.yml

@@ -23,7 +23,6 @@ jobs:
       EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
       POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
       SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
-      USERS_OPEN_REGISTRATION: ${{ secrets.USERS_OPEN_REGISTRATION_PRODUCTION }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.github/workflows/deploy-staging.yml

@@ -23,7 +23,6 @@ jobs:
       EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
       POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
       SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
-      USERS_OPEN_REGISTRATION: ${{ secrets.USERS_OPEN_REGISTRATION_STAGING }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.github/workflows/playwright.yml

@@ -0,0 +1,66 @@
+name: Playwright Tests
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    types:
+    - opened
+    - synchronize
+  workflow_dispatch:
+    inputs:
+      debug_enabled:
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: 'false'
+
+jobs:
+
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+    - name: Setup tmate session
+      uses: mxschmitt/action-tmate@v3
+      if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
+      with:
+        limit-access-to-actor: true
+    - name: Install dependencies
+      run: npm ci
+      working-directory: frontend
+    - name: Install Playwright Browsers
+      run: npx playwright install --with-deps
+      working-directory: frontend
+    - run: docker compose build
+    - run: docker compose down -v --remove-orphans
+    - run: docker compose up -d
+    - name: Run Playwright tests
+      run: npx playwright test
+      working-directory: frontend
+    - run: docker compose down -v --remove-orphans
+    - uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: playwright-report
+        path: frontend/playwright-report/
+        retention-days: 30
+
+  # https://github.com/marketplace/actions/alls-green#why
+  e2e-alls-green:  # This job does nothing and is only used for the branch protection
+    if: always()
+    needs:
+      - test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

CONTRIBUTING.md

@@ -17,6 +17,7 @@
   - Using TypeScript, hooks, Vite, and other parts of a modern frontend stack.
   - [Chakra UI](https://chakra-ui.com) for the frontend components.
   - An automatically generated frontend client.
+  - [Playwright](https://playwright.dev) for End-to-End testing.
   - Dark mode support.
 - [Docker Compose](https://www.docker.com) for development and production.
 - Secure password hashing by default.

backend/README.md

@@ -63,16 +63,6 @@ Make sure your editor is using the correct Python virtual environment.
 
 Modify or add SQLModel models for data and SQL tables in `./backend/app/models.py`, API endpoints in `./backend/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/crud.py`.
 
-### Enabling Open User Registration
-
-By default the backend has user registration disabled, but there's already a route to register users. If you want to allow users to register themselves, you can set the environment variable `USERS_OPEN_REGISTRATION` to `True` in the `.env` file.
-
-After modifying the environment variables, restart the Docker containers to apply the changes. You can do this by running:
-
-```console
-docker compose up -d
-```
-
 ### VS Code
 
 There are already configurations in place to run the backend through the VS Code debugger, so that you can use breakpoints, pause and explore variables, etc.

backend/app/alembic/env.py

@@ -19,6 +19,7 @@
 # target_metadata = None
 
 from app.models import SQLModel  # noqa
+from app.core.config import settings # noqa
 
 target_metadata = SQLModel.metadata
 
@@ -29,12 +30,7 @@
 
 
 def get_url():
-    user = os.getenv("POSTGRES_USER", "postgres")
-    password = os.getenv("POSTGRES_PASSWORD", "")
-    server = os.getenv("POSTGRES_SERVER", "db")
-    port = os.getenv("POSTGRES_PORT", "5432")
-    db = os.getenv("POSTGRES_DB", "app")
-    return f"postgresql+psycopg://{user}:{password}@{server}:{port}/{db}"
+    return str(settings.SQLALCHEMY_DATABASE_URI)
 
 
 def run_migrations_offline():

backend/app/alembic/versions/c48758dce0b3_feat_add_cascade_delete_relationships.py

@@ -0,0 +1,77 @@
+"""feat: add cascade delete relationships
+
+Revision ID: c48758dce0b3
+Revises: 119709b3f9bb
+Create Date: 2024-08-02 16:33:22.524259
+
+"""
+from alembic import op
+import sqlalchemy as sa
+import sqlmodel.sql.sqltypes
+
+
+# revision identifiers, used by Alembic.
+revision = 'c48758dce0b3'
+down_revision = '119709b3f9bb'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.alter_column('item', 'id',
+               existing_type=sa.INTEGER(),
+               type_=sa.Uuid(),
+               existing_nullable=False)
+    op.alter_column('item', 'owner_id',
+               existing_type=sa.INTEGER(),
+               type_=sa.Uuid(),
+               existing_nullable=False)
+    op.drop_constraint('item_owner_id_fkey', 'item', type_='foreignkey')
+    op.create_foreign_key(None, 'item', 'user', ['owner_id'], ['id'], ondelete='CASCADE')
+    op.alter_column('task', 'id',
+               existing_type=sa.INTEGER(),
+               type_=sa.Uuid(),
+               existing_nullable=False)
+    op.alter_column('task', 'owner_id',
+               existing_type=sa.INTEGER(),
+               type_=sa.Uuid(),
+               existing_nullable=False)
+    op.drop_constraint('task_owner_id_fkey', 'task', type_='foreignkey')
+    op.create_foreign_key(None, 'task', 'user', ['owner_id'], ['id'], ondelete='CASCADE')
+    op.alter_column('user', 'id',
+               existing_type=sa.INTEGER(),
+               type_=sa.Uuid(),
+               existing_nullable=False,
+               existing_server_default=sa.text("nextval('user_id_seq'::regclass)"))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.alter_column('user', 'id',
+               existing_type=sa.Uuid(),
+               type_=sa.INTEGER(),
+               existing_nullable=False,
+               existing_server_default=sa.text("nextval('user_id_seq'::regclass)"))
+    op.drop_constraint(None, 'task', type_='foreignkey')
+    op.create_foreign_key('task_owner_id_fkey', 'task', 'user', ['owner_id'], ['id'])
+    op.alter_column('task', 'owner_id',
+               existing_type=sa.Uuid(),
+               type_=sa.INTEGER(),
+               existing_nullable=False)
+    op.alter_column('task', 'id',
+               existing_type=sa.Uuid(),
+               type_=sa.INTEGER(),
+               existing_nullable=False)
+    op.drop_constraint(None, 'item', type_='foreignkey')
+    op.create_foreign_key('item_owner_id_fkey', 'item', 'user', ['owner_id'], ['id'])
+    op.alter_column('item', 'owner_id',
+               existing_type=sa.Uuid(),
+               type_=sa.INTEGER(),
+               existing_nullable=False)
+    op.alter_column('item', 'id',
+               existing_type=sa.Uuid(),
+               type_=sa.INTEGER(),
+               existing_nullable=False)
+    # ### end Alembic commands ###

backend/app/api/routes/items.py

@@ -1,3 +1,4 @@
+import uuid
 from typing import Any
 
 from fastapi import APIRouter, HTTPException
@@ -41,7 +42,7 @@ def read_items(
 
 
 @router.get("/{id}", response_model=ItemPublic)
-def read_item(session: SessionDep, current_user: CurrentUser, id: int) -> Any:
+def read_item(session: SessionDep, current_user: CurrentUser, id: uuid.UUID) -> Any:
     """
     Get item by ID.
     """
@@ -69,7 +70,11 @@ def create_item(
 
 @router.put("/{id}", response_model=ItemPublic)
 def update_item(
-    *, session: SessionDep, current_user: CurrentUser, id: int, item_in: ItemUpdate
+    *,
+    session: SessionDep,
+    current_user: CurrentUser,
+    id: uuid.UUID,
+    item_in: ItemUpdate,
 ) -> Any:
     """
     Update an item.
@@ -88,7 +93,9 @@ def update_item(
 
 
 @router.delete("/{id}")
-def delete_item(session: SessionDep, current_user: CurrentUser, id: int) -> Message:
+def delete_item(
+    session: SessionDep, current_user: CurrentUser, id: uuid.UUID
+) -> Message:
     """
     Delete an item.
     """

backend/app/api/routes/users.py

@@ -1,3 +1,4 @@
+import uuid
 from typing import Any
 
 from fastapi import APIRouter, Depends, HTTPException
@@ -145,11 +146,6 @@ def register_user(session: SessionDep, user_in: UserRegister) -> Any:
     """
     Create new user without the need to be logged in.
     """
-    if not settings.USERS_OPEN_REGISTRATION:
-        raise HTTPException(
-            status_code=403,
-            detail="Open user registration is forbidden on this server",
-        )
     user = crud.get_user_by_email(session=session, email=user_in.email)
     if user:
         raise HTTPException(
@@ -163,7 +159,7 @@ def register_user(session: SessionDep, user_in: UserRegister) -> Any:
 
 @router.get("/{user_id}", response_model=UserPublic)
 def read_user_by_id(
-    user_id: int, session: SessionDep, current_user: CurrentUser
+    user_id: uuid.UUID, session: SessionDep, current_user: CurrentUser
 ) -> Any:
     """
     Get a specific user by id.
@@ -187,7 +183,7 @@ def read_user_by_id(
 def update_user(
     *,
     session: SessionDep,
-    user_id: int,
+    user_id: uuid.UUID,
     user_in: UserUpdate,
 ) -> Any:
     """
@@ -213,7 +209,7 @@ def update_user(
 
 @router.delete("/{user_id}", dependencies=[Depends(get_current_active_superuser)])
 def delete_user(
-    session: SessionDep, current_user: CurrentUser, user_id: int
+    session: SessionDep, current_user: CurrentUser, user_id: uuid.UUID
 ) -> Message:
     """
     Delete a user.