feat: ロールにアイコンを設定してユーザー名の横に表示できるように

Resolve #9761

packages/backend/src/core/RoleService.ts

@@ -202,6 +202,19 @@ export class RoleService implements OnApplicationShutdown {
 		return [...assignedRoles, ...matchedCondRoles];
 	}
 
+	/**
+	 * 指定ユーザーのバッジロール一覧取得
+	 */
+	@bindThis
+	public async getUserBadgeRoles(userId: User['id']) {
+		const assigns = await this.roleAssignmentByUserIdCache.fetch(userId, () => this.roleAssignmentsRepository.findBy({ userId }));
+		const assignedRoleIds = assigns.map(x => x.roleId);
+		const roles = await this.rolesCache.fetch(null, () => this.rolesRepository.findBy({}));
+		const assignedBadgeRoles = roles.filter(r => r.asBadge && assignedRoleIds.includes(r.id));
+		// コンディショナルロールも含めるのは負荷高そうだから一旦無し
+		return assignedBadgeRoles;
+	}
+
 	@bindThis
 	public async getUserPolicies(userId: User['id'] | null): Promise<RolePolicies> {
 		const meta = await this.metaService.fetch();

packages/backend/src/core/entities/RoleEntityService.ts

@@ -56,11 +56,13 @@ export class RoleEntityService {
 			name: role.name,
 			description: role.description,
 			color: role.color,
+			iconUrl: role.iconUrl,
 			target: role.target,
 			condFormula: role.condFormula,
 			isPublic: role.isPublic,
 			isAdministrator: role.isAdministrator,
 			isModerator: role.isModerator,
+			asBadge: role.asBadge,
 			canEditMembersByModerator: role.canEditMembersByModerator,
 			policies: policies,
 			usersCount: assigns.length,

packages/backend/src/core/entities/UserEntityService.ts

@@ -415,6 +415,11 @@ export class UserEntityService implements OnModuleInit {
 			} : undefined) : undefined,
 			emojis: this.customEmojiService.populateEmojis(user.emojis, user.host),
 			onlineStatus: this.getOnlineStatus(user),
+			// パフォーマンス上の理由でローカルユーザーのみ
+			badgeRoles: user.host == null ? this.roleService.getUserBadgeRoles(user.id).then(rs => rs.map(r => ({
+				name: r.name,
+				iconUrl: r.iconUrl,
+			}))) : undefined,
 
 			...(opts.detail ? {
 				url: profile!.url,
@@ -454,6 +459,7 @@ export class UserEntityService implements OnModuleInit {
 					id: role.id,
 					name: role.name,
 					color: role.color,
+					iconUrl: role.iconUrl,
 					description: role.description,
 					isModerator: role.isModerator,
 					isAdministrator: role.isAdministrator,

packages/backend/src/models/entities/Role.ts

@@ -102,6 +102,11 @@ export class Role {
 	})
 	public color: string | null;
 
+	@Column('varchar', {
+		length: 512, nullable: true,
+	})
+	public iconUrl: string | null;
+
 	@Column('enum', {
 		enum: ['manual', 'conditional'],
 		default: 'manual',
@@ -118,6 +123,12 @@ export class Role {
 	})
 	public isPublic: boolean;
 
+	// trueの場合ユーザー名の横にバッジとして表示
+	@Column('boolean', {
+		default: false,
+	})
+	public asBadge: boolean;
+
 	@Column('boolean', {
 		default: false,
 	})

packages/backend/src/server/api/endpoints/admin/roles/create.ts

@@ -19,11 +19,13 @@ export const paramDef = {
 		name: { type: 'string' },
 		description: { type: 'string' },
 		color: { type: 'string', nullable: true },
+		iconUrl: { type: 'string', nullable: true },
 		target: { type: 'string' },
 		condFormula: { type: 'object' },
 		isPublic: { type: 'boolean' },
 		isModerator: { type: 'boolean' },
 		isAdministrator: { type: 'boolean' },
+		asBadge: { type: 'boolean' },
 		canEditMembersByModerator: { type: 'boolean' },
 		policies: {
 			type: 'object',
@@ -33,11 +35,13 @@ export const paramDef = {
 		'name',
 		'description',
 		'color',
+		'iconUrl',
 		'target',
 		'condFormula',
 		'isPublic',
 		'isModerator',
 		'isAdministrator',
+		'asBadge',
 		'canEditMembersByModerator',
 		'policies',
 	],
@@ -64,11 +68,13 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 				name: ps.name,
 				description: ps.description,
 				color: ps.color,
+				iconUrl: ps.iconUrl,
 				target: ps.target,
 				condFormula: ps.condFormula,
 				isPublic: ps.isPublic,
 				isAdministrator: ps.isAdministrator,
 				isModerator: ps.isModerator,
+				asBadge: ps.asBadge,
 				canEditMembersByModerator: ps.canEditMembersByModerator,
 				policies: ps.policies,
 			}).then(x => this.rolesRepository.findOneByOrFail(x.identifiers[0]));

packages/backend/src/server/api/endpoints/admin/roles/update.ts

@@ -27,11 +27,13 @@ export const paramDef = {
 		name: { type: 'string' },
 		description: { type: 'string' },
 		color: { type: 'string', nullable: true },
+		iconUrl: { type: 'string', nullable: true },
 		target: { type: 'string' },
 		condFormula: { type: 'object' },
 		isPublic: { type: 'boolean' },
 		isModerator: { type: 'boolean' },
 		isAdministrator: { type: 'boolean' },
+		asBadge: { type: 'boolean' },
 		canEditMembersByModerator: { type: 'boolean' },
 		policies: {
 			type: 'object',
@@ -42,11 +44,13 @@ export const paramDef = {
 		'name',
 		'description',
 		'color',
+		'iconUrl',
 		'target',
 		'condFormula',
 		'isPublic',
 		'isModerator',
 		'isAdministrator',
+		'asBadge',
 		'canEditMembersByModerator',
 		'policies',
 	],
@@ -73,11 +77,13 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 				name: ps.name,
 				description: ps.description,
 				color: ps.color,
+				iconUrl: ps.iconUrl,
 				target: ps.target,
 				condFormula: ps.condFormula,
 				isPublic: ps.isPublic,
 				isModerator: ps.isModerator,
 				isAdministrator: ps.isAdministrator,
+				asBadge: ps.asBadge,
 				canEditMembersByModerator: ps.canEditMembersByModerator,
 				policies: ps.policies,
 			});