Merge pull request #845 from tsg-ut/slack-mock-ts

refactor: lib/slackMockをTypeScript化

achievement-quiz/index.test.ts

@@ -1,8 +1,7 @@
 import achievementQuiz from './index';
+import Slack from '../lib/slackMock';
 
-const Slack = require('../lib/slackMock.js');
-
-let slack: typeof Slack;
+let slack: Slack;
 
 beforeEach(() => {
   slack = new Slack();

achievements/index_production.test.ts

@@ -2,8 +2,7 @@
 import noop from 'lodash/noop';
 // @ts-expect-error
 import MockFirebase from 'mock-cloud-firestore';
-// @ts-expect-error
-import Slack from '../lib/slackMock.js';
+import Slack from '../lib/slackMock';
 
 import achievements from './index_production';
 

ahokusa/index.test.js

@@ -3,7 +3,7 @@
 jest.mock('../achievements');
 
 const ahokusa = require('./index.js');
-const Slack = require('../lib/slackMock.js');
+const {default: Slack} = require('../lib/slackMock.ts');
 
 let slack = null;
 

amongyou/index.ts

@@ -1,6 +1,6 @@
 import {constants, promises as fs} from 'fs';
 import path from 'path';
-import type {TeamEventClient} from '../lib/slackEventClient';
+import type {EventEmitter} from 'events';
 import {ChatPostMessageArguments, WebClient} from '@slack/web-api';
 import {stripIndent} from 'common-tags';
 import type {FastifyPluginCallback} from 'fastify';
@@ -131,7 +131,7 @@ const getBlocks = () => [
 ];
 
 class Among {
-	eventClient: TeamEventClient;
+	eventClient: EventEmitter;
 
 	slack: WebClient;
 
@@ -149,7 +149,7 @@ class Among {
 		slack,
 		slackInteractions,
 	}: {
-		eventClient: TeamEventClient,
+		eventClient: EventEmitter,
 		slack: WebClient,
 		slackInteractions: any,
 	}) {

atequiz/index.ts

@@ -1,5 +1,5 @@
 import { WebAPICallOptions, WebClient } from '@slack/web-api';
-import type { TeamEventClient } from '../lib/slackEventClient';
+import type { EventEmitter } from 'events';
 import { SlackInterface } from '../lib/slack';
 import { ChatPostMessageArguments } from '@slack/web-api/dist/methods';
 import assert from 'assert';
@@ -52,7 +52,7 @@ export const typicalMessageTextsGenerator = {
  * To use other judge/watSecGen/ngReaction, please extend this class.
  */
 export class AteQuiz {
-  eventClient: TeamEventClient;
+  eventClient: EventEmitter;
   slack: WebClient;
   problem: AteQuizProblem;
   ngReaction: string | null = 'no_good';

channel-notifier/index.test.js

@@ -2,7 +2,7 @@
 
 jest.mock('axios');
 
-const Slack = require('../lib/slackMock.js');
+const {default: Slack} = require('../lib/slackMock.ts');
 const channelNotifier = require('./index.js');
 
 let slack = null;

checkin/index.test.js

@@ -3,7 +3,7 @@
 jest.mock('axios');
 
 const axios = require('axios');
-const Slack = require('../lib/slackMock.js');
+const {default: Slack} = require('../lib/slackMock.ts');
 const checkin = require('./index.js');
 
 let slack = null;

dajare/index.test.js

@@ -5,7 +5,7 @@ jest.mock('./tokenize.js');
 jest.mock('../achievements');
 
 const dajare = require('./index.js');
-const Slack = require('../lib/slackMock.js');
+const {default: Slack} = require('../lib/slackMock.ts');
 const tokenize = require('./tokenize.js');
 
 tokenize.virtualTokens = {

discord/hayaoshiUtils.test.ts

@@ -3,6 +3,11 @@
 import {inspect} from 'util';
 import {extractValidAnswers} from './hayaoshiUtils';
 
+jest.mock('../hayaoshi', () => ({
+	isCorrectAnswer: jest.fn(),
+	normalize: jest.fn(),
+}));
+
 const testCases: [string, string, string[]][] = [
 	['', 'リトグラフ[lithograph]【「石版画」「石版印刷」「リトグラフィー[lithographie]」も○】',
 		['リトグラフ', 'lithograph', '石版画', '石版印刷', 'リトグラフィー', 'lithographie'],

emoji-notifier/index.test.js

@@ -1,6 +1,6 @@
 /* eslint-env node, jest */
 
-const Slack = require('../lib/slackMock.js');
+const {default: Slack} = require('../lib/slackMock.ts');
 const emojiNotifier = require('./index.js');
 
 let slack = null;

hitandblow/index.test.ts

@@ -1,9 +1,8 @@
 import { stripIndent } from 'common-tags';
 import hitandblow from './';
+import Slack from '../lib/slackMock';
 
-const Slack = require('../lib/slackMock.js');
-
-let slack: typeof Slack;
+let slack: Slack;
 
 beforeEach(() => {
   slack = new Slack();

hitandblow/index.ts

@@ -1,9 +1,9 @@
-import { SlackEventAdapter } from '@slack/events-api';
 import { WebClient } from '@slack/web-api';
 import { range, shuffle, round } from 'lodash';
 import { stripIndent } from 'common-tags';
 import { unlock } from '../achievements';
 import assert from 'assert';
+import type { EventEmitter } from 'events';
 
 interface HitAndBlowHistory {
   call: number[];
@@ -17,7 +17,7 @@ class HitAndBlowState {
   thread: string | null = null;
   startDate: number | null = null;
   timer: NodeJS.Timeout | null = null;
-  inGame: boolean = false;
+  inGame = false;
   clear() {
     this.answer = [];
     this.history = [];
@@ -90,7 +90,7 @@ export default ({
   eventClient,
   webClient: slack,
 }: {
-  eventClient: SlackEventAdapter;
+  eventClient: EventEmitter;
   webClient: WebClient;
 }) => {
   const state = new HitAndBlowState();

lib/slack.ts

@@ -6,12 +6,13 @@ import * as sqlite from 'sqlite';
 import sqlite3 from 'sqlite3';
 import path from 'path';
 import {TeamEventClient} from './slackEventClient';
+import type {EventEmitter} from 'events';
 import {Deferred} from './utils';
 import {Token} from '../oauth/tokens';
 
 export interface SlackInterface {
 	webClient: WebClient;
-	eventClient: TeamEventClient;
+	eventClient: EventEmitter & Pick<TeamEventClient, keyof TeamEventClient>;
 	messageClient: ReturnType<typeof createMessageAdapter>;
 };
 

lib/slackCache.test.ts

@@ -8,7 +8,6 @@ import type {
 	EmojiListArguments,
 	EmojiListResponse,
 } from '@slack/web-api';
-// @ts-expect-error
 import Slack from './slackMock';
 import SlackCache from './slackCache';
 

lib/slackCache.ts

@@ -1,10 +1,10 @@
 import {get} from 'lodash';
+import type {EventEmitter} from 'events';
 import type {Token} from '../oauth/tokens';
 import {Deferred} from './utils';
 import {TeamEventClient} from './slackEventClient';
 import logger from './logger';
 
-import type {SlackEventAdapter} from '@slack/events-api';
 import type {Reaction} from '@slack/web-api/dist/response/ConversationsHistoryResponse';
 import type {Member} from '@slack/web-api/dist/response/UsersListResponse';
 import type {
@@ -32,7 +32,7 @@ interface WebClient {
 
 interface Config {
 	token: Token;
-	eventClient: SlackEventAdapter;
+	eventClient: EventEmitter;
 	webClient: WebClient;
 	enableReactions?: boolean;
 }

lib/slackEventClient.ts

@@ -1,27 +1,27 @@
-import type {SlackEventAdapter} from '@slack/events-api';
+import type {EventEmitter} from 'events';
 
 export class TeamEventClient {
-	private readonly eventAdapter: SlackEventAdapter;
-	private readonly team: string;
+	readonly #eventAdapter: EventEmitter;
+	readonly #team: string;
 
 	// contract: 渡されるeventAdapterは、EventAdapterOptions.includeBodyがtrueでなければならない。
-	constructor(eventAdapter: SlackEventAdapter, team: string) {
-		this.eventAdapter = eventAdapter;
-		this.team = team;
+	constructor(eventAdapter: EventEmitter, team: string) {
+		this.#eventAdapter = eventAdapter;
+		this.#team = team;
 	}
 
 	// listen on events against all teams.
 	onAllTeam(event: string, listener: (...args: any[]) => void): any {
-		return this.eventAdapter.on(event, listener);
+		return this.#eventAdapter.on(event, listener);
 	}
 	// listen on events against the team.
 	on(event: string, listener: (...args: any[]) => void): any {
-		return this.eventAdapter.on(event, (...args: any[]) => {
+		return this.#eventAdapter.on(event, (...args: any[]) => {
 			// https://slack.dev/node-slack-sdk/events-api#receive-additional-event-data
 			// https://github.com/slackapi/node-slack-sdk/blob/3e9c483c593d6aa28f6f5680f287722df3327609/packages/events-api/src/http-handler.ts#L212-L223
 			// https://api.slack.com/apis/connections/events-api#the-events-api__receiving-events__events-dispatched-as-json
 			// args: [body.event, body: {team_id: string}]
-			if (args[1].team_id === this.team) {
+			if (args[1].team_id === this.#team) {
 				listener(...args);
 			}
 		});