OpenSource/misskey
OpenSource/misskey
1
0
Fork 0
mirror of https://github.com/misskey-dev/misskey.git synced 2024-11-23 00:09:08 +01:00
Code Issues Projects Releases Packages Wiki Activity

wip

Browse source
This commit is contained in:
tamaina 2023-05-22 05:20:19 +00:00
parent 86f4e206f4
commit 1b6ac7888b
10 changed files with 68 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
packages/backend/src/server/api/openapi/gen-spec.ts
View file

@ -38,7 +38,7 @@ export function genOpenapiSpec(config: Config) {
},
};
for (const [name, endpoint] of Object.entries(endpoints).filter(([name, ep]) => !ep.secure)) {
for (const [name, endpoint] of Object.entries(endpoints).filter(([name, ep]) => !('secure' in ep) || !ep.secure)) {
const errors = {} as any;
if ('errors' in endpoint && endpoint.errors) {
@ -107,7 +107,7 @@ export function genOpenapiSpec(config: Config) {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/Error',
$ref: '#/components/schemas/ApiError',
},
examples: { ...errors, ...basicErrors['400'] },
},
@ -118,7 +118,7 @@ export function genOpenapiSpec(config: Config) {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/Error',
$ref: '#/components/schemas/ApiError',
},
examples: basicErrors['401'],
},
@ -129,7 +129,7 @@ export function genOpenapiSpec(config: Config) {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/Error',
$ref: '#/components/schemas/ApiError',
},
examples: basicErrors['403'],
},
@ -140,7 +140,7 @@ export function genOpenapiSpec(config: Config) {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/Error',
$ref: '#/components/schemas/ApiError',
},
examples: basicErrors['418'],
},
@ -152,7 +152,7 @@ export function genOpenapiSpec(config: Config) {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/Error',
$ref: '#/components/schemas/ApiError',
},
examples: basicErrors['429'],
},
@ -164,7 +164,7 @@ export function genOpenapiSpec(config: Config) {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/Error',
$ref: '#/components/schemas/ApiError',
},
examples: basicErrors['500'],
},

27
packages/backend/src/server/api/openapi/schemas.ts
View file

@ -1,32 +1,5 @@
import { refs } from 'misskey-js/built/schemas.js';
export const schemas = {
Error: {
type: 'object',
properties: {
error: {
type: 'object',
description: 'An error object.',
properties: {
code: {
type: 'string',
description: 'An error code. Unique within the endpoint.',
},
message: {
type: 'string',
description: 'An error message.',
},
id: {
type: 'string',
format: 'uuid',
description: 'An error ID. This ID is static.',
},
},
required: ['code', 'id', 'message'],
},
},
required: ['error'],
},
...refs,
};

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

@ -3,7 +3,6 @@ process.env.NODE_ENV = 'test';
import * as assert from 'assert';
import { inspect } from 'node:util';
import { DEFAULT_POLICIES } from '@/core/RoleService.js';
import type { Packed } from '@/misc/json-schema.js';
import {
signup,
post,
@ -19,6 +18,7 @@ import {
} from '../utils.js';
import type * as misskey from 'misskey-js';
import type { INestApplicationContext } from '@nestjs/common';
import { WeakSerialized } from 'schema-type';
const compareBy = <T extends { id: string }>(selector: (s: T) => string = (s: T): string => s.id) => (a: T, b: T): number => {
return selector(a).localeCompare(selector(b));
@ -28,12 +28,9 @@ describe('アンテナ', () => {
// エンティティとしてのアンテナを主眼においたテストを記述する
// (Antennaを返すエンドポイント、Antennaエンティティを書き換えるエンドポイント、Antennaからノートを取得するエンドポイントをテストする)
// BUG misskey-jsとjson-schemaが一致していない。
// - srcのenumにgroupが残っている
// - userGroupIdが残っている, isActiveがない
type Antenna = misskey.entities.Antenna | Packed<'Antenna'>;
type User = misskey.entities.MeDetailed & { token: string };
type Note = misskey.entities.Note;
type Antenna = WeakSerialized<misskey.entities.Antenna>;
type User = WeakSerialized<misskey.entities.MeDetailed & { token: string }>;
type Note = WeakSerialized<misskey.entities.Note>;
// アンテナを作成できる最小のパラメタ
const defaultParam = {

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

@ -10,6 +10,7 @@ import { DEFAULT_POLICIES } from '@/core/RoleService.js';
import { entities } from '../src/postgres.js';
import { loadConfig } from '../src/config.js';
import type * as misskey from 'misskey-js';
import { SchemaOrUndefined } from 'misskey-js/built/endpoints.types.js';
export { server as startServer } from '@/boot/common.js';
@ -25,15 +26,18 @@ export const api = async (endpoint: string, params: any, me?: any) => {
return await request(`api/${normalized}`, params, me);
};
export type ApiRequest = {
endpoint: string,
parameters: object,
export type ApiRequest<X extends keyof misskey.Endpoints = keyof misskey.Endpoints, D extends misskey.Endpoints[X]['defines'][number] = misskey.Endpoints[X]['defines'][number], P extends D['req'] = D['req']> = {
endpoint: X,
parameters: SchemaOrUndefined<P>,
user: object | undefined,
};
export const successfulApiCall = async <T, >(request: ApiRequest, assertion: {
status?: number,
} = {}): Promise<T> => {
export const successfulApiCall = async <X extends keyof misskey.Endpoints, D extends misskey.Endpoints[X]['defines'][number] = misskey.Endpoints[X]['defines'][number]>(
request: ApiRequest<X, D>,
assertion: {
status?: number,
} = {}
): Promise<SchemaOrUndefined<D['res']>> => {
const { endpoint, parameters, user } = request;
const res = await api(endpoint, parameters, user);
const status = assertion.status ?? (res.body == null ? 204 : 200);
@ -41,11 +45,11 @@ export const successfulApiCall = async <T, >(request: ApiRequest, assertion: {
return res.body;
};
export const failedApiCall = async <T, >(request: ApiRequest, assertion: {
export const failedApiCall = async <X extends keyof misskey.Endpoints>(request: ApiRequest<X>, assertion: {
status: number,
code: string,
id: string
}): Promise<T> => {
}): Promise<misskey.Packed<'Error#/$defs/Error'>> => {
const { endpoint, parameters, user } = request;
const { status, code, id } = assertion;
const res = await api(endpoint, parameters, user);

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

@ -7,6 +7,7 @@ type TODO = Record<string, any>;
// NOTE: 極力この型を使うのは避け、UserLite か UserDetailed か明示するように
export type User = Packed<'User'>;
export type UserLite = Packed<'UserLite'>;
export type UserDetailed = Packed<'UserDetailed'>;
export type UserList = Packed<'UserList'>;

4
packages/misskey-js/src/schemas.ts
View file

@ -35,6 +35,7 @@ import { packedEmojiDetailedSchema, packedEmojiSimpleSchema } from './schemas/em
import { packedFlashSchema } from './schemas/flash.js';
import { packedAdSchema } from './schemas/ad.js';
import { packedAnnouncementSchema } from './schemas/announcement.js';
import { Error, ApiError } from './schemas/error.js';
import type { JSONSchema7, JSONSchema7Definition, GetDef, GetRefs, GetKeys, UnionToArray } from 'schema-type';
export const refs = {
@ -74,6 +75,9 @@ export const refs = {
Flash: packedFlashSchema,
Ad: packedAdSchema,
Announcement: packedAnnouncementSchema,
Error: Error,
ApiError: ApiError,
} as const satisfies { [x: string]: JSONSchema7Definition };
export type References = GetRefs<typeof refs>;

2
packages/misskey-js/src/schemas/blocking.ts
View file

@ -17,6 +17,6 @@ export const packedBlockingSchema = {
'id',
'createdAt',
'blockeeId',
'blockee',
//'blockee',
],
} as const satisfies JSONSchema7Definition;

34
packages/misskey-js/src/schemas/error.ts Normal file
View file

@ -0,0 +1,34 @@
import type { JSONSchema7Definition } from 'schema-type';
export const Error = {
$id: 'https://misskey-hub.net/api/schemas/Error',
type: 'object',
description: 'An error object.',
properties: {
code: {
type: 'string',
description: 'An error code. Unique within the endpoint.',
},
message: {
type: 'string',
description: 'An error message.',
},
id: {
type: 'string',
format: 'uuid',
description: 'An error ID. This ID is static.',
},
},
required: ['code', 'id', 'message'],
} as const satisfies JSONSchema7Definition;
export const ApiError = {
$id: 'https://misskey-hub.net/api/schemas/ApiError',
type: 'object',
properties: {
error: { $ref: 'https://misskey-hub.net/api/schemas/Error' },
},
required: ['error'],
} as const satisfies JSONSchema7Definition;

4
packages/misskey-js/test-d/schemas.ts
View file

@ -97,4 +97,8 @@ describe('schemas', () => {
test('ad', () => {
type Ad = Packed<'Ad'>;
});
test('error', () => {
type Error = Packed<'Error'>;
type ApiError = Packed<'ApiError'>;
});
});

2
packages/misskey-js/test/api.ts
View file

@ -20,7 +20,7 @@ describe('schemas', () => {
}
});
test('jointed schema (oneOf)', () => {
test('jointed schema', () => {
const req = getEndpointSchema('req', key as keyof Endpoints);
if (req) ajv.compile(req);
});