feat: お知らせの優先順位機能 (#118)

ついでにお知らせのページング処理、わかったのボタン押したとき更新されるように

locales/en-US.yml

@@ -251,6 +251,7 @@ noSuchUser: "User not found"
 lookup: "Lookup"
 announcements: "Announcements"
 imageUrl: "Image URL"
+displayOrder: "Position"
 remove: "Delete"
 removed: "Successfully deleted"
 removeAreYouSure: "Are you sure that you want to remove \"{x}\"?"

locales/index.d.ts

@@ -254,6 +254,7 @@ export interface Locale {
     "lookup": string;
     "announcements": string;
     "imageUrl": string;
+    "displayOrder": string;
     "remove": string;
     "removed": string;
     "removeAreYouSure": string;

locales/ja-JP.yml

@@ -251,6 +251,7 @@ noSuchUser: "ユーザーが見つかりません"
 lookup: "照会"
 announcements: "お知らせ"
 imageUrl: "画像URL"
+displayOrder: "表示順"
 remove: "削除"
 removed: "削除しました"
 removeAreYouSure: "「{x}」を削除しますか？"

packages/backend/migration/1690463372775-announcement-display-order.js

@@ -0,0 +1,13 @@
+export class AnnouncementDisplayOrder1690463372775 {
+    name = 'AnnouncementDisplayOrder1690463372775'
+
+    async up(queryRunner) {
+        await queryRunner.query(`ALTER TABLE "announcement" ADD "displayOrder" integer NOT NULL DEFAULT '0'`);
+        await queryRunner.query(`CREATE INDEX "IDX_b64d293ca4bef21e91963054b0" ON "announcement" ("displayOrder") `);
+    }
+
+    async down(queryRunner) {
+        await queryRunner.query(`DROP INDEX "public"."IDX_b64d293ca4bef21e91963054b0"`);
+        await queryRunner.query(`ALTER TABLE "announcement" DROP COLUMN "displayOrder"`);
+    }
+}

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

@@ -33,6 +33,13 @@ export class Announcement {
 	})
 	public imageUrl: string | null;
 
+	// UIに表示する際の並び順用(大きいほど先頭)
+	@Index()
+	@Column('integer', {
+		default: 0,
+	})
+	public displayOrder: number;
+
 	@Index()
 	@Column('varchar', {
 		...id(),

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

@@ -42,6 +42,10 @@ export const meta = {
 				type: 'string',
 				optional: false, nullable: true,
 			},
+			displayOrder: {
+				type: 'number',
+				optional: false, nullable: false,
+			},
 			userId: {
 				type: 'string',
 				optional: false, nullable: true,
@@ -60,6 +64,7 @@ export const paramDef = {
 		title: { type: 'string', minLength: 1 },
 		text: { type: 'string', minLength: 1 },
 		imageUrl: { type: 'string', nullable: true, minLength: 1 },
+		displayOrder: { type: 'number' },
 		userId: { type: 'string', nullable: true, format: 'misskey:id' },
 		closeDuration: { type: 'number', nullable: false },
 	},
@@ -83,6 +88,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 				title: ps.title,
 				text: ps.text,
 				imageUrl: ps.imageUrl,
+				displayOrder: ps.displayOrder,
 				userId: ps.userId ?? null,
 				closeDuration: ps.closeDuration,
 			}).then(x => this.announcementsRepository.findOneByOrFail(x.identifiers[0]));

packages/backend/src/server/api/endpoints/admin/announcements/list.ts

@@ -48,6 +48,10 @@ export const meta = {
 					type: 'string',
 					optional: false, nullable: true,
 				},
+				displayOrder: {
+					type: 'number',
+					optional: false, nullable: false,
+				},
 				userId: {
 					type: 'string',
 					optional: false, nullable: true,
@@ -74,8 +78,7 @@ export const paramDef = {
 	type: 'object',
 	properties: {
 		limit: { type: 'integer', minimum: 1, maximum: 100, default: 10 },
-		sinceId: { type: 'string', format: 'misskey:id' },
-		untilId: { type: 'string', format: 'misskey:id' },
+		offset: { type: 'integer', default: 0 },
 		userId: { type: 'string', format: 'misskey:id' },
 	},
 	required: [],
@@ -94,20 +97,25 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 		@Inject(DI.usersRepository)
 		private usersRepository: UsersRepository,
 
-		private queryService: QueryService,
 		private userEntityService: UserEntityService,
 	) {
 		super(meta, paramDef, async (ps, me) => {
-			const builder = this.announcementsRepository.createQueryBuilder('announcement');
+			const query = this.announcementsRepository.createQueryBuilder('announcement');
 			if (ps.userId) {
-				builder.where('"userId" = :userId', { userId: ps.userId });
+				query.where('"userId" = :userId', { userId: ps.userId });
 			} else {
-				builder.where('"userId" IS NULL');
+				query.where('"userId" IS NULL');
 			}
 
-			const query = this.queryService.makePaginationQuery(builder, ps.sinceId, ps.untilId);
+			query.orderBy({
+				'announcement."displayOrder"': 'DESC',
+				'announcement."createdAt"': 'DESC',
+			});
 
-			const announcements = await query.limit(ps.limit).getMany();
+			const announcements = await query
+				.offset(ps.offset)
+				.limit(ps.limit)
+				.getMany();
 
 			const reads = new Map<Announcement, number>();
 
@@ -131,6 +139,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 				title: announcement.title,
 				text: announcement.text,
 				imageUrl: announcement.imageUrl,
+				displayOrder: announcement.displayOrder,
 				userId: announcement.userId,
 				user: packedUsers.find(user => user.id === announcement.userId),
 				reads: reads.get(announcement)!,

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

@@ -26,6 +26,7 @@ export const paramDef = {
 		title: { type: 'string', minLength: 1 },
 		text: { type: 'string', minLength: 1 },
 		imageUrl: { type: 'string', nullable: true, minLength: 0 },
+		displayOrder: { type: 'number' },
 		userId: { type: 'string', nullable: true, format: 'misskey:id' },
 		closeDuration: { type: 'number', nullable: false },
 	},
@@ -57,6 +58,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 				text: ps.text,
 				/* eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- 空の文字列の場合、nullを渡すようにするため */
 				imageUrl: ps.imageUrl || null,
+				displayOrder: ps.displayOrder,
 				userId: ps.userId ?? null,
 				closeDuration: ps.closeDuration,
 			});

packages/backend/src/server/api/endpoints/announcements.ts

@@ -1,8 +1,8 @@
 import { Inject, Injectable } from '@nestjs/common';
 import { Endpoint } from '@/server/api/endpoint-base.js';
-import { QueryService } from '@/core/QueryService.js';
 import { DI } from '@/di-symbols.js';
-import type { AnnouncementReadsRepository, AnnouncementsRepository } from '@/models/index.js';
+import type { AnnouncementsRepository } from '@/models/index.js';
+import { Announcement, AnnouncementRead } from '@/models/index.js';
 
 export const meta = {
 	tags: ['meta'],
@@ -65,9 +65,8 @@ export const paramDef = {
 	type: 'object',
 	properties: {
 		limit: { type: 'integer', minimum: 1, maximum: 100, default: 10 },
+		offset: { type: 'integer', default: 0 },
 		withUnreads: { type: 'boolean', default: false },
-		sinceId: { type: 'string', format: 'misskey:id' },
-		untilId: { type: 'string', format: 'misskey:id' },
 		privateOnly: { type: 'boolean', default: false },
 	},
 	required: [],
@@ -79,39 +78,37 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 	constructor(
 		@Inject(DI.announcementsRepository)
 		private announcementsRepository: AnnouncementsRepository,
-
-		@Inject(DI.announcementReadsRepository)
-		private announcementReadsRepository: AnnouncementReadsRepository,
-
-		private queryService: QueryService,
 	) {
 		super(meta, paramDef, async (ps, me) => {
-			const builder = this.announcementsRepository.createQueryBuilder('announcement');
+			const query = this.announcementsRepository.createQueryBuilder('announcement');
 			if (me) {
+				query.leftJoinAndSelect(AnnouncementRead, 'reads', 'reads."announcementId" = announcement.id AND reads."userId" = :userId', { userId: me.id });
+				query.select([
+					'announcement.*',
+					'CASE WHEN reads.id IS NULL THEN FALSE ELSE TRUE END as "isRead"',
+				]);
 				if (ps.privateOnly) {
-					builder.where('"userId" = :userId', { userId: me.id });
+					query.where('announcement."userId" = :userId', { userId: me.id });
 				} else {
-					builder.where('"userId" IS NULL');
-					builder.orWhere('"userId" = :userId', { userId: me.id });
+					query.where('announcement."userId" IS NULL');
+					query.orWhere('announcement."userId" = :userId', { userId: me.id });
 				}
 			} else {
-				builder.where('"userId" IS NULL');
+				query.where('announcement."userId" IS NULL');
 			}
 
-			const query = this.queryService.makePaginationQuery(builder, ps.sinceId, ps.untilId);
-			const announcements = await query.limit(ps.limit).getMany();
+			query.orderBy({
+				'"isRead"': 'ASC',
+				'announcement."displayOrder"': 'DESC',
+				'announcement."createdAt"': 'DESC',
+			});
 
-			if (me) {
-				const reads = (await this.announcementReadsRepository.findBy({
-					userId: me.id,
-				})).map(x => x.announcementId);
+			const announcements = await query
+				.offset(ps.offset)
+				.limit(ps.limit)
+				.getRawMany<Announcement & { isRead: boolean }>();
 
-				for (const announcement of announcements) {
-					(announcement as any).isRead = reads.includes(announcement.id);
-				}
-			}
-
-			return (ps.withUnreads ? announcements.filter((a: any) => !a.isRead) : announcements).map((a) => ({
+			return (ps.withUnreads ? announcements.filter(i => !i.isRead) : announcements).map((a) => ({
 				...a,
 				createdAt: a.createdAt.toISOString(),
 				updatedAt: a.updatedAt?.toISOString() ?? null,

packages/frontend/src/pages/admin/announcements.vue

@@ -19,7 +19,7 @@
 					</div>
 				</MkFolder>
 			</MkFolder>
-			<section v-for="announcement in announcements" class="">
+			<section v-for="announcement in announcements" :key="announcement.id">
 				<div class="_panel _gaps_m" style="padding: 24px;">
 					<MkInput ref="announceTitleEl" v-model="announcement.title" :large="false">
 						<template #label>{{ i18n.ts.title }}&nbsp;<button v-tooltip="i18n.ts.emoji" :class="['_button']" @click="insertEmoji"><i class="ti ti-mood-happy"></i></button></template>
@@ -30,6 +30,9 @@
 					<MkInput v-model="announcement.imageUrl">
 						<template #label>{{ i18n.ts.imageUrl }}</template>
 					</MkInput>
+					<MkInput v-model="announcement.displayOrder" type="number">
+						<template #label>{{ i18n.ts.displayOrder }}</template>
+					</MkInput>
 					<MkInput v-model="announcement.closeDuration" type="number">
 						<template #label>{{ i18n.ts.dialogCloseDuration }}</template>
 						<template #suffix>{{ i18n.ts._time.second }}</template>
@@ -43,6 +46,7 @@
 					</div>
 				</div>
 			</section>
+			<MkButton v-if="hasMore" :class="$style.more" :disabled="!hasMore" primary rounded @click="fetch()">{{ i18n.ts.loadMore }}</MkButton>
 		</div>
 	</MkSpacer>
 </MkStickyContainer>
@@ -61,33 +65,31 @@ import * as os from '@/os';
 import { i18n } from '@/i18n';
 import { definePageMetadata } from '@/scripts/page-metadata';
 
+const announceTitleEl = $shallowRef<HTMLInputElement | null>(null);
+const user = ref<UserLite | null>(null);
+const offset = ref(0);
+const hasMore = ref(false);
+
 let announcements: any[] = $ref([]);
 
-const user = ref<UserLite>(null);
-const announceTitleEl = $shallowRef<HTMLInputElement | null>(null);
+function insertEmoji(ev: MouseEvent): void {
+	os.openEmojiPicker(ev.currentTarget ?? ev.target, {}, announceTitleEl);
+}
 
-function selectUserFilter() {
+function selectUserFilter(): void {
 	os.selectUser().then(_user => {
 		user.value = _user;
 	});
 }
 
-function editUser(an) {
+function editUser(announcement): void {
 	os.selectUser().then(_user => {
-		an.userId = _user.id;
-		an.user = _user;
+		announcement.userId = _user.id;
+		announcement.user = _user;
 	});
 }
 
-async function insertEmoji(ev: MouseEvent) {
-	os.openEmojiPicker(ev.currentTarget ?? ev.target, {}, announceTitleEl);
-}
-
-os.api('admin/announcements/list').then(announcementResponse => {
-	announcements = announcementResponse;
-});
-
-function add() {
+function add(): void {
 	announcements.unshift({
 		id: null,
 		title: '',
@@ -95,11 +97,12 @@ function add() {
 		imageUrl: null,
 		userId: null,
 		user: null,
+		displayOrder: 0,
 		closeDuration: 10,
 	});
 }
 
-function remove(announcement) {
+function remove(announcement): void {
 	os.confirm({
 		type: 'warning',
 		text: i18n.t('removeAreYouSure', { x: announcement.title }),
@@ -110,14 +113,14 @@ function remove(announcement) {
 	});
 }
 
-function save(announcement) {
+function save(announcement): void {
 	if (announcement.id == null) {
 		os.api('admin/announcements/create', announcement).then(() => {
 			os.alert({
 				type: 'success',
 				text: i18n.ts.saved,
 			});
-			refresh();
+			fetch(true);
 		}).catch(err => {
 			os.alert({
 				type: 'error',
@@ -139,15 +142,26 @@ function save(announcement) {
 	}
 }
 
-function refresh() {
-	os.api('admin/announcements/list', { userId: user.value?.id }).then(announcementResponse => {
-		announcements = announcementResponse;
+function fetch(resetOffset = false): void {
+	if (resetOffset) {
+		announcements = [];
+		offset.value = 0;
+	}
+
+	os.api('admin/announcements/list', {
+		offsetMode: true,
+		offset: offset.value,
+		limit: 10,
+		userId: user.value?.id,
+	}).then(announcementResponse => {
+		announcements = announcements.concat(announcementResponse);
+		hasMore.value = announcementResponse?.length === 10;
+		offset.value += announcements.length;
 	});
 }
 
-watch(user, refresh);
-
-refresh();
+watch(user, () => fetch(true));
+fetch();
 
 const headerActions = $computed(() => [{
 	asFullButton: true,
@@ -163,3 +177,10 @@ definePageMetadata({
 	icon: 'ti ti-speakerphone',
 });
 </script>
+
+<style lang="scss" module>
+.more {
+  margin-left: auto;
+  margin-right: auto;
+}
+</style>

packages/frontend/src/pages/announcements.vue

@@ -2,7 +2,7 @@
 <MkStickyContainer>
 	<template #header><MkPageHeader :actions="headerActions" :tabs="headerTabs"/></template>
 	<MkSpacer :contentMax="800">
-		<MkPagination v-slot="{items}" :pagination="pagination" class="ruryvtyk _gaps_m">
+		<MkPagination v-slot="{items, reload}" :pagination="pagination" class="ruryvtyk _gaps_m">
 			<section v-for="(announcement, i) in items" :key="announcement.id" :class="{ announcement: true, _panel: true, private: announcement.isPrivate }">
 				<div class="header"><span v-if="$i && !announcement.isRead"><span class="ti ti-speakerphone"></span></span><Mfm :text="announcement.title"/></div>
 				<div class="content">
@@ -10,7 +10,7 @@
 					<img v-if="announcement.imageUrl" :src="announcement.imageUrl"/>
 				</div>
 				<div v-if="$i && !announcement.isRead" class="footer">
-					<MkButton primary @click="read(items, announcement, i)"><i class="ti ti-check"></i> {{ i18n.ts.gotIt }}</MkButton>
+					<MkButton primary @click="read(items, reload, announcement, i)"><i class="ti ti-check"></i> {{ i18n.ts.gotIt }}</MkButton>
 				</div>
 			</section>
 		</MkPagination>
@@ -19,7 +19,6 @@
 </template>
 
 <script lang="ts" setup>
-import { } from 'vue';
 import MkPagination from '@/components/MkPagination.vue';
 import MkButton from '@/components/MkButton.vue';
 import * as os from '@/os';
@@ -29,16 +28,15 @@ import { $i } from '@/account';
 
 const pagination = {
 	endpoint: 'announcements' as const,
+	offsetMode: true,
 	limit: 10,
 };
 
-// TODO: これは実質的に親コンポーネントから子コンポーネントのプロパティを変更してるのでなんとかしたい
-function read(items, announcement, i) {
-	items[i] = {
-		...announcement,
-		isRead: true,
-	};
-	os.api('i/read-announcement', { announcementId: announcement.id });
+function read(items, reload, announcement, i) {
+	items[i].isRead = true;
+	os.api('i/read-announcement', {
+		announcementId: announcement.id,
+	}).then(reload);
 }
 
 const headerActions = $computed(() => []);

packages/frontend/src/ui/visitor.vue

@@ -91,6 +91,7 @@ provideMetadataReceiver((info) => {
 
 const announcements = {
 	endpoint: 'announcements',
+	offsetMode: true,
 	limit: 10,
 };