deps: upgrade to prisma 5 and prepare for JSON types (#3874)

apps/auth/package.json

@@ -40,7 +40,7 @@
     "prettier": "2.8.8",
     "prettier-plugin-organize-imports": "3.2.3",
     "prettier-plugin-tailwindcss": "0.4.1",
-    "prisma": "4.14.1",
+    "prisma": "5.3.1",
     "tailwindcss": "3.3.3",
     "typescript": "5.0.4"
   },

apps/backend-docker/package.json

@@ -55,7 +55,7 @@
     "nodemon": "3.0.1",
     "npm-run-all": "4.1.5",
     "nyc": "15.1.0",
-    "prisma": "4.14.1",
+    "prisma": "5.3.1",
     "tsup": "6.7.0",
     "typescript": "5.0.4"
   },

apps/func-migration-v3-import/package.json

@@ -27,7 +27,7 @@
     "npm-run-all": "4.1.5",
     "prettier": "2.8.8",
     "prettier-plugin-organize-imports": "3.2.3",
-    "prisma": "4.14.1",
+    "prisma": "5.3.1",
     "ts-node": "10.9.1",
     "tsup": "7.2.0",
     "typescript": "5.1.6"

package.json

@@ -26,7 +26,7 @@
     "Valentin Meyer <valentin.meyer@bf.uzh.ch>"
   ],
   "devDependencies": {
-    "@prisma/nextjs-monorepo-workaround-plugin": "4.14.1",
+    "@prisma/nextjs-monorepo-workaround-plugin": "5.3.1",
     "husky": "8.0.3",
     "standard-version": "9.5.0",
     "syncpack": "11.2.1",

packages/graphql/src/schema/query.ts

@@ -372,7 +372,7 @@ export const Query = builder.queryType({
           sessionId: t.arg.string({ required: true }),
         },
         resolve(_, args, ctx) {
-          return SessionService.getLeaderboard(args, ctx)
+          return SessionService.getLeaderboard(args, ctx) as any
         },
       }),
 

packages/graphql/src/services/courses.ts

@@ -295,12 +295,15 @@ export async function getCourseOverviewData(
       )
 
       const sortByScoreAndUsername = R.curry(R.sortWith)([
-        R.descend(R.prop('score')),
-        R.ascend(R.prop('username')),
+        R.descend(R.prop<number>('score')),
+        R.ascend(R.prop<string>('username')),
       ])
 
-      const sortedEntries = sortByScoreAndUsername(allEntries.mapped)
-      const sortedGroupEntries = sortByScoreAndUsername(allGroupEntries.mapped)
+      const sortedEntries: typeof allEntries.mapped = sortByScoreAndUsername(
+        allEntries.mapped
+      )
+      const sortedGroupEntries: typeof allGroupEntries.mapped =
+        sortByScoreAndUsername(allGroupEntries.mapped)
 
       const filteredEntries = sortedEntries.flatMap((entry, ix) => {
         if (ix < 10 || entry.participantId === ctx.user?.sub)
@@ -606,11 +609,11 @@ export async function getCourseData(
         }
       },
       {
-        activeLBEntries: [] as typeof course.leaderboard,
+        activeLBEntries: [] as Partial<typeof course.leaderboard>,
         activeSum: 0,
         activeCount: 0,
       }
-    )
+    ) ?? {}
 
   const totalCount = course?.participations.length || 0
   const averageActiveScore = activeCount > 0 ? activeSum / activeCount : 0

packages/graphql/src/services/learningElements.ts

@@ -19,6 +19,7 @@ import {
   QuestionType,
   UserRole,
 } from '@klicker-uzh/prisma'
+import { PrismaClientKnownRequestError } from '@klicker-uzh/prisma/dist/runtime/library'
 import dayjs from 'dayjs'
 import { GraphQLError } from 'graphql'
 import * as R from 'ramda'
@@ -1092,8 +1093,7 @@ export async function deleteLearningElement(
 
     return deletedItem
   } catch (e) {
-    // TODO: resolve type issue by first testing for prisma error
-    if (e?.code === 'P2025') {
+    if (e instanceof PrismaClientKnownRequestError && e?.code === 'P2025') {
       console.log(
         'The learning element is not in draft status and cannot be deleted.'
       )

packages/graphql/src/services/microLearning.ts

@@ -4,6 +4,7 @@ import {
   QuestionInstanceType,
   QuestionType,
 } from '@klicker-uzh/prisma'
+import { PrismaClientKnownRequestError } from '@klicker-uzh/prisma/dist/runtime/library'
 import { GraphQLError } from 'graphql'
 import { pick } from 'ramda'
 import { Context, ContextWithUser } from '../lib/context'
@@ -387,8 +388,7 @@ export async function deleteMicroSession(
 
     return deletedItem
   } catch (e) {
-    // TODO: resolve type issue by first testing for prisma error
-    if (e?.code === 'P2025') {
+    if (e instanceof PrismaClientKnownRequestError && e.code === 'P2025') {
       console.log(
         'The micro-session is already published and cannot be deleted anymore.'
       )

packages/graphql/src/services/notifications.ts

@@ -1,6 +1,11 @@
-import { MicroSession, MicroSessionStatus } from '@klicker-uzh/prisma'
+import {
+  Course,
+  MicroSession,
+  MicroSessionStatus,
+  PushSubscription,
+} from '@klicker-uzh/prisma'
 import { GraphQLError } from 'graphql'
-import webpush from 'web-push'
+import webpush, { WebPushError } from 'web-push'
 import { Context, ContextWithUser } from '../lib/context'
 import { formatDate } from '../lib/util'
 
@@ -115,7 +120,6 @@ export async function sendPushNotifications(ctx: Context) {
           subscriptions: true,
         },
       },
-      instances: false,
     },
   })
 
@@ -125,7 +129,7 @@ export async function sendPushNotifications(ctx: Context) {
   // 1. Investigate implementing this method as a background process to reduce the load on the main thread.
   // 2. Investigate implementing this method in Azure
   await Promise.all(
-    microSessions.map(async (microSession: MicroSession) => {
+    microSessions.map(async (microSession) => {
       try {
         await sendPushNotificationsToSubscribers(microSession, ctx)
 
@@ -155,10 +159,12 @@ export async function sendPushNotifications(ctx: Context) {
 //E.g., store the language on the course entity and use it here to translate the message or
 // store the language on the user subscription entity and use this language when sending to the specific user?
 async function sendPushNotificationsToSubscribers(
-  microSession: MicroSession,
+  microSession: MicroSession & {
+    course: null | (Course & { subscriptions: PushSubscription[] })
+  },
   ctx: Context
 ) {
-  for (let sub of microSession.course.subscriptions) {
+  for (let sub of microSession.course?.subscriptions ?? []) {
     try {
       const formattedDate = formatDate(microSession.scheduledEndAt)
       await webpush.sendNotification(
@@ -170,16 +176,20 @@ async function sendPushNotificationsToSubscribers(
           },
         },
         JSON.stringify({
-          message: `Microlearning ${microSession.displayName} for ${microSession.course.displayName} is available until ${formattedDate.date} at ${formattedDate.time}.`,
-          title: `KlickerUZH - New Microlearning available for the course ${microSession.course.name}`,
+          message: `Microlearning ${microSession.displayName} for ${
+            microSession.course?.displayName ?? ''
+          } is available until ${formattedDate.date} at ${formattedDate.time}.`,
+          title: `KlickerUZH - New Microlearning available for the course ${
+            microSession.course?.name ?? ''
+          }`,
         })
       )
     } catch (error) {
       console.error(
         'An error occured while trying to send the push notification: ',
         error
       )
-      if (error.statusCode === 410) {
+      if (error instanceof WebPushError && error.statusCode === 410) {
         try {
           // subscription has expired or is no longer valid
           // remove it from the database

packages/graphql/src/services/sessions.ts

@@ -2,7 +2,6 @@ import {
   AccessMode,
   ConfusionTimestep,
   Question,
-  QuestionInstance,
   QuestionInstanceType,
   QuestionType,
   SessionBlockStatus,
@@ -13,6 +12,7 @@ import * as R from 'ramda'
 import { ascend, dissoc, mapObjIndexed, pick, prop, sortWith } from 'ramda'
 import { Context, ContextWithUser } from '../lib/context'
 // TODO: rework scheduling for serverless
+import { PrismaClientKnownRequestError } from '@klicker-uzh/prisma/dist/runtime/library'
 import { GraphQLError } from 'graphql'
 import { max, mean, median, min, quantileSeq, std } from 'mathjs'
 import schedule from 'node-schedule'
@@ -765,12 +765,19 @@ export async function activateSessionBlock(
   return updatedSession
 }
 
+interface GetCachedBlockResultsArgs {
+  ctx: Context
+  sessionId: string
+  sessionBlockId: number
+  activeInstanceIds: number[]
+}
+
 async function getCachedBlockResults({
   ctx,
   sessionId,
   sessionBlockId,
   activeInstanceIds,
-}) {
+}: GetCachedBlockResultsArgs) {
   const redisMulti = ctx.redisExec.multi()
   redisMulti.hgetall(`s:${sessionId}:lb`)
   redisMulti.hgetall(`s:${sessionId}:b:${sessionBlockId}:lb`)
@@ -782,12 +789,19 @@ async function getCachedBlockResults({
   return await redisMulti.exec()
 }
 
+interface UnlinkCachedBlockResultsArgs {
+  ctx: Context
+  sessionId: string
+  sessionBlockId: number
+  activeInstanceIds: number[]
+}
+
 async function unlinkCachedBlockResults({
   ctx,
   sessionId,
   sessionBlockId,
   activeInstanceIds,
-}) {
+}: UnlinkCachedBlockResultsArgs) {
   // unlink everything regarding the block in redis
   const unlinkMulti = ctx.redisExec.pipeline()
   unlinkMulti.unlink(`s:${sessionId}:b:${sessionBlockId}:lb`)
@@ -800,7 +814,15 @@ async function unlinkCachedBlockResults({
   return unlinkMulti.exec()
 }
 
-async function processCachedData({ cachedResults, activeBlock }) {
+interface ProcessCachedDataArgs {
+  cachedResults: any[]
+  activeBlock: any
+}
+
+async function processCachedData({
+  cachedResults,
+  activeBlock,
+}: ProcessCachedDataArgs) {
   const mappedResults: any[] = cachedResults.map(([_, result]) => result)
 
   const sessionLeaderboard: Record<string, string> = mappedResults[0]
@@ -1235,11 +1257,12 @@ export async function getLeaderboard(
   })
 
   const sortByScoreAndUsername = R.curry(R.sortWith)([
-    R.descend(R.prop('score')),
-    R.ascend(R.prop('username')),
+    R.descend(R.prop<number>('score')),
+    R.ascend(R.prop<string>('username')),
   ])
 
-  const sortedEntries = sortByScoreAndUsername(preparedEntries)
+  const sortedEntries: typeof preparedEntries =
+    sortByScoreAndUsername(preparedEntries)
 
   const filteredEntries = sortedEntries.flatMap((entry, ix) => {
     return { ...entry, rank: ix + 1 }
@@ -1923,8 +1946,7 @@ export async function deleteSession(
 
     return deletedItem
   } catch (e) {
-    // TODO: resolve type issue by first testing for prisma error
-    if (e?.code === 'P2025') {
+    if (e instanceof PrismaClientKnownRequestError && e.code === 'P2025') {
       console.log(
         'The learning element is not in draft status and cannot be deleted.'
       )

packages/prisma/package.json

@@ -8,7 +8,7 @@
     "dist"
   ],
   "dependencies": {
-    "@prisma/client": "4.14.1"
+    "@prisma/client": "5.3.1"
   },
   "devDependencies": {
     "@pothos/plugin-prisma": "3.56.0",
@@ -23,10 +23,12 @@
     "dotenv": "16.0.3",
     "dotenv-cli": "7.2.1",
     "eslint": "8.45.0",
+    "fs-extra": "11.1.1",
     "npm-run-all": "4.1.5",
     "prettier": "2.8.8",
     "prettier-plugin-organize-imports": "3.2.3",
-    "prisma": "4.14.1",
+    "prisma": "5.3.1",
+    "prisma-json-types-generator": "3.0.1",
     "ramda": "0.29.0",
     "size-limit": "8.2.4",
     "ts-node": "10.9.1",

packages/prisma/src/copy.js

@@ -1,44 +1,7 @@
-const fs = require('fs')
+const fs = require('fs-extra')
 const path = require('path')
 
-fs.mkdirSync(path.resolve(__dirname, '../dist/runtime'), { recursive: true })
-fs.copyFileSync(
-  path.resolve(__dirname, './client/index.d.ts'),
-  path.resolve(__dirname, '../dist/index.d.ts')
-)
-fs.copyFileSync(
-  path.resolve(__dirname, './prisma/schema.prisma'),
-  path.resolve(__dirname, '../dist/schema.prisma')
-)
-fs.copyFileSync(
-  path.resolve(__dirname, './client/runtime/index-browser.d.ts'),
-  path.resolve(__dirname, '../dist/runtime/index-browser.d.ts')
-)
-fs.copyFileSync(
-  path.resolve(__dirname, './client/runtime/index.d.ts'),
-  path.resolve(__dirname, '../dist/runtime/index.d.ts')
-)
-fs.copyFileSync(
-  path.resolve(
-    __dirname,
-    './client/libquery_engine-linux-musl-openssl-3.0.x.so.node'
-  ),
-  path.resolve(
-    __dirname,
-    '../dist/libquery_engine-linux-musl-openssl-3.0.x.so.node'
-  )
-)
-fs.copyFileSync(
-  path.resolve(
-    __dirname,
-    './client/libquery_engine-debian-openssl-1.1.x.so.node'
-  ),
-  path.resolve(
-    __dirname,
-    '../dist/libquery_engine-debian-openssl-1.1.x.so.node'
-  )
-)
-fs.copyFileSync(
-  path.resolve(__dirname, './client/pothos.d.ts'),
-  path.resolve(__dirname, '../dist/pothos.d.ts')
+fs.copySync(
+  path.resolve(__dirname, './client'),
+  path.resolve(__dirname, '../dist/')
 )

packages/prisma/src/prisma/schema.prisma

@@ -1,6 +1,6 @@
 generator client {
   provider        = "prisma-client-js"
-  previewFeatures = ["fullTextSearch", "fullTextIndex", "postgresqlExtensions", "fieldReference", "extendedWhereUnique"]
+  previewFeatures = ["fullTextSearch", "fullTextIndex", "postgresqlExtensions"]
   output          = "../client"
   binaryTargets   = ["native", "debian-openssl-1.1.x", "linux-musl-openssl-3.0.x"]
 }
@@ -11,6 +11,10 @@ generator pothos {
   output       = "../client/pothos.d.ts"
 }
 
+generator json {
+  provider = "prisma-json-types-generator"
+}
+
 datasource db {
   provider          = "postgres"
   url               = env("DATABASE_URL")
@@ -526,8 +530,10 @@ model MicroSession {
 
   instances QuestionInstance[]
 
-  owner    User    @relation(fields: [ownerId], references: [id], onDelete: Cascade, onUpdate: Cascade)
-  ownerId  String  @db.Uuid
+  owner   User   @relation(fields: [ownerId], references: [id], onDelete: Cascade, onUpdate: Cascade)
+  ownerId String @db.Uuid
+
+  // TODO: why is course optional?
   course   Course? @relation(fields: [courseId], references: [id], onDelete: SetNull, onUpdate: Cascade)
   courseId String? @db.Uuid
 

packages/prisma/src/types.ts

@@ -0,0 +1,5 @@
+declare global {
+  namespace PrismaJson {
+    // Insert your types here!
+  }
+}