aboutsummaryrefslogtreecommitdiff
path: root/test/playwright/playwright-util.js
blob: 5481eb75af376400805a94144a18722b62e4e611 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
 * Copyright (C) 2023-2024  Yomitan Authors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

import {test as base, chromium} from '@playwright/test';
import path from 'path';
import {fileURLToPath} from 'url';

const dirname = path.dirname(fileURLToPath(import.meta.url));

export const root = path.join(dirname, '..', '..');

export const test = base.extend({
    // eslint-disable-next-line no-empty-pattern
    context: async ({}, use) => {
        const pathToExtension = path.join(root, 'ext');
        const context = await chromium.launchPersistentContext('', {
            // Disabled: headless: false,
            args: [
                '--headless=new',
                `--disable-extensions-except=${pathToExtension}`,
                `--load-extension=${pathToExtension}`
            ]
        });
        await use(context);
        await context.close();
    },
    extensionId: async ({context}, use) => {
        let [background] = context.serviceWorkers();
        if (!background) {
            background = await context.waitForEvent('serviceworker');
        }

        const extensionId = background.url().split('/')[2];
        await use(extensionId);
    }
});

export const expect = test.expect;

/**
 * @returns {Map<string, string>}
 */
export function getMockModelFields() {
    return new Map([
        ['Word', '{expression}'],
        ['Reading', '{furigana-plain}'],
        ['Sentence', '{clipboard-text}'],
        ['Audio', '{audio}']
    ]);
}

/**
 * @param {import('playwright').Route} route
 * @returns {Promise<void>}
 */
export async function mockAnkiRouteHandler(route) {
    try {
        /** @type {unknown} */
        const requestJson = route.request().postDataJSON();
        if (typeof requestJson !== 'object' || requestJson === null) {
            throw new Error(`Invalid request type: ${typeof requestJson}`);
        }
        const body = getResponseBody(/** @type {import('core').SerializableObject} */ (requestJson).action);
        const responseJson = {
            status: 200,
            contentType: 'text/json',
            body: JSON.stringify(body)
        };
        await route.fulfill(responseJson);
    } catch {
        return await route.abort();
    }
}

/**
 * @param {import('playwright').Page} page
 * @param {string} text
 * @returns {Promise<void>}
 */
export const writeToClipboardFromPage = async (page, text) => {
    await page.evaluate(`navigator.clipboard.writeText('${text}')`);
};

/**
 * @returns {Record<string, unknown>}
 */
export function getExpectedAddNoteBody() {
    return {
        version: 2,
        action: 'addNote',
        params: {
            note: {
                fields: {
                    Word: '読む',
                    Reading: '読[よ]む',
                    Audio: '[sound:mock_audio.mp3]',
                    Sentence: '読むの例文'
                },
                tags: ['yomitan'],
                deckName: 'Mock Deck',
                modelName: 'Mock Model',
                options: {
                    allowDuplicate: true,
                    duplicateScope: 'collection',
                    duplicateScopeOptions: {
                        deckName: null,
                        checkChildren: false,
                        checkAllModels: false
                    }
                }
            }
        }
    };
}

/**
 * @param {unknown} action
 * @returns {unknown}
 * @throws {Error}
 */
function getResponseBody(action) {
    switch (action) {
        case 'version': return 6;
        case 'deckNames': return ['Mock Deck'];
        case 'modelNames': return ['Mock Model'];
        case 'modelFieldNames': return [...getMockModelFields().keys()];
        case 'canAddNotes': return [true, true];
        case 'storeMediaFile': return 'mock_audio.mp3';
        case 'addNote': return 102312488912;
        default: throw new Error(`Unknown action: ${action}`);
    }
}