github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-24 18:56:32 -05:00
Code Issues Projects Releases Packages Wiki Activity

refactor: extract permission metadata key

Browse source 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
This commit is contained in:
Tilman Vatteroth 2023-05-19 14:22:10 +02:00
parent 488238d854
commit 9ca6485219
2 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
backend/src/permissions/permissions.guard.ts
View file

@ -11,6 +11,7 @@ import { CompleteRequest } from '../api/utils/request.type';
import { ConsoleLoggerService } from '../logger/console-logger.service';
import { NotesService } from '../notes/notes.service';
import { PermissionsService } from './permissions.service';
import { PERMISSION_METADATA_KEY } from './require-permission.decorator';
import { RequiredPermission } from './required-permission.enum';
/**
@ -32,7 +33,7 @@ export class PermissionsGuard implements CanActivate {
async canActivate(context: ExecutionContext): Promise<boolean> {
const permissions = this.reflector.get<RequiredPermission[]>(
'permissions',
PERMISSION_METADATA_KEY,
context.getHandler(),
);
// If no permissions are set this is probably an error and this guard should not let the request pass

9
backend/src/permissions/require-permission.decorator.ts
View file

@ -7,12 +7,13 @@ import { CustomDecorator, SetMetadata } from '@nestjs/common';
import { RequiredPermission } from './required-permission.enum';
export const PERMISSION_METADATA_KEY = 'requiredPermission';
/**
* This decorator gathers the {@link Permission Permission} a user must hold for the {@link PermissionsGuard}
* @param permissions - an array of permissions. In practice this should always contain exactly one {@link Permission}
* @constructor
* This decorator gathers the {@link RequiredPermission Permission} a user must hold for the {@link PermissionsGuard}
* @param permissions - an array of permissions. In practice this should always contain exactly one {@link RequiredPermission}
*/
// eslint-disable-next-line func-style,@typescript-eslint/naming-convention
export const RequirePermission = (
...permissions: RequiredPermission[]
): CustomDecorator => SetMetadata('permissions', permissions);
): CustomDecorator => SetMetadata(PERMISSION_METADATA_KEY, permissions);