feat: add soft delete setter and filter

Author: Markkop

src/controllers/user.ts

@@ -1,10 +1,11 @@
-import { Controller, Get, Response, Route, Security } from 'tsoa'
+import { Body, Controller, Get, Post, Response, Route, Security } from 'tsoa'
 import { getRankService } from '../services/rank'
-import { checkForSuspiciousActivity, getDatabaseUserById, getDatabaseUsers } from '../services/user'
+import { checkForSuspiciousActivity, getDatabaseUserById, getDatabaseUsers, softDeleteUserById } from '../services/user'
 import {
   ErrorResponseModel,
   RankRequestResult,
   RequestResult,
+  SoftDeleteResult,
   User
 } from '../types'
 
@@ -58,4 +59,21 @@ export class UserController extends Controller {
       return []
     }
   }
+
+  @Response<ErrorResponseModel>('404', 'Not Found', {
+    statusCode: 404,
+    message: 'Usuário não encontrado'
+  })
+  @Security('api_key')
+  @Post('/susp/softdelete')
+  public async softDeleteUser(@Body() body: { userId: string }): Promise<SoftDeleteResult> {
+    try {
+      const { userId } = body
+      const result = await softDeleteUserById(userId)
+      return result
+    } catch (error) {
+      console.log(error)
+      return { success: false, message: 'An error occurred while soft deleting the user' }
+    }
+  }
 }

src/models/user.ts

@@ -20,6 +20,10 @@ const UserSchema = new Schema<User>({
   tokens: {
     type: Array,
     required: true
+  },
+  softDeleted: {
+    type: Boolean,
+    default: false
   }
 })
 

src/routes/user.ts

@@ -47,4 +47,18 @@ router.get(
   }
 )
 
+router.post(
+  '/susp/softdelete',
+  middlewares.authentication,
+  async (request, response, next) => {
+    try {
+      const controller = new UserController()
+      const result = await controller.softDeleteUser(request.body)
+      return response.send(result)
+    } catch (error) {
+      next(error)
+    }
+  }
+)
+
 export default router

src/services/claim.ts

@@ -98,6 +98,11 @@ export default async function claimService(
       return parseResponseResult('error', config.claim.disabledMessage, 422)
     }
 
+    const user = await getDatabaseUserById(userId)
+    if (!user || user.softDeleted) {
+      return parseResponseResult('error', 'Usuário não encontrado ou banido', 422)
+    }
+
     if (!code) {
       return parseResponseResult('error', 'Nenhum código foi fornecido', 422)
     }

src/services/mongoose.ts

@@ -128,7 +128,8 @@ export async function getUserFromMongo(
   try {
     await connectMongoose()
     const [user] = await UserModel.find({
-      $or: [{ userId: userIdOrTag }, { tag: userIdOrTag }]
+      $or: [{ userId: userIdOrTag }, { tag: userIdOrTag }],
+      softDeleted: { $ne: true }
     }).lean()
     if (!user) {
       return null
@@ -140,10 +141,10 @@ export async function getUserFromMongo(
   }
 }
 
-export async function getUsersFromMongo(): Promise<User[]> {
+export async function getUsersFromMongo(query = {}): Promise<User[]> {
   try {
     await connectMongoose()
-    const users = await UserModel.find({})
+    const users = await UserModel.find({ ...query, softDeleted: { $ne: true } })
     if (!users) {
       return []
     }
@@ -161,7 +162,7 @@ export async function createOrUpdateUser(
     await connectMongoose()
     const user = await UserModel.findOneAndUpdate(
       { userId: userId },
-      userContent,
+      { ...userContent, softDeleted: userContent.softDeleted ?? false },
       {
         new: true,
         upsert: true
@@ -173,3 +174,18 @@ export async function createOrUpdateUser(
     console.log(`Failed to create or update user on mongo: ${error}`)
   }
 }
+
+export async function softDeleteUser(userId: string): Promise<User | null> {
+  try {
+    await connectMongoose()
+    const user = await UserModel.findOneAndUpdate(
+      { userId: userId },
+      { softDeleted: true },
+      { new: true }
+    )
+    return user
+  } catch (error) {
+    console.log(`Failed to soft delete user on mongo: ${error}`)
+    return null
+  }
+}

src/services/user.ts

@@ -1,12 +1,12 @@
 import { DateTime } from 'luxon'
-import { User } from '../types'
+import { SoftDeleteResult, User } from '../types'
 import {
   createOrUpdateUser,
   getUserFromMongo,
-  getUsersFromMongo
+  getUsersFromMongo,
+  softDeleteUser
 } from './mongoose'
 
-
 export async function getDatabaseUserById(userId: string): Promise<User> {
   try {
     const user = await getUserFromMongo(userId)
@@ -38,7 +38,7 @@ export async function updateDatabaseUser(user: User): Promise<User | false> {
 
 export async function getDatabaseUsers(): Promise<User[]> {
   try {
-    const users = await getUsersFromMongo()
+    const users = await getUsersFromMongo({ softDeleted: { $ne: true } })
     return users
   } catch (error) {
     console.log(error)
@@ -47,7 +47,7 @@ export async function getDatabaseUsers(): Promise<User[]> {
 
 export async function checkForSuspiciousActivity(): Promise<any[]> {
   try {
-    const users = await getUsersFromMongo()
+    const users = await getUsersFromMongo({ softDeleted: { $ne: true } })
     const suspiciousUsers = users.filter(user => {
       if (user.tokens.length < 10) return false
 
@@ -94,3 +94,16 @@ export async function checkForSuspiciousActivity(): Promise<any[]> {
     return []
   }
 }
+
+export async function softDeleteUserById(userId: string): Promise<SoftDeleteResult> {
+  try {
+    const user = await softDeleteUser(userId)
+    if (!user) {
+      return { success: false, message: `User ${userId} not found` }
+    }
+    return { success: true, message: `User ${userId} has been soft deleted`, user }
+  } catch (error) {
+    console.log(`Error soft deleting user ${userId}:`, error)
+    return { success: false, message: 'An error occurred while soft deleting the user' }
+  }
+}

src/types.ts

@@ -40,13 +40,15 @@ export type User = {
   tag: string
   score: number
   tokens: UserClaimedToken[]
+  softDeleted?: boolean
 }
 
 export type CompactUser = {
   userId: string
   score: number
   tag: string
   claims: number
+  softDeleted?: boolean
 }
 
 export type ClaimRequestResult = {
@@ -107,3 +109,10 @@ export interface ErrorResponseModel {
   statusCode: number
   message: string
 }
+
+// Add a new interface for soft delete operations
+export interface SoftDeleteResult {
+  success: boolean
+  message: string
+  user?: User
+}