Merge remote-tracking branch 'origin/main' into F25/artyom/invite-user

Author: VictorChan880

.github/workflows/lint.yml

@@ -22,7 +22,7 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
-      
+
       - name: Filter changed files
         uses: dorny/paths-filter@v2
         id: changes
@@ -34,7 +34,19 @@ jobs:
               - "backend/typescript/**"
             python-backend:
               - "backend/python/**"
-      
+
+      - name: Get Yarn cache directory
+        id: yarn-cache-dir
+        run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache Yarn dependencies
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.yarn-cache-dir.outputs.dir }}
+          key: yarn-${{ runner.os }}-${{ hashFiles('frontend/yarn.lock', 'backend/typescript/yarn.lock') }}
+          restore-keys: |
+            yarn-${{ runner.os }}-
+
       - name: Set up Node.js
         if: steps.changes.outputs.frontend == 'true' || steps.changes.outputs.typescript-backend == 'true'
         uses: actions/setup-node@v4
@@ -44,7 +56,7 @@ jobs:
           cache-dependency-path: |
             frontend/yarn.lock
             backend/typescript/yarn.lock
-            
+
       - name: Install Node.js dependencies
         if: steps.changes.outputs.frontend == 'true' || steps.changes.outputs.typescript-backend == 'true'
         run: yarn --cwd ./frontend --prefer-offline && yarn --cwd ./backend/typescript --prefer-offline
@@ -58,7 +70,7 @@ jobs:
         if: steps.changes.outputs.typescript-backend == 'true'
         working-directory: ./backend/typescript
         run: yarn lint
-      
+
       - name: Lint Python backend
         if: steps.changes.outputs.python-backend == 'true'
         working-directory: ./backend/python

README.md

@@ -113,6 +113,17 @@ docker exec -it humane_society_frontend /bin/bash -c "yarn run fix"
 docker exec -it humane_society_backend /bin/bash -c "yarn test"
 ```
 
+## Running against Supabase DB
+We have deployed our Postgres DB on Supabase which you can connect your local application to, which can be useful for testing.
+
+1. Ask your Project Lead for the `DATABASE_URL` environment variable which stores our Supabase connection URL and add it to `.env` at the root of this project.
+    - Optionally, you can also be added to the OMHS organization on Supabase if you need to do some admin work on the deployed DB.
+2. Run the app against the Supabase DB
+```bash
+NODE_ENV=production docker compose up
+```
+
+> **Note:** Currently, the `humane_society_db` container is also run even when you run against Supabase. You should be able to stop it if the application is correctly connected to Supabase. Additional changes can be made to stop it from running when you want to run against Supabase, involving setting another environment variable (see this [PR](https://github.com/uwblueprint/humane-society/pull/152)).
 
 ## Version Control Guide
 

backend/typescript/middlewares/validators/userValidators.ts

@@ -31,6 +31,14 @@ export const createUserDtoValidator = async (
   if (false && !validatePrimitive(req.body.colorLevel, "integer")) {
     return res.status(400).send(getApiValidationError("colorLevel", "integer"));
   }
+  if (!validateNumberConstraint(req.body.colorLevel, 1, 5)) {
+    return res.status(400).send(getConstraintError("colorLevel", 1, 5));
+  }
+  if (!validateEnumArray(req.body.animalTags, AnimalTag)) {
+    return res
+      .status(400)
+      .send(getApiValidationError("animalTags", "AnimalTag", true));
+  }
   if (
     req.body.canSeeAllLogs !== undefined &&
     req.body.canSeeAllLogs !== null &&

backend/typescript/package.json

@@ -18,6 +18,7 @@
     "@faker-js/faker": "^8.4.1",
     "@types/graphql-upload": "^8.0.6",
     "@types/json2csv": "^5.0.3",
+    "@types/luxon": "^3.6.2",
     "@types/multer": "^1.4.6",
     "@types/swagger-ui-express": "^4.1.6",
     "@types/uuid": "^8.3.1",
@@ -34,6 +35,7 @@
     "graphql-upload": "^12.0.0",
     "json2csv": "^5.0.6",
     "lodash": "^4.17.21",
+    "luxon": "^3.7.2",
     "mongoose": "^6.13.6",
     "multer": "^2.0.1",
     "node-fetch": "^2.6.1",
@@ -43,7 +45,8 @@
     "sequelize": "^6.5.0",
     "sequelize-typescript": "^2.1.0",
     "swagger-ui-express": "^4.1.6",
-    "ts-node": "^10.0.0",
+    "ts-node": "10.9.2",
+    "typescript": "4.7.2",
     "umzug": "^3.0.0-beta.16",
     "uuid": "^8.3.2",
     "winston": "^3.3.3",

backend/typescript/rest/authRoutes.ts

@@ -34,10 +34,16 @@ const cookieOptions: CookieOptions = {
 /* Returns access token and user info in response body and sets refreshToken as an httpOnly cookie */
 authRouter.post("/login", loginRequestValidator, async (req, res) => {
   try {
-    const authDTO = req.body.idToken
-      ? // OAuth
-        await authService.generateTokenOAuth(req.body.idToken)
-      : await authService.generateToken(req.body.email, req.body.password);
+    // OAuth is not in use
+    // const authDTO = req.body.idToken
+    //   ? // OAuth
+    //     await authService.generateTokenOAuth(req.body.idToken)
+    //   : await authService.generateToken(req.body.email, req.body.password);
+
+    const authDTO = await authService.generateToken(
+      req.body.email,
+      req.body.password,
+    );
 
     const { refreshToken, ...rest } = authDTO;
 

backend/typescript/rest/petRoutes.ts

@@ -124,6 +124,21 @@ petRouter.get("/", async (req, res) => {
   }
 });
 
+/* Get PetList by userId */
+petRouter.get("/list/:userId", async (req, res) => {
+  const { userId } = req.params;
+  try {
+    const petList = await petService.getPetList(parseInt(userId, 10));
+    res.status(200).json(petList);
+  } catch (e: unknown) {
+    if (e instanceof NotFoundError) {
+      res.status(404).send(getErrorMessage(e));
+    } else {
+      res.status(500).send(INTERNAL_SERVER_ERROR_MESSAGE);
+    }
+  }
+});
+
 /* Get Pet by id */
 petRouter.get("/:id", async (req, res) => {
   const { id } = req.params;

backend/typescript/rest/userRoutes.ts

@@ -131,6 +131,8 @@ userRouter.post("/", createUserDtoValidator, async (req, res) => {
       lastName: req.body.lastName,
       email: req.body.email,
       role: req.body.role,
+      colorLevel: req.body.colorLevel,
+      animalTags: req.body.animalTags,
       canSeeAllLogs: req.body.canSeeAllLogs ?? null,
       canAssignUsersToTasks: req.body.canAssignUsersToTasks ?? null,
       phoneNumber: req.body.phoneNumber ?? null,

backend/typescript/services/implementations/authService.ts

@@ -39,39 +39,42 @@ class AuthService implements IAuthService {
     }
   }
 
+  // OAuth is not in use
   /* eslint-disable class-methods-use-this */
-  async generateTokenOAuth(idToken: string): Promise<AuthDTO> {
-    try {
-      const googleUser = await FirebaseRestClient.signInWithGoogleOAuth(
-        idToken,
-      );
-      // googleUser.idToken refers to the Firebase Auth access token for the user
-      const token = {
-        accessToken: googleUser.idToken,
-        refreshToken: googleUser.refreshToken,
-      };
-      // If user already has a login with this email, just return the token
-      try {
-        // Note: an error message will be logged from UserService if this lookup fails.
-        // You may want to silence the logger for this special OAuth user lookup case
-        const user = await this.userService.getUserByEmail(googleUser.email);
-        return { ...token, ...user };
-        /* eslint-disable-next-line no-empty */
-      } catch (error) {}
-
-      const user = await this.userService.createUser({
-        firstName: googleUser.firstName,
-        lastName: googleUser.lastName,
-        email: googleUser.email,
-        role: Role.STAFF,
-      });
-
-      return { ...token, ...user };
-    } catch (error) {
-      Logger.error(`Failed to generate token for user with OAuth ID token`);
-      throw error;
-    }
-  }
+  // async generateTokenOAuth(idToken: string): Promise<AuthDTO> {
+  //   try {
+  //     const googleUser = await FirebaseRestClient.signInWithGoogleOAuth(
+  //       idToken,
+  //     );
+  //     // googleUser.idToken refers to the Firebase Auth access token for the user
+  //     const token = {
+  //       accessToken: googleUser.idToken,
+  //       refreshToken: googleUser.refreshToken,
+  //     };
+  //     // If user already has a login with this email, just return the token
+  //     try {
+  //       // Note: an error message will be logged from UserService if this lookup fails.
+  //       // You may want to silence the logger for this special OAuth user lookup case
+  //       const user = await this.userService.getUserByEmail(googleUser.email);
+  //       return { ...token, ...user };
+  //       /* eslint-disable-next-line no-empty */
+  //     } catch (error) {}
+  //
+  //     const user = await this.userService.createUser({
+  //       firstName: googleUser.firstName,
+  //       lastName: googleUser.lastName,
+  //       email: googleUser.email,
+  //       role: Role.STAFF,
+  //       colorLevel: 1,
+  //       animalTags: [],
+  //     });
+  //
+  //     return { ...token, ...user };
+  //   } catch (error) {
+  //     Logger.error(`Failed to generate token for user with OAuth ID token`);
+  //     throw error;
+  //   }
+  // }
 
   async revokeTokens(userId: string): Promise<void> {
     try {