Merge pull request #216 from chingu-x/dev

End of sprint merge into main (29/30)

Author: cherylli

.github/workflows/pr-reviwer-reminder.yml

@@ -0,0 +1,15 @@
+name: 'Pull request reviewer reminder'
+on:
+  schedule:
+    # Check reviews every weekday, 10:00 and 17:00
+    - cron: '0 10,17 * * 1-5'
+    
+jobs:
+  pull-request-reviewer-reminder: 
+    runs-on: ubuntu-latest
+    steps:
+      - uses: tommykw/pull-request-reviewer-reminder-action@v2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }} # Required
+          reminder_message: 'One business day has passed since the review started. Give priority to reviews as much as possible.' # Required. Messages to send to reviewers on Github.
+          review_turnaround_hours: 24 # Required. This is the deadline for reviews. If this time is exceeded, a reminder wil be send.

CHANGELOG.md

@@ -10,28 +10,49 @@ Another example [here](https://co-pilot.dev/changelog)
 
 ### Added
 
+- Add units tests for the forms controller and services([#204](https://github.com/chingu-x/chingu-dashboard-be/pull/204))
+- Add same site property to cookie ([#212](https://github.com/chingu-x/chingu-dashboard-be/pull/212))
+- Add same site property to cookie in refresh endpoint ([#214](https://github.com/chingu-x/chingu-dashboard-be/pull/214))
+- Add new comment model ([#213](https://github.com/chingu-x/chingu-dashboard-be/pull/213))
+
 ### Changed
 
+- Update PostgreSQL image to timescale/timescaledb-ha:pg16 to match railway postgres image ([#210](https://github.com/chingu-x/chingu-dashboard-be/pull/210))
+- refactored e2e tests to use absolute import paths ([#207](https://github.com/chingu-x/chingu-dashboard-be/pull/207))
+- Updated seed data of user voyage roles and added new users([#206](https://github.com/chingu-x/chingu-dashboard-be/pull/206))
+- Refactored e2e tests to use absolute import paths ([#207](https://github.com/chingu-x/chingu-dashboard-be/pull/207))
+- Update solo project model ([#213](https://github.com/chingu-x/chingu-dashboard-be/pull/213))
+- Update readme to include more instructions for using the test database ([#213](https://github.com/chingu-x/chingu-dashboard-be/pull/213))
+- refactored unit tests to use absolute import paths ([#215](https://github.com/chingu-x/chingu-dashboard-be/pull/215))
+
 ### Fixed
 
-### Removed
+- Fix cors localhost address ([#205](https://github.com/chingu-x/chingu-dashboard-be/pull/205))
+- Fix voyages/sprints/teams/{teamId} returning wrong meetingIds ([#209](https://github.com/chingu-x/chingu-dashboard-be/pull/209))
+- Fix one of the regex in cors origin list ([#211](https://github.com/chingu-x/chingu-dashboard-be/pull/211))
 
+### Removed
 
 ## [v1.0.1-alpha]
 
 ### Added
+
 - Add units tests for the teams controller & services([#189](https://github.com/chingu-x/chingu-dashboard-be/pull/189))
 - Add discord oauth and e2e test ([#194](https://github.com/chingu-x/chingu-dashboard-be/pull/194))
 - Add morgan middleware for request logging with custom logger ([#200](https://github.com/chingu-x/chingu-dashboard-be/pull/200))
 - Add CASL permissions for Team Sprint endpoint ([#193](https://github.com/chingu-x/chingu-dashboard-be/pull/193))
 - Add units tests for the teams resource controller & services([#201](https://github.com/chingu-x/chingu-dashboard-be/pull/201))
+- Add github workflow for PR reminders ([#202](https://github.com/chingu-x/chingu-dashboard-be/pull/202))
 
 ### Changed
+
 - updated changelog ([#195](https://github.com/chingu-x/chingu-dashboard-be/pull/195))
 - Update accepted localhost port and docker compose file for a custom network setup ([#199](https://github.com/chingu-x/chingu-dashboard-be/pull/199))
 
 ### Fixed
+
 - Fix seed data for alpha test (check in form question changes, gravatar) ([#190](https://github.com/chingu-x/chingu-dashboard-be/pull/190))
+- Fix voyageNumber generation from sprintId for check-in submissions ([#186](https://github.com/chingu-x/chingu-dashboard-be/pull/186))
 - revised 2 checkin questions for alpha test ([#192](https://github.com/chingu-x/chingu-dashboard-be/pull/192))
 - Fix seed checkin form data for PO and SM , and voyage-role for team 6 ([#196](https://github.com/chingu-x/chingu-dashboard-be/pull/196))
 - Bug add check for team id in place memberId ([#197](https://github.com/chingu-x/chingu-dashboard-be/pull/197))
@@ -81,14 +102,10 @@ Another example [here](https://co-pilot.dev/changelog)
 - Add CASL permissions for Tech endpoint ([#174](https://github.com/chingu-x/chingu-dashboard-be/pull/174))
 - Add CASL permissions for Team Resource endpoint ([#177](https://github.com/chingu-x/chingu-dashboard-be/pull/177))
 - Add units tests for the users controller & services([#179](https://github.com/chingu-x/chingu-dashboard-be/pull/178))
--  Add CASL permissions for Team features endpoint ([#184](https://github.com/chingu-x/chingu-dashboard-be/pull/184))
+- Add CASL permissions for Team features endpoint ([#184](https://github.com/chingu-x/chingu-dashboard-be/pull/184))
 - Add production seed for alpha test ([#185](https://github.com/chingu-x/chingu-dashboard-be/pull/185))
 - Add types and validation to env variables ([#187](https://github.com/chingu-x/chingu-dashboard-be/pull/187))
 
-
-
-
-
 ### Changed
 
 - Update docker compose and scripts in package.json to include a test database container and remove usage of .env.dev to avoid confusion ([#100](https://github.com/chingu-x/chingu-dashboard-be/pull/100))
@@ -105,7 +122,7 @@ Another example [here](https://co-pilot.dev/changelog)
 - updated meeting model schema to include optional description field [#135](https://github.com/chingu-x/chingu-dashboard-be/pull/135)
 - Remove teamMeetings from response for getSprintDatesByTeamId [#139](https://github.com/chingu-x/chingu-dashboard-be/pull/139)
 - Updated response for route GET sprints/meetings/{meetingId} to include updatedAt for agendas [#140](https://github.com/chingu-x/chingu-dashboard-be/pull/140)
-- Updated response for route GET /sprints/teams/{teamId}  to include voyage start and end dates [#147](https://github.com/chingu-x/chingu-dashboard-be/pull/147)
+- Updated response for route GET /sprints/teams/{teamId} to include voyage start and end dates [#147](https://github.com/chingu-x/chingu-dashboard-be/pull/147)
 - Update test github actions workflow with timeout [#143](https://github.com/chingu-x/chingu-dashboard-be/pull/143)
 - Refractor of all form title reference to use values from formTitle.ts [#145](https://github.com/chingu-x/chingu-dashboard-be/pull/145)
 - Update/Add more form input types [#146](https://github.com/chingu-x/chingu-dashboard-be/pull/146)
@@ -116,11 +133,10 @@ Another example [here](https://co-pilot.dev/changelog)
 - Updated DELETE ideation-vote service to also delete ideation when no votes remain [#161](https://github.com/chingu-x/chingu-dashboard-be/pull/161)
 - Refactored the prisma models to be grouped by domain type [#172](https://github.com/chingu-x/chingu-dashboard-be/pull/172)
 - Updated response for GET teams/:teamId/techs to include isSelected value for techs [#173](https://github.com/chingu-x/chingu-dashboard-be/pull/173)
-- Refactor ideation endpoints to remove redundant teamId params  [#175](https://github.com/chingu-x/chingu-dashboard-be/pull/175)
+- Refactor ideation endpoints to remove redundant teamId params [#175](https://github.com/chingu-x/chingu-dashboard-be/pull/175)
 - Squashed migration files into one [#176](https://github.com/chingu-x/chingu-dashboard-be/pull/176)
 - Update prisma schema to include oauth [#181](https://github.com/chingu-x/chingu-dashboard-be/pull/181)
 
-
 ### Fixed
 
 - Fix failed tests in app and ideation due to the change from jwt token response to http cookies ([#98](https://github.com/chingu-x/chingu-dashboard-be/pull/98))
@@ -131,8 +147,6 @@ Another example [here](https://co-pilot.dev/changelog)
 - Fix a bug for check on voyageTeamMemberId ([#159](https://github.com/chingu-x/chingu-dashboard-be/pull/159))
 - Fix users unit test failing due to a schema change ([#182](https://github.com/chingu-x/chingu-dashboard-be/pull/182))
 
-
-
 ### Removed
 
 - Removed email from reset-password request body ([#118](https://github.com/chingu-x/chingu-dashboard-be/pull/118))

README.md

@@ -68,6 +68,8 @@ $ yarn seed
 # run Prisma Studio
 $ yarn studio
 ```
+> [!TIP]
+> It is recommended to use `db push` to [prototype your schema](https://www.prisma.io/docs/orm/prisma-migrate/workflows/prototyping-your-schema)
 
 ## Running the app
 
@@ -84,6 +86,9 @@ $ yarn start:prod
 
 ## Test<a name="tests"></a>
 
+> [!IMPORTANT]
+> To prepare the test database, run `yarn push:test` or `yarn push:test:docker`
+
 ```bash
 # all tests (unit and e2e for now)
 $ yarn test 
@@ -250,4 +255,4 @@ Permissions based on roles are defined in the CASL ability factory (`ability.fac
 ### JWT Refresh Token Guard (JwtRefreshAuthGuard) - `jwt-rt-auth.guard.ts`
 This guard is only used for the refresh access token route, `/refresh`, using passport 'jwt-refresh' strategy
 ### Local Auth guard (LocalAuthGuard) - `local-auth.guard.ts`
-This guard is only used for the `/login` route, using the passport 'local' strategy
+This guard is only used for the `/login` route, using the passport 'local' strategy

docker-compose.yml

@@ -1,7 +1,7 @@
 services:
   postgres:
     container_name: postgres
-    image: postgres:15-alpine
+    image: timescale/timescaledb-ha:pg16
     restart: always
     ports:
       - "5433:5433"
@@ -15,7 +15,7 @@ services:
 
   postgres-test:
     container_name: postgres-test
-    image: postgres:15-alpine
+    image: timescale/timescaledb-ha:pg16
     restart: always
     environment:
       - POSTGRES_USER=chingu

package.json

@@ -113,8 +113,21 @@
             "json",
             "ts"
         ],
-        "rootDir": "src",
-        "testRegex": ".*\\.spec|.jest\\.ts$",
+        "moduleDirectories": [
+            "node_modules",
+            "src"
+        ],
+        "rootDir": ".",
+        "moduleNameMapper": {
+            "@/(.*)": "<rootDir>/src/$1",
+            "@Prisma/(.*)": "<rootDir>/prisma/$1"
+        },
+        "modulePaths": [
+            "<rootDir>"
+        ],
+        "testRegex": [
+            ".*\\.spec|.jest\\.ts$"
+        ],
         "transform": {
             "^.+\\.(t|j)s$": "ts-jest"
         },
@@ -124,11 +137,11 @@
         "coverageDirectory": "../coverage",
         "testEnvironment": "node",
         "setupFilesAfterEnv": [
-            "<rootDir>/prisma/singleton.ts"
+            "<rootDir>/src/prisma/singleton.ts"
         ]
     },
     "prisma": {
-        "seed": "ts-node prisma/seed/index.ts"
+        "seed": "ts-node -r tsconfig-paths/register prisma/seed/index.ts"
     },
     "lint-staged": {
         "src/**/*.ts": [

prisma/migrations/20241009120111_update_solo_project_model/migration.sql

@@ -0,0 +1,35 @@
+/*
+  Warnings:
+
+  - You are about to drop the column `adminComments` on the `SoloProject` table. All the data in the column will be lost.
+
+*/
+-- CreateEnum
+CREATE TYPE "CommentType" AS ENUM ('SoloProject');
+
+-- AlterTable
+ALTER TABLE "SoloProject" DROP COLUMN "adminComments";
+
+-- CreateTable
+CREATE TABLE "Comment" (
+    "id" SERIAL NOT NULL,
+    "content" TEXT NOT NULL,
+    "authorId" UUID,
+    "path" TEXT,
+    "parentCommentId" INTEGER,
+    "type" "CommentType" NOT NULL,
+    "soloProjectId" INTEGER,
+    "createdAt" TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "Comment_pkey" PRIMARY KEY ("id")
+);
+
+-- AddForeignKey
+ALTER TABLE "Comment" ADD CONSTRAINT "Comment_authorId_fkey" FOREIGN KEY ("authorId") REFERENCES "User"("id") ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Comment" ADD CONSTRAINT "Comment_parentCommentId_fkey" FOREIGN KEY ("parentCommentId") REFERENCES "Comment"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Comment" ADD CONSTRAINT "Comment_soloProjectId_fkey" FOREIGN KEY ("soloProjectId") REFERENCES "SoloProject"("id") ON DELETE CASCADE ON UPDATE CASCADE;

prisma/schema/comment.prisma

@@ -0,0 +1,23 @@
+// === Comment ===
+model Comment {
+  id              Int      @id @default(autoincrement())
+  content         String
+  author          User?    @relation(fields: [authorId], references: [id], onDelete: SetNull)
+  authorId        String?  @db.Uuid()
+  path            String?
+  parentCommentId Int?
+  parentComment   Comment? @relation("ParentChildComment", fields: [parentCommentId], references: [id], onDelete: Restrict)
+
+  type          CommentType
+  SoloProject   SoloProject? @relation(fields: [soloProjectId], references: [id], onDelete: Cascade)
+  soloProjectId Int?
+
+  createdAt DateTime @default(now()) @db.Timestamptz()
+  updatedAt DateTime @updatedAt
+
+  childComments Comment[] @relation("ParentChildComment")
+}
+
+enum CommentType {
+  SoloProject
+}

prisma/schema/soloproject.prisma

@@ -16,7 +16,6 @@ model SoloProject {
   evaluatorUserId   String?            @db.Uuid()
   evaluator         User?              @relation(fields: [evaluatorUserId], references: [id], name: "evaluators", onDelete: SetNull)
   evaluatorFeedback String?
-  adminComments     String?
   statusId          Int?
   status            SoloProjectStatus? @relation(fields: [statusId], references: [id], onDelete: SetNull)
   formId            Int?
@@ -26,4 +25,6 @@ model SoloProject {
 
   createdAt DateTime @default(now()) @db.Timestamptz()
   updatedAt DateTime @updatedAt
+
+  comments Comment[]
 }

prisma/schema/user.prisma

@@ -38,6 +38,7 @@ model User {
   emailVerificationToken EmailVerificationToken?
   roles                  UserRole[]
   oAuthProfiles          UserOAuthProfile[]
+  comments               Comment[]
 }
 
 model Role {

prisma/seed/solo-project.ts

@@ -31,6 +31,7 @@ export const populateSoloProjects = async () => {
         },
     });
 
+    // Solo Project 1
     const responseGroup = await prisma.responseGroup.create({
         data: {
             responses: {
@@ -50,11 +51,31 @@ export const populateSoloProjects = async () => {
         },
     });
 
-    // solo project entries
     await prisma.soloProject.create({
         data: {
             userId: users[0].id,
-            adminComments: "This is a tier 3 project, not tier 2",
+            comments: {
+                createMany: {
+                    data: [
+                        {
+                            content: "This is a tier 2 project, not tier 3",
+                            type: "SoloProject",
+                        },
+                        {
+                            content: "ok",
+                            parentCommentId: 1,
+                            type: "SoloProject",
+                            path: "/1",
+                        },
+                        {
+                            content: "not ok",
+                            parentCommentId: 2,
+                            type: "SoloProject",
+                            path: "/1/2",
+                        },
+                    ],
+                },
+            },
             evaluatorUserId: users[1].id,
             evaluatorFeedback: passedSampleFeedback,
             statusId: (await prisma.soloProjectStatus.findUnique({
@@ -67,5 +88,40 @@ export const populateSoloProjects = async () => {
         },
     });
 
+    // Solo Project 2
+    const responseGroup2 = await prisma.responseGroup.create({
+        data: {
+            responses: {
+                createMany: {
+                    data: [
+                        {
+                            questionId: soloProjectForm!.questions[0].id,
+                            text: "www.github.com/repo2",
+                        },
+                        {
+                            questionId: soloProjectForm!.questions[1].id,
+                            text: "www.vercel.com/2",
+                        },
+                    ],
+                },
+            },
+        },
+    });
+
+    await prisma.soloProject.create({
+        data: {
+            userId: users[5].id,
+            evaluatorUserId: users[2].id,
+            evaluatorFeedback: passedSampleFeedback,
+            statusId: (await prisma.soloProjectStatus.findUnique({
+                where: {
+                    status: "Waiting Evaluation",
+                },
+            }))!.id,
+            formId: soloProjectForm!.id,
+            responseGroupId: responseGroup2.id,
+        },
+    });
+
     console.log("Solo projects populated.");
 };