forks/peertube
1
0
Fork 0
Code Releases Activity

Refactor sort middlewares

Browse source
This commit is contained in:
Chocobozzz 2021-10-19 09:10:01 +02:00
parent 9c58375c08
commit 9593a78ae1
No known key found for this signature in database
GPG key ID: 583A612D890159BE
4 changed files with 59 additions and 80 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
server/controllers/api/server/follows.ts
View file

@ -21,8 +21,8 @@ import {
} from '../../../middlewares' } from '../../../middlewares'
import { import {
acceptOrRejectFollowerValidator, acceptOrRejectFollowerValidator,
followersSortValidator, instanceFollowersSortValidator,
followingSortValidator, instanceFollowingSortValidator,
followValidator, followValidator,
getFollowerValidator, getFollowerValidator,
listFollowsValidator, listFollowsValidator,
@ -35,7 +35,7 @@ const serverFollowsRouter = express.Router()
serverFollowsRouter.get('/following', serverFollowsRouter.get('/following',
listFollowsValidator, listFollowsValidator,
paginationValidator, paginationValidator,
followingSortValidator, instanceFollowingSortValidator,
setDefaultSort, setDefaultSort,
setDefaultPagination, setDefaultPagination,
asyncMiddleware(listFollowing) asyncMiddleware(listFollowing)
@ -59,7 +59,7 @@ serverFollowsRouter.delete('/following/:hostOrHandle',
serverFollowsRouter.get('/followers', serverFollowsRouter.get('/followers',
listFollowsValidator, listFollowsValidator,
paginationValidator, paginationValidator,
followersSortValidator, instanceFollowersSortValidator,
setDefaultSort, setDefaultSort,
setDefaultPagination, setDefaultPagination,
asyncMiddleware(listFollowers) asyncMiddleware(listFollowers)

4
server/initializers/constants.ts
View file

@ -69,8 +69,8 @@ const SORTABLE_COLUMNS = {
VIDEO_RATES: [ 'createdAt' ], VIDEO_RATES: [ 'createdAt' ],
BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ], BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
FOLLOWERS: [ 'createdAt', 'state', 'score' ], INSTANCE_FOLLOWERS: [ 'createdAt', 'state', 'score' ],
FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ], INSTANCE_FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ], VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ],

22
server/middlewares/validators/shared/utils.ts
View file

@ -22,26 +22,6 @@ function areValidationErrors (req: express.Request, res: express.Response) {
return false return false
} }
function checkSort (sortableColumns: string[], tags: string[] = []) {
return [
query('sort').optional().isIn(sortableColumns).withMessage('Should have correct sortable column'),
(req: express.Request, res: express.Response, next: express.NextFunction) => {
logger.debug('Checking sort parameters', { parameters: req.query, tags })
if (areValidationErrors(req, res)) return
return next()
}
]
}
function createSortableColumns (sortableColumns: string[]) {
const sortableColumnDesc = sortableColumns.map(sortableColumn => '-' + sortableColumn)
return sortableColumns.concat(sortableColumnDesc)
}
function isValidVideoIdParam (paramName: string) { function isValidVideoIdParam (paramName: string) {
return param(paramName) return param(paramName)
.customSanitizer(toCompleteUUID) .customSanitizer(toCompleteUUID)
@ -58,8 +38,6 @@ function isValidPlaylistIdParam (paramName: string) {
export { export {
areValidationErrors, areValidationErrors,
checkSort,
createSortableColumns,
isValidVideoIdParam, isValidVideoIdParam,
isValidPlaylistIdParam isValidPlaylistIdParam
} }

105
server/middlewares/validators/sort.ts
View file

@ -1,56 +1,57 @@
import express from 'express'
import { query } from 'express-validator'
import { logger } from '@server/helpers/logger'
import { SORTABLE_COLUMNS } from '../../initializers/constants' import { SORTABLE_COLUMNS } from '../../initializers/constants'
import { checkSort, createSortableColumns } from './shared' import { areValidationErrors } from './shared'
// Initialize constants here for better performances function checkSortFactory (columns: string[], tags: string[] = []) {
const SORTABLE_USERS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.USERS) return checkSort(createSortableColumns(columns), tags)
const SORTABLE_ACCOUNTS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.ACCOUNTS) }
const SORTABLE_JOBS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.JOBS)
const SORTABLE_ABUSES_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.ABUSES)
const SORTABLE_VIDEOS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEOS)
const SORTABLE_VIDEOS_SEARCH_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEOS_SEARCH)
const SORTABLE_VIDEO_CHANNELS_SEARCH_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEO_CHANNELS_SEARCH)
const SORTABLE_VIDEO_PLAYLISTS_SEARCH_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEO_PLAYLISTS_SEARCH)
const SORTABLE_VIDEO_IMPORTS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEO_IMPORTS)
const SORTABLE_VIDEO_COMMENTS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEO_COMMENT_THREADS)
const SORTABLE_VIDEO_COMMENT_THREADS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEO_COMMENT_THREADS)
const SORTABLE_VIDEO_RATES_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEO_RATES)
const SORTABLE_BLACKLISTS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.BLACKLISTS)
const SORTABLE_VIDEO_CHANNELS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEO_CHANNELS)
const SORTABLE_FOLLOWERS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.FOLLOWERS)
const SORTABLE_FOLLOWING_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.FOLLOWING)
const SORTABLE_USER_SUBSCRIPTIONS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.USER_SUBSCRIPTIONS)
const SORTABLE_ACCOUNTS_BLOCKLIST_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.ACCOUNTS_BLOCKLIST)
const SORTABLE_SERVERS_BLOCKLIST_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.SERVERS_BLOCKLIST)
const SORTABLE_USER_NOTIFICATIONS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.USER_NOTIFICATIONS)
const SORTABLE_VIDEO_PLAYLISTS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEO_PLAYLISTS)
const SORTABLE_PLUGINS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.PLUGINS)
const SORTABLE_AVAILABLE_PLUGINS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.AVAILABLE_PLUGINS)
const SORTABLE_VIDEO_REDUNDANCIES_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEO_REDUNDANCIES)
const usersSortValidator = checkSort(SORTABLE_USERS_COLUMNS) function checkSort (sortableColumns: string[], tags: string[] = []) {
const accountsSortValidator = checkSort(SORTABLE_ACCOUNTS_COLUMNS) return [
const jobsSortValidator = checkSort(SORTABLE_JOBS_COLUMNS, [ 'jobs' ]) query('sort').optional().isIn(sortableColumns).withMessage('Should have correct sortable column'),
const abusesSortValidator = checkSort(SORTABLE_ABUSES_COLUMNS)
const videosSortValidator = checkSort(SORTABLE_VIDEOS_COLUMNS) (req: express.Request, res: express.Response, next: express.NextFunction) => {
const videoImportsSortValidator = checkSort(SORTABLE_VIDEO_IMPORTS_COLUMNS) logger.debug('Checking sort parameters', { parameters: req.query, tags })
const videosSearchSortValidator = checkSort(SORTABLE_VIDEOS_SEARCH_COLUMNS)
const videoChannelsSearchSortValidator = checkSort(SORTABLE_VIDEO_CHANNELS_SEARCH_COLUMNS) if (areValidationErrors(req, res)) return
const videoPlaylistsSearchSortValidator = checkSort(SORTABLE_VIDEO_PLAYLISTS_SEARCH_COLUMNS)
const videoCommentsValidator = checkSort(SORTABLE_VIDEO_COMMENTS_COLUMNS) return next()
const videoCommentThreadsSortValidator = checkSort(SORTABLE_VIDEO_COMMENT_THREADS_COLUMNS) }
const videoRatesSortValidator = checkSort(SORTABLE_VIDEO_RATES_COLUMNS) ]
const blacklistSortValidator = checkSort(SORTABLE_BLACKLISTS_COLUMNS) }
const videoChannelsSortValidator = checkSort(SORTABLE_VIDEO_CHANNELS_COLUMNS)
const followersSortValidator = checkSort(SORTABLE_FOLLOWERS_COLUMNS) function createSortableColumns (sortableColumns: string[]) {
const followingSortValidator = checkSort(SORTABLE_FOLLOWING_COLUMNS) const sortableColumnDesc = sortableColumns.map(sortableColumn => '-' + sortableColumn)
const userSubscriptionsSortValidator = checkSort(SORTABLE_USER_SUBSCRIPTIONS_COLUMNS)
const accountsBlocklistSortValidator = checkSort(SORTABLE_ACCOUNTS_BLOCKLIST_COLUMNS) return sortableColumns.concat(sortableColumnDesc)
const serversBlocklistSortValidator = checkSort(SORTABLE_SERVERS_BLOCKLIST_COLUMNS) }
const userNotificationsSortValidator = checkSort(SORTABLE_USER_NOTIFICATIONS_COLUMNS)
const videoPlaylistsSortValidator = checkSort(SORTABLE_VIDEO_PLAYLISTS_COLUMNS) const usersSortValidator = checkSortFactory(SORTABLE_COLUMNS.USERS)
const pluginsSortValidator = checkSort(SORTABLE_PLUGINS_COLUMNS) const accountsSortValidator = checkSortFactory(SORTABLE_COLUMNS.ACCOUNTS)
const availablePluginsSortValidator = checkSort(SORTABLE_AVAILABLE_PLUGINS_COLUMNS) const jobsSortValidator = checkSortFactory(SORTABLE_COLUMNS.JOBS, [ 'jobs' ])
const videoRedundanciesSortValidator = checkSort(SORTABLE_VIDEO_REDUNDANCIES_COLUMNS) const abusesSortValidator = checkSortFactory(SORTABLE_COLUMNS.ABUSES)
const videosSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEOS)
const videoImportsSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_IMPORTS)
const videosSearchSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEOS_SEARCH)
const videoChannelsSearchSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_CHANNELS_SEARCH)
const videoPlaylistsSearchSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_PLAYLISTS_SEARCH)
const videoCommentsValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_COMMENTS)
const videoCommentThreadsSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_COMMENT_THREADS)
const videoRatesSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_RATES)
const blacklistSortValidator = checkSortFactory(SORTABLE_COLUMNS.BLACKLISTS)
const videoChannelsSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_CHANNELS)
const instanceFollowersSortValidator = checkSortFactory(SORTABLE_COLUMNS.INSTANCE_FOLLOWERS)
const instanceFollowingSortValidator = checkSortFactory(SORTABLE_COLUMNS.INSTANCE_FOLLOWING)
const userSubscriptionsSortValidator = checkSortFactory(SORTABLE_COLUMNS.USER_SUBSCRIPTIONS)
const accountsBlocklistSortValidator = checkSortFactory(SORTABLE_COLUMNS.ACCOUNTS_BLOCKLIST)
const serversBlocklistSortValidator = checkSortFactory(SORTABLE_COLUMNS.SERVERS_BLOCKLIST)
const userNotificationsSortValidator = checkSortFactory(SORTABLE_COLUMNS.USER_NOTIFICATIONS)
const videoPlaylistsSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_PLAYLISTS)
const pluginsSortValidator = checkSortFactory(SORTABLE_COLUMNS.PLUGINS)
const availablePluginsSortValidator = checkSortFactory(SORTABLE_COLUMNS.AVAILABLE_PLUGINS)
const videoRedundanciesSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_REDUNDANCIES)
// --------------------------------------------------------------------------- // ---------------------------------------------------------------------------
@ -64,8 +65,8 @@ export {
videosSortValidator, videosSortValidator,
blacklistSortValidator, blacklistSortValidator,
accountsSortValidator, accountsSortValidator,
followersSortValidator, instanceFollowersSortValidator,
followingSortValidator, instanceFollowingSortValidator,
jobsSortValidator, jobsSortValidator,
videoCommentThreadsSortValidator, videoCommentThreadsSortValidator,
videoRatesSortValidator, videoRatesSortValidator,