Skip to content

ActivityPub-federated video streaming platform using P2P directly in your web browser

Add ability to filter users by role

Chocobozzzd7b2cd9e665f
diff --git a/client/src/app/+admin/overview/users/user-list/user-list.component.ts b/client/src/app/+admin/overview/users/user-list/user-list.component.ts
index 9dbcf7d6a9..8e63575b74 100644
--- a/client/src/app/+admin/overview/users/user-list/user-list.component.ts
+++ b/client/src/app/+admin/overview/users/user-list/user-list.component.ts
@@ -89,6 +89,17 @@ export class UserListComponent implements OnInit, OnDestroy {
{ value: true, label: $localize`Banned` },
{ value: false, label: $localize`Not banned` }
]
+ },
+ {
+ type: 'options',
+ key: 'role',
+ title: $localize`Role`,
+ options: [
+ { value: 'all', label: $localize`All` },
+ { value: UserRole.ADMINISTRATOR, label: $localize`Administrator` },
+ { value: UserRole.MODERATOR, label: $localize`Moderator` },
+ { value: UserRole.USER, label: $localize`User` }
+ ]
}
]
@@ -290,7 +301,12 @@ export class UserListComponent implements OnInit, OnDestroy {
})
}
- private _dataLoader (options: DataLoaderOptionsBase & { blocked?: boolean }) {
+ private _dataLoader (
+ options: DataLoaderOptionsBase & {
+ blocked?: boolean
+ role?: UserRoleType
+ }
+ ) {
return this.userAdminService.listUsers(options)
.pipe(
switchMap(result => {
diff --git a/client/src/app/shared/shared-users/user-admin.service.ts b/client/src/app/shared/shared-users/user-admin.service.ts
index 0e5ae11f04..590ec2741f 100644
--- a/client/src/app/shared/shared-users/user-admin.service.ts
+++ b/client/src/app/shared/shared-users/user-admin.service.ts
@@ -56,14 +56,16 @@ export class UserAdminService {
sort: SortMeta
search?: string
blocked?: boolean
+ role?: UserRoleType
}) {
- const { pagination, sort, search, blocked } = parameters
+ const { pagination, sort, search, blocked, role } = parameters
let params = new HttpParams()
params = this.restService.addRestGetParams(params, pagination, sort)
if (search) params = params.append('search', search)
if (blocked !== undefined) params = params.append('blocked', blocked.toString())
+ if (role !== undefined) params = params.append('role', role.toString())
return this.authHttp.get<ResultList<UserServerModel>>(UserService.BASE_USERS_URL, { params })
.pipe(
diff --git a/packages/server-commands/src/users/users-command.ts b/packages/server-commands/src/users/users-command.ts
index 884669eb62..5ce670e515 100644
--- a/packages/server-commands/src/users/users-command.ts
+++ b/packages/server-commands/src/users/users-command.ts
@@ -372,6 +372,7 @@ export class UsersCommand extends AbstractCommand {
sort?: string
search?: string
blocked?: boolean
+ role?: UserRoleType
} = {}) {
const path = '/api/v1/users'
@@ -379,7 +380,7 @@ export class UsersCommand extends AbstractCommand {
...options,
path,
- query: pick(options, [ 'start', 'count', 'sort', 'search', 'blocked' ]),
+ query: pick(options, [ 'start', 'count', 'sort', 'search', 'blocked', 'role' ]),
implicitToken: true,
defaultExpectedStatus: HttpStatusCode.OK_200
})
diff --git a/packages/tests/src/api/check-params/users-admin.ts b/packages/tests/src/api/check-params/users-admin.ts
index 67c64cab49..dbe6069d2e 100644
--- a/packages/tests/src/api/check-params/users-admin.ts
+++ b/packages/tests/src/api/check-params/users-admin.ts
@@ -86,6 +86,25 @@ describe('Test users admin API validators', function () {
expectedStatus: HttpStatusCode.FORBIDDEN_403
})
})
+
+ it('Should fail with an invalid role filter', async function () {
+ await makeGetRequest({
+ url: server.url,
+ path,
+ query: { role: 4 },
+ token: server.accessToken
+ })
+ })
+
+ it('Should succeed with the correct params', async function () {
+ await makeGetRequest({
+ url: server.url,
+ path,
+ token: server.accessToken,
+ query: { role: UserRole.MODERATOR },
+ expectedStatus: HttpStatusCode.OK_200
+ })
+ })
})
describe('When adding a new user', function () {
diff --git a/packages/tests/src/api/users/users.ts b/packages/tests/src/api/users/users.ts
index ae5f43ccb3..0558bef682 100644
--- a/packages/tests/src/api/users/users.ts
+++ b/packages/tests/src/api/users/users.ts
@@ -178,6 +178,22 @@ describe('Test users', function () {
expect(data[1].username).to.equal('user_1')
}
})
+
+ it('Should filter users by role', async function () {
+ {
+ const { total, data } = await server.users.list({ role: UserRole.ADMINISTRATOR })
+ expect(total).to.equal(1)
+ expect(data.length).to.equal(1)
+ expect(data[0].username).to.equal('root')
+ }
+
+ {
+ const { total, data } = await server.users.list({ role: UserRole.USER })
+ expect(total).to.equal(1)
+ expect(data.length).to.equal(1)
+ expect(data[0].username).to.equal('user_1')
+ }
+ })
})
describe('Update my account', function () {
diff --git a/server/core/controllers/api/users/index.ts b/server/core/controllers/api/users/index.ts
index 395f37a0cb..ce7ab9d68f 100644
--- a/server/core/controllers/api/users/index.ts
+++ b/server/core/controllers/api/users/index.ts
@@ -230,7 +230,8 @@ async function listUsers (req: express.Request, res: express.Response) {
count: req.query.count,
sort: req.query.sort,
search: req.query.search,
- blocked: req.query.blocked
+ blocked: req.query.blocked,
+ role: req.query.role
})
return res.json(getFormattedObjects(resultList.data, resultList.total, { withAdminFlags: true }))
diff --git a/server/core/helpers/custom-validators/users.ts b/server/core/helpers/custom-validators/users.ts
index 9d6f40cbbc..ea9a5f7dfb 100644
--- a/server/core/helpers/custom-validators/users.ts
+++ b/server/core/helpers/custom-validators/users.ts
@@ -106,7 +106,7 @@ export function isUserBlockedReasonValid (value: any) {
export function isUserRoleValid (value: any) {
return exists(value) &&
validator.default.isInt('' + value) &&
- [ UserRole.ADMINISTRATOR, UserRole.MODERATOR, UserRole.USER ].includes(value)
+ [ UserRole.ADMINISTRATOR, UserRole.MODERATOR, UserRole.USER ].includes(+value as any)
}
export function isUserFeatureInfo (value: string) {
diff --git a/server/core/middlewares/validators/users/users.ts b/server/core/middlewares/validators/users/users.ts
index 46470117b5..c96cb71a88 100644
--- a/server/core/middlewares/validators/users/users.ts
+++ b/server/core/middlewares/validators/users/users.ts
@@ -52,6 +52,10 @@ export const usersListValidator = [
.customSanitizer(toBooleanOrNull)
.isBoolean().withMessage('Should be a valid blocked boolean'),
+ query('role')
+ .optional()
+ .custom(isUserRoleValid),
+
(req: express.Request, res: express.Response, next: express.NextFunction) => {
if (areValidationErrors(req, res)) return
diff --git a/server/core/models/user/user.ts b/server/core/models/user/user.ts
index ecb77dfe76..f825c27e0d 100644
--- a/server/core/models/user/user.ts
+++ b/server/core/models/user/user.ts
@@ -522,8 +522,9 @@ export class UserModel extends SequelizeModel<UserModel> {
sort: string
search?: string
blocked?: boolean
+ role?: UserRoleType
}) {
- const { start, count, sort, search, blocked } = parameters
+ const { start, count, sort, search, blocked, role } = parameters
const where: WhereOptions = {}
if (search) {
@@ -547,6 +548,10 @@ export class UserModel extends SequelizeModel<UserModel> {
Object.assign(where, { blocked })
}
+ if (role !== undefined) {
+ Object.assign(where, { role })
+ }
+
const query: FindOptions = {
offset: start,
limit: count,
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 9c04fd0f01..a0f9126135 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1452,6 +1452,7 @@ paths:
parameters:
- $ref: '#/components/parameters/usersSearch'
- $ref: '#/components/parameters/usersBlocked'
+ - $ref: '#/components/parameters/usersRole'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/usersSort'
@@ -8191,6 +8192,13 @@ components:
description: Filter results down to (un)banned users
schema:
type: boolean
+ usersRole:
+ name: role
+ in: query
+ required: false
+ description: Filter results down to users with a specific role
+ schema:
+ $ref: '#/components/schemas/UserRole'
usersSort:
name: sort
in: query