Merge pull request #24 from nickatnight/nickatnight-GH-23

[GH-23] New is_it field and update logic

Author: nickatnight

.github/workflows/build.yml

@@ -25,7 +25,7 @@ jobs:
           token: ${{ secrets.do-token }}
       - name: Build backend
         run: |
-          docker build --build-arg env=staging -t ${{ secrets.registry }}/backend:${{ github.sha }} ./backend
+          docker build --build-arg env=prod -t ${{ secrets.registry }}/backend:${{ github.sha }} ./backend
       - name: Log in to DigitalOcean Container Registry with short-lived credentials
         run: doctl registry login --expiry-seconds 600
       - name: Push image to DigitalOcean Container Registry
@@ -43,7 +43,7 @@ jobs:
           token: ${{ secrets.do-token }}
       - name: Build nginx
         run: |
-          docker build --build-arg env=staging -t ${{ secrets.registry }}/nginx:${{ github.sha }} ./nginx
+          docker build --build-arg env=prod -t ${{ secrets.registry }}/nginx:${{ github.sha }} ./nginx
       - name: Log in to DigitalOcean Container Registry with short-lived credentials
         run: doctl registry login --expiry-seconds 600
       - name: Push image to DigitalOcean Container Registry

.github/workflows/main.yml

@@ -6,7 +6,6 @@ on:
       - '*'
     branches:
       - main
-      - develop
 
 env:
   DOCTL_VERSION: 1.92.0
@@ -42,47 +41,48 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Deploy staging
+      # - name: Deploy staging
+      #   uses: ironhalik/docker-over-ssh-action@v6
+      #   if: github.ref == 'refs/heads/develop'
+      #   env:
+      #     COMPOSE_FILE: ops/docker-compose.staging.yml
+      #     STACK_NAME: tagyoureitbackend-staging
+      #     DIGITALOCEAN_ACCESS_TOKEN: ${{ secrets.DIGITALOCEAN_TOKEN }}
+      #     REGISTRY: ${{ secrets.REGISTRY }}
+      #     POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
+      #     POSTGRES_STAGING_HOST: ${{ secrets.POSTGRES_STAGING_HOST }}
+      #     PASSWORD: ${{ secrets.PASSWORD }}
+      #     CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
+      #   with:
+      #     user: ubuntu
+      #     host: ${{ secrets.STAGING_HOST_IP }}
+      #     key: ${{ secrets.SSH_KEY }}
+      #     script: |
+      #       wget https://github.com/digitalocean/doctl/releases/download/v${{ env.DOCTL_VERSION }}/doctl-${{ env.DOCTL_VERSION }}-linux-amd64.tar.gz
+      #       tar xf ./doctl-${{ env.DOCTL_VERSION }}-linux-amd64.tar.gz
+      #       mv ./doctl /usr/local/bin
+      #       doctl registry login
+      #       docker stack deploy --compose-file ${COMPOSE_FILE} --with-registry-auth --prune ${STACK_NAME}
+
+      - name: Deploy prod
         uses: ironhalik/docker-over-ssh-action@v6
-        if: github.ref == 'refs/heads/develop'
+        if: github.ref == 'refs/heads/main'
         env:
-          COMPOSE_FILE: ops/docker-compose.staging.yml
-          STACK_NAME: tagyoureitbackend-staging
+          COMPOSE_FILE: ops/docker-compose.prod.yml
+          STACK_NAME: tagyoureitbackend-prod
           DIGITALOCEAN_ACCESS_TOKEN: ${{ secrets.DIGITALOCEAN_TOKEN }}
           REGISTRY: ${{ secrets.REGISTRY }}
           POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
-          POSTGRES_STAGING_HOST: ${{ secrets.POSTGRES_STAGING_HOST }}
+          POSTGRES_PROD_HOST: ${{ secrets.POSTGRES_PROD_HOST }}
           PASSWORD: ${{ secrets.PASSWORD }}
           CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
         with:
           user: ubuntu
-          host: ${{ secrets.STAGING_HOST_IP }}
+          host: ${{ secrets.PROD_HOST_IP }}
           key: ${{ secrets.SSH_KEY }}
           script: |
             wget https://github.com/digitalocean/doctl/releases/download/v${{ env.DOCTL_VERSION }}/doctl-${{ env.DOCTL_VERSION }}-linux-amd64.tar.gz
             tar xf ./doctl-${{ env.DOCTL_VERSION }}-linux-amd64.tar.gz
             mv ./doctl /usr/local/bin
             doctl registry login
             docker stack deploy --compose-file ${COMPOSE_FILE} --with-registry-auth --prune ${STACK_NAME}
-
-  #     - name: Deploy prod
-  #       uses: ironhalik/docker-over-ssh-action@v6
-  #       if: github.ref == 'refs/heads/main'
-  #       env:
-  #         COMPOSE_FILE: ops/docker-compose.prod.yml
-  #         STACK_NAME: tagyoureitbackend-prod
-  #         DIGITALOCEAN_ACCESS_TOKEN: ${{ secrets.DIGITALOCEAN_TOKEN }}
-  #         REGISTRY: ${{ secrets.REGISTRY }}
-  #         POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
-  #         PASSWORD: ${{ secrets.PASSWORD }}
-  #         CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
-  #       with:
-  #         user: ubuntu
-  #         host: ${{ secrets.PROD_HOST_IP }}
-  #         key: ${{ secrets.SSH_KEY }}
-  #         script: |
-  #           wget https://github.com/digitalocean/doctl/releases/download/v${{ env.DOCTL_VERSION }}/doctl-${{ env.DOCTL_VERSION }}-linux-amd64.tar.gz
-  #           tar xf ./doctl-${{ env.DOCTL_VERSION }}-linux-amd64.tar.gz
-  #           mv ./doctl /usr/local/bin
-  #           doctl registry login
-  #           docker stack deploy --compose-file ${COMPOSE_FILE} --with-registry-auth --prune ${STACK_NAME}

.github/workflows/pr.yml

@@ -6,7 +6,6 @@ on:
   pull_request:
     branches:
       - main
-      - develop
 
 jobs:
   lint:

backend/src/core/const.py

@@ -68,17 +68,14 @@ class Envs:
     else ""
 )
 
-SUB_DOMAIN = "api"
-if settings.ENV != Envs.PRODUCTION:
-    SUB_DOMAIN = "api-staging"
 
 FOOTER = (
     "^^[ how to use]"
     "(https://www.reddit.com/r/TagYoureItBot/comments/11bcwi1/tagyoureitbot_info_beta_relase/)"
     " | [creator](https://www.reddit.com/message/compose/?to=throwie_one)"
     " | [source code](https://github.com/nickatnight/tag-youre-it-backend)"
     " | [wikihow](https://www.wikihow.com/Play-Tag)"
-    f" | [public api](https://{SUB_DOMAIN}.tagyoureitbot.com/docs)"
+    f" | [public api](https://api.tagyoureitbot.com/docs)"
     " | [website](https://tagyoureitbot.com)"
     f"{OPT_OUT}"
 )

backend/src/core/decorators.py

@@ -1,26 +1,24 @@
-# import logging
-# from typing import Any, Callable
+import functools
+import logging
+from typing import Any
 
-# import asyncprawcore
-# from result import Result, Ok, Err
+import asyncprawcore
 
 
-# logger = logging.getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
-# class CatchAsyncPraw:
-#     """generic catch handler for methods using asyncpraw"""
-#     def __init__(self, function: Callable[..., Any]) -> None:
-#         self.function = function
+def catch_apraw_and_log(func):
+    @functools.wraps(func)
+    async def wrapper_catch_apraw_and_log(*args, **kwargs):
+        try:
+            result: Any = await func(*args, **kwargs)
+        except asyncprawcore.exceptions.RequestException as a_exc:
+            logger.warning(a_exc, exc_info=True)
+        except Exception as e:
+            logger.warning(e, exc_info=True)
+        else:
+            return result
+        return False
 
-#     def __call__(self, *args: str, **kwargs: Any) -> Result[Any, str]:
-#         try:
-#             result: Any = self.function(*args, **kwargs)
-#         except asyncprawcore.exceptions.RequestException as a_exc:
-#             logger.error(a_exc, exc_info=True)
-#             return Err(str(a_exc))
-#         except Exception as e:
-#             logger.error(e, exc_info=True)
-#             return Err(f"Unknown error occurred: {e}")
-#         else:
-#             return Ok(result)
+    return wrapper_catch_apraw_and_log

backend/src/migrations/versions/001ed18e8a99_init.py renamed to backend/src/migrations/versions/dcf44004a9e6_init.py

@@ -1,8 +1,8 @@
 """init
 
-Revision ID: 001ed18e8a99
+Revision ID: dcf44004a9e6
 Revises: 
-Create Date: 2023-02-24 02:29:14.014323
+Create Date: 2023-03-09 21:53:18.928636
 
 """
 from alembic import op
@@ -11,7 +11,7 @@
 
 
 # revision identifiers, used by Alembic.
-revision = '001ed18e8a99'
+revision = 'dcf44004a9e6'
 down_revision = None
 branch_labels = None
 depends_on = None
@@ -33,6 +33,7 @@ def upgrade() -> None:
     sa.Column('is_suspended', sa.Boolean(), nullable=True),
     sa.Column('opted_out', sa.Boolean(), nullable=True),
     sa.Column('is_banned', sa.Boolean(), nullable=True),
+    sa.Column('is_it', sa.Boolean(), nullable=True),
     sa.Column('ref_id', sqlmodel.sql.sqltypes.GUID(), server_default=sa.text('gen_random_uuid()'), nullable=False),
     sa.Column('id', sa.Integer(), nullable=False),
     sa.PrimaryKeyConstraint('id'),

backend/src/models/player.py

@@ -38,6 +38,7 @@ class PlayerBase(SQLModel):
     # game fields
     opted_out: Optional[bool] = Field(default=False, description="Did the user opt out of playing.")
     is_banned: Optional[bool] = Field(default=False, description="Is the user banned from playing.")
+    is_it: Optional[bool] = Field(default=False, description="Is the user it.")
     tag_time: Optional[datetime] = Field(
         sa_column=Column(
             DateTime(timezone=True),

backend/src/repositories/sqlalchemy.py

@@ -46,7 +46,7 @@ async def create(self, obj_in: CreateSchemaType, **kwargs: Any) -> ModelType:
         return db_obj
 
     async def get(self, **kwargs: Any) -> Optional[ModelType]:
-        logger.info(f"Fetching [{self._model.__class__.__name__}] object by [{kwargs}]")
+        logger.info(f"Fetching [{self._model.__table__.name.capitalize()}] object by [{kwargs}]")
 
         query = select(self._model).filter_by(**kwargs)
         response = await self.db.execute(query)
@@ -58,7 +58,7 @@ async def get(self, **kwargs: Any) -> Optional[ModelType]:
         return scalar
 
     async def update(self, obj_current: ModelType, obj_in: UpdateSchemaType) -> ModelType:
-        logger.info(f"Updating [{self._model.__class__.__name__}] object with [{obj_in}]")
+        logger.info(f"Updating [{self._model.__table__.name.capitalize()}] object with [{obj_in}]")
 
         update_data = obj_in.dict(
             exclude_unset=True
@@ -101,7 +101,7 @@ async def all(
         return response.scalars().all()
 
     async def f(self, **kwargs: Any) -> List[ModelType]:
-        logger.info(f"Fetching [{self._model.__class__.__name__}] object by [{kwargs}]")
+        logger.info(f"Filtering [{self._model.__table__.name.capitalize()}] object by [{kwargs}]")
 
         query = select(self._model).filter_by(**kwargs)
         response = await self.db.execute(query)

backend/src/services/game.py

@@ -1,5 +1,5 @@
 import logging
-from typing import List, Optional, Union
+from typing import Optional, Union
 from uuid import UUID
 
 from sqlmodel import select
@@ -41,14 +41,18 @@ async def add_player(self, player: Player, game_ref_id: Union[UUID, str]) -> Non
 
         logger.info(f"Adding Players[{player.username}] to Game[{game.ref_id}]")
 
-    async def active(self) -> List[Game]:
+    async def active(self, sub: SubReddit) -> Optional[Game]:
         logger.info("Fetching current game")
         statement = (
             select(self.repo._model)
             .where(self.repo._model.is_active == True)  # noqa
+            .where(self.repo._model.subreddit_id == sub.id)
             .order_by(self.repo._model.__table__.columns["created_at"].desc())  # type: ignore
         )
         results = await self.repo.db.execute(statement)
-        games: List[Game] = results.scalars().all()
+        game: Optional[Game] = results.scalar_one_or_none()
 
-        return games
+        if not game:
+            logger.info(f"No Game found for sub[{sub.ref_id}]")
+
+        return game

backend/src/services/player.py

@@ -28,7 +28,7 @@ async def set_opted_out(self, reddit_id: str, value: bool) -> None:
         if not player:
             raise ObjectNotFound
 
-        player_obj = IPlayerUpdate(opted_out=value)
+        player_obj = IPlayerUpdate(opted_out=value, is_it=False)
         _ = await self.repo.update(player, player_obj)
 
         logger.info(f"[{player.username}] opted out of playing.")
@@ -51,11 +51,11 @@ async def get_or_create(self, reddit_obj: Redditor) -> Player:
     async def untag(self, reddit_obj: Redditor) -> None:
         instance = await self.get_or_create(reddit_obj)
 
-        player_obj = IPlayerUpdate(tag_time=None)
+        player_obj = IPlayerUpdate(is_it=False)
         _ = await self.repo.update(instance, player_obj)
 
     async def tag(self, reddit_obj: Redditor) -> None:
         instance = await self.get_or_create(reddit_obj)
 
-        player_obj = IPlayerUpdate(tag_time=datetime.now(timezone.utc))
+        player_obj = IPlayerUpdate(tag_time=datetime.now(timezone.utc), is_it=True)
         _ = await self.repo.update(instance, player_obj)