rsesot/misskey
1
0
Fork 0
forked from mirrors/misskey
Code Pull Requests Activity

chore(deps): update [misskey-js] update dependencies (major) (#16177)

Browse Source 
* chore(deps): update [misskey-js] update dependencies

* enhance(misskey-js): テストスイートをVitestに置き換え (#16340)

* enhance(misskey-js): テストスイートをVitestに置き換え

* fix: 変なものが混入

* fix test, lint

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: かっこかり <67428053+kakkokari-gtyih@users.noreply.github.com>
This commit is contained in:
renovate[bot]
2025-08-02 16:20:08 +09:00
committed by GitHub
parent 905d3c87f1
commit 6d54370f01
11 changed files with 233 additions and 595 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
packages/misskey-js/.swcrc
View File

@@ -1,23 +0,0 @@
{
"$schema": "https://swc.rs/schema.json",
"jsc": {
"parser": {
"syntax": "typescript",
"dynamicImport": true,
"decorators": true
},
"transform": {
"legacyDecorator": true,
"decoratorMetadata": true
},
"experimental": {
"keepImportAssertions": true
},
"baseUrl": "src",
"paths": {
"@/*": ["*"]
},
"target": "es2022"
},
"minify": false
}

2
packages/misskey-js/eslint.config.js
View File

@@ -9,7 +9,7 @@ export default [
'**/node_modules',
'built',
'coverage',
'jest.config.ts',
'vitest.config.ts',
'test',
'test-d',
'generator',

2
packages/misskey-js/generator/package.json
View File

@@ -7,7 +7,7 @@
"generate": "tsx src/generator.ts && eslint ./built/**/*.ts --fix"
},
"devDependencies": {
"@readme/openapi-parser": "2.7.0",
"@readme/openapi-parser": "5.0.0",
"@types/node": "22.16.4",
"@typescript-eslint/eslint-plugin": "8.37.0",
"@typescript-eslint/parser": "8.37.0",

207
packages/misskey-js/jest.config.cjs
View File

@@ -1,207 +0,0 @@
/*
* For a detailed explanation regarding each configuration property and type check, visit:
* https://jestjs.io/docs/en/configuration.html
*/
module.exports = {
// All imported modules in your tests should be mocked automatically
// automock: false,
// Stop running tests after `n` failures
// bail: 0,
// The directory where Jest should store its cached dependency information
// cacheDirectory: "C:\\Users\\ai\\AppData\\Local\\Temp\\jest",
// Automatically clear mock calls and instances between every test
// clearMocks: false,
// Indicates whether the coverage information should be collected while executing the test
// collectCoverage: false,
// An array of glob patterns indicating a set of files for which coverage information should be collected
// collectCoverageFrom: undefined,
// The directory where Jest should output its coverage files
coverageDirectory: "coverage",
// An array of regexp pattern strings used to skip coverage collection
// coveragePathIgnorePatterns: [
// "\\\\node_modules\\\\"
// ],
// Indicates which provider should be used to instrument code for coverage
coverageProvider: "v8",
// A list of reporter names that Jest uses when writing coverage reports
// coverageReporters: [
// "json",
// "text",
// "lcov",
// "clover"
// ],
// An object that configures minimum threshold enforcement for coverage results
// coverageThreshold: undefined,
// A path to a custom dependency extractor
// dependencyExtractor: undefined,
// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,
// Force coverage collection from ignored files using an array of glob patterns
// forceCoverageMatch: [],
// A path to a module which exports an async function that is triggered once before all test suites
// globalSetup: undefined,
// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: undefined,
// A set of global variables that need to be available in all test environments
// globals: {},
// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
// maxWorkers: "50%",
// An array of directory names to be searched recursively up from the requiring module's location
// moduleDirectories: [
// "node_modules"
// ],
// An array of file extensions your modules use
// moduleFileExtensions: [
// "js",
// "json",
// "jsx",
// "ts",
// "tsx",
// "node"
// ],
// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
moduleNameMapper: {
// Do not resolve .wasm.js to .wasm by the rule below
'^(.+)\\.wasm\\.js$': '$1.wasm.js',
// SWC converts @/foo/bar.js to `../../src/foo/bar.js`, and then this rule
// converts it again to `../../src/foo/bar` which then can be resolved to
// `.ts` files.
// See https://github.com/swc-project/jest/issues/64#issuecomment-1029753225
// TODO: Use `--allowImportingTsExtensions` on TypeScript 5.0 so that we can
// directly import `.ts` files without this hack.
'^((?:\\.{1,2}|[A-Z:])*/.*)\\.js$': '$1',
},
// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
// modulePathIgnorePatterns: [],
// Activates notifications for test results
// notify: false,
// An enum that specifies notification mode. Requires { notify: true }
// notifyMode: "failure-change",
// A preset that is used as a base for Jest's configuration
// preset: undefined,
// Run tests from one or more projects
// projects: undefined,
// Use this configuration option to add custom reporters to Jest
// reporters: undefined,
// Automatically reset mock state between every test
// resetMocks: false,
// Reset the module registry before running each individual test
// resetModules: false,
// A path to a custom resolver
// resolver: undefined,
// Automatically restore mock state between every test
// restoreMocks: false,
// The root directory that Jest should scan for tests and modules within
// rootDir: undefined,
// A list of paths to directories that Jest should use to search for files in
roots: [
"<rootDir>"
],
// Allows you to use a custom runner instead of Jest's default test runner
// runner: "jest-runner",
// The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: [],
// A list of paths to modules that run some code to configure or set up the testing framework before each test
// setupFilesAfterEnv: [],
// The number of seconds after which a test is considered as slow and reported as such in the results.
// slowTestThreshold: 5,
// A list of paths to snapshot serializer modules Jest should use for snapshot testing
// snapshotSerializers: [],
// The test environment that will be used for testing
testEnvironment: "node",
// Options that will be passed to the testEnvironment
// testEnvironmentOptions: {},
// Adds a location field to test results
// testLocationInResults: false,
// The glob patterns Jest uses to detect test files
testMatch: [
"**/__tests__/**/*.[jt]s?(x)",
"**/?(*.)+(spec|test).[tj]s?(x)",
"<rootDir>/test/**/*"
],
// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
// testPathIgnorePatterns: [
// "\\\\node_modules\\\\"
// ],
// The regexp pattern or array of patterns that Jest uses to detect test files
// testRegex: [],
// This option allows the use of a custom results processor
// testResultsProcessor: undefined,
// This option allows use of a custom test runner
// testRunner: "jasmine2",
// This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
// testURL: "http://localhost",
// Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
// timers: "real",
// A map from regular expressions to paths to transformers
transform: {
"^.+\\.(t|j)sx?$": ["@swc/jest"],
},
// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
// transformIgnorePatterns: [
// "\\\\node_modules\\\\",
// "\\.pnp\\.[^\\\\]+$"
// ],
// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
// unmockedModulePathPatterns: undefined,
// Indicates whether each individual test should be reported during the run
// verbose: undefined,
// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
// watchPathIgnorePatterns: [],
// Whether to use watchman for file crawling
// watchman: true,
};

19
packages/misskey-js/package.json
View File

@@ -25,8 +25,8 @@
"eslint": "eslint './**/*.{js,jsx,ts,tsx}'",
"typecheck": "tsc --noEmit",
"lint": "pnpm typecheck && pnpm eslint",
"jest": "jest --coverage --detectOpenHandles",
"test": "pnpm jest && pnpm tsd",
"vitest": "vitest run --coverage",
"test": "pnpm vitest && pnpm tsd",
"update-autogen-code": "pnpm --filter misskey-js-type-generator generate && ncp generator/built/autogen src/autogen"
},
"repository": {
@@ -36,22 +36,19 @@
},
"devDependencies": {
"@microsoft/api-extractor": "7.52.8",
"@swc/jest": "0.2.39",
"@types/jest": "29.5.14",
"@types/node": "22.16.4",
"@typescript-eslint/eslint-plugin": "8.37.0",
"@typescript-eslint/parser": "8.37.0",
"jest": "29.7.0",
"jest-fetch-mock": "3.0.3",
"jest-websocket-mock": "2.5.0",
"mock-socket": "9.3.1",
"@vitest/coverage-v8": "3.2.4",
"esbuild": "0.25.6",
"execa": "9.6.0",
"glob": "11.0.3",
"ncp": "2.0.0",
"nodemon": "3.1.10",
"execa": "8.0.1",
"tsd": "0.32.0",
"typescript": "5.8.3",
"esbuild": "0.25.6",
"glob": "11.0.3"
"vitest": "3.2.4",
"vitest-websocket-mock": "0.5.0"
},
"files": [
"built"

1
packages/misskey-js/test-d/api.ts
View File

@@ -1,3 +1,4 @@
import { describe, test } from 'vitest';
import { expectType } from 'tsd';
import * as Misskey from '../src/index.js';

1
packages/misskey-js/test-d/streaming.ts
View File

@@ -1,3 +1,4 @@
import { describe, test } from 'vitest';
import { expectType } from 'tsd';
import * as Misskey from '../src/index.js';

266
packages/misskey-js/test/api.ts
View File

@@ -1,41 +1,24 @@
import { enableFetchMocks } from 'jest-fetch-mock';
import { vi, describe, test, expect } from 'vitest';
import { APIClient, isAPIError } from '../src/api.js';
enableFetchMocks();
function getFetchCall(call: any[]) {
const { body, method } = call[1];
const contentType = call[1].headers['Content-Type'];
if (
body == null ||
(contentType === 'application/json' && typeof body !== 'string') ||
(contentType === 'multipart/form-data' && !(body instanceof FormData))
) {
throw new Error('invalid body');
}
return {
url: call[0],
method: method,
contentType: contentType,
body: body instanceof FormData ? Object.fromEntries(body.entries()) : JSON.parse(body),
};
}
describe('API', () => {
test('success', async () => {
fetchMock.resetMocks();
fetchMock.mockResponse(async (req) => {
const body = await req.json();
if (req.method == 'POST' && req.url == 'https://misskey.test/api/i') {
if (body.i === 'TOKEN') {
return JSON.stringify({ id: 'foo' });
} else {
return { status: 400 };
const fetchMock = vi
.spyOn(globalThis, 'fetch')
.mockImplementation(async (url, options) => {
if (url === 'https://misskey.test/api/i' && options?.method === 'POST') {
if (options.body) {
const body = JSON.parse(options.body as string);
if (body.i === 'TOKEN') {
return new Response(JSON.stringify({ id: 'foo' }), { status: 200 });
}
}
return new Response(null, { status: 400 });
}
} else {
return { status: 404 };
}
});
return new Response(null, { status: 404 });
});
const cli = new APIClient({
origin: 'https://misskey.test',
@@ -48,28 +31,38 @@ describe('API', () => {
id: 'foo'
});
expect(getFetchCall(fetchMock.mock.calls[0])).toEqual({
url: 'https://misskey.test/api/i',
fetch('https://misskey.test/api/i', {
method: 'POST',
contentType: 'application/json',
body: { i: 'TOKEN' }
})
expect(fetchMock).toHaveBeenCalledWith('https://misskey.test/api/i', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
credentials: 'omit',
cache: 'no-cache',
body: JSON.stringify({ i: 'TOKEN' }),
});
fetchMock.mockRestore();
});
test('with params', async () => {
fetchMock.resetMocks();
fetchMock.mockResponse(async (req) => {
const body = await req.json();
if (req.method == 'POST' && req.url == 'https://misskey.test/api/notes/show') {
if (body.i === 'TOKEN' && body.noteId === 'aaaaa') {
return JSON.stringify({ id: 'foo' });
} else {
return { status: 400 };
const fetchMock = vi
.spyOn(globalThis, 'fetch')
.mockImplementation(async (url, options) => {
if (url === 'https://misskey.test/api/notes/show' && options?.method === 'POST') {
if (options.body) {
const body = JSON.parse(options.body as string);
if (body.i === 'TOKEN' && body.noteId === 'aaaaa') {
return new Response(JSON.stringify({ id: 'foo' }), { status: 200 });
}
}
return new Response(null, { status: 400 });
}
} else {
return { status: 404 };
}
});
return new Response(null, { status: 404 });
});
const cli = new APIClient({
origin: 'https://misskey.test',
@@ -82,23 +75,34 @@ describe('API', () => {
id: 'foo'
});
expect(getFetchCall(fetchMock.mock.calls[0])).toEqual({
url: 'https://misskey.test/api/notes/show',
expect(fetchMock).toHaveBeenCalledWith('https://misskey.test/api/notes/show', {
method: 'POST',
contentType: 'application/json',
body: { i: 'TOKEN', noteId: 'aaaaa' }
headers: {
'Content-Type': 'application/json',
},
credentials: 'omit',
cache: 'no-cache',
body: JSON.stringify({ noteId: 'aaaaa', i: 'TOKEN' }),
});
fetchMock.mockRestore();
});
test('multipart/form-data', async () => {
fetchMock.resetMocks();
fetchMock.mockResponse(async (req) => {
if (req.method == 'POST' && req.url == 'https://misskey.test/api/drive/files/create') {
return JSON.stringify({ id: 'foo' });
} else {
return { status: 404 };
}
});
const fetchMock = vi
.spyOn(globalThis, 'fetch')
.mockImplementation(async (url, options) => {
if (url === 'https://misskey.test/api/drive/files/create' && options?.method === 'POST') {
if (options.body instanceof FormData) {
const file = options.body.get('file');
if (file instanceof File && file.name === 'foo.txt') {
return new Response(JSON.stringify({ id: 'foo' }), { status: 200 });
}
}
return new Response(null, { status: 400 });
}
return new Response(null, { status: 404 });
});
const cli = new APIClient({
origin: 'https://misskey.test',
@@ -116,26 +120,26 @@ describe('API', () => {
id: 'foo'
});
expect(getFetchCall(fetchMock.mock.calls[0])).toEqual({
url: 'https://misskey.test/api/drive/files/create',
expect(fetchMock).toHaveBeenCalledWith('https://misskey.test/api/drive/files/create', {
method: 'POST',
contentType: undefined,
body: {
i: 'TOKEN',
file: testFile,
}
body: expect.any(FormData),
headers: {},
credentials: 'omit',
cache: 'no-cache',
});
fetchMock.mockRestore();
});
test('204 No Content で null が返る', async () => {
fetchMock.resetMocks();
fetchMock.mockResponse(async (req) => {
if (req.method == 'POST' && req.url == 'https://misskey.test/api/reset-password') {
return { status: 204 };
} else {
return { status: 404 };
}
});
const fetchMock = vi
.spyOn(globalThis, 'fetch')
.mockImplementation(async (url, options) => {
if (url === 'https://misskey.test/api/reset-password' && options?.method === 'POST') {
return new Response(null, { status: 204 });
}
return new Response(null, { status: 404 });
});
const cli = new APIClient({
origin: 'https://misskey.test',
@@ -146,37 +150,42 @@ describe('API', () => {
expect(res).toEqual(null);
expect(getFetchCall(fetchMock.mock.calls[0])).toEqual({
url: 'https://misskey.test/api/reset-password',
expect(fetchMock).toHaveBeenCalledWith('https://misskey.test/api/reset-password', {
method: 'POST',
contentType: 'application/json',
body: { i: 'TOKEN', token: 'aaa', password: 'aaa' }
headers: {
'Content-Type': 'application/json',
},
credentials: 'omit',
cache: 'no-cache',
body: JSON.stringify({ token: 'aaa', password: 'aaa', i: 'TOKEN' }),
});
fetchMock.mockRestore();
});
test('インスタンスの credential が指定されていても引数で credential が null ならば null としてリクエストされる', async () => {
fetchMock.resetMocks();
fetchMock.mockResponse(async (req) => {
const body = await req.json();
if (req.method == 'POST' && req.url == 'https://misskey.test/api/i') {
if (typeof body.i === 'string') {
return JSON.stringify({ id: 'foo' });
} else {
return {
status: 401,
body: JSON.stringify({
error: {
message: 'Credential required.',
code: 'CREDENTIAL_REQUIRED',
id: '1384574d-a912-4b81-8601-c7b1c4085df1',
}
})
};
const fetchMock = vi
.spyOn(globalThis, 'fetch')
.mockImplementation(async (url, options) => {
if (url === 'https://misskey.test/api/i' && options?.method === 'POST') {
if (options.body) {
const body = JSON.parse(options.body as string);
if (typeof body.i === 'string') {
return new Response(JSON.stringify({ id: 'foo' }), { status: 200 });
} else {
return new Response(JSON.stringify({
error: {
message: 'Credential required.',
code: 'CREDENTIAL_REQUIRED',
id: '1384574d-a912-4b81-8601-c7b1c4085df1',
}
}), { status: 401 });
}
}
return new Response(null, { status: 400 });
}
} else {
return { status: 404 };
}
});
return new Response(null, { status: 404 });
});
try {
const cli = new APIClient({
@@ -187,24 +196,24 @@ describe('API', () => {
await cli.request('i', {}, null);
} catch (e) {
expect(isAPIError(e)).toEqual(true);
} finally {
fetchMock.mockRestore();
}
});
test('api error', async () => {
fetchMock.resetMocks();
fetchMock.mockResponse(async (req) => {
return {
status: 500,
body: JSON.stringify({
const fetchMock = vi
.spyOn(globalThis, 'fetch')
.mockImplementation(async () => {
return new Response(JSON.stringify({
error: {
message: 'Internal error occurred. Please contact us if the error persists.',
code: 'INTERNAL_ERROR',
id: '5d37dbcb-891e-41ca-a3d6-e690c97775ac',
kind: 'server',
},
})
};
});
}), { status: 500 });
});
try {
const cli = new APIClient({
@@ -216,12 +225,17 @@ describe('API', () => {
} catch (e: any) {
expect(isAPIError(e)).toEqual(true);
expect(e.id).toEqual('5d37dbcb-891e-41ca-a3d6-e690c97775ac');
} finally {
fetchMock.mockRestore();
}
});
test('network error', async () => {
fetchMock.resetMocks();
fetchMock.mockAbort();
const fetchMock = vi
.spyOn(globalThis, 'fetch')
.mockImplementation(async () => {
throw new Error('Network error');
});
try {
const cli = new APIClient({
@@ -232,17 +246,17 @@ describe('API', () => {
await cli.request('i');
} catch (e) {
expect(isAPIError(e)).toEqual(false);
} finally {
fetchMock.mockRestore();
}
});
test('json parse error', async () => {
fetchMock.resetMocks();
fetchMock.mockResponse(async (req) => {
return {
status: 500,
body: '<html>I AM NOT JSON</html>'
};
});
const fetchMock = vi
.spyOn(globalThis, 'fetch')
.mockImplementation(async () => {
return new Response('<html>I AM NOT JSON</html>', { status: 500 });
});
try {
const cli = new APIClient({
@@ -253,18 +267,18 @@ describe('API', () => {
await cli.request('i');
} catch (e) {
expect(isAPIError(e)).toEqual(false);
} finally {
fetchMock.mockRestore();
}
});
test('admin/roles/create の型が合う', async() => {
fetchMock.resetMocks();
fetchMock.mockResponse(async () => {
return {
const fetchMock = vi
.spyOn(globalThis, 'fetch')
.mockImplementation(async () => {
// 本来返すべき値は`Role`型だが、テストなのでお茶を濁す
status: 200,
body: '{}'
};
});
return new Response('{}', { status: 200 });
});
const cli = new APIClient({
origin: 'https://misskey.test',
@@ -292,5 +306,7 @@ describe('API', () => {
},
target: 'manual',
});
fetchMock.mockRestore();
})
});

3
packages/misskey-js/test/streaming.ts
View File

@@ -1,4 +1,5 @@
import WS from 'jest-websocket-mock';
import { describe, test, expect } from 'vitest';
import WS from 'vitest-websocket-mock';
import Stream from '../src/streaming.js';
describe('Streaming', () => {

17
packages/misskey-js/vitest.config.ts Normal file
View File

@@ -0,0 +1,17 @@
import { defineConfig, configDefaults } from 'vitest/config';
export default defineConfig({
test: {
include: ['test/**/*.ts'],
coverage: {
exclude: [
...configDefaults.coverage.exclude!,
'src/autogen/**/*',
'generator/**/*',
'built/**/*',
'test-d/**/*',
'build.js',
],
}
},
});