]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/middlewares/validators/follows.ts
refactor API errors to standard error format
[github/Chocobozzz/PeerTube.git] / server / middlewares / validators / follows.ts
index 7887356630a54191824bdf3d039247f4ddd7fe19..733be379bdd6961e0953f1a6aab145c020e0d552 100644 (file)
@@ -1,16 +1,33 @@
 import * as express from 'express'
-import { body, param } from 'express-validator'
+import { body, param, query } from 'express-validator'
+import { isFollowStateValid } from '@server/helpers/custom-validators/follows'
+import { getServerActor } from '@server/models/application/application'
+import { MActorFollowActorsDefault } from '@server/types/models'
+import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
 import { isTestInstance } from '../../helpers/core-utils'
+import { isActorTypeValid, isValidActorHandle } from '../../helpers/custom-validators/activitypub/actor'
 import { isEachUniqueHostValid, isHostValid } from '../../helpers/custom-validators/servers'
 import { logger } from '../../helpers/logger'
-import { getServerActor } from '../../helpers/utils'
+import { loadActorUrlOrGetFromWebfinger } from '../../helpers/webfinger'
 import { SERVER_ACTOR_NAME, WEBSERVER } from '../../initializers/constants'
-import { ActorFollowModel } from '../../models/activitypub/actor-follow'
+import { ActorModel } from '../../models/actor/actor'
+import { ActorFollowModel } from '../../models/actor/actor-follow'
 import { areValidationErrors } from './utils'
-import { ActorModel } from '../../models/activitypub/actor'
-import { loadActorUrlOrGetFromWebfinger } from '../../helpers/webfinger'
-import { isValidActorHandle } from '../../helpers/custom-validators/activitypub/actor'
-import { MActorFollowActorsDefault } from '@server/typings/models'
+
+const listFollowsValidator = [
+  query('state')
+    .optional()
+    .custom(isFollowStateValid).withMessage('Should have a valid follow state'),
+  query('actorType')
+    .optional()
+    .custom(isActorTypeValid).withMessage('Should have a valid actor type'),
+
+  (req: express.Request, res: express.Response, next: express.NextFunction) => {
+    if (areValidationErrors(req, res)) return
+
+    return next()
+  }
+]
 
 const followValidator = [
   body('hosts').custom(isEachUniqueHostValid).withMessage('Should have an array of unique hosts'),
@@ -18,7 +35,8 @@ const followValidator = [
   (req: express.Request, res: express.Response, next: express.NextFunction) => {
     // Force https if the administrator wants to make friends
     if (isTestInstance() === false && WEBSERVER.SCHEME === 'http') {
-      return res.status(500)
+      return res
+        .status(HttpStatusCode.INTERNAL_SERVER_ERROR_500)
         .json({
           error: 'Cannot follow on a non HTTPS web server.'
         })
@@ -45,12 +63,10 @@ const removeFollowingValidator = [
     const follow = await ActorFollowModel.loadByActorAndTargetNameAndHostForAPI(serverActor.id, SERVER_ACTOR_NAME, req.params.host)
 
     if (!follow) {
-      return res
-        .status(404)
-        .json({
-          error: `Following ${req.params.host} not found.`
-        })
-        .end()
+      return res.fail({
+        status: HttpStatusCode.NOT_FOUND_404,
+        message: `Following ${req.params.host} not found.`
+      })
     }
 
     res.locals.follow = follow
@@ -78,12 +94,10 @@ const getFollowerValidator = [
     }
 
     if (!follow) {
-      return res
-        .status(404)
-        .json({
-          error: `Follower ${req.params.nameWithHost} not found.`
-        })
-        .end()
+      return res.fail({
+        status: HttpStatusCode.NOT_FOUND_404,
+        message: `Follower ${req.params.nameWithHost} not found.`
+      })
     }
 
     res.locals.follow = follow
@@ -97,7 +111,7 @@ const acceptOrRejectFollowerValidator = [
 
     const follow = res.locals.follow
     if (follow.state !== 'pending') {
-      return res.status(400).json({ error: 'Follow is not in pending state.' }).end()
+      return res.fail({ message: 'Follow is not in pending state.' })
     }
 
     return next()
@@ -110,5 +124,6 @@ export {
   followValidator,
   removeFollowingValidator,
   getFollowerValidator,
-  acceptOrRejectFollowerValidator
+  acceptOrRejectFollowerValidator,
+  listFollowsValidator
 }