Skip to content

Webhookの設定にお知らせの作成時を追加 #645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions locales/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9607,6 +9607,10 @@ export interface Locale extends ILocale {
* 通報が自動解決されたとき
*/
"reportAutoResolved": string;
/**
* お知らせが作成されたとき
*/
"announceCreated": string;
};
};
"_abuse": {
Expand Down
1 change: 1 addition & 0 deletions locales/ja-JP.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2542,6 +2542,7 @@ _webhookSettings:
reportCreated: "通報が登録されたとき"
reportResolved: "通報が解決されたとき"
reportAutoResolved: "通報が自動解決されたとき"
announceCreated: "お知らせが作成されたとき"

_abuse:
_resolver:
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/models/Webhook.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { PrimaryColumn, Entity, Index, JoinColumn, Column, ManyToOne } from 'typ
import { id } from './util/id.js';
import { MiUser } from './User.js';

export const webhookEventTypes = ['mention', 'unfollow', 'follow', 'followed', 'note', 'reply', 'renote', 'reaction', 'reportCreated', 'reportResolved', 'reportAutoResolved'] as const;
export const webhookEventTypes = ['mention', 'unfollow', 'follow', 'followed', 'note', 'reply', 'renote', 'reaction', 'reportCreated', 'reportResolved', 'reportAutoResolved', 'announceCreated'] as const;

@Entity('webhook')
export class MiWebhook {
Expand Down
53 changes: 53 additions & 0 deletions packages/backend/src/queue/processors/AnnounceProcessorService.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* SPDX-FileCopyrightText: syuilo and misskey-project
* SPDX-License-Identifier: AGPL-3.0-only
*/

import { Injectable, Inject } from '@nestjs/common';
import { bindThis } from '@/decorators.js';
import type Logger from '@/logger.js';
import { RoleService } from '@/core/RoleService.js';
import { GlobalEventService } from '@/core/GlobalEventService.js';
import { InstanceActorService } from '@/core/InstanceActorService.js';
import type { AnnouncementsRepository, UsersRepository } from '@/models/_.js';
import { DI } from '@/di-symbols.js';
import { ApRendererService } from '@/core/activitypub/ApRendererService.js';
import { QueueService } from '@/core/QueueService.js';
import { WebhookService } from '@/core/WebhookService.js';
import { QueueLoggerService } from '../QueueLoggerService.js';
import type { DbAnnouncementJobData } from '../types.js';
import type * as Bull from 'bullmq';

@Injectable()
export class AnnounceProcessorService {
private logger: Logger;
constructor(
@Inject(DI.announcementsRepository)
private announcementsRepository: AnnouncementsRepository,

private queueLoggerService: QueueLoggerService,
private roleService: RoleService,
private queueService: QueueService,
private webhookService: WebhookService,
) {
this.logger = this.queueLoggerService.logger.createSubLogger('announce');
}
@bindThis
public async process(job: Bull.Job<DbAnnouncementJobData>): Promise<void> {
this.logger.info('Running...');

const announce = await this.announcementsRepository.findOneByOrFail({
id: job.data.id,
});
const webhooks = (await this.webhookService.getActiveWebhooks()).filter(x => x.on.includes('announceCreated'));
for (const webhook of webhooks) {
if (await this.roleService.isAdministrator({ id: webhook.userId, isRoot: false })) {
this.queueService.webhookDeliver(webhook, 'announceCreated', {
resolver: announce,
announce: job.data,
});
}
}

Check failure on line 50 in packages/backend/src/queue/processors/AnnounceProcessorService.ts

View workflow job for this annotation

GitHub Actions / lint (backend)

Block must not be padded by blank lines

}
}
3 changes: 3 additions & 0 deletions packages/backend/src/queue/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import type { MiAbuseUserReport } from '@/models/AbuseUserReport.js';
import type { MiWebhook } from '@/models/Webhook.js';
import type { IActivity } from '@/core/activitypub/type.js';
import type httpSignature from '@peertube/http-signature';
import { MiAnnouncement } from '@/models/Announcement.js';

export type DeliverJobData = {
/** Actor */
Expand Down Expand Up @@ -102,6 +103,8 @@ export type DbUserImportToDbJobData = {

export type DbAbuseReportJobData = MiAbuseUserReport;

export type DbAnnouncementJobData = MiAnnouncement;

export type ObjectStorageJobData = ObjectStorageFileJobData | Record<string, unknown>;

export type ObjectStorageFileJobData = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
import { Injectable } from '@nestjs/common';
import { Endpoint } from '@/server/api/endpoint-base.js';
import { AnnouncementService } from '@/core/AnnouncementService.js';
import { QueueService } from '@/core/QueueService.js';
import { WebhookService } from '@/core/WebhookService.js';

export const meta = {
tags: ['admin'],
Expand Down Expand Up @@ -104,6 +106,8 @@
export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-disable-line import/no-default-export
constructor(
private announcementService: AnnouncementService,
private queueService: QueueService,
private webhookService: WebhookService,
) {
super(meta, paramDef, async (ps, me) => {
const { raw, packed } = await this.announcementService.create({
Expand All @@ -120,7 +124,16 @@
silence: ps.silence,
userId: ps.userId,
}, me);

if(ps.userId === null) {

Check failure on line 127 in packages/backend/src/server/api/endpoints/admin/announcements/create.ts

View workflow job for this annotation

GitHub Actions / lint (backend)

Expected space(s) after "if"
this.webhookService.getActiveWebhooks().then(webhooks => {
webhooks = webhooks.filter(x => x.on.includes('announceCreated'));
for (const webhook of webhooks) {
this.queueService.webhookDeliver(webhook, 'announceCreated', {
announcement: packed,
});
}
});
}
return packed;
});
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
throw new ApiError(meta.errors.tooManyWebhooks);
}

if (ps.on.includes('reportCreated') || ps.on.includes('reportResolved') || ps.on.includes('reportAutoResolved')) {
if (ps.on.some( item => ['reportCreated','reportResolved','reportAutoResolved','announceCreated'].includes(item) )) {

Check failure on line 98 in packages/backend/src/server/api/endpoints/i/webhooks/create.ts

View workflow job for this annotation

GitHub Actions / lint (backend)

A space is required after ','

Check failure on line 98 in packages/backend/src/server/api/endpoints/i/webhooks/create.ts

View workflow job for this annotation

GitHub Actions / lint (backend)

A space is required after ','

Check failure on line 98 in packages/backend/src/server/api/endpoints/i/webhooks/create.ts

View workflow job for this annotation

GitHub Actions / lint (backend)

A space is required after ','
if (!await this.roleService.isAdministrator(me)) {
throw new ApiError(meta.errors.youAreNotAdmin);
}
Expand Down
2 changes: 2 additions & 0 deletions packages/frontend/src/pages/settings/webhook.edit.vue
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
<MkSwitch v-if="$i?.isAdmin" v-model="event_reportCreated">{{ i18n.ts._webhookSettings._events.reportCreated }}</MkSwitch>
<MkSwitch v-if="$i?.isAdmin" v-model="event_reportResolved">{{ i18n.ts._webhookSettings._events.reportResolved }}</MkSwitch>
<MkSwitch v-if="$i?.isAdmin" v-model="event_reportAutoResolved">{{ i18n.ts._webhookSettings._events.reportAutoResolved }}</MkSwitch>
<MkSwitch v-if="$i?.isAdmin" v-model="event_announceCreated">{{ i18n.ts._webhookSettings._events.announceCreated }}</MkSwitch>
</div>
</FormSection>

Expand Down Expand Up @@ -95,6 +96,7 @@
if (event_reportCreated.value) events.push('reportCreated');
if (event_reportResolved.value) events.push('reportResolved');
if (event_reportAutoResolved.value) events.push('reportAutoResolved');
if (event_announceCreated.value) events.push('announceCreated');

Check failure on line 99 in packages/frontend/src/pages/settings/webhook.edit.vue

View workflow job for this annotation

GitHub Actions / lint (frontend)

'event_announceCreated' is not defined

os.apiWithDialog('i/webhooks/update', {
name: name.value,
Expand Down
3 changes: 3 additions & 0 deletions packages/frontend/src/pages/settings/webhook.new.vue
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ SPDX-License-Identifier: AGPL-3.0-only
<MkSwitch v-if="$i?.isAdmin" v-model="event_reportCreated">{{ i18n.ts._webhookSettings._events.reportCreated }}</MkSwitch>
<MkSwitch v-if="$i?.isAdmin" v-model="event_reportResolved">{{ i18n.ts._webhookSettings._events.reportResolved }}</MkSwitch>
<MkSwitch v-if="$i?.isAdmin" v-model="event_reportAutoResolved">{{ i18n.ts._webhookSettings._events.reportAutoResolved }}</MkSwitch>
<MkSwitch v-if="$i?.isAdmin" v-model="event_announceCreated">{{ i18n.ts._webhookSettings._events.announceCreated }}</MkSwitch>
</div>
</FormSection>

Expand Down Expand Up @@ -66,6 +67,7 @@ const event_mention = ref(true);
const event_reportCreated = ref(false);
const event_reportResolved = ref(false);
const event_reportAutoResolved = ref(false);
const event_announceCreated = ref(false);

async function create(): Promise<void> {
const events = [];
Expand All @@ -79,6 +81,7 @@ async function create(): Promise<void> {
if (event_reportCreated.value) events.push('reportCreated');
if (event_reportResolved.value) events.push('reportResolved');
if (event_reportAutoResolved.value) events.push('reportAutoResolved');
if (event_announceCreated.value) events.push('announceCreated');

os.apiWithDialog('i/webhooks/create', {
name: name.value,
Expand Down
Loading