monkee.ch/monkeeShark
1
0
Fork 0
Code Pull requests Activity

chore(backend, misskey-js): add type for signup (#11043)

Browse source 
* chore(backend, misskey-js): add type for signup

* rerun
This commit is contained in:
Kagami Sascha Rosylight 2023-06-25 01:34:18 +02:00 committed by GitHub
parent a2c0573f84
commit 7bb8c71543
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
21 changed files with 354 additions and 280 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
packages/backend/test/e2e/2fa.ts
View file

@ -7,10 +7,11 @@ import * as OTPAuth from 'otpauth';
import { loadConfig } from '../../src/config.js'; import { loadConfig } from '../../src/config.js';
import { signup, api, post, react, startServer, waitFire } from '../utils.js'; import { signup, api, post, react, startServer, waitFire } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
describe('2要素認証', () => { describe('2要素認証', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
let alice: unknown; let alice: misskey.entities.MeSignup;
const config = loadConfig(); const config = loadConfig();
const password = 'test'; const password = 'test';
@ -68,7 +69,7 @@ describe('2要素認証', () => {
])); ]));
// AuthenticatorAssertionResponse.authenticatorData // AuthenticatorAssertionResponse.authenticatorData
// https://developer.mozilla.org/en-US/docs/Web/API/AuthenticatorAssertionResponse/authenticatorData // https://developer.mozilla.org/en-US/docs/Web/API/AuthenticatorAssertionResponse/authenticatorData
const credentialIdLength = Buffer.allocUnsafe(2); const credentialIdLength = Buffer.allocUnsafe(2);
credentialIdLength.writeUInt16BE(param.credentialId.length); credentialIdLength.writeUInt16BE(param.credentialId.length);
const authData = Buffer.concat([ const authData = Buffer.concat([
@ -80,7 +81,7 @@ describe('2要素認証', () => {
param.credentialId, param.credentialId,
credentialPublicKey, credentialPublicKey,
]); ]);
return { return {
attestationObject: cbor.encode({ attestationObject: cbor.encode({
fmt: 'none', fmt: 'none',
@ -98,7 +99,7 @@ describe('2要素認証', () => {
name: param.keyName, name: param.keyName,
}; };
}; };
const signinParam = (): { const signinParam = (): {
username: string, username: string,
password: string, password: string,
@ -130,7 +131,7 @@ describe('2要素認証', () => {
'hcaptcha-response'?: string | null, 'hcaptcha-response'?: string | null,
} => { } => {
// AuthenticatorAssertionResponse.authenticatorData // AuthenticatorAssertionResponse.authenticatorData
// https://developer.mozilla.org/en-US/docs/Web/API/AuthenticatorAssertionResponse/authenticatorData // https://developer.mozilla.org/en-US/docs/Web/API/AuthenticatorAssertionResponse/authenticatorData
const authenticatorData = Buffer.concat([ const authenticatorData = Buffer.concat([
rpIdHash(), rpIdHash(),
Buffer.from([0x05]), // flags(1) Buffer.from([0x05]), // flags(1)
@ -146,7 +147,7 @@ describe('2要素認証', () => {
.update(clientDataJSONBuffer) .update(clientDataJSONBuffer)
.digest(); .digest();
const privateKey = crypto.createPrivateKey(pemToSign); const privateKey = crypto.createPrivateKey(pemToSign);
const signature = crypto.createSign('SHA256') const signature = crypto.createSign('SHA256')
.update(Buffer.concat([authenticatorData, hashedclientDataJSON])) .update(Buffer.concat([authenticatorData, hashedclientDataJSON]))
.sign(privateKey); .sign(privateKey);
return { return {
@ -186,14 +187,14 @@ describe('2要素認証', () => {
token: otpToken(registerResponse.body.secret), token: otpToken(registerResponse.body.secret),
}, alice); }, alice);
assert.strictEqual(doneResponse.status, 204); assert.strictEqual(doneResponse.status, 204);
const usersShowResponse = await api('/users/show', { const usersShowResponse = await api('/users/show', {
username, username,
}, alice); }, alice);
assert.strictEqual(usersShowResponse.status, 200); assert.strictEqual(usersShowResponse.status, 200);
assert.strictEqual(usersShowResponse.body.twoFactorEnabled, true); assert.strictEqual(usersShowResponse.body.twoFactorEnabled, true);
const signinResponse = await api('/signin', { const signinResponse = await api('/signin', {
...signinParam(), ...signinParam(),
token: otpToken(registerResponse.body.secret), token: otpToken(registerResponse.body.secret),
}); });
@ -211,7 +212,7 @@ describe('2要素認証', () => {
token: otpToken(registerResponse.body.secret), token: otpToken(registerResponse.body.secret),
}, alice); }, alice);
assert.strictEqual(doneResponse.status, 204); assert.strictEqual(doneResponse.status, 204);
const registerKeyResponse = await api('/i/2fa/register-key', { const registerKeyResponse = await api('/i/2fa/register-key', {
password, password,
}, alice); }, alice);
@ -230,7 +231,7 @@ describe('2要素認証', () => {
assert.strictEqual(keyDoneResponse.status, 200); assert.strictEqual(keyDoneResponse.status, 200);
assert.strictEqual(keyDoneResponse.body.id, credentialId.toString('hex')); assert.strictEqual(keyDoneResponse.body.id, credentialId.toString('hex'));
assert.strictEqual(keyDoneResponse.body.name, keyName); assert.strictEqual(keyDoneResponse.body.name, keyName);
const usersShowResponse = await api('/users/show', { const usersShowResponse = await api('/users/show', {
username, username,
}); });
@ -267,7 +268,7 @@ describe('2要素認証', () => {
token: otpToken(registerResponse.body.secret), token: otpToken(registerResponse.body.secret),
}, alice); }, alice);
assert.strictEqual(doneResponse.status, 204); assert.strictEqual(doneResponse.status, 204);
const registerKeyResponse = await api('/i/2fa/register-key', { const registerKeyResponse = await api('/i/2fa/register-key', {
password, password,
}, alice); }, alice);
@ -282,7 +283,7 @@ describe('2要素認証', () => {
credentialId, credentialId,
}), alice); }), alice);
assert.strictEqual(keyDoneResponse.status, 200); assert.strictEqual(keyDoneResponse.status, 200);
const passwordLessResponse = await api('/i/2fa/password-less', { const passwordLessResponse = await api('/i/2fa/password-less', {
value: true, value: true,
}, alice); }, alice);
@ -301,7 +302,7 @@ describe('2要素認証', () => {
assert.strictEqual(signinResponse.status, 200); assert.strictEqual(signinResponse.status, 200);
assert.strictEqual(signinResponse.body.i, undefined); assert.strictEqual(signinResponse.body.i, undefined);
const signinResponse2 = await api('/signin', { const signinResponse2 = await api('/signin', {
...signinWithSecurityKeyParam({ ...signinWithSecurityKeyParam({
keyName, keyName,
challengeId: signinResponse.body.challengeId, challengeId: signinResponse.body.challengeId,
@ -324,7 +325,7 @@ describe('2要素認証', () => {
token: otpToken(registerResponse.body.secret), token: otpToken(registerResponse.body.secret),
}, alice); }, alice);
assert.strictEqual(doneResponse.status, 204); assert.strictEqual(doneResponse.status, 204);
const registerKeyResponse = await api('/i/2fa/register-key', { const registerKeyResponse = await api('/i/2fa/register-key', {
password, password,
}, alice); }, alice);
@ -339,14 +340,14 @@ describe('2要素認証', () => {
credentialId, credentialId,
}), alice); }), alice);
assert.strictEqual(keyDoneResponse.status, 200); assert.strictEqual(keyDoneResponse.status, 200);
const renamedKey = 'other-key'; const renamedKey = 'other-key';
const updateKeyResponse = await api('/i/2fa/update-key', { const updateKeyResponse = await api('/i/2fa/update-key', {
name: renamedKey, name: renamedKey,
credentialId: credentialId.toString('hex'), credentialId: credentialId.toString('hex'),
}, alice); }, alice);
assert.strictEqual(updateKeyResponse.status, 200); assert.strictEqual(updateKeyResponse.status, 200);
const iResponse = await api('/i', { const iResponse = await api('/i', {
}, alice); }, alice);
assert.strictEqual(iResponse.status, 200); assert.strictEqual(iResponse.status, 200);
@ -366,7 +367,7 @@ describe('2要素認証', () => {
token: otpToken(registerResponse.body.secret), token: otpToken(registerResponse.body.secret),
}, alice); }, alice);
assert.strictEqual(doneResponse.status, 204); assert.strictEqual(doneResponse.status, 204);
const registerKeyResponse = await api('/i/2fa/register-key', { const registerKeyResponse = await api('/i/2fa/register-key', {
password, password,
}, alice); }, alice);
@ -381,7 +382,7 @@ describe('2要素認証', () => {
credentialId, credentialId,
}), alice); }), alice);
assert.strictEqual(keyDoneResponse.status, 200); assert.strictEqual(keyDoneResponse.status, 200);
// テストの実行順によっては複数残ってるので全部消す // テストの実行順によっては複数残ってるので全部消す
const iResponse = await api('/i', { const iResponse = await api('/i', {
}, alice); }, alice);
@ -400,14 +401,14 @@ describe('2要素認証', () => {
assert.strictEqual(usersShowResponse.status, 200); assert.strictEqual(usersShowResponse.status, 200);
assert.strictEqual(usersShowResponse.body.securityKeys, false); assert.strictEqual(usersShowResponse.body.securityKeys, false);
const signinResponse = await api('/signin', { const signinResponse = await api('/signin', {
...signinParam(), ...signinParam(),
token: otpToken(registerResponse.body.secret), token: otpToken(registerResponse.body.secret),
}); });
assert.strictEqual(signinResponse.status, 200); assert.strictEqual(signinResponse.status, 200);
assert.notEqual(signinResponse.body.i, undefined); assert.notEqual(signinResponse.body.i, undefined);
}); });
test('が設定でき、設定解除できる。（パスワードのみでログインできる。）', async () => { test('が設定でき、設定解除できる。（パスワードのみでログインできる。）', async () => {
const registerResponse = await api('/i/2fa/register', { const registerResponse = await api('/i/2fa/register', {
password, password,
@ -418,7 +419,7 @@ describe('2要素認証', () => {
token: otpToken(registerResponse.body.secret), token: otpToken(registerResponse.body.secret),
}, alice); }, alice);
assert.strictEqual(doneResponse.status, 204); assert.strictEqual(doneResponse.status, 204);
const usersShowResponse = await api('/users/show', { const usersShowResponse = await api('/users/show', {
username, username,
}); });

2
packages/backend/test/e2e/antennas.ts
View file

@ -32,7 +32,7 @@ describe('アンテナ', () => {
// - srcのenumにgroupが残っている // - srcのenumにgroupが残っている
// - userGroupIdが残っている, isActiveがない // - userGroupIdが残っている, isActiveがない
type Antenna = misskey.entities.Antenna | Packed<'Antenna'>; type Antenna = misskey.entities.Antenna | Packed<'Antenna'>;
type User = misskey.entities.MeDetailed & { token: string }; type User = misskey.entities.MeSignup;
type Note = misskey.entities.Note; type Note = misskey.entities.Note;
// アンテナを作成できる最小のパラメタ // アンテナを作成できる最小のパラメタ

11
packages/backend/test/e2e/api-visibility.ts
View file

@ -3,6 +3,7 @@ process.env.NODE_ENV = 'test';
import * as assert from 'assert'; import * as assert from 'assert';
import { signup, api, post, startServer } from '../utils.js'; import { signup, api, post, startServer } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
describe('API visibility', () => { describe('API visibility', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
@ -18,15 +19,15 @@ describe('API visibility', () => {
describe('Note visibility', () => { describe('Note visibility', () => {
//#region vars //#region vars
/** ヒロイン */ /** ヒロイン */
let alice: any; let alice: misskey.entities.MeSignup;
/** フォロワー */ /** フォロワー */
let follower: any; let follower: misskey.entities.MeSignup;
/** 非フォロワー */ /** 非フォロワー */
let other: any; let other: misskey.entities.MeSignup;
/** 非フォロワーでもリプライやメンションをされた人 */ /** 非フォロワーでもリプライやメンションをされた人 */
let target: any; let target: misskey.entities.MeSignup;
/** specified mentionでmentionを飛ばされる人 */ /** specified mentionでmentionを飛ばされる人 */
let target2: any; let target2: misskey.entities.MeSignup;
/** public-post */ /** public-post */
let pub: any; let pub: any;

7
packages/backend/test/e2e/api.ts
View file

@ -3,12 +3,13 @@ process.env.NODE_ENV = 'test';
import * as assert from 'assert'; import * as assert from 'assert';
import { signup, api, startServer } from '../utils.js'; import { signup, api, startServer } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
describe('API', () => { describe('API', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
let alice: any; let alice: misskey.entities.MeSignup;
let bob: any; let bob: misskey.entities.MeSignup;
let carol: any; let carol: misskey.entities.MeSignup;
beforeAll(async () => { beforeAll(async () => {
app = await startServer(); app = await startServer();

7
packages/backend/test/e2e/block.ts
View file

@ -3,14 +3,15 @@ process.env.NODE_ENV = 'test';
import * as assert from 'assert'; import * as assert from 'assert';
import { signup, api, post, startServer } from '../utils.js'; import { signup, api, post, startServer } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
describe('Block', () => { describe('Block', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
// alice blocks bob // alice blocks bob
let alice: any; let alice: misskey.entities.MeSignup;
let bob: any; let bob: misskey.entities.MeSignup;
let carol: any; let carol: misskey.entities.MeSignup;
beforeAll(async () => { beforeAll(async () => {
app = await startServer(); app = await startServer();

130
packages/backend/test/e2e/clips.ts
View file

@ -13,12 +13,12 @@ import { paramDef as UnfavoriteParamDef } from '@/server/api/endpoints/clips/unf
import { paramDef as AddNoteParamDef } from '@/server/api/endpoints/clips/add-note.js'; import { paramDef as AddNoteParamDef } from '@/server/api/endpoints/clips/add-note.js';
import { paramDef as RemoveNoteParamDef } from '@/server/api/endpoints/clips/remove-note.js'; import { paramDef as RemoveNoteParamDef } from '@/server/api/endpoints/clips/remove-note.js';
import { paramDef as NotesParamDef } from '@/server/api/endpoints/clips/notes.js'; import { paramDef as NotesParamDef } from '@/server/api/endpoints/clips/notes.js';
import { import {
signup, signup,
post, post,
startServer, startServer,
api, api,
successfulApiCall, successfulApiCall,
failedApiCall, failedApiCall,
ApiRequest, ApiRequest,
hiddenNote, hiddenNote,
@ -82,14 +82,14 @@ describe('クリップ', () => {
const update = async (parameters: Partial<UpdateParam>, request: Partial<ApiRequest> = {}): Promise<Clip> => { const update = async (parameters: Partial<UpdateParam>, request: Partial<ApiRequest> = {}): Promise<Clip> => {
const clip = await successfulApiCall<Clip>({ const clip = await successfulApiCall<Clip>({
endpoint: '/clips/update', endpoint: '/clips/update',
parameters: { parameters: {
name: 'updated', name: 'updated',
...parameters, ...parameters,
}, },
user: alice, user: alice,
...request, ...request,
}); });
// 入力が結果として入っていること。clipIdはidになるので消しておく // 入力が結果として入っていること。clipIdはidになるので消しておく
delete (parameters as { clipId?: string }).clipId; delete (parameters as { clipId?: string }).clipId;
assert.deepStrictEqual(clip, { assert.deepStrictEqual(clip, {
@ -98,7 +98,7 @@ describe('クリップ', () => {
}); });
return clip; return clip;
}; };
type DeleteParam = JTDDataType<typeof DeleteParamDef>; type DeleteParam = JTDDataType<typeof DeleteParamDef>;
const deleteClip = async (parameters: DeleteParam, request: Partial<ApiRequest> = {}): Promise<void> => { const deleteClip = async (parameters: DeleteParam, request: Partial<ApiRequest> = {}): Promise<void> => {
return await successfulApiCall<void>({ return await successfulApiCall<void>({
@ -129,7 +129,7 @@ describe('クリップ', () => {
...request, ...request,
}); });
}; };
const usersClips = async (request: Partial<ApiRequest>): Promise<Clip[]> => { const usersClips = async (request: Partial<ApiRequest>): Promise<Clip[]> => {
return await successfulApiCall<Clip[]>({ return await successfulApiCall<Clip[]>({
endpoint: '/users/clips', endpoint: '/users/clips',
@ -145,14 +145,14 @@ describe('クリップ', () => {
bob = await signup({ username: 'bob' }); bob = await signup({ username: 'bob' });
// FIXME: misskey-jsのNoteはoutdatedなので直接変換できない // FIXME: misskey-jsのNoteはoutdatedなので直接変換できない
aliceNote = await post(alice, { text: 'test' }) as any; aliceNote = await post(alice, { text: 'test' }) as any;
aliceHomeNote = await post(alice, { text: 'home only', visibility: 'home' }) as any; aliceHomeNote = await post(alice, { text: 'home only', visibility: 'home' }) as any;
aliceFollowersNote = await post(alice, { text: 'followers only', visibility: 'followers' }) as any; aliceFollowersNote = await post(alice, { text: 'followers only', visibility: 'followers' }) as any;
aliceSpecifiedNote = await post(alice, { text: 'specified only', visibility: 'specified' }) as any; aliceSpecifiedNote = await post(alice, { text: 'specified only', visibility: 'specified' }) as any;
bobNote = await post(bob, { text: 'test' }) as any; bobNote = await post(bob, { text: 'test' }) as any;
bobHomeNote = await post(bob, { text: 'home only', visibility: 'home' }) as any; bobHomeNote = await post(bob, { text: 'home only', visibility: 'home' }) as any;
bobFollowersNote = await post(bob, { text: 'followers only', visibility: 'followers' }) as any; bobFollowersNote = await post(bob, { text: 'followers only', visibility: 'followers' }) as any;
bobSpecifiedNote = await post(bob, { text: 'specified only', visibility: 'specified' }) as any; bobSpecifiedNote = await post(bob, { text: 'specified only', visibility: 'specified' }) as any;
}, 1000 * 60 * 2); }, 1000 * 60 * 2);
afterAll(async () => { afterAll(async () => {
@ -172,7 +172,7 @@ describe('クリップ', () => {
test('の作成ができる', async () => { test('の作成ができる', async () => {
const res = await create(); const res = await create();
// ISO 8601で日付が返ってくること // ISO 8601で日付が返ってくること
assert.strictEqual(res.createdAt, new Date(res.createdAt).toISOString()); assert.strictEqual(res.createdAt, new Date(res.createdAt).toISOString());
assert.strictEqual(res.lastClippedAt, null); assert.strictEqual(res.lastClippedAt, null);
assert.strictEqual(res.name, 'test'); assert.strictEqual(res.name, 'test');
assert.strictEqual(res.description, null); assert.strictEqual(res.description, null);
@ -217,7 +217,7 @@ describe('クリップ', () => {
]; ];
test.each(createClipDenyPattern)('の作成は$labelならできない', async ({ parameters }) => failedApiCall({ test.each(createClipDenyPattern)('の作成は$labelならできない', async ({ parameters }) => failedApiCall({
endpoint: '/clips/create', endpoint: '/clips/create',
parameters: { parameters: {
...defaultCreate(), ...defaultCreate(),
...parameters, ...parameters,
}, },
@ -229,7 +229,7 @@ describe('クリップ', () => {
})); }));
test('の更新ができる', async () => { test('の更新ができる', async () => {
const res = await update({ const res = await update({
clipId: (await create()).id, clipId: (await create()).id,
name: 'updated', name: 'updated',
description: 'new description', description: 'new description',
@ -237,7 +237,7 @@ describe('クリップ', () => {
}); });
// ISO 8601で日付が返ってくること // ISO 8601で日付が返ってくること
assert.strictEqual(res.createdAt, new Date(res.createdAt).toISOString()); assert.strictEqual(res.createdAt, new Date(res.createdAt).toISOString());
assert.strictEqual(res.lastClippedAt, null); assert.strictEqual(res.lastClippedAt, null);
assert.strictEqual(res.name, 'updated'); assert.strictEqual(res.name, 'updated');
assert.strictEqual(res.description, 'new description'); assert.strictEqual(res.description, 'new description');
@ -251,7 +251,7 @@ describe('クリップ', () => {
name: 'updated', name: 'updated',
...parameters, ...parameters,
})); }));
test.each([ test.each([
{ label: 'clipIdがnull', parameters: { clipId: null } }, { label: 'clipIdがnull', parameters: { clipId: null } },
{ label: '存在しないクリップ', parameters: { clipId: 'xxxxxx' }, assertion: { { label: '存在しないクリップ', parameters: { clipId: 'xxxxxx' }, assertion: {
@ -265,7 +265,7 @@ describe('クリップ', () => {
...createClipDenyPattern as any, ...createClipDenyPattern as any,
])('の更新は$labelならできない', async ({ parameters, user, assertion }) => failedApiCall({ ])('の更新は$labelならできない', async ({ parameters, user, assertion }) => failedApiCall({
endpoint: '/clips/update', endpoint: '/clips/update',
parameters: { parameters: {
clipId: (await create({}, { user: (user ?? ((): User => alice))() })).id, clipId: (await create({}, { user: (user ?? ((): User => alice))() })).id,
name: 'updated', name: 'updated',
...parameters, ...parameters,
@ -279,7 +279,7 @@ describe('クリップ', () => {
})); }));
test('の削除ができる', async () => { test('の削除ができる', async () => {
await deleteClip({ await deleteClip({
clipId: (await create()).id, clipId: (await create()).id,
}); });
assert.deepStrictEqual(await list({}), []); assert.deepStrictEqual(await list({}), []);
@ -297,7 +297,7 @@ describe('クリップ', () => {
} }, } },
])('の削除は$labelならできない', async ({ parameters, user, assertion }) => failedApiCall({ ])('の削除は$labelならできない', async ({ parameters, user, assertion }) => failedApiCall({
endpoint: '/clips/delete', endpoint: '/clips/delete',
parameters: { parameters: {
clipId: (await create({}, { user: (user ?? ((): User => alice))() })).id, clipId: (await create({}, { user: (user ?? ((): User => alice))() })).id,
...parameters, ...parameters,
}, },
@ -329,14 +329,14 @@ describe('クリップ', () => {
}); });
test.each([ test.each([
{ label: 'clipId未指定', parameters: { clipId: undefined } }, { label: 'clipId未指定', parameters: { clipId: undefined } },
{ label: '存在しないクリップ', parameters: { clipId: 'xxxxxx' }, assetion: { { label: '存在しないクリップ', parameters: { clipId: 'xxxxxx' }, assetion: {
code: 'NO_SUCH_CLIP', code: 'NO_SUCH_CLIP',
id: 'c3c5fe33-d62c-44d2-9ea5-d997703f5c20', id: 'c3c5fe33-d62c-44d2-9ea5-d997703f5c20',
} }, } },
])('のID指定取得は$labelならできない', async ({ parameters, assetion }) => failedApiCall({ ])('のID指定取得は$labelならできない', async ({ parameters, assetion }) => failedApiCall({
endpoint: '/clips/show', endpoint: '/clips/show',
parameters: { parameters: {
...parameters, ...parameters,
}, },
user: alice, user: alice,
@ -361,14 +361,14 @@ describe('クリップ', () => {
// 返ってくる配列には順序保障がないのでidでソートして厳密比較 // 返ってくる配列には順序保障がないのでidでソートして厳密比較
assert.deepStrictEqual( assert.deepStrictEqual(
res.sort(compareBy(s => s.id)), res.sort(compareBy(s => s.id)),
clips.sort(compareBy(s => s.id)), clips.sort(compareBy(s => s.id)),
); );
}); });
test('の一覧が取得できる(空)', async () => { test('の一覧が取得できる(空)', async () => {
const res = await usersClips({ const res = await usersClips({
parameters: { parameters: {
userId: alice.id, userId: alice.id,
}, },
}); });
@ -381,14 +381,14 @@ describe('クリップ', () => {
])('の一覧が$label取得できる', async () => { ])('の一覧が$label取得できる', async () => {
const clips = await createMany({ isPublic: true }); const clips = await createMany({ isPublic: true });
const res = await usersClips({ const res = await usersClips({
parameters: { parameters: {
userId: alice.id, userId: alice.id,
}, },
}); });
// 返ってくる配列には順序保障がないのでidでソートして厳密比較 // 返ってくる配列には順序保障がないのでidでソートして厳密比較
assert.deepStrictEqual( assert.deepStrictEqual(
res.sort(compareBy<Clip>(s => s.id)), res.sort(compareBy<Clip>(s => s.id)),
clips.sort(compareBy(s => s.id))); clips.sort(compareBy(s => s.id)));
// 認証状態で見たときだけisFavoritedが入っている // 認証状態で見たときだけisFavoritedが入っている
@ -421,7 +421,7 @@ describe('クリップ', () => {
await create({ isPublic: false }); await create({ isPublic: false });
const aliceClip = await create({ isPublic: true }); const aliceClip = await create({ isPublic: true });
const res = await usersClips({ const res = await usersClips({
parameters: { parameters: {
userId: alice.id, userId: alice.id,
limit: 2, limit: 2,
}, },
@ -433,7 +433,7 @@ describe('クリップ', () => {
const clips = await createMany({ isPublic: true }, 7); const clips = await createMany({ isPublic: true }, 7);
clips.sort(compareBy(s => s.id)); clips.sort(compareBy(s => s.id));
const res = await usersClips({ const res = await usersClips({
parameters: { parameters: {
userId: alice.id, userId: alice.id,
sinceId: clips[1].id, sinceId: clips[1].id,
untilId: clips[5].id, untilId: clips[5].id,
@ -443,7 +443,7 @@ describe('クリップ', () => {
// Promise.allで返ってくる配列には順序保障がないのでidでソートして厳密比較 // Promise.allで返ってくる配列には順序保障がないのでidでソートして厳密比較
assert.deepStrictEqual( assert.deepStrictEqual(
res.sort(compareBy<Clip>(s => s.id)), res.sort(compareBy<Clip>(s => s.id)),
[clips[2], clips[3], clips[4]], // sinceIdとuntilId自体は結果に含まれない [clips[2], clips[3], clips[4]], // sinceIdとuntilId自体は結果に含まれない
clips[1].id + ' ... ' + clips[3].id + ' with ' + clips.map(s => s.id) + ' vs. ' + res.map(s => s.id)); clips[1].id + ' ... ' + clips[3].id + ' with ' + clips.map(s => s.id) + ' vs. ' + res.map(s => s.id));
}); });
@ -454,7 +454,7 @@ describe('クリップ', () => {
{ label: 'limit最大+1', parameters: { limit: 101 } }, { label: 'limit最大+1', parameters: { limit: 101 } },
])('の一覧は$labelだと取得できない', async ({ parameters }) => failedApiCall({ ])('の一覧は$labelだと取得できない', async ({ parameters }) => failedApiCall({
endpoint: '/users/clips', endpoint: '/users/clips',
parameters: { parameters: {
userId: alice.id, userId: alice.id,
...parameters, ...parameters,
}, },
@ -520,7 +520,7 @@ describe('クリップ', () => {
...request, ...request,
}); });
}; };
beforeEach(async () => { beforeEach(async () => {
aliceClip = await create(); aliceClip = await create();
}); });
@ -544,7 +544,7 @@ describe('クリップ', () => {
assert.strictEqual(clip2.favoritedCount, 1); assert.strictEqual(clip2.favoritedCount, 1);
assert.strictEqual(clip2.isFavorited, false); assert.strictEqual(clip2.isFavorited, false);
}); });
test('は1つのクリップに対して複数人が設定できる。', async () => { test('は1つのクリップに対して複数人が設定できる。', async () => {
const publicClip = await create({ isPublic: true }); const publicClip = await create({ isPublic: true });
await favorite({ clipId: publicClip.id }, { user: bob }); await favorite({ clipId: publicClip.id }, { user: bob });
@ -552,7 +552,7 @@ describe('クリップ', () => {
const clip = await show({ clipId: publicClip.id }, { user: bob }); const clip = await show({ clipId: publicClip.id }, { user: bob });
assert.strictEqual(clip.favoritedCount, 2); assert.strictEqual(clip.favoritedCount, 2);
assert.strictEqual(clip.isFavorited, true); assert.strictEqual(clip.isFavorited, true);
const clip2 = await show({ clipId: publicClip.id }); const clip2 = await show({ clipId: publicClip.id });
assert.strictEqual(clip2.favoritedCount, 2); assert.strictEqual(clip2.favoritedCount, 2);
assert.strictEqual(clip2.isFavorited, true); assert.strictEqual(clip2.isFavorited, true);
@ -581,7 +581,7 @@ describe('クリップ', () => {
await favorite({ clipId: aliceClip.id }); await favorite({ clipId: aliceClip.id });
await failedApiCall({ await failedApiCall({
endpoint: '/clips/favorite', endpoint: '/clips/favorite',
parameters: { parameters: {
clipId: aliceClip.id, clipId: aliceClip.id,
}, },
user: alice, user: alice,
@ -604,7 +604,7 @@ describe('クリップ', () => {
} }, } },
])('の設定は$labelならできない', async ({ parameters, user, assertion }) => failedApiCall({ ])('の設定は$labelならできない', async ({ parameters, user, assertion }) => failedApiCall({
endpoint: '/clips/favorite', endpoint: '/clips/favorite',
parameters: { parameters: {
clipId: (await create({}, { user: (user ?? ((): User => alice))() })).id, clipId: (await create({}, { user: (user ?? ((): User => alice))() })).id,
...parameters, ...parameters,
}, },
@ -615,7 +615,7 @@ describe('クリップ', () => {
id: '3d81ceae-475f-4600-b2a8-2bc116157532', id: '3d81ceae-475f-4600-b2a8-2bc116157532',
...assertion, ...assertion,
})); }));
test('を設定解除できる。', async () => { test('を設定解除できる。', async () => {
await favorite({ clipId: aliceClip.id }); await favorite({ clipId: aliceClip.id });
await unfavorite({ clipId: aliceClip.id }); await unfavorite({ clipId: aliceClip.id });
@ -641,7 +641,7 @@ describe('クリップ', () => {
} }, } },
])('の設定解除は$labelならできない', async ({ parameters, user, assertion }) => failedApiCall({ ])('の設定解除は$labelならできない', async ({ parameters, user, assertion }) => failedApiCall({
endpoint: '/clips/unfavorite', endpoint: '/clips/unfavorite',
parameters: { parameters: {
clipId: (await create({}, { user: (user ?? ((): User => alice))() })).id, clipId: (await create({}, { user: (user ?? ((): User => alice))() })).id,
...parameters, ...parameters,
}, },
@ -652,7 +652,7 @@ describe('クリップ', () => {
id: '3d81ceae-475f-4600-b2a8-2bc116157532', id: '3d81ceae-475f-4600-b2a8-2bc116157532',
...assertion, ...assertion,
})); }));
test('を取得できる。', async () => { test('を取得できる。', async () => {
await favorite({ clipId: aliceClip.id }); await favorite({ clipId: aliceClip.id });
const favorited = await myFavorites(); const favorited = await myFavorites();
@ -717,7 +717,7 @@ describe('クリップ', () => {
const res = await show({ clipId: aliceClip.id }); const res = await show({ clipId: aliceClip.id });
assert.strictEqual(res.lastClippedAt, new Date(res.lastClippedAt ?? '').toISOString()); assert.strictEqual(res.lastClippedAt, new Date(res.lastClippedAt ?? '').toISOString());
assert.deepStrictEqual(await notes({ clipId: aliceClip.id }), [aliceNote]); assert.deepStrictEqual(await notes({ clipId: aliceClip.id }), [aliceNote]);
// 他人の非公開ノートも突っ込める // 他人の非公開ノートも突っ込める
await addNote({ clipId: aliceClip.id, noteId: bobHomeNote.id }); await addNote({ clipId: aliceClip.id, noteId: bobHomeNote.id });
await addNote({ clipId: aliceClip.id, noteId: bobFollowersNote.id }); await addNote({ clipId: aliceClip.id, noteId: bobFollowersNote.id });
@ -728,7 +728,7 @@ describe('クリップ', () => {
await addNote({ clipId: aliceClip.id, noteId: aliceNote.id }); await addNote({ clipId: aliceClip.id, noteId: aliceNote.id });
await failedApiCall({ await failedApiCall({
endpoint: '/clips/add-note', endpoint: '/clips/add-note',
parameters: { parameters: {
clipId: aliceClip.id, clipId: aliceClip.id,
noteId: aliceNote.id, noteId: aliceNote.id,
}, },
@ -747,10 +747,10 @@ describe('クリップ', () => {
text: `test ${i}`, text: `test ${i}`,
}) as unknown)) as Note[]; }) as unknown)) as Note[];
await Promise.all(noteList.map(s => addNote({ clipId: aliceClip.id, noteId: s.id }))); await Promise.all(noteList.map(s => addNote({ clipId: aliceClip.id, noteId: s.id })));
await failedApiCall({ await failedApiCall({
endpoint: '/clips/add-note', endpoint: '/clips/add-note',
parameters: { parameters: {
clipId: aliceClip.id, clipId: aliceClip.id,
noteId: aliceNote.id, noteId: aliceNote.id,
}, },
@ -764,7 +764,7 @@ describe('クリップ', () => {
test('は他人のクリップへ追加できない。', async () => await failedApiCall({ test('は他人のクリップへ追加できない。', async () => await failedApiCall({
endpoint: '/clips/add-note', endpoint: '/clips/add-note',
parameters: { parameters: {
clipId: aliceClip.id, clipId: aliceClip.id,
noteId: aliceNote.id, noteId: aliceNote.id,
}, },
@ -776,9 +776,9 @@ describe('クリップ', () => {
})); }));
test.each([ test.each([
{ label: 'clipId未指定', parameters: { clipId: undefined } }, { label: 'clipId未指定', parameters: { clipId: undefined } },
{ label: 'noteId未指定', parameters: { noteId: undefined } }, { label: 'noteId未指定', parameters: { noteId: undefined } },
{ label: '存在しないクリップ', parameters: { clipId: 'xxxxxx' }, assetion: { { label: '存在しないクリップ', parameters: { clipId: 'xxxxxx' }, assetion: {
code: 'NO_SUCH_CLIP', code: 'NO_SUCH_CLIP',
id: 'd6e76cc0-a1b5-4c7c-a287-73fa9c716dcf', id: 'd6e76cc0-a1b5-4c7c-a287-73fa9c716dcf',
} }, } },
@ -792,7 +792,7 @@ describe('クリップ', () => {
} }, } },
])('の追加は$labelだとできない', async ({ parameters, user, assetion }) => failedApiCall({ ])('の追加は$labelだとできない', async ({ parameters, user, assetion }) => failedApiCall({
endpoint: '/clips/add-note', endpoint: '/clips/add-note',
parameters: { parameters: {
clipId: aliceClip.id, clipId: aliceClip.id,
noteId: aliceNote.id, noteId: aliceNote.id,
...parameters, ...parameters,
@ -810,11 +810,11 @@ describe('クリップ', () => {
await removeNote({ clipId: aliceClip.id, noteId: aliceNote.id }); await removeNote({ clipId: aliceClip.id, noteId: aliceNote.id });
assert.deepStrictEqual(await notes({ clipId: aliceClip.id }), []); assert.deepStrictEqual(await notes({ clipId: aliceClip.id }), []);
}); });
test.each([ test.each([
{ label: 'clipId未指定', parameters: { clipId: undefined } }, { label: 'clipId未指定', parameters: { clipId: undefined } },
{ label: 'noteId未指定', parameters: { noteId: undefined } }, { label: 'noteId未指定', parameters: { noteId: undefined } },
{ label: '存在しないクリップ', parameters: { clipId: 'xxxxxx' }, assetion: { { label: '存在しないクリップ', parameters: { clipId: 'xxxxxx' }, assetion: {
code: 'NO_SUCH_CLIP', code: 'NO_SUCH_CLIP',
id: 'b80525c6-97f7-49d7-a42d-ebccd49cfd52', // add-noteと異なる id: 'b80525c6-97f7-49d7-a42d-ebccd49cfd52', // add-noteと異なる
} }, } },
@ -828,7 +828,7 @@ describe('クリップ', () => {
} }, } },
])('の削除は$labelだとできない', async ({ parameters, user, assetion }) => failedApiCall({ ])('の削除は$labelだとできない', async ({ parameters, user, assetion }) => failedApiCall({
endpoint: '/clips/remove-note', endpoint: '/clips/remove-note',
parameters: { parameters: {
clipId: aliceClip.id, clipId: aliceClip.id,
noteId: aliceNote.id, noteId: aliceNote.id,
...parameters, ...parameters,
@ -848,12 +848,12 @@ describe('クリップ', () => {
} }
const res = await notes({ clipId: aliceClip.id }); const res = await notes({ clipId: aliceClip.id });
// 自分のノートは非公開でも入れられるし、見える // 自分のノートは非公開でも入れられるし、見える
// 他人の非公開ノートは入れられるけど、除外される // 他人の非公開ノートは入れられるけど、除外される
const expects = [ const expects = [
aliceNote, aliceHomeNote, aliceFollowersNote, aliceSpecifiedNote, aliceNote, aliceHomeNote, aliceFollowersNote, aliceSpecifiedNote,
bobNote, bobHomeNote, bobNote, bobHomeNote,
]; ];
assert.deepStrictEqual( assert.deepStrictEqual(
res.sort(compareBy(s => s.id)), res.sort(compareBy(s => s.id)),
@ -867,7 +867,7 @@ describe('クリップ', () => {
await addNote({ clipId: aliceClip.id, noteId: note.id }); await addNote({ clipId: aliceClip.id, noteId: note.id });
} }
const res = await notes({ const res = await notes({
clipId: aliceClip.id, clipId: aliceClip.id,
sinceId: noteList[2].id, sinceId: noteList[2].id,
limit: 3, limit: 3,
@ -892,7 +892,7 @@ describe('クリップ', () => {
sinceId: noteList[1].id, sinceId: noteList[1].id,
untilId: noteList[4].id, untilId: noteList[4].id,
}); });
// Promise.allで返ってくる配列はID順で並んでないのでソートして厳密比較 // Promise.allで返ってくる配列はID順で並んでないのでソートして厳密比較
const expects = [noteList[2], noteList[3]]; const expects = [noteList[2], noteList[3]];
assert.deepStrictEqual( assert.deepStrictEqual(
@ -918,7 +918,7 @@ describe('クリップ', () => {
const res = await notes({ clipId: publicClip.id }, { user: undefined }); const res = await notes({ clipId: publicClip.id }, { user: undefined });
const expects = [ const expects = [
aliceNote, aliceHomeNote, aliceNote, aliceHomeNote,
// 認証なしだと非公開ノートは結果には含むけどhideされる。 // 認証なしだと非公開ノートは結果には含むけどhideされる。
hiddenNote(aliceFollowersNote), hiddenNote(aliceSpecifiedNote), hiddenNote(aliceFollowersNote), hiddenNote(aliceSpecifiedNote),
]; ];
@ -926,7 +926,7 @@ describe('クリップ', () => {
res.sort(compareBy(s => s.id)), res.sort(compareBy(s => s.id)),
expects.sort(compareBy(s => s.id))); expects.sort(compareBy(s => s.id)));
}); });
test.todo('ブロック、ミュートされたユーザーからの設定＆取得etc.'); test.todo('ブロック、ミュートされたユーザーからの設定＆取得etc.');
test.each([ test.each([
@ -947,7 +947,7 @@ describe('クリップ', () => {
} }, } },
])('は$labelだと取得できない', async ({ parameters, user, assertion }) => failedApiCall({ ])('は$labelだと取得できない', async ({ parameters, user, assertion }) => failedApiCall({
endpoint: '/clips/notes', endpoint: '/clips/notes',
parameters: { parameters: {
clipId: aliceClip.id, clipId: aliceClip.id,
...parameters, ...parameters,
}, },

11
packages/backend/test/e2e/endpoints.ts
View file

@ -4,17 +4,18 @@ import * as assert from 'assert';
// node-fetch only supports it's own Blob yet // node-fetch only supports it's own Blob yet
// https://github.com/node-fetch/node-fetch/pull/1664 // https://github.com/node-fetch/node-fetch/pull/1664
import { Blob } from 'node-fetch'; import { Blob } from 'node-fetch';
import { User } from '@/models/index.js';
import { startServer, signup, post, api, uploadFile, simpleGet, initTestDb } from '../utils.js'; import { startServer, signup, post, api, uploadFile, simpleGet, initTestDb } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import { User } from '@/models/index.js'; import type * as misskey from 'misskey-js';
describe('Endpoints', () => { describe('Endpoints', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
let alice: any; let alice: misskey.entities.MeSignup;
let bob: any; let bob: misskey.entities.MeSignup;
let carol: any; let carol: misskey.entities.MeSignup;
let dave: any; let dave: misskey.entities.MeSignup;
beforeAll(async () => { beforeAll(async () => {
app = await startServer(); app = await startServer();

209
packages/backend/test/e2e/fetch-resource.ts
View file

@ -4,6 +4,7 @@ import * as assert from 'assert';
import { startServer, channel, clip, cookie, galleryPost, signup, page, play, post, simpleGet, uploadFile } from '../utils.js'; import { startServer, channel, clip, cookie, galleryPost, signup, page, play, post, simpleGet, uploadFile } from '../utils.js';
import type { SimpleGetResponse } from '../utils.js'; import type { SimpleGetResponse } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
// Request Accept // Request Accept
const ONLY_AP = 'application/activity+json'; const ONLY_AP = 'application/activity+json';
@ -19,7 +20,7 @@ const JSON_UTF8 = 'application/json; charset=utf-8';
describe('Webリソース', () => { describe('Webリソース', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
let alice: any; let alice: misskey.entities.MeSignup;
let aliceUploadedFile: any; let aliceUploadedFile: any;
let alicesPost: any; let alicesPost: any;
let alicePage: any; let alicePage: any;
@ -28,8 +29,8 @@ describe('Webリソース', () => {
let aliceGalleryPost: any; let aliceGalleryPost: any;
let aliceChannel: any; let aliceChannel: any;
type Request = { type Request = {
path: string, path: string,
accept?: string, accept?: string,
cookie?: string, cookie?: string,
}; };
@ -46,7 +47,7 @@ describe('Webリソース', () => {
const notOk = async (param: Request & { const notOk = async (param: Request & {
status?: number, status?: number,
code?: string, code?: string,
}): Promise<SimpleGetResponse> => { }): Promise<SimpleGetResponse> => {
const { path, accept, cookie, status, code } = param; const { path, accept, cookie, status, code } = param;
const res = await simpleGet(path, accept, cookie); const res = await simpleGet(path, accept, cookie);
assert.notStrictEqual(res.status, 200); assert.notStrictEqual(res.status, 200);
@ -58,8 +59,8 @@ describe('Webリソース', () => {
} }
return res; return res;
}; };
const notFound = async (param: Request): Promise<SimpleGetResponse> => { const notFound = async (param: Request): Promise<SimpleGetResponse> => {
return await notOk({ return await notOk({
...param, ...param,
status: 404, status: 404,
@ -94,23 +95,23 @@ describe('Webリソース', () => {
{ path: '/', type: HTML }, { path: '/', type: HTML },
{ path: '/docs/ja-JP/about', type: HTML }, // "指定されたURLに該当するページはありませんでした。" { path: '/docs/ja-JP/about', type: HTML }, // "指定されたURLに該当するページはありませんでした。"
// fastify-static gives charset=UTF-8 instead of utf-8 and that's okay // fastify-static gives charset=UTF-8 instead of utf-8 and that's okay
{ path: '/api-doc', type: 'text/html; charset=UTF-8' }, { path: '/api-doc', type: 'text/html; charset=UTF-8' },
{ path: '/api.json', type: JSON_UTF8 }, { path: '/api.json', type: JSON_UTF8 },
{ path: '/api-console', type: HTML }, { path: '/api-console', type: HTML },
{ path: '/_info_card_', type: HTML }, { path: '/_info_card_', type: HTML },
{ path: '/bios', type: HTML }, { path: '/bios', type: HTML },
{ path: '/cli', type: HTML }, { path: '/cli', type: HTML },
{ path: '/flush', type: HTML }, { path: '/flush', type: HTML },
{ path: '/robots.txt', type: 'text/plain; charset=UTF-8' }, { path: '/robots.txt', type: 'text/plain; charset=UTF-8' },
{ path: '/favicon.ico', type: 'image/vnd.microsoft.icon' }, { path: '/favicon.ico', type: 'image/vnd.microsoft.icon' },
{ path: '/opensearch.xml', type: 'application/opensearchdescription+xml' }, { path: '/opensearch.xml', type: 'application/opensearchdescription+xml' },
{ path: '/apple-touch-icon.png', type: 'image/png' }, { path: '/apple-touch-icon.png', type: 'image/png' },
{ path: '/twemoji/2764.svg', type: 'image/svg+xml' }, { path: '/twemoji/2764.svg', type: 'image/svg+xml' },
{ path: '/twemoji/2764-fe0f-200d-1f525.svg', type: 'image/svg+xml' }, { path: '/twemoji/2764-fe0f-200d-1f525.svg', type: 'image/svg+xml' },
{ path: '/twemoji-badge/2764.png', type: 'image/png' }, { path: '/twemoji-badge/2764.png', type: 'image/png' },
{ path: '/twemoji-badge/2764-fe0f-200d-1f525.png', type: 'image/png' }, { path: '/twemoji-badge/2764-fe0f-200d-1f525.png', type: 'image/png' },
{ path: '/fluent-emoji/2764.png', type: 'image/png' }, { path: '/fluent-emoji/2764.png', type: 'image/png' },
{ path: '/fluent-emoji/2764-fe0f-200d-1f525.png', type: 'image/png' }, { path: '/fluent-emoji/2764-fe0f-200d-1f525.png', type: 'image/png' },
])('$path', (p) => { ])('$path', (p) => {
test('がGETできる。', async () => await ok({ ...p })); test('がGETできる。', async () => await ok({ ...p }));
@ -120,58 +121,58 @@ describe('Webリソース', () => {
}); });
describe.each([ describe.each([
{ path: '/twemoji/2764.png' }, { path: '/twemoji/2764.png' },
{ path: '/twemoji/2764-fe0f-200d-1f525.png' }, { path: '/twemoji/2764-fe0f-200d-1f525.png' },
{ path: '/twemoji-badge/2764.svg' }, { path: '/twemoji-badge/2764.svg' },
{ path: '/twemoji-badge/2764-fe0f-200d-1f525.svg' }, { path: '/twemoji-badge/2764-fe0f-200d-1f525.svg' },
{ path: '/fluent-emoji/2764.svg' }, { path: '/fluent-emoji/2764.svg' },
{ path: '/fluent-emoji/2764-fe0f-200d-1f525.svg' }, { path: '/fluent-emoji/2764-fe0f-200d-1f525.svg' },
])('$path', ({ path }) => { ])('$path', ({ path }) => {
test('はGETできない。', async () => await notFound({ path })); test('はGETできない。', async () => await notFound({ path }));
}); });
describe.each([ describe.each([
{ ext: 'rss', type: 'application/rss+xml; charset=utf-8' }, { ext: 'rss', type: 'application/rss+xml; charset=utf-8' },
{ ext: 'atom', type: 'application/atom+xml; charset=utf-8' }, { ext: 'atom', type: 'application/atom+xml; charset=utf-8' },
{ ext: 'json', type: 'application/json; charset=utf-8' }, { ext: 'json', type: 'application/json; charset=utf-8' },
])('/@:username.$ext', ({ ext, type }) => { ])('/@:username.$ext', ({ ext, type }) => {
const path = (username: string): string => `/@${username}.${ext}`; const path = (username: string): string => `/@${username}.${ext}`;
test('がGETできる。', async () => await ok({ test('がGETできる。', async () => await ok({
path: path(alice.username), path: path(alice.username),
type, type,
})); }));
test('は存在しないユーザーはGETできない。', async () => await notOk({ test('は存在しないユーザーはGETできない。', async () => await notOk({
path: path('nonexisting'), path: path('nonexisting'),
status: 404, status: 404,
})); }));
}); });
describe.each([{ path: '/api/foo' }])('$path', ({ path }) => { describe.each([{ path: '/api/foo' }])('$path', ({ path }) => {
test('はGETできない。', async () => await notOk({ test('はGETできない。', async () => await notOk({
path, path,
status: 404, status: 404,
code: 'UNKNOWN_API_ENDPOINT', code: 'UNKNOWN_API_ENDPOINT',
})); }));
}); });
describe.each([{ path: '/queue' }])('$path', ({ path }) => { describe.each([{ path: '/queue' }])('$path', ({ path }) => {
test('はadminでなければGETできない。', async () => await notOk({ test('はadminでなければGETできない。', async () => await notOk({
path, path,
status: 500, // FIXME? 403ではない。 status: 500, // FIXME? 403ではない。
})); }));
test('はadminならGETできる。', async () => await ok({ test('はadminならGETできる。', async () => await ok({
path, path,
cookie: cookie(alice), cookie: cookie(alice),
})); }));
}); });
describe.each([{ path: '/streaming' }])('$path', ({ path }) => { describe.each([{ path: '/streaming' }])('$path', ({ path }) => {
test('はGETできない。', async () => await notOk({ test('はGETできない。', async () => await notOk({
path, path,
status: 503, status: 503,
})); }));
}); });
@ -183,21 +184,21 @@ describe('Webリソース', () => {
{ accept: UNSPECIFIED }, { accept: UNSPECIFIED },
])('(Acceptヘッダ: $accept)', ({ accept }) => { ])('(Acceptヘッダ: $accept)', ({ accept }) => {
test('はHTMLとしてGETできる。', async () => { test('はHTMLとしてGETできる。', async () => {
const res = await ok({ const res = await ok({
path: path(alice.username), path: path(alice.username),
accept, accept,
type: HTML, type: HTML,
}); });
assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username); assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username);
assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id); assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id);
// TODO ogタグの検証 // TODO ogタグの検証
// TODO profile.noCrawleの検証 // TODO profile.noCrawleの検証
// TODO twitter:creatorの検証 // TODO twitter:creatorの検証
// TODO <link rel="me" ...>の検証 // TODO <link rel="me" ...>の検証
}); });
test('はHTMLとしてGETできる。(存在しないIDでも。)', async () => await ok({ test('はHTMLとしてGETできる。(存在しないIDでも。)', async () => await ok({
path: path('xxxxxxxxxx'), path: path('xxxxxxxxxx'),
type: HTML, type: HTML,
})); }));
}); });
@ -207,22 +208,22 @@ describe('Webリソース', () => {
{ accept: PREFER_AP }, { accept: PREFER_AP },
])('(Acceptヘッダ: $accept)', ({ accept }) => { ])('(Acceptヘッダ: $accept)', ({ accept }) => {
test('はActivityPubとしてGETできる。', async () => { test('はActivityPubとしてGETできる。', async () => {
const res = await ok({ const res = await ok({
path: path(alice.username), path: path(alice.username),
accept, accept,
type: AP, type: AP,
}); });
assert.strictEqual(res.body.type, 'Person'); assert.strictEqual(res.body.type, 'Person');
}); });
test('は存在しないIDのときActivityPubとしてGETできない。', async () => await notFound({ test('は存在しないIDのときActivityPubとしてGETできない。', async () => await notFound({
path: path('xxxxxxxxxx'), path: path('xxxxxxxxxx'),
accept, accept,
})); }));
}); });
}); });
describe.each([ describe.each([
// 実際のハンドルはフロントエンド(index.vue)で行われる // 実際のハンドルはフロントエンド(index.vue)で行われる
{ sub: 'home' }, { sub: 'home' },
{ sub: 'notes' }, { sub: 'notes' },
@ -236,32 +237,32 @@ describe('Webリソース', () => {
const path = (username: string): string => `/@${username}/${sub}`; const path = (username: string): string => `/@${username}/${sub}`;
test('はHTMLとしてGETできる。', async () => { test('はHTMLとしてGETできる。', async () => {
const res = await ok({ const res = await ok({
path: path(alice.username), path: path(alice.username),
}); });
assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username); assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username);
assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id); assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id);
}); });
}); });
describe('/@:user/pages/:page', () => { describe('/@:user/pages/:page', () => {
const path = (username: string, pagename: string): string => `/@${username}/pages/${pagename}`; const path = (username: string, pagename: string): string => `/@${username}/pages/${pagename}`;
test('はHTMLとしてGETできる。', async () => { test('はHTMLとしてGETできる。', async () => {
const res = await ok({ const res = await ok({
path: path(alice.username, alicePage.name), path: path(alice.username, alicePage.name),
}); });
assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username); assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username);
assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id); assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id);
assert.strictEqual(metaTag(res, 'misskey:page-id'), alicePage.id); assert.strictEqual(metaTag(res, 'misskey:page-id'), alicePage.id);
// TODO ogタグの検証 // TODO ogタグの検証
// TODO profile.noCrawleの検証 // TODO profile.noCrawleの検証
// TODO twitter:creatorの検証 // TODO twitter:creatorの検証
}); });
test('はGETできる。(存在しないIDでも。)', async () => await ok({ test('はGETできる。(存在しないIDでも。)', async () => await ok({
path: path(alice.username, 'xxxxxxxxxx'), path: path(alice.username, 'xxxxxxxxxx'),
})); }));
}); });
@ -278,7 +279,7 @@ describe('Webリソース', () => {
assert.strictEqual(res.location, `/@${alice.username}`); assert.strictEqual(res.location, `/@${alice.username}`);
}); });
test('は存在しないユーザーはGETできない。', async () => await notFound({ test('は存在しないユーザーはGETできない。', async () => await notFound({
path: path('xxxxxxxx'), path: path('xxxxxxxx'),
})); }));
}); });
@ -288,24 +289,24 @@ describe('Webリソース', () => {
{ accept: PREFER_AP }, { accept: PREFER_AP },
])('(Acceptヘッダ: $accept)', ({ accept }) => { ])('(Acceptヘッダ: $accept)', ({ accept }) => {
test('はActivityPubとしてGETできる。', async () => { test('はActivityPubとしてGETできる。', async () => {
const res = await ok({ const res = await ok({
path: path(alice.id), path: path(alice.id),
accept, accept,
type: AP, type: AP,
}); });
assert.strictEqual(res.body.type, 'Person'); assert.strictEqual(res.body.type, 'Person');
}); });
test('は存在しないIDのときActivityPubとしてGETできない。', async () => await notOk({ test('は存在しないIDのときActivityPubとしてGETできない。', async () => await notOk({
path: path('xxxxxxxx'), path: path('xxxxxxxx'),
accept, accept,
status: 404, status: 404,
})); }));
}); });
}); });
describe('/users/inbox', () => { describe('/users/inbox', () => {
test('がGETできる。(POST専用だけど4xx/5xxにならずHTMLが返ってくる)', async () => await ok({ test('がGETできる。(POST専用だけど4xx/5xxにならずHTMLが返ってくる)', async () => await ok({
path: '/inbox', path: '/inbox',
})); }));
@ -315,7 +316,7 @@ describe('Webリソース', () => {
describe('/users/:id/inbox', () => { describe('/users/:id/inbox', () => {
const path = (id: string): string => `/users/${id}/inbox`; const path = (id: string): string => `/users/${id}/inbox`;
test('がGETできる。(POST専用だけど4xx/5xxにならずHTMLが返ってくる)', async () => await ok({ test('がGETできる。(POST専用だけど4xx/5xxにならずHTMLが返ってくる)', async () => await ok({
path: path(alice.id), path: path(alice.id),
})); }));
@ -326,14 +327,14 @@ describe('Webリソース', () => {
const path = (id: string): string => `/users/${id}/outbox`; const path = (id: string): string => `/users/${id}/outbox`;
test('がGETできる。', async () => { test('がGETできる。', async () => {
const res = await ok({ const res = await ok({
path: path(alice.id), path: path(alice.id),
type: AP, type: AP,
}); });
assert.strictEqual(res.body.type, 'OrderedCollection'); assert.strictEqual(res.body.type, 'OrderedCollection');
}); });
}); });
describe('/notes/:id', () => { describe('/notes/:id', () => {
const path = (noteId: string): string => `/notes/${noteId}`; const path = (noteId: string): string => `/notes/${noteId}`;
@ -342,22 +343,22 @@ describe('Webリソース', () => {
{ accept: UNSPECIFIED }, { accept: UNSPECIFIED },
])('(Acceptヘッダ: $accept)', ({ accept }) => { ])('(Acceptヘッダ: $accept)', ({ accept }) => {
test('はHTMLとしてGETできる。', async () => { test('はHTMLとしてGETできる。', async () => {
const res = await ok({ const res = await ok({
path: path(alicesPost.id), path: path(alicesPost.id),
accept, accept,
type: HTML, type: HTML,
}); });
assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username); assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username);
assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id); assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id);
assert.strictEqual(metaTag(res, 'misskey:note-id'), alicesPost.id); assert.strictEqual(metaTag(res, 'misskey:note-id'), alicesPost.id);
// TODO ogタグの検証 // TODO ogタグの検証
// TODO profile.noCrawleの検証 // TODO profile.noCrawleの検証
// TODO twitter:creatorの検証 // TODO twitter:creatorの検証
}); });
test('はHTMLとしてGETできる。(存在しないIDでも。)', async () => await ok({ test('はHTMLとしてGETできる。(存在しないIDでも。)', async () => await ok({
path: path('xxxxxxxxxx'), path: path('xxxxxxxxxx'),
})); }));
}); });
@ -366,48 +367,48 @@ describe('Webリソース', () => {
{ accept: PREFER_AP }, { accept: PREFER_AP },
])('(Acceptヘッダ: $accept)', ({ accept }) => { ])('(Acceptヘッダ: $accept)', ({ accept }) => {
test('はActivityPubとしてGETできる。', async () => { test('はActivityPubとしてGETできる。', async () => {
const res = await ok({ const res = await ok({
path: path(alicesPost.id), path: path(alicesPost.id),
accept, accept,
type: AP, type: AP,
}); });
assert.strictEqual(res.body.type, 'Note'); assert.strictEqual(res.body.type, 'Note');
}); });
test('は存在しないIDのときActivityPubとしてGETできない。', async () => await notFound({ test('は存在しないIDのときActivityPubとしてGETできない。', async () => await notFound({
path: path('xxxxxxxxxx'), path: path('xxxxxxxxxx'),
accept, accept,
})); }));
}); });
}); });
describe('/play/:id', () => { describe('/play/:id', () => {
const path = (playid: string): string => `/play/${playid}`; const path = (playid: string): string => `/play/${playid}`;
test('がGETできる。', async () => { test('がGETできる。', async () => {
const res = await ok({ const res = await ok({
path: path(alicePlay.id), path: path(alicePlay.id),
}); });
assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username); assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username);
assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id); assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id);
assert.strictEqual(metaTag(res, 'misskey:flash-id'), alicePlay.id); assert.strictEqual(metaTag(res, 'misskey:flash-id'), alicePlay.id);
// TODO ogタグの検証 // TODO ogタグの検証
// TODO profile.noCrawleの検証 // TODO profile.noCrawleの検証
// TODO twitter:creatorの検証 // TODO twitter:creatorの検証
}); });
test('がGETできる。(存在しないIDでも。)', async () => await ok({ test('がGETできる。(存在しないIDでも。)', async () => await ok({
path: path('xxxxxxxxxx'), path: path('xxxxxxxxxx'),
})); }));
}); });
describe('/clips/:clip', () => { describe('/clips/:clip', () => {
const path = (clip: string): string => `/clips/${clip}`; const path = (clip: string): string => `/clips/${clip}`;
test('がGETできる。', async () => { test('がGETできる。', async () => {
const res = await ok({ const res = await ok({
path: path(aliceClip.id), path: path(aliceClip.id),
}); });
assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username); assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username);
assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id); assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id);
@ -416,9 +417,9 @@ describe('Webリソース', () => {
// TODO ogタグの検証 // TODO ogタグの検証
// TODO profile.noCrawleの検証 // TODO profile.noCrawleの検証
}); });
test('がGETできる。(存在しないIDでも。)', async () => await ok({ test('がGETできる。(存在しないIDでも。)', async () => await ok({
path: path('xxxxxxxxxx'), path: path('xxxxxxxxxx'),
})); }));
}); });
@ -426,8 +427,8 @@ describe('Webリソース', () => {
const path = (post: string): string => `/gallery/${post}`; const path = (post: string): string => `/gallery/${post}`;
test('がGETできる。', async () => { test('がGETできる。', async () => {
const res = await ok({ const res = await ok({
path: path(aliceGalleryPost.id), path: path(aliceGalleryPost.id),
}); });
assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username); assert.strictEqual(metaTag(res, 'misskey:user-username'), alice.username);
assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id); assert.strictEqual(metaTag(res, 'misskey:user-id'), alice.id);
@ -436,26 +437,26 @@ describe('Webリソース', () => {
// TODO profile.noCrawleの検証 // TODO profile.noCrawleの検証
// TODO twitter:creatorの検証 // TODO twitter:creatorの検証
}); });
test('がGETできる。(存在しないIDでも。)', async () => await ok({ test('がGETできる。(存在しないIDでも。)', async () => await ok({
path: path('xxxxxxxxxx'), path: path('xxxxxxxxxx'),
})); }));
}); });
describe('/channels/:channel', () => { describe('/channels/:channel', () => {
const path = (channel: string): string => `/channels/${channel}`; const path = (channel: string): string => `/channels/${channel}`;
test('はGETできる。', async () => { test('はGETできる。', async () => {
const res = await ok({ const res = await ok({
path: path(aliceChannel.id), path: path(aliceChannel.id),
}); });
// FIXME: misskey関連のmetaタグの設定がない // FIXME: misskey関連のmetaタグの設定がない
// TODO ogタグの検証 // TODO ogタグの検証
}); });
test('がGETできる。(存在しないIDでも。)', async () => await ok({ test('がGETできる。(存在しないIDでも。)', async () => await ok({
path: path('xxxxxxxxxx'), path: path('xxxxxxxxxx'),
})); }));
}); });
}); });

5
packages/backend/test/e2e/ff-visibility.ts
View file

@ -3,12 +3,13 @@ process.env.NODE_ENV = 'test';
import * as assert from 'assert'; import * as assert from 'assert';
import { signup, api, startServer, simpleGet } from '../utils.js'; import { signup, api, startServer, simpleGet } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
describe('FF visibility', () => { describe('FF visibility', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
let alice: any; let alice: misskey.entities.MeSignup;
let bob: any; let bob: misskey.entities.MeSignup;
beforeAll(async () => { beforeAll(async () => {
app = await startServer(); app = await startServer();

13
packages/backend/test/e2e/move.ts
View file

@ -7,6 +7,7 @@ import { User, UsersRepository } from '@/models/index.js';
import { jobQueue } from '@/boot/common.js'; import { jobQueue } from '@/boot/common.js';
import { uploadFile, signup, startServer, initTestDb, api, sleep, successfulApiCall } from '../utils.js'; import { uploadFile, signup, startServer, initTestDb, api, sleep, successfulApiCall } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
describe('Account Move', () => { describe('Account Move', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
@ -14,12 +15,12 @@ describe('Account Move', () => {
let url: URL; let url: URL;
let root: any; let root: any;
let alice: any; let alice: misskey.entities.MeSignup;
let bob: any; let bob: misskey.entities.MeSignup;
let carol: any; let carol: misskey.entities.MeSignup;
let dave: any; let dave: misskey.entities.MeSignup;
let eve: any; let eve: misskey.entities.MeSignup;
let frank: any; let frank: misskey.entities.MeSignup;
let Users: UsersRepository; let Users: UsersRepository;

7
packages/backend/test/e2e/mute.ts
View file

@ -3,14 +3,15 @@ process.env.NODE_ENV = 'test';
import * as assert from 'assert'; import * as assert from 'assert';
import { signup, api, post, react, startServer, waitFire } from '../utils.js'; import { signup, api, post, react, startServer, waitFire } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
describe('Mute', () => { describe('Mute', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
// alice mutes carol // alice mutes carol
let alice: any; let alice: misskey.entities.MeSignup;
let bob: any; let bob: misskey.entities.MeSignup;
let carol: any; let carol: misskey.entities.MeSignup;
beforeAll(async () => { beforeAll(async () => {
app = await startServer(); app = await startServer();

7
packages/backend/test/e2e/note.ts
View file

@ -4,13 +4,14 @@ import * as assert from 'assert';
import { Note } from '@/models/entities/Note.js'; import { Note } from '@/models/entities/Note.js';
import { signup, post, uploadUrl, startServer, initTestDb, api, uploadFile } from '../utils.js'; import { signup, post, uploadUrl, startServer, initTestDb, api, uploadFile } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
describe('Note', () => { describe('Note', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
let Notes: any; let Notes: any;
let alice: any; let alice: misskey.entities.MeSignup;
let bob: any; let bob: misskey.entities.MeSignup;
beforeAll(async () => { beforeAll(async () => {
app = await startServer(); app = await startServer();
@ -378,7 +379,7 @@ describe('Note', () => {
}, },
}, },
}, alice); }, alice);
assert.strictEqual(res.status, 200); assert.strictEqual(res.status, 200);
const assign = await api('admin/roles/assign', { const assign = await api('admin/roles/assign', {

7
packages/backend/test/e2e/renote-mute.ts
View file

@ -3,14 +3,15 @@ process.env.NODE_ENV = 'test';
import * as assert from 'assert'; import * as assert from 'assert';
import { signup, api, post, react, startServer, waitFire } from '../utils.js'; import { signup, api, post, react, startServer, waitFire } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
describe('Renote Mute', () => { describe('Renote Mute', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
// alice mutes carol // alice mutes carol
let alice: any; let alice: misskey.entities.MeSignup;
let bob: any; let bob: misskey.entities.MeSignup;
let carol: any; let carol: misskey.entities.MeSignup;
beforeAll(async () => { beforeAll(async () => {
app = await startServer(); app = await startServer();

11
packages/backend/test/e2e/streaming.ts
View file

@ -4,6 +4,7 @@ import * as assert from 'assert';
import { Following } from '@/models/entities/Following.js'; import { Following } from '@/models/entities/Following.js';
import { connectStream, signup, api, post, startServer, initTestDb, waitFire } from '../utils.js'; import { connectStream, signup, api, post, startServer, initTestDb, waitFire } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
describe('Streaming', () => { describe('Streaming', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
@ -26,13 +27,13 @@ describe('Streaming', () => {
describe('Streaming', () => { describe('Streaming', () => {
// Local users // Local users
let ayano: any; let ayano: misskey.entities.MeSignup;
let kyoko: any; let kyoko: misskey.entities.MeSignup;
let chitose: any; let chitose: misskey.entities.MeSignup;
// Remote users // Remote users
let akari: any; let akari: misskey.entities.MeSignup;
let chinatsu: any; let chinatsu: misskey.entities.MeSignup;
let kyokoNote: any; let kyokoNote: any;
let list: any; let list: any;

7
packages/backend/test/e2e/thread-mute.ts
View file

@ -3,13 +3,14 @@ process.env.NODE_ENV = 'test';
import * as assert from 'assert'; import * as assert from 'assert';
import { signup, api, post, connectStream, startServer } from '../utils.js'; import { signup, api, post, connectStream, startServer } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
describe('Note thread mute', () => { describe('Note thread mute', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
let alice: any; let alice: misskey.entities.MeSignup;
let bob: any; let bob: misskey.entities.MeSignup;
let carol: any; let carol: misskey.entities.MeSignup;
beforeAll(async () => { beforeAll(async () => {
app = await startServer(); app = await startServer();

3
packages/backend/test/e2e/user-notes.ts
View file

@ -3,11 +3,12 @@ process.env.NODE_ENV = 'test';
import * as assert from 'assert'; import * as assert from 'assert';
import { signup, api, post, uploadUrl, startServer } from '../utils.js'; import { signup, api, post, uploadUrl, startServer } from '../utils.js';
import type { INestApplicationContext } from '@nestjs/common'; import type { INestApplicationContext } from '@nestjs/common';
import type * as misskey from 'misskey-js';
describe('users/notes', () => { describe('users/notes', () => {
let app: INestApplicationContext; let app: INestApplicationContext;
let alice: any; let alice: misskey.entities.MeSignup;
let jpgNote: any; let jpgNote: any;
let pngNote: any; let pngNote: any;
let jpgPngNote: any; let jpgPngNote: any;

66
packages/backend/test/e2e/users.ts
View file

@ -4,14 +4,14 @@ import * as assert from 'assert';
import { inspect } from 'node:util'; import { inspect } from 'node:util';
import { DEFAULT_POLICIES } from '@/core/RoleService.js'; import { DEFAULT_POLICIES } from '@/core/RoleService.js';
import type { Packed } from '@/misc/json-schema.js'; import type { Packed } from '@/misc/json-schema.js';
import { import {
signup, signup,
post, post,
page, page,
role, role,
startServer, startServer,
api, api,
successfulApiCall, successfulApiCall,
failedApiCall, failedApiCall,
uploadFile, uploadFile,
} from '../utils.js'; } from '../utils.js';
@ -36,19 +36,19 @@ describe('ユーザー', () => {
badgeRoles: any[], badgeRoles: any[],
}; };
type UserDetailedNotMe = UserLite & type UserDetailedNotMe = UserLite &
misskey.entities.UserDetailed & { misskey.entities.UserDetailed & {
roles: any[], roles: any[],
}; };
type MeDetailed = UserDetailedNotMe & type MeDetailed = UserDetailedNotMe &
misskey.entities.MeDetailed & { misskey.entities.MeDetailed & {
achievements: object[], achievements: object[],
loggedInDays: number, loggedInDays: number,
policies: object, policies: object,
}; };
type User = MeDetailed & { token: string }; type User = MeDetailed & { token: string };
const show = async (id: string, me = root): Promise<MeDetailed | UserDetailedNotMe> => { const show = async (id: string, me = root): Promise<MeDetailed | UserDetailedNotMe> => {
return successfulApiCall({ endpoint: 'users/show', parameters: { userId: id }, user: me }) as any; return successfulApiCall({ endpoint: 'users/show', parameters: { userId: id }, user: me }) as any;
@ -159,7 +159,7 @@ describe('ユーザー', () => {
mutedInstances: user.mutedInstances, mutedInstances: user.mutedInstances,
mutingNotificationTypes: user.mutingNotificationTypes, mutingNotificationTypes: user.mutingNotificationTypes,
emailNotificationTypes: user.emailNotificationTypes, emailNotificationTypes: user.emailNotificationTypes,
achievements: user.achievements, achievements: user.achievements,
loggedInDays: user.loggedInDays, loggedInDays: user.loggedInDays,
policies: user.policies, policies: user.policies,
...(security ? { ...(security ? {
@ -222,11 +222,11 @@ describe('ユーザー', () => {
beforeAll(async () => { beforeAll(async () => {
root = await signup({ username: 'root' }); root = await signup({ username: 'root' });
alice = await signup({ username: 'alice' }); alice = await signup({ username: 'alice' });
aliceNote = await post(alice, { text: 'test' }) as any; aliceNote = await post(alice, { text: 'test' }) as any;
alicePage = await page(alice); alicePage = await page(alice);
aliceList = (await api('users/list/create', { name: 'aliceList' }, alice)).body; aliceList = (await api('users/list/create', { name: 'aliceList' }, alice)).body;
bob = await signup({ username: 'bob' }); bob = await signup({ username: 'bob' });
bobNote = await post(bob, { text: 'test' }) as any; bobNote = await post(bob, { text: 'test' }) as any;
carol = await signup({ username: 'carol' }); carol = await signup({ username: 'carol' });
dave = await signup({ username: 'dave' }); dave = await signup({ username: 'dave' });
ellen = await signup({ username: 'ellen' }); ellen = await signup({ username: 'ellen' });
@ -236,10 +236,10 @@ describe('ユーザー', () => {
usersReplying = await [...Array(10)].map((_, i) => i).reduce(async (acc, i) => { usersReplying = await [...Array(10)].map((_, i) => i).reduce(async (acc, i) => {
const u = await signup({ username: `replying${i}` }); const u = await signup({ username: `replying${i}` });
for (let j = 0; j < 10 - i; j++) { for (let j = 0; j < 10 - i; j++) {
const p = await post(u, { text: `test${j}` }); const p = await post(u, { text: `test${j}` });
await post(alice, { text: `@${u.username} test${j}`, replyId: p.id }); await post(alice, { text: `@${u.username} test${j}`, replyId: p.id });
} }
return (await acc).concat(u); return (await acc).concat(u);
}, Promise.resolve([] as User[])); }, Promise.resolve([] as User[]));
@ -376,7 +376,7 @@ describe('ユーザー', () => {
assert.strictEqual(response.securityKeys, false); assert.strictEqual(response.securityKeys, false);
assert.deepStrictEqual(response.roles, []); assert.deepStrictEqual(response.roles, []);
assert.strictEqual(response.memo, null); assert.strictEqual(response.memo, null);
// MeDetailedOnly // MeDetailedOnly
assert.strictEqual(response.avatarId, null); assert.strictEqual(response.avatarId, null);
assert.strictEqual(response.bannerId, null); assert.strictEqual(response.bannerId, null);
@ -406,7 +406,7 @@ describe('ユーザー', () => {
assert.deepStrictEqual(response.emailNotificationTypes, ['follow', 'receiveFollowRequest']); assert.deepStrictEqual(response.emailNotificationTypes, ['follow', 'receiveFollowRequest']);
assert.deepStrictEqual(response.achievements, []); assert.deepStrictEqual(response.achievements, []);
assert.deepStrictEqual(response.loggedInDays, 0); assert.deepStrictEqual(response.loggedInDays, 0);
assert.deepStrictEqual(response.policies, DEFAULT_POLICIES); assert.deepStrictEqual(response.policies, DEFAULT_POLICIES);
assert.notStrictEqual(response.email, undefined); assert.notStrictEqual(response.email, undefined);
assert.strictEqual(response.emailVerified, false); assert.strictEqual(response.emailVerified, false);
assert.deepStrictEqual(response.securityKeysList, []); assert.deepStrictEqual(response.securityKeysList, []);
@ -499,8 +499,8 @@ describe('ユーザー', () => {
const response = await successfulApiCall({ endpoint: 'i/update', parameters: parameters, user: alice }); const response = await successfulApiCall({ endpoint: 'i/update', parameters: parameters, user: alice });
assert.match(response.avatarUrl ?? '.', /^[-a-zA-Z0-9@:%._\+~#&?=\/]+$/); assert.match(response.avatarUrl ?? '.', /^[-a-zA-Z0-9@:%._\+~#&?=\/]+$/);
assert.match(response.avatarBlurhash ?? '.', /[ -~]{54}/); assert.match(response.avatarBlurhash ?? '.', /[ -~]{54}/);
const expected = { const expected = {
...meDetailed(alice, true), ...meDetailed(alice, true),
avatarId: aliceFile.id, avatarId: aliceFile.id,
avatarBlurhash: response.avatarBlurhash, avatarBlurhash: response.avatarBlurhash,
avatarUrl: response.avatarUrl, avatarUrl: response.avatarUrl,
@ -509,8 +509,8 @@ describe('ユーザー', () => {
const parameters2 = { avatarId: null }; const parameters2 = { avatarId: null };
const response2 = await successfulApiCall({ endpoint: 'i/update', parameters: parameters2, user: alice }); const response2 = await successfulApiCall({ endpoint: 'i/update', parameters: parameters2, user: alice });
const expected2 = { const expected2 = {
...meDetailed(alice, true), ...meDetailed(alice, true),
avatarId: null, avatarId: null,
avatarBlurhash: null, avatarBlurhash: null,
avatarUrl: alice.avatarUrl, // 解除した場合、identiconになる avatarUrl: alice.avatarUrl, // 解除した場合、identiconになる
@ -524,8 +524,8 @@ describe('ユーザー', () => {
const response = await successfulApiCall({ endpoint: 'i/update', parameters: parameters, user: alice }); const response = await successfulApiCall({ endpoint: 'i/update', parameters: parameters, user: alice });
assert.match(response.bannerUrl ?? '.', /^[-a-zA-Z0-9@:%._\+~#&?=\/]+$/); assert.match(response.bannerUrl ?? '.', /^[-a-zA-Z0-9@:%._\+~#&?=\/]+$/);
assert.match(response.bannerBlurhash ?? '.', /[ -~]{54}/); assert.match(response.bannerBlurhash ?? '.', /[ -~]{54}/);
const expected = { const expected = {
...meDetailed(alice, true), ...meDetailed(alice, true),
bannerId: aliceFile.id, bannerId: aliceFile.id,
bannerBlurhash: response.bannerBlurhash, bannerBlurhash: response.bannerBlurhash,
bannerUrl: response.bannerUrl, bannerUrl: response.bannerUrl,
@ -534,8 +534,8 @@ describe('ユーザー', () => {
const parameters2 = { bannerId: null }; const parameters2 = { bannerId: null };
const response2 = await successfulApiCall({ endpoint: 'i/update', parameters: parameters2, user: alice }); const response2 = await successfulApiCall({ endpoint: 'i/update', parameters: parameters2, user: alice });
const expected2 = { const expected2 = {
...meDetailed(alice, true), ...meDetailed(alice, true),
bannerId: null, bannerId: null,
bannerBlurhash: null, bannerBlurhash: null,
bannerUrl: null, bannerUrl: null,
@ -551,7 +551,7 @@ describe('ユーザー', () => {
const response = await successfulApiCall({ endpoint: 'i/pin', parameters, user: alice }); const response = await successfulApiCall({ endpoint: 'i/pin', parameters, user: alice });
const expected = { ...meDetailed(alice, false), pinnedNoteIds: [aliceNote.id], pinnedNotes: [aliceNote] }; const expected = { ...meDetailed(alice, false), pinnedNoteIds: [aliceNote.id], pinnedNotes: [aliceNote] };
assert.deepStrictEqual(response, expected); assert.deepStrictEqual(response, expected);
const response2 = await successfulApiCall({ endpoint: 'i/unpin', parameters, user: alice }); const response2 = await successfulApiCall({ endpoint: 'i/unpin', parameters, user: alice });
const expected2 = meDetailed(alice, false); const expected2 = meDetailed(alice, false);
assert.deepStrictEqual(response2, expected2); assert.deepStrictEqual(response2, expected2);
@ -612,7 +612,7 @@ describe('ユーザー', () => {
}); });
test.todo('をリスト形式で取得することができる（リモート, hostname指定）'); test.todo('をリスト形式で取得することができる（リモート, hostname指定）');
test.todo('をリスト形式で取得することができる（pagenation）'); test.todo('をリスト形式で取得することができる（pagenation）');
//#endregion //#endregion
//#region ユーザー情報(users/show) //#region ユーザー情報(users/show)
@ -684,9 +684,9 @@ describe('ユーザー', () => {
const parameters = { userIds: [bob.id, alice.id, carol.id] }; const parameters = { userIds: [bob.id, alice.id, carol.id] };
const response = await successfulApiCall({ endpoint: 'users/show', parameters, user: alice }); const response = await successfulApiCall({ endpoint: 'users/show', parameters, user: alice });
const expected = [ const expected = [
await successfulApiCall({ endpoint: 'users/show', parameters: { userId: bob.id }, user: alice }), await successfulApiCall({ endpoint: 'users/show', parameters: { userId: bob.id }, user: alice }),
await successfulApiCall({ endpoint: 'users/show', parameters: { userId: alice.id }, user: alice }), await successfulApiCall({ endpoint: 'users/show', parameters: { userId: alice.id }, user: alice }),
await successfulApiCall({ endpoint: 'users/show', parameters: { userId: carol.id }, user: alice }), await successfulApiCall({ endpoint: 'users/show', parameters: { userId: carol.id }, user: alice }),
]; ];
assert.deepStrictEqual(response, expected); assert.deepStrictEqual(response, expected);
}); });
@ -701,7 +701,7 @@ describe('ユーザー', () => {
// BUG サスペンドユーザーを一般ユーザーから見るとrootユーザーが返ってくる // BUG サスペンドユーザーを一般ユーザーから見るとrootユーザーが返ってくる
//{ label: 'サスペンドユーザーが（一般ユーザーが見るときは）含まれない', user: (): User => userSuspended, me: (): User => bob, excluded: true }, //{ label: 'サスペンドユーザーが（一般ユーザーが見るときは）含まれない', user: (): User => userSuspended, me: (): User => bob, excluded: true },
{ label: '削除済ユーザーが含まれる', user: (): User => userDeletedBySelf }, { label: '削除済ユーザーが含まれる', user: (): User => userDeletedBySelf },
{ label: '削除済(byAdmin)ユーザーが含まれる', user: (): User => userDeletedByAdmin }, { label: '削除済(byAdmin)ユーザーが含まれる', user: (): User => userDeletedByAdmin },
] as const)('をID指定のリスト形式で取得することができ、結果に$label', async ({ user, me, excluded }) => { ] as const)('をID指定のリスト形式で取得することができ、結果に$label', async ({ user, me, excluded }) => {
const parameters = { userIds: [user().id] }; const parameters = { userIds: [user().id] };
const response = await successfulApiCall({ endpoint: 'users/show', parameters, user: me?.() ?? alice }); const response = await successfulApiCall({ endpoint: 'users/show', parameters, user: me?.() ?? alice });
@ -734,7 +734,7 @@ describe('ユーザー', () => {
{ label: 'サイレンスユーザーが含まれる', user: (): User => userSilenced }, { label: 'サイレンスユーザーが含まれる', user: (): User => userSilenced },
{ label: 'サスペンドユーザーが含まれない', user: (): User => userSuspended, excluded: true }, { label: 'サスペンドユーザーが含まれない', user: (): User => userSuspended, excluded: true },
{ label: '削除済ユーザーが含まれる', user: (): User => userDeletedBySelf }, { label: '削除済ユーザーが含まれる', user: (): User => userDeletedBySelf },
{ label: '削除済(byAdmin)ユーザーが含まれる', user: (): User => userDeletedByAdmin }, { label: '削除済(byAdmin)ユーザーが含まれる', user: (): User => userDeletedByAdmin },
] as const)('を検索することができ、結果に$labelが含まれる', async ({ user, excluded }) => { ] as const)('を検索することができ、結果に$labelが含まれる', async ({ user, excluded }) => {
const parameters = { query: user().username, limit: 1 }; const parameters = { query: user().username, limit: 1 };
const response = await successfulApiCall({ endpoint: 'users/search', parameters, user: alice }); const response = await successfulApiCall({ endpoint: 'users/search', parameters, user: alice });
@ -747,7 +747,7 @@ describe('ユーザー', () => {
//#endregion //#endregion
//#region ID指定検索(users/search-by-username-and-host) //#region ID指定検索(users/search-by-username-and-host)
test.each([ test.each([
{ label: '自分', parameters: { username: 'alice' }, user: (): User[] => [alice] }, { label: '自分', parameters: { username: 'alice' }, user: (): User[] => [alice] },
{ label: '自分かつusernameが大文字', parameters: { username: 'ALICE' }, user: (): User[] => [alice] }, { label: '自分かつusernameが大文字', parameters: { username: 'ALICE' }, user: (): User[] => [alice] },
{ label: 'ローカルのフォロイーでノートなし', parameters: { username: 'userFollowedByAlice' }, user: (): User[] => [userFollowedByAlice] }, { label: 'ローカルのフォロイーでノートなし', parameters: { username: 'userFollowedByAlice' }, user: (): User[] => [userFollowedByAlice] },
@ -786,7 +786,7 @@ describe('ユーザー', () => {
test('がよくリプライをするユーザーのリストを取得できる', async () => { test('がよくリプライをするユーザーのリストを取得できる', async () => {
const parameters = { userId: alice.id, limit: 5 }; const parameters = { userId: alice.id, limit: 5 };
const response = await successfulApiCall({ endpoint: 'users/get-frequently-replied-users', parameters, user: alice }); const response = await successfulApiCall({ endpoint: 'users/get-frequently-replied-users', parameters, user: alice });
const expected = await Promise.all(usersReplying.slice(0, parameters.limit).map(async (s, i) => ({ const expected = await Promise.all(usersReplying.slice(0, parameters.limit).map(async (s, i) => ({
user: await show(s.id, alice), user: await show(s.id, alice),
weight: (usersReplying.length - i) / usersReplying.length, weight: (usersReplying.length - i) / usersReplying.length,
}))); })));

22
packages/backend/test/utils.ts
View file

@ -83,7 +83,7 @@ const relativeFetch = async (path: string, init?: RequestInit | undefined) => {
return await fetch(new URL(path, `http://127.0.0.1:${port}/`).toString(), init); return await fetch(new URL(path, `http://127.0.0.1:${port}/`).toString(), init);
}; };
export const signup = async (params?: any): Promise<any> => { export const signup = async (params?: Partial<misskey.Endpoints['signup']['req']>): Promise<NonNullable<misskey.Endpoints['signup']['res']>> => {
const q = Object.assign({ const q = Object.assign({
username: 'test', username: 'test',
password: 'test', password: 'test',
@ -213,8 +213,8 @@ export const role = async (user: any, role: any = {}, policies: any = {}): Promi
isPublic: false, isPublic: false,
name: 'New Role', name: 'New Role',
target: 'manual', target: 'manual',
policies: { policies: {
...Object.entries(DEFAULT_POLICIES).map(([k, v]) => [k, { ...Object.entries(DEFAULT_POLICIES).map(([k, v]) => [k, {
priority: 0, priority: 0,
useDefault: true, useDefault: true,
value: v, value: v,
@ -351,11 +351,11 @@ export const waitFire = async (user: any, channel: string, trgr: () => any, cond
}); });
}; };
export type SimpleGetResponse = { export type SimpleGetResponse = {
status: number, status: number,
body: any | JSDOM | null, body: any | JSDOM | null,
type: string | null, type: string | null,
location: string | null location: string | null
}; };
export const simpleGet = async (path: string, accept = '*/*', cookie: any = undefined): Promise<SimpleGetResponse> => { export const simpleGet = async (path: string, accept = '*/*', cookie: any = undefined): Promise<SimpleGetResponse> => {
const res = await relativeFetch(path, { const res = await relativeFetch(path, {
@ -374,9 +374,9 @@ export const simpleGet = async (path: string, accept = '*/*', cookie: any = unde
'text/html; charset=utf-8', 'text/html; charset=utf-8',
]; ];
const body = const body =
jsonTypes.includes(res.headers.get('content-type') ?? '') ? await res.json() : jsonTypes.includes(res.headers.get('content-type') ?? '') ? await res.json() :
htmlTypes.includes(res.headers.get('content-type') ?? '') ? new JSDOM(await res.text()) : htmlTypes.includes(res.headers.get('content-type') ?? '') ? new JSDOM(await res.text()) :
null; null;
return { return {

33
packages/misskey-js/etc/misskey-js.api.md
View file

@ -1942,6 +1942,19 @@ export type Endpoints = {
req: TODO; req: TODO;
res: TODO; res: TODO;
}; };
'signup': {
req: {
username: string;
password: string;
host?: string;
invitationCode?: string;
emailAddress?: string;
'hcaptcha-response'?: string;
'g-recaptcha-response'?: string;
'turnstile-response'?: string;
};
res: MeSignup | null;
};
'stats': { 'stats': {
req: NoParams; req: NoParams;
res: Stats; res: Stats;
@ -2159,6 +2172,8 @@ declare namespace entities {
UserGroup, UserGroup,
UserList, UserList,
MeDetailed, MeDetailed,
MeDetailedWithSecret,
MeSignup,
DriveFile, DriveFile,
DriveFolder, DriveFolder,
GalleryPost, GalleryPost,
@ -2374,6 +2389,22 @@ type MeDetailed = UserDetailed & {
[other: string]: any; [other: string]: any;
}; };
// @public (undocumented)
type MeDetailedWithSecret = MeDetailed & {
email: string;
emailVerified: boolean;
securityKeysList: {
id: string;
name: string;
lastUsed: string;
}[];
};
// @public (undocumented)
type MeSignup = MeDetailedWithSecret & {
token: string;
};
// @public (undocumented) // @public (undocumented)
type MessagingMessage = { type MessagingMessage = {
id: ID; id: ID;
@ -2719,7 +2750,7 @@ type UserSorting = '+follower' | '-follower' | '+createdAt' | '-createdAt' | '+u
// //
// src/api.types.ts:16:32 - (ae-forgotten-export) The symbol "TODO" needs to be exported by the entry point index.d.ts // src/api.types.ts:16:32 - (ae-forgotten-export) The symbol "TODO" needs to be exported by the entry point index.d.ts
// src/api.types.ts:18:25 - (ae-forgotten-export) The symbol "NoParams" needs to be exported by the entry point index.d.ts // src/api.types.ts:18:25 - (ae-forgotten-export) The symbol "NoParams" needs to be exported by the entry point index.d.ts
// src/api.types.ts:596:18 - (ae-forgotten-export) The symbol "ShowUserReq" needs to be exported by the entry point index.d.ts // src/api.types.ts:611:18 - (ae-forgotten-export) The symbol "ShowUserReq" needs to be exported by the entry point index.d.ts
// src/streaming.types.ts:33:4 - (ae-forgotten-export) The symbol "FIXME" needs to be exported by the entry point index.d.ts // src/streaming.types.ts:33:4 - (ae-forgotten-export) The symbol "FIXME" needs to be exported by the entry point index.d.ts
// (No @packageDocumentation comment for this package) // (No @packageDocumentation comment for this package)

17
packages/misskey-js/src/api.types.ts
View file

@ -2,7 +2,7 @@ import type {
Ad, Announcement, Antenna, App, AuthSession, Blocking, Channel, Clip, DateString, DetailedInstanceMetadata, DriveFile, DriveFolder, Following, FollowingFolloweePopulated, FollowingFollowerPopulated, FollowRequest, GalleryPost, Instance, Ad, Announcement, Antenna, App, AuthSession, Blocking, Channel, Clip, DateString, DetailedInstanceMetadata, DriveFile, DriveFolder, Following, FollowingFolloweePopulated, FollowingFollowerPopulated, FollowRequest, GalleryPost, Instance,
LiteInstanceMetadata, LiteInstanceMetadata,
MeDetailed, MeDetailed,
Note, NoteFavorite, OriginType, Page, ServerInfo, Stats, User, UserDetailed, UserGroup, UserList, UserSorting, Notification, NoteReaction, Signin, MessagingMessage, Note, NoteFavorite, OriginType, Page, ServerInfo, Stats, User, UserDetailed, MeSignup, UserGroup, UserList, UserSorting, Notification, NoteReaction, Signin, MessagingMessage,
} from './entities.js'; } from './entities.js';
type TODO = Record<string, any> | null; type TODO = Record<string, any> | null;
@ -549,6 +549,21 @@ export type Endpoints = {
'room/show': { req: TODO; res: TODO; }; 'room/show': { req: TODO; res: TODO; };
'room/update': { req: TODO; res: TODO; }; 'room/update': { req: TODO; res: TODO; };
// signup
'signup': {
req: {
username: string;
password: string;
host?: string;
invitationCode?: string;
emailAddress?: string;
'hcaptcha-response'?: string;
'g-recaptcha-response'?: string;
'turnstile-response'?: string;
};
res: MeSignup | null;
};
// stats // stats
'stats': { req: NoParams; res: Stats; }; 'stats': { req: NoParams; res: Stats; };

14
packages/misskey-js/src/entities.ts
View file

@ -107,6 +107,20 @@ export type MeDetailed = UserDetailed & {
[other: string]: any; [other: string]: any;
}; };
export type MeDetailedWithSecret = MeDetailed & {
email: string;
emailVerified: boolean;
securityKeysList: {
id: string;
name: string;
lastUsed: string;
}[];
};
export type MeSignup = MeDetailedWithSecret & {
token: string;
};
export type DriveFile = { export type DriveFile = {
id: ID; id: ID;
createdAt: DateString; createdAt: DateString;