Overhaul structure and functionality

.github/workflows/docker-hub-image-build.yml

@@ -40,7 +40,7 @@ jobs:
         uses: docker/build-push-action@v2
         with:
           context: .
-          file: ./Dockerfile.prod
+          file: ./Dockerfile
           platforms: linux/amd64
           build-args: |
             release_version=${{ github.event.inputs.versionTag || steps.get_version.outputs.VERSION }}

Dockerfile

@@ -1,6 +1,13 @@
 FROM tiangolo/uvicorn-gunicorn-fastapi:python3.9
 
-RUN mkdir -p /root/.aws
-COPY . /app
+WORKDIR /app/
+
+COPY ./requirements.pip /app/requirements.pip
+COPY ./dev-requirements.pip /app/dev-requirements.pip
+RUN pip install -r requirements.pip
 
-RUN mkdir -p /app/media && pip install --no-cache-dir -r /app/requirements.pip
+ARG INSTALL_DEV=false
+RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then pip install -r dev-requirements.pip ; fi"
+
+COPY . /app
+ENV PYTHONPATH=/app

README.md

@@ -91,3 +91,17 @@ $ ./scripts/run-tests.sh
 ```sh
 $ PYTHONPATH=. pytest -s app/tests
 ```
+
+### FAQ
+
+1. How do I access the shell for the application ?
+
+> The application shell can be accessed via `python3`. You can import the crud module to perform any C.R.U.D(Create, Read, Update & Delete) actions on the models
+
+2. What handles the authentication ?
+
+> Authentication is handled via the functions in `app/api/auth_deps.py`. The `onadata` module contains a helper class used to keep OAuth2 Credentials valid.
+
+3. How do I go about adding an extra field in responses ?
+
+> All responses returned by the application are managed using pydantic schemas. In case you'd like to modify a response ensure the field exists in the model and update the `schemas` module

app/alembic/env.py

@@ -1,11 +1,11 @@
+from __future__ import with_statement
+
+import os
 from logging.config import fileConfig
 
 from alembic import context
 from sqlalchemy import engine_from_config, pool
 
-from app.models import Base
-from app.settings import settings
-
 # this is the Alembic Config object, which provides
 # access to the values within the .ini file in use.
 config = context.config
@@ -14,10 +14,29 @@
 # This line sets up loggers basically.
 fileConfig(config.config_file_name)
 
-config.set_main_option("sqlalchemy.url", settings.database_url)
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+# target_metadata = None
+
+from app.database.base import Base  # noqa
 
 target_metadata = Base.metadata
 
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def get_url():
+    user = os.getenv("POSTGRES_USER", "duva")
+    password = os.getenv("POSTGRES_PASSWORD", "duva")
+    server = os.getenv("POSTGRES_SERVER", "postgres")
+    db = os.getenv("POSTGRES_DB", "duva")
+    return f"postgresql://{user}:{password}@{server}/{db}"
+
 
 def run_migrations_offline():
     """Run migrations in 'offline' mode.
@@ -31,12 +50,9 @@ def run_migrations_offline():
     script output.
 
     """
-    url = config.get_main_option("sqlalchemy.url")
+    url = get_url()
     context.configure(
-        url=url,
-        target_metadata=target_metadata,
-        literal_binds=True,
-        dialect_opts={"paramstyle": "named"},
+        url=url, target_metadata=target_metadata, literal_binds=True, compare_type=True
     )
 
     with context.begin_transaction():
@@ -50,14 +66,18 @@ def run_migrations_online():
     and associate a connection with the context.
 
     """
+    configuration = config.get_section(config.config_ini_section)
+    configuration["sqlalchemy.url"] = get_url()
     connectable = engine_from_config(
-        config.get_section(config.config_ini_section),
+        configuration,
         prefix="sqlalchemy.",
         poolclass=pool.NullPool,
     )
 
     with connectable.connect() as connection:
-        context.configure(connection=connection, target_metadata=target_metadata)
+        context.configure(
+            connection=connection, target_metadata=target_metadata, compare_type=True
+        )
 
         with context.begin_transaction():
             context.run_migrations()

app/alembic/versions/7e33515949c2_add_access_token_column.py

@@ -0,0 +1,29 @@
+"""add access_token column
+
+Revision ID: 7e33515949c2
+Revises: dcbb9d699ca4
+Create Date: 2023-06-08 10:10:58.240323
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "7e33515949c2"
+down_revision = "dcbb9d699ca4"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column("server", sa.Column("configuration", sa.JSON(), nullable=True))
+    op.add_column("user", sa.Column("access_token", sa.String(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("user", "access_token")
+    op.drop_column("server", "configuration")
+    # ### end Alembic commands ###

app/alembic/versions/8a3e2f1927b8_add_file_status_field.py

@@ -8,7 +8,7 @@
 import sqlalchemy as sa
 from alembic import op
 
-from app.models import ChoiceType, schemas
+from app.models.hyperfile import ChoiceType, schemas
 
 # revision identifiers, used by Alembic.
 revision = "8a3e2f1927b8"

app/alembic/versions/dcbb9d699ca4_reorganize_models.py

@@ -0,0 +1,42 @@
+"""Reorganize models
+
+Revision ID: dcbb9d699ca4
+Revises: 259f90f13bd6
+Create Date: 2023-05-31 11:57:11.230587
+
+"""
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "dcbb9d699ca4"
+down_revision = "259f90f13bd6"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("hyper_file", "last_synced")
+    op.create_index(op.f("ix_server_id"), "server", ["id"], unique=False)
+    op.alter_column("configuration", "user", new_column_name="user_id")
+    op.alter_column("hyper_file", "user", new_column_name="user_id")
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(op.f("ix_server_id"), table_name="server")
+    op.add_column(
+        "hyper_file",
+        sa.Column(
+            "last_synced",
+            postgresql.TIMESTAMP(),
+            autoincrement=False,
+            nullable=True,
+        ),
+    )
+    op.alter_column("hyper_file", "user_id", new_column_name="user")
+    op.alter_column("configuration", "user_id", new_column_name="user")
+    # ### end Alembic commands ###

app/api/auth_deps.py

@@ -0,0 +1,43 @@
+import jwt
+from fastapi import Depends, HTTPException, Request
+from fastapi.security import OAuth2PasswordBearer
+from sqlalchemy.orm import Session
+
+from app import crud
+from app.api.deps import get_db
+from app.core.config import settings
+from app.models.user import User
+from app.schemas.token import TokenPayload
+
+reusable_oauth2 = OAuth2PasswordBearer(tokenUrl="/api/v1/oauth/login", auto_error=False)
+
+
+def get_current_user(
+    db: Session = Depends(get_db),
+    token: str = Depends(reusable_oauth2),
+    *,
+    request: Request,
+) -> User:
+    if not token:
+        token = request.session.get("token")
+
+    if token:
+        try:
+            payload = jwt.decode(
+                token, settings.SECRET_KEY, algorithms=[settings.ALGORITHM]
+            )
+            token_data = TokenPayload(**payload)
+        except jwt.PyJWTError:
+            if request.session.get("token"):
+                del request.session["token"]
+            raise HTTPException(
+                status_code=401, detail="Could not validate credentials"
+            )
+
+        user = crud.user.get(db, id=token_data.sub)
+        if not user:
+            raise HTTPException(status_code=401, detail="User not found")
+
+        return user
+    else:
+        raise HTTPException(status_code=401, detail="Could not validate credentials")

app/api/deps.py

@@ -0,0 +1,51 @@
+from typing import Generator, Any, Callable
+from fastapi import APIRouter as FastAPIRouter
+from fastapi.types import DecoratedCallable
+
+import redis
+
+from app.core.config import settings
+from app.database.session import SessionLocal
+
+
+def get_db() -> Generator:
+    try:
+        db = SessionLocal()
+        yield db
+    finally:
+        db.close()
+
+
+def get_redis_client() -> Generator:
+    try:
+        client = redis.from_url(str(settings.REDIS_URL))
+        yield client
+    finally:
+        client.close()
+
+
+class APIRouter(FastAPIRouter):
+    """
+    Custom APIRouter that allows for trailing slashes on endpoints.
+    """
+
+    def api_route(
+        self, path: str, *, include_in_schema: bool = True, **kwargs: Any
+    ) -> Callable[[DecoratedCallable], DecoratedCallable]:
+        if path.endswith("/"):
+            path = path[:-1]
+
+        add_path = super().api_route(
+            path, include_in_schema=include_in_schema, **kwargs
+        )
+
+        alternate_path = path + "/"
+        add_alternate_path = super().api_route(
+            alternate_path, include_in_schema=False, **kwargs
+        )
+
+        def decorator(func: DecoratedCallable) -> DecoratedCallable:
+            add_alternate_path(func)
+            return add_path(func)
+
+        return decorator

app/api/v1/api.py

@@ -0,0 +1,11 @@
+from fastapi import APIRouter
+
+from app.api.v1.endpoints import configuration, file, oauth, server
+
+api_router = APIRouter()
+api_router.include_router(
+    configuration.router, prefix="/configurations", tags=["configuration"]
+)
+api_router.include_router(oauth.router, prefix="/oauth", tags=["oauth"])
+api_router.include_router(server.router, prefix="/servers", tags=["server"])
+api_router.include_router(file.router, prefix="/files", tags=["file"])