fix: update comments to clarify test environment usage and remove unused state.js file

Author: hakatashi

atequiz/index.js

@@ -1,4 +1,4 @@
-// XXX: このファイルは mahjong/index.js (CJS) が require('../atequiz/index') でロードするために存在するスタブ。
+// XXX: このファイルは mahjong/index.js (CJS) がテスト環境で require('../atequiz/index') でロードするために存在するスタブ。
 // mahjong/index.js は CJS 形式のため Vite のモジュール解決をバイパスし、Node の CJS ローダーが
 // .ts 拡張子を解決できないので、atequiz/index.ts の代わりにこの .js スタブが必要になっている。
 // プロジェクトの ESM 化（または mahjong/index.js の TypeScript 化）完了後は必ずこのファイルを削除すること。(#846)

deploy/index.js

@@ -1,4 +1,4 @@
-// XXX: このファイルは mahjong/index.js (CJS) が require('../deploy/index') でロードするために存在するスタブ。
+// XXX: このファイルは mahjong/index.js (CJS) がテスト環境で require('../deploy/index') でロードするために存在するスタブ。
 // mahjong/index.js は CJS 形式のため Vite のモジュール解決をバイパスし、Node の CJS ローダーが
 // .ts 拡張子を解決できないので、deploy/index.ts の代わりにこの .js スタブが必要になっている。
 // プロジェクトの ESM 化（または mahjong/index.js の TypeScript 化）完了後は必ずこのファイルを削除すること。(#846)

lib/logger.js

@@ -1,5 +1,5 @@
 // XXX: このファイルは hangman/index.js・summary/index.js・summary/summary_writer.js (CJS) が
-// require('../lib/logger') でロードするために存在するスタブ。
+// テスト環境で require('../lib/logger') でロードするために存在するスタブ。
 // これらのファイルは CJS 形式のため Vite のモジュール解決をバイパスし、Node の CJS ローダーが
 // .ts 拡張子を解決できないので、lib/logger.ts の代わりにこの .js スタブが必要になっている。
 // プロジェクトの ESM 化（または各 CJS ファイルの TypeScript 化）完了後は必ずこのファイルを削除すること。(#846)

lib/slackMock.ts

@@ -4,23 +4,28 @@ import last from 'lodash/last.js';
 import type {SlackInterface} from './slack';
 import {createMessageAdapter} from '@slack/interactive-messages';
 import type {BlockAction} from '@slack/bolt';
-import {vi, type MockInstance} from 'vitest';
+import {vi, type Mock} from 'vitest';
 
 // https://vitest.dev/api/mock.html
 const mockMethodCalls = [
+	'getMockImplementation',
+	'getMockName',
+	'mockClear',
+	'mockName',
 	'mockImplementation',
 	'mockImplementationOnce',
-	'mockReturnThis',
-	'mockReturnValue',
-	'mockReturnValueOnce',
-	'mockResolvedValue',
-	'mockResolvedValueOnce',
+	'withImplementation',
 	'mockRejectedValue',
 	'mockRejectedValueOnce',
-	'mockRestore',
-	'mockClear',
 	'mockReset',
-	'mockName',
+	'mockRestore',
+	'mockResolvedValue',
+	'mockResolvedValueOnce',
+	'mockReturnThis',
+	'mockReturnValue',
+	'mockReturnValueOnce',
+	'mockThrow',
+	'mockThrowOnce',
 ] as const;
 
 const isMockMethodCall = (name: string): name is (typeof mockMethodCalls)[number] => (
@@ -33,15 +38,16 @@ interface MockWebClient extends Record<string, MockWebClient> {
 
 const createWebClient = (
 	fallbackFn: (stack: string[], ...args: any[]) => Promise<any>,
-	registeredMocks: Map<string, MockInstance>,
+	registeredMocks: Map<string, Mock>,
 ) => {
 	const handler = (stack: string[]): MockWebClient => {
 		return new Proxy(
 			(...args: any[]) => {
 				const path = stack.join('.');
 				const methodName = last(stack);
-				if (registeredMocks.has(path)) {
-					return (registeredMocks.get(path) as unknown as (...args: any[]) => any)(...args);
+				const registeredMock = registeredMocks.get(path);
+				if (registeredMock !== undefined) {
+					return registeredMock(...args);
 				}
 				if (isMockMethodCall(methodName)) {
 					const mock = vi.fn();
@@ -139,7 +145,7 @@ export default class SlackMock extends EventEmitter implements SlackInterface {
 	fakeTimestamp = '1234567890.123456';
 
 	readonly eventClient: MockTeamEventClient;
-	readonly registeredMocks: Map<string, MockInstance>;
+	readonly registeredMocks: Map<string, Mock>;
 	readonly webClient: WebClient;
 	readonly messageClient: ReturnType<typeof createMessageAdapter> & MockMessageClient;
 

lib/slackUtils.js

@@ -1,4 +1,4 @@
-// XXX: このファイルは anime/index.js・hangman/index.js (CJS) が require('../lib/slackUtils') で
+// XXX: このファイルは anime/index.js・hangman/index.js (CJS) がテスト環境で require('../lib/slackUtils') で
 // ロードするために存在するスタブ。
 // これらのファイルは CJS 形式のため Vite のモジュール解決をバイパスし、Node の CJS ローダーが
 // .ts 拡張子を解決できないので、lib/slackUtils.ts の代わりにこの .js スタブが必要になっている。

lib/state.js

@@ -2,44 +2,28 @@ import lyrics from './index';
 import Slack from '../lib/slackMock';
 import axios from 'axios';
 import type {AxiosResponse} from 'axios';
-import { stripIndent } from 'common-tags';
+import { stripIndent, oneLineTrim } from 'common-tags';
 
-vi.mock('scrape-it', async (importOriginal) => {
-    const actual = await importOriginal<typeof import('scrape-it')>();
-    const {scrapeHTML} = actual;
-    const searchHtml = [
-        '<html><body><dl id="search_list">',
-        '<dt><span><a href="/song/159792/">とまどい→レシピ</a></span>',
-        '<a>みかくにんぐッ!</a>（作詞：<a>Junky</a>/作曲：<a>Junky</a>）</dt>',
-        '<dd></dd></dl></body></html>',
-    ].join('');
-    const songHtml = [
-        '<html><head><link rel="canonical" href="https://www.uta-net.com/song/159792/"></head>',
-        '<body><div id="main"><div class="row"><div><div><div><div>',
-        '<h2>とまどい→レシピ</h2>',
-        '<h3><a><span itemprop="byArtist name">みかくにんぐッ!</span></a></h3>',
-        '</div><div></div><div><p class="detail">',
-        '作詞：<a href="/lyricist/7740/" itemprop="lyricist">Junky</a><br>',
-        '作曲：<a href="/composer/9401/" itemprop="composer">Junky</a><br>',
-        '</p></div></div></div></div></div>',
-        '<div id="kashi"><div><div id="kashi_area">',
-        '略<br><br>',
-        '朝目が覚めたらもう昨日みたいな日常はなくて<br>',
-        '「ホントあぁもう...えっとどうしよう」<br>',
-        'ため息混じりに練るお菓子と妄想のレシピの中に<br>',
-        '恋心入っちゃった<br><br>',
-        '略</div></div></div></div></body></html>',
-    ].join('');
-    return {
-        default: vi.fn(async (url: any, opts: any) => {
-            if (String(url).includes('index_search')) return {data: scrapeHTML(searchHtml, opts)};
-            if (String(url).includes('/song/')) return {data: scrapeHTML(songHtml, opts)};
-            return {data: {}};
-        }),
-        scrapeHTML,
+vi.mock('axios');
+
+// scrape-itはCJSのrequire経由でaxiosを呼ぶため、ESMモックが届かない。
+// そのためscrape-itをモックし、内部でモック済みaxiosを使って同じURLルーティングを通す。
+vi.mock('scrape-it', async () => {
+    const {load} = await vi.importActual<typeof import('cheerio')>('cheerio');
+    const {default: axiosFn} = await import('axios');
+    const scrapeItCoreModule = await vi.importActual<any>('scrape-it-core');
+    const scrapeHTML: ($: any, opts: any) => any =
+        typeof scrapeItCoreModule === 'function' ? scrapeItCoreModule : scrapeItCoreModule.default;
+
+    const scrapeIt = async <T>(url: string, opts: object): Promise<{data: T}> => {
+        const res = await axiosFn(url) as {data: string};
+        const $ = load(res.data);
+        return {data: scrapeHTML($, opts) as T};
     };
+    (scrapeIt as any).scrapeHTML = scrapeHTML;
+
+    return {default: scrapeIt};
 });
-vi.mock('axios');
 
 let slack: Slack = null;
 
@@ -51,8 +35,55 @@ beforeEach(async () => {
 
 describe('lyrics', () => {
     it('responds to @lyrics query', async () => {
+        const searchHtml = oneLineTrim`
+            <html><body><dl id="search_list">
+                <dt>
+                    <span><a href="/song/159792/">とまどい→レシピ</a></span>
+                    <a>みかくにんぐッ!</a>　（作詞：<a>Junky</a>/作曲：<a>Junky</a>）
+                </dt>
+                <dd></dd>
+            </dl></body></html>`;
+        const songHtml = oneLineTrim`
+            <html><head>
+                <link rel="canonical" href="https://www.uta-net.com/song/159792/">
+            </head><body><div id="main">
+                <div class="row"><div><div><div>
+                    <div>
+                        <h2>とまどい→レシピ</h2>
+                        <h3><a><span itemprop="byArtist name">みかくにんぐッ!</span></a></h3>
+                    </div>
+                    <div></div>
+                    <div>
+                        <p>未確認で進行形 オープニング</p>
+                        <p class="detail">
+                            作詞：<a href="/lyricist/7740/" itemprop="lyricist">Junky</a><br>
+                            作曲：<a href="/composer/9401/" itemprop="composer">Junky</a><br>
+                            発売日：2014/02/19<br>                                    この曲の表示回数：106,837回
+                        </p>
+                    </div>
+                </div></div></div></div>
+                <div id="kashi"><div><div id="kashi_area">
+                    略
+                    <br><br>
+                    朝目が覚めたらもう昨日みたいな日常はなくて
+                    <br>
+                    「ホントあぁもう...えっとどうしよう」
+                    <br>
+                    ため息混じりに練るお菓子と妄想のレシピの中に
+                    <br>
+                    恋心入っちゃった
+                    <br><br>
+                    略
+                </div></div></div>
+            </div></body></html>`;
         const mockAxios = vi.mocked(axios);
         mockAxios.mockImplementation(async (url: string) => {
+            if (url.includes('index_search')) {
+                return {data: searchHtml} as AxiosResponse;
+            }
+            if (url.includes('song')) {
+                return {data: songHtml} as AxiosResponse;
+            }
             if (url.includes('itunes')) {
                 return {data: {
                     resultCount: 1,

lyrics/index.test.ts

@@ -1,4 +1,4 @@
-// XXX: このファイルは prime/index.js (CJS) が require('./primes') でロードするために存在する。
+// XXX: このファイルは prime/index.js (CJS) がテスト環境で require('./primes') でロードするために存在する。
 // prime/index.js は CJS 形式のため Vite のモジュール解決をバイパスし、Node の CJS ローダーが
 // .ts 拡張子を解決できないので、primes.ts の代わりにこの .js ファイルが必要になっている。
 // プロジェクトの ESM 化（または prime/index.js の TypeScript 化）完了後は必ずこのファイルを削除すること。(#846)