refactor: clean-up types across the codebase

Author: luoingly

backend/src/controllers/problem.ts

@@ -7,6 +7,7 @@ import type { CourseEntity, ProblemEntity, ProblemEntityItem, ProblemEntityPrevi
 import {
   DiscussionListQueryResultSchema,
   DiscussionListQuerySchema,
+  JudgeStatus,
   ProblemSolutionListQueryResultSchema,
   ProblemSolutionListQuerySchema,
   ProblemStatisticsQueryResultSchema,
@@ -25,9 +26,7 @@ import solutionService from '../services/solution'
 import tagService from '../services/tag'
 import { getUser } from '../services/user'
 import { createEnvelopedResponse, createZodErrorResponse, parsePaginateOption } from '../utils'
-import constants, { ERR_PERM_DENIED } from '../utils/constants'
-
-const { judge } = constants
+import { ERR_PERM_DENIED } from '../utils/constants'
 
 const findProblems = async (ctx: Context) => {
   const opt = ctx.request.query
@@ -89,7 +88,7 @@ const findProblems = async (ctx: Context) => {
       .find({
         uid: profile.uid,
         pid: { $in: list.docs.map(p => p.pid) },
-        judge: judge.Accepted,
+        judge: JudgeStatus.Accepted,
       })
       .distinct('pid')
       .lean()

backend/src/controllers/solution.ts

@@ -2,7 +2,7 @@ import type { Context } from 'koa'
 import type { CourseDocument } from '../models/Course'
 import { Buffer } from 'node:buffer'
 import path from 'node:path'
-import { ErrorCode } from '@putongoj/shared'
+import { ErrorCode, JudgeStatus } from '@putongoj/shared'
 import fse from 'fs-extra'
 import { pick } from 'lodash'
 import redis from '../config/redis'
@@ -12,7 +12,6 @@ import Problem from '../models/Problem'
 import Solution from '../models/Solution'
 import { loadCourseStateOrThrow } from '../policies/course'
 import { createEnvelopedResponse, createErrorResponse } from '../utils'
-import { judgeResult } from '../utils/constants'
 
 export async function findOne (ctx: Context) {
   const opt = Number.parseInt(ctx.params.sid, 10)
@@ -174,7 +173,7 @@ async function updateSolution (ctx: Context) {
     return createErrorResponse(ctx, ErrorCode.BadRequest, 'Invalid submission id')
   }
   const updatedJudge = Number(opt.judge)
-  if (updatedJudge !== judgeResult.RejudgePending && updatedJudge !== judgeResult.Skipped) {
+  if (updatedJudge !== JudgeStatus.RejudgePending && updatedJudge !== JudgeStatus.Skipped) {
     return createErrorResponse(ctx, ErrorCode.BadRequest, 'Invalid judge status, only support RejudgePending and Skipped')
   }
 
@@ -203,7 +202,7 @@ async function updateSolution (ctx: Context) {
     return createErrorResponse(ctx, ErrorCode.InternalServerError)
   }
 
-  if (updatedJudge !== judgeResult.RejudgePending) {
+  if (updatedJudge !== JudgeStatus.RejudgePending) {
     return createEnvelopedResponse(ctx, solution)
   }
 

backend/src/controllers/user.ts

@@ -2,6 +2,7 @@ import type { Context } from 'koa'
 import type { UserDocument } from '../models/User'
 import {
   ErrorCode,
+  JudgeStatus,
   UserItemListQueryResultSchema,
   UserProfileQueryResultSchema,
   UserRanklistExportQueryResultSchema,
@@ -12,7 +13,6 @@ import {
   UserSuggestQuerySchema,
 } from '@putongoj/shared'
 import difference from 'lodash/difference'
-import config from '../config'
 import { loadProfile } from '../middlewares/authn'
 import Group from '../models/Group'
 import Solution from '../models/Solution'
@@ -75,11 +75,11 @@ export async function getUser (ctx: Context) {
   const user = await loadUser(ctx)
   const [ solved, failed, groups ] = await Promise.all([
     Solution
-      .find({ uid: user.uid, judge: config.judge.Accepted })
+      .find({ uid: user.uid, judge: JudgeStatus.Accepted })
       .distinct('pid')
       .lean(),
     Solution
-      .find({ uid: user.uid, judge: { $nin: [ config.judge.Accepted, config.judge.Skipped ] } })
+      .find({ uid: user.uid, judge: { $nin: [ JudgeStatus.Accepted, JudgeStatus.Skipped ] } })
       .distinct('pid')
       .lean(),
     Group

backend/src/jobs/tasks/checkSimilarity.ts

@@ -1,6 +1,6 @@
+import { JudgeStatus } from '@putongoj/shared'
 import levenshtein from 'fast-levenshtein'
 import Solution from '../../models/Solution'
-import { judge } from '../../utils/constants'
 import logger from '../../utils/logger'
 
 function codeNormalize (code: string): string {
@@ -28,7 +28,7 @@ async function checkSimilarity (item: string) {
     pid: solution.pid,
     uid: { $ne: solution.uid },
     create: { $lt: solution.create },
-    judge: judge.Accepted,
+    judge: JudgeStatus.Accepted,
   }, {
     code: 1, sid: 1,
   }).lean().exec()

backend/src/jobs/tasks/updateStatistic.ts

@@ -1,9 +1,9 @@
+import { JudgeStatus } from '@putongoj/shared'
 import Comment from '../../models/Comment'
 import Discussion from '../../models/Discussion'
 import Problem from '../../models/Problem'
 import Solution from '../../models/Solution'
 import User from '../../models/User'
-import { judge } from '../../utils/constants'
 import logger from '../../utils/logger'
 
 /**
@@ -14,8 +14,8 @@ async function updateUserStatistic (uid: string) {
   uid = uid.trim()
 
   const [ submitProblems, solveProblems ] = await Promise.all([
-    Solution.distinct('pid', { uid, judge: { $ne: judge.Skipped } }),
-    Solution.distinct('pid', { uid, judge: judge.Accepted }),
+    Solution.distinct('pid', { uid, judge: { $ne: JudgeStatus.Skipped } }),
+    Solution.distinct('pid', { uid, judge: JudgeStatus.Accepted }),
   ])
   await User.findOneAndUpdate(
     { uid },
@@ -40,8 +40,8 @@ async function updateProblemStatistic (pid: number | string) {
   }
 
   const [ submitUsers, acceptedUsers ] = await Promise.all([
-    Solution.distinct('uid', { pid, judge: { $ne: judge.Skipped } }),
-    Solution.distinct('uid', { pid, judge: judge.Accepted }),
+    Solution.distinct('uid', { pid, judge: { $ne: JudgeStatus.Skipped } }),
+    Solution.distinct('uid', { pid, judge: JudgeStatus.Accepted }),
   ])
   await Problem.findOneAndUpdate(
     { pid },

backend/src/jobs/updater.ts

@@ -1,8 +1,7 @@
 import type { WebSocketDispatch, WebSocketMessage } from '@putongoj/shared'
-import { WebSocketDispatchType, WebSocketMessageType } from '@putongoj/shared'
+import { JudgeStatus, WebSocketDispatchType, WebSocketMessageType } from '@putongoj/shared'
 import redis from '../config/redis'
 import Solution from '../models/Solution'
-import { judge } from '../utils/constants'
 import logger from '../utils/logger'
 import { distributeWork } from './helper'
 import '../config/db'
@@ -47,12 +46,12 @@ async function updateResult (result: any) {
   logger.info(`Solution <${sid}> update to status ${solution.judge}`)
 
   const tasks = [] as Promise<any>[]
-  if (solution.judge !== judge.Running) {
+  if (solution.judge !== JudgeStatus.RunningJudge) {
     tasks.push(distributeWork('updateStatistic', `problem:${solution.pid}`))
     tasks.push(distributeWork('updateStatistic', `user:${solution.uid}`))
     tasks.push(redis.publish('websocket:message', JSON.stringify(dispatch)))
   }
-  if (solution.judge === judge.Accepted) {
+  if (solution.judge === JudgeStatus.Accepted) {
     tasks.push(distributeWork('checkSimilarity', solution.sid))
   }
   await Promise.all(tasks)

backend/src/models/Contest.ts

@@ -1,4 +1,4 @@
-import { LabelingStyle, TITLE_LENGTH_MAX } from '@putongoj/shared'
+import { LabelingStyle, LabelingStyleValues, TITLE_LENGTH_MAX } from '@putongoj/shared'
 import mongoose from '../config/db'
 import ID from './ID'
 
@@ -80,7 +80,7 @@ const contestSchema = new mongoose.Schema({
   } ],
   labelingStyle: {
     type: Number,
-    enum: Object.values(LabelingStyle),
+    enum: LabelingStyleValues,
     default: LabelingStyle.Numeric,
   },
   course: {

backend/src/models/Solution.ts

@@ -1,8 +1,9 @@
 import type { Document, PaginateModel, Types } from 'mongoose'
 import type { SolutionEntity } from '../types/entity'
+import { JudgeStatus, JudgeStatusValues } from '@putongoj/shared'
 import mongoosePaginate from 'mongoose-paginate-v2'
 import mongoose from '../config/db'
-import { judge, status } from '../utils/constants'
+import { status } from '../utils/constants'
 import ID from './ID'
 
 export interface SolutionDocument extends Document<Types.ObjectId>, SolutionEntity {
@@ -106,8 +107,8 @@ const solutionSchema = new mongoose.Schema({
   },
   judge: {
     type: Number,
-    enum: Object.values(judge),
-    default: judge.Pending,
+    enum: JudgeStatusValues,
+    default: JudgeStatus.Pending,
     index: true,
   },
   time: {
@@ -142,10 +143,10 @@ const solutionSchema = new mongoose.Schema({
 solutionSchema.plugin(mongoosePaginate)
 
 solutionSchema.virtual('isAccepted').get(function () {
-  return this.judge === judge.Accepted
+  return this.judge === JudgeStatus.Accepted
 })
 solutionSchema.virtual('isPending').get(function () {
-  return this.judge === judge.Pending
+  return this.judge === JudgeStatus.Pending
 })
 
 solutionSchema.index({ createdAt: -1 })

backend/src/services/contest.ts

@@ -3,14 +3,13 @@ import type { Types } from 'mongoose'
 import type { CourseDocument } from '../models/Course'
 import type { PaginateOption, SortOption } from '../types'
 import type { QueryFilter } from '../types/mongo'
-import { ParticipationStatus } from '@putongoj/shared'
+import { JudgeStatus, ParticipationStatus } from '@putongoj/shared'
 import { escapeRegExp } from 'lodash'
 import Contest from '../models/Contest'
 import ContestParticipation from '../models/ContestParticipation'
 import Problem from '../models/Problem'
 import Solution from '../models/Solution'
 import User from '../models/User'
-import { judge } from '../utils/constants'
 import { CacheKey, cacheService } from './cache'
 
 async function findContests (
@@ -125,7 +124,7 @@ export type ContestProblemsWithStats = {
   solve: number
 }[]
 
-const ignoredJudges = [ judge.CompileError, judge.SystemError, judge.Skipped ] as number[]
+const ignoredJudges = [ JudgeStatus.CompileError, JudgeStatus.SystemError, JudgeStatus.Skipped ] as number[]
 
 async function getProblemsWithStats (contest: Types.ObjectId, isJury: boolean) {
   return await cacheService.getOrCreate<ContestProblemsWithStats>(
@@ -160,7 +159,7 @@ async function getProblemsWithStats (contest: Types.ObjectId, isJury: boolean) {
           Solution.distinct('uid', {
             mid: contestId,
             pid,
-            judge: judge.Accepted,
+            judge: JudgeStatus.Accepted,
             createdAt: { $lt: before },
           }).lean(),
         ])
@@ -175,7 +174,7 @@ async function getProblemsWithStats (contest: Types.ObjectId, isJury: boolean) {
   )
 }
 
-const pendingJudges = [ judge.Pending, judge.RejudgePending, judge.Running ] as number[]
+const pendingJudges = [ JudgeStatus.Pending, JudgeStatus.RejudgePending, JudgeStatus.RunningJudge ] as number[]
 
 async function getRanklist (contest: Types.ObjectId, isJury: boolean) {
   return await cacheService.getOrCreate<ContestRanklist>(
@@ -231,7 +230,7 @@ async function getRanklist (contest: Types.ObjectId, isJury: boolean) {
           return
         }
 
-        if (judgement === judge.Accepted) {
+        if (judgement === JudgeStatus.Accepted) {
           item.solvedAt = createdAt.toISOString()
           return
         }

backend/src/types/entity.ts

@@ -1,6 +1,6 @@
 import type { TagColor } from '@putongoj/shared'
 import type { Types } from 'mongoose'
-import type { ContestOption, CourseRole } from '.'
+import type { CourseRole } from '.'
 import type { CourseDocument } from '../models/Course'
 import type { UserEntity } from '../models/User'
 import type { encrypt, problemType, status } from '../utils/constants'
@@ -133,35 +133,6 @@ export type ProblemEntityView = Pick<ProblemEntity,
   tags: TagEntityItem[]
 }
 
-// Contest
-
-export interface ContestEntity extends Entity {
-  cid: number
-  title: string
-  start: number
-  end: number
-  list: number[]
-  status: number
-  encrypt: number
-  argument: string
-  option: ContestOption
-  course: CourseDocument | null
-}
-
-export type ContestEntityEditable = Pick<ContestEntity,
-  'title' | 'start' | 'end' | 'list' | 'status' | 'encrypt' | 'argument' | 'option'
-> & { course?: Types.ObjectId | null }
-
-export type ContestEntityPreview = Pick<ContestEntity,
-  'cid' | 'title' | 'start' | 'end' | 'status' | 'encrypt'
->
-
-export type ContestEntityView = Pick<ContestEntity,
-  'cid' | 'title' | 'start' | 'end' | 'status' | 'encrypt' | 'list' | 'option'
-> & Partial<Pick<ContestEntity, 'argument'>> & {
-  course: CourseEntityPreviewWithRole | null
-}
-
 // Solution
 
 export interface SolutionEntity extends Entity {
@@ -230,18 +201,3 @@ export interface GroupEntity extends Entity {
   list: string[]
   create: number
 }
-
-// Discuss
-
-export interface DiscussEntity extends Entity {
-  did: number
-  title: string
-  uid: string
-  comments: {
-    uid: string
-    content: string
-    create: number
-  }[]
-  create: number
-  update: number
-}