Scrapbox: 指定したページが更新されても通知が来ないようにする

.env.example

@@ -7,13 +7,15 @@ SWARM_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 CHANNEL_SANDBOX=CXXXXXXXX
 CHANNEL_ESOLANG=CXXXXXXXX
 CHANNEL_PROCON=CXXXXXXXX
+CHANNEL_SCRAPBOX=CXXXXXXXX
 CHANNEL_RANDOM=CXXXXXXXX
 USER_TSGBOT=UXXXXXXXX
 GITHUB_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 GOOGLE_APPLICATION_CREDENTIALS=google_application_credentials.json
 FIREBASE_ENDPOINT=https://hakata-shi.firebaseio.com
 ACCUWEATHER_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 SCRAPBOX_SID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+SCRAPBOX_PROJECT_NAME=xxxxxxxxx
 GITHUB_WEBHOOK_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 SIGNING_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 PORT=21864

scrapbox/.eslintrc.json

@@ -3,6 +3,12 @@
     "parser": "@typescript-eslint/parser",
     "rules": {
         "no-console": "off",
-        "camelcase": "off"
+        "camelcase": "off",
+        "valid-jsdoc": [
+            "error", {
+                "requireParamType": false,
+                "requireReturnType": false
+            }
+        ]
     }
 }

scrapbox/index.test.ts

@@ -1,32 +1,40 @@
 jest.mock('axios');
 
-import scrapbox from './index';
 // @ts-ignore
 import Slack from '../lib/slackMock.js';
 import axios from 'axios';
 import qs from 'querystring';
+import { escapeRegExp } from 'lodash';
+import fastifyConstructor from 'fastify';
+import {MessageAttachment} from '@slack/client';
+
 
 // @ts-ignore
 axios.response = {data: {title: 'hoge', descriptions: ['fuga', 'piyo']}};
 
 let slack: Slack = null;
 
-beforeEach(async () => {
-	slack = new Slack();
-	process.env.CHANNEL_SANDBOX = slack.fakeChannel;
-	await scrapbox(slack);
-});
+const projectName = 'PROJECTNAME';
+process.env.SCRAPBOX_PROJECT_NAME = projectName;
+import scrapbox from './index';
+import {server} from './index';
 
 describe('scrapbox', () => {
+	beforeEach(async () => {
+		slack = new Slack();
+		process.env.CHANNEL_SANDBOX = slack.fakeChannel;
+		await scrapbox(slack);
+	});
+
 	it('respond to slack hook of scrapbox unfurling', async () => {
 		const done = new Promise((resolve) => {
 			// @ts-ignore
 			axios.mockImplementation(({url, data}: {url: string, data: any}) => {
 				if (url === 'https://slack.com/api/chat.unfurl') {
 					const parsed = qs.parse(data);
 					const unfurls = JSON.parse(Array.isArray(parsed.unfurls) ? parsed.unfurls[0] : parsed.unfurls);
-					expect(unfurls['https://scrapbox.io/tsg/hoge']).toBeTruthy();
-					expect(unfurls['https://scrapbox.io/tsg/hoge'].text).toBe('fuga\npiyo');
+					expect(unfurls[`https://scrapbox.io/${projectName}/hoge`]).toBeTruthy();
+					expect(unfurls[`https://scrapbox.io/${projectName}/hoge`].text).toBe('fuga\npiyo');
 					resolve();
 					return Promise.resolve({data: {ok: true}});
 				}
@@ -44,11 +52,89 @@ describe('scrapbox', () => {
 			links: [
 				{
 					domain: 'scrapbox.io',
-					url: 'https://scrapbox.io/tsg/hoge',
+					url: `https://scrapbox.io/${projectName}/hoge`,
 				},
 			],
 		});
 
 		return done;
 	});
 });
+
+describe('scrapbox', () => {
+	it('mutes pages with ##ミュート tag', async () => {
+		const fakeChannel = 'CSCRAPBOX';
+		process.env.CHANNEL_SCRAPBOX = fakeChannel;
+		const fastify = fastifyConstructor();
+		// eslint-disable-next-line array-plural/array-plural
+		const attachments_req: (MessageAttachment & any)[] = [
+			{
+				title: 'page 1',
+				title_link: `https://scrapbox.io/${projectName}/page_1#c632c886dc3061e3b85cabbd`,
+				text: 'hoge',
+				rawText: 'hoge',
+				mrkdwn_in: ['text'],
+				author_name: 'Alice',
+				image_url: 'https://example.com/hoge1.png',
+				thumb_url: 'https://example.com/fuga1.png',
+			},
+			{
+				title: 'page 2',
+				title_link: `https://scrapbox.io/${projectName}/page_2#aaf8924806eb538413c07c43`,
+				text: 'hoge',
+				rawText: 'hoge',
+				mrkdwn_in: ['text'],
+				author_name: 'Bob',
+				image_url: 'https://example.com/hoge2.png',
+				thumb_url: 'https://example.com/fuga2.png',
+			},
+		];
+		// @ts-ignore
+		axios.get.mockImplementation((url: string) => {
+			if (url.match(new RegExp(`${escapeRegExp(`https://scrapbox.io/api/pages/${projectName}/page_1`)}(?:#.*)?`))) {
+				return {data: {title: 'page 1', links: ['page 3', '##ミュート']}};
+			} else if (url.match(new RegExp(`${escapeRegExp(`https://scrapbox.io/api/pages/${projectName}/page_2`)}(?:#.*)?`))) {
+				return {data: {title: 'page 2', links: ['page 4']}};
+			}
+			throw Error('axios-mock: unexpected URL');
+		});
+
+		slack = {chat: {
+			postMessage: jest.fn(),
+		}};
+		fastify.register(server({webClient: slack} as any));
+		const args = {
+			text: `New lines on <https://scrapbox.io/${projectName}|${projectName}>`,
+			mrkdwn: true,
+			username: 'Scrapbox',
+			attachments: attachments_req,
+		};
+		const {payload, statusCode} = await fastify.inject({
+			method: 'POST',
+			url: '/scrapbox',
+			payload: args,
+		});
+		if (statusCode !== 200) {
+			throw JSON.parse(payload);
+		}
+		expect(slack.chat.postMessage.mock.calls.length).toBe(1);
+		const {channel, text, attachments: attachments_res}: {channel: string; text: string; attachments: MessageAttachment[]} = slack.chat.postMessage.mock.calls[0][0];
+		expect(channel).toBe(fakeChannel);
+		expect(text).toBe(args.text);
+		const unchanged = ['title', 'title_link', 'mrkdwn_in', 'author_name'] as const;
+		for (const i of [0, 1]) {
+			for (const key of unchanged) {
+				expect(attachments_res[i][key]).toEqual(attachments_req[i][key]);
+			}
+		}
+		const nulled = ['image_url', 'thumb_url'] as const;
+		for (const key of nulled) {
+			expect(attachments_res[0][key]).toBeNull();
+			// eslint-disable-next-line array-plural/array-plural
+			expect(attachments_res[1][key]).toEqual(attachments_req[1][key]);
+		}
+		expect(attachments_res[0].text).toContain('ミュート');
+		// eslint-disable-next-line array-plural/array-plural
+		expect(attachments_res[1].text).toBe(attachments_req[1].text);
+	});
+});

scrapbox/index.ts

@@ -1,12 +1,24 @@
 import axios from 'axios';
 // @ts-ignore
 import logger from '../lib/logger.js';
-import {LinkUnfurls} from '@slack/client';
 import qs from 'querystring';
+import plugin from 'fastify-plugin';
+import { escapeRegExp } from 'lodash';
+import {WebClient, RTMClient, LinkUnfurls, MessageAttachment} from '@slack/client';
 
-const getScrapboxUrl = (pageName: string) => `https://scrapbox.io/api/pages/tsg/${pageName}`;
+const projectName = process.env.SCRAPBOX_PROJECT_NAME;
+const scrapboxUrlRegexp = new RegExp(`^https?${escapeRegExp(`://scrapbox.io/${projectName}/`)}(?<pageTitle>.+)$`);
+const getScrapboxUrl = (pageName: string) => `https://scrapbox.io/api/pages/${projectName}/${pageName}`;
+const getScrapboxUrlFromPageUrl = (url: string): string => {
+	let pageName = url.replace(scrapboxUrlRegexp, '$<pageTitle>');
+	try {
+		if (decodeURI(pageName) === pageName) {
+			pageName = encodeURI(pageName);
+		}
+	} catch {}
+	return getScrapboxUrl(pageName);
+};
 
-import {WebClient, RTMClient} from '@slack/client';
 
 interface SlackInterface {
 	rtmClient: RTMClient,
@@ -22,16 +34,10 @@ export default async ({rtmClient: rtm, webClient: slack, eventClient: event}: Sl
 		const unfurls: LinkUnfurls = {};
 		for (const link of links) {
 			const {url} = link;
-			if (!(/^https?:\/\/scrapbox.io\/tsg\/.+/).test(url)) {
+			if (!scrapboxUrlRegexp.test(url)) {
 				continue;
 			}
-			let pageName = url.replace(/^https?:\/\/scrapbox.io\/tsg\/(.+)$/, '$1');
-			try {
-				if (decodeURI(pageName) === pageName) {
-					pageName = encodeURI(pageName);
-				}
-			} catch {}
-			const scrapboxUrl = getScrapboxUrl(pageName);
+			const scrapboxUrl = getScrapboxUrlFromPageUrl(url);
 			const response = await axios.get(scrapboxUrl, {headers: {Cookie: `connect.sid=${process.env.SCRAPBOX_SID}`}});
 			const {data} = response;
 
@@ -73,3 +79,68 @@ export default async ({rtmClient: rtm, webClient: slack, eventClient: event}: Sl
 		}
 	});
 };
+
+
+interface SlackIncomingWebhookRequest {
+	text: string;
+	mrkdwn?: boolean;
+	username?: string;
+	attachments: MessageAttachment[];
+}
+
+/**
+ * ミュートしたいattachmentに対し，隠したい情報を消して返す
+ *
+ * @param attachment ミュートするattachment
+ * @return ミュート済みのattachment
+ */
+const maskAttachment = (attachment: MessageAttachment): MessageAttachment => {
+	const dummyText = 'この記事の更新通知はミュートされています。';
+	return {
+		...attachment,
+		text: dummyText,
+		fallback: dummyText,
+		image_url: null,
+		thumb_url: null,
+	};
+};
+
+/**
+ * 指定したURLの記事がミュート対象かどうかを判定する
+ *
+ * @param url Scrapbox記事のURL
+ * @return ミュート対象ならtrue, 対象外ならfalse
+ */
+const isMuted = async (url: string): Promise<boolean> => {
+	if (!scrapboxUrlRegexp.test(url)) {
+		// this url is not a scrapbox page
+		return false;
+	}
+	const muteTag = '##ミュート';
+	const infoUrl = getScrapboxUrlFromPageUrl(url);
+	const pageInfo = await axios.get(infoUrl, {headers: {Cookie: `connect.sid=${process.env.SCRAPBOX_SID}`}});
+	return pageInfo.data.links.indexOf(muteTag) !== -1; // if found, the page is muted
+};
+
+/**
+ * Scrapboxからの更新通知 (Incoming Webhook形式) を受け取り，ミュート処理をしてSlackに投稿する
+ */
+// eslint-disable-next-line node/no-unsupported-features, node/no-unsupported-features/es-syntax
+export const server = ({webClient: slack}: SlackInterface) => plugin((fastify, opts, next) => {
+	fastify.post<unknown, unknown, unknown, SlackIncomingWebhookRequest>('/scrapbox', async (req) => {
+		await slack.chat.postMessage(
+			{
+				channel: process.env.CHANNEL_SCRAPBOX,
+				icon_emoji: ':scrapbox:',
+				...req.body,
+				attachments: await Promise.all(req.body.attachments.map(
+					async (attachment) => await isMuted(attachment.title_link) ? maskAttachment(attachment) : attachment
+				)),
+			}
+		);
+		return '';
+	});
+
+	next();
+});
+