fix(backend): 虚無ノートを投稿できる問題の修正と api.json の OpenAPI Specification 3.1.0 への対応 (#12969)

* fix(backend): `text: null`だけのノートは投稿できないように * add test * Update CHANGELOG.md * chore: bump OpenAPI Specification from 3.0.0 to 3.1.0 * chore: テストがすでにコメントで記述されていたのでそっちを使うことにする * fix test * fix(backend): prohibit posting whitespace-only notes * Update CHANGELOG.md * fix(backend): `renoteId`または`fileIds`（`mediaIds`）または`poll`が`null`でない場合に、`text が空白文字のみで構成されたリクエストになることを許可して、結果は`text: null`を返すように * test(backend): 引用renoteで空白文字のみで構成されたtextにするとレスポンスが`text: null`になることをチェックするテストを追加 * fix(frontend): `text`が`null`であって`renoteId`と`replyId`が`null`でないようなノートは引用リノートとして表示するように * fix(misskey-js): OpenAPI 3.1に対応 * fix(misskey-js): 型生成をOpenAPI Specification 3.1.0に対応 * fix(ci): `validate-api.json`をOpenAPI Specification 3.1.0に対応 * fix(ci): スキーマ書き換えの際のミスを修正 * Revert "fix(frontend): `text`が`null`であって`renoteId`と`replyId`が`null`でないようなノートは引用リノートとして表示するように" This reverts commit a9ca55343d. * fix(misskey-js): `build-misskey-js-with-types`時は`api.json`のGETをスキップするように * Revert "fix(misskey-js): `build-misskey-js-with-types`時は`api.json`のGETをスキップするように" This reverts commit 865458989f. * fix(misskey-js): `openapi-parser`で`validate`のかわりに`parse`を用いるように * Update CHANGELOG.md
2024-01-13 16:54:25 +09:00
parent 79370aaee2
commit d792f4f348
19 changed files with 259 additions and 146 deletions
--- a/packages/misskey-js/generator/package.json
+++ b/packages/misskey-js/generator/package.json
@@ -7,14 +7,14 @@
 		"generate": "tsx src/generator.ts && eslint ./built/**/* --ext .ts --fix"
 	},
 	"devDependencies": {
-		"@apidevtools/swagger-parser": "10.1.0",
 		"@misskey-dev/eslint-plugin": "^1.0.0",
+		"@readme/openapi-parser": "2.5.0",
 		"@types/node": "20.9.1",
 		"@typescript-eslint/eslint-plugin": "6.11.0",
 		"@typescript-eslint/parser": "6.11.0",
 		"eslint": "8.53.0",
 		"openapi-types": "12.1.3",
-		"openapi-typescript": "6.7.1",
+		"openapi-typescript": "6.7.3",
 		"ts-case-convert": "2.0.2",
 		"tsx": "4.4.0",
 		"typescript": "5.3.3"
--- a/packages/misskey-js/generator/src/generator.ts
+++ b/packages/misskey-js/generator/src/generator.ts
@@ -1,10 +1,10 @@
 import { mkdir, writeFile } from 'fs/promises';
-import { OpenAPIV3 } from 'openapi-types';
+import { OpenAPIV3_1 } from 'openapi-types';
 import { toPascal } from 'ts-case-convert';
-import SwaggerParser from '@apidevtools/swagger-parser';
+import OpenAPIParser from '@readme/openapi-parser';
 import openapiTS from 'openapi-typescript';

-function generateVersionHeaderComment(openApiDocs: OpenAPIV3.Document): string {
+function generateVersionHeaderComment(openApiDocs: OpenAPIV3_1.Document): string {
 	const contents = {
 		version: openApiDocs.info.version,
 		generatedAt: new Date().toISOString(),
@@ -21,7 +21,7 @@ function generateVersionHeaderComment(openApiDocs: OpenAPIV3.Document): string {
 }

 async function generateBaseTypes(
-	openApiDocs: OpenAPIV3.Document,
+	openApiDocs: OpenAPIV3_1.Document,
 	openApiJsonPath: string,
 	typeFileName: string,
 ) {
@@ -47,7 +47,7 @@ async function generateBaseTypes(
 }

 async function generateSchemaEntities(
-	openApiDocs: OpenAPIV3.Document,
+	openApiDocs: OpenAPIV3_1.Document,
 	typeFileName: string,
 	outputPath: string,
 ) {
@@ -71,7 +71,7 @@ async function generateSchemaEntities(
 }

 async function generateEndpoints(
-	openApiDocs: OpenAPIV3.Document,
+	openApiDocs: OpenAPIV3_1.Document,
 	typeFileName: string,
 	entitiesOutputPath: string,
 	endpointOutputPath: string,
@@ -79,7 +79,7 @@ async function generateEndpoints(
 	const endpoints: Endpoint[] = [];

 	// misskey-jsはPOST固定で送っているので、こちらも決め打ちする。別メソッドに対応することがあればこちらも直す必要あり
-	const paths = openApiDocs.paths;
+	const paths = openApiDocs.paths ?? {};
 	const postPathItems = Object.keys(paths)
 		.map(it => paths[it]?.post)
 		.filter(filterUndefined);
@@ -160,7 +160,7 @@ async function generateEndpoints(
 }

 async function generateApiClientJSDoc(
-	openApiDocs: OpenAPIV3.Document,
+	openApiDocs: OpenAPIV3_1.Document,
 	apiClientFileName: string,
 	endpointsFileName: string,
 	warningsOutputPath: string,
@@ -168,7 +168,7 @@ async function generateApiClientJSDoc(
 	const endpoints: { operationId: string; description: string; }[] = [];

 	// misskey-jsはPOST固定で送っているので、こちらも決め打ちする。別メソッドに対応することがあればこちらも直す必要あり
-	const paths = openApiDocs.paths;
+	const paths = openApiDocs.paths ?? {};
 	const postPathItems = Object.keys(paths)
 		.map(it => paths[it]?.post)
 		.filter(filterUndefined);
@@ -221,21 +221,21 @@ async function generateApiClientJSDoc(
 	await writeFile(warningsOutputPath, endpointOutputLine.join('\n'));
 }

-function isRequestBodyObject(value: unknown): value is OpenAPIV3.RequestBodyObject {
+function isRequestBodyObject(value: unknown): value is OpenAPIV3_1.RequestBodyObject {
 	if (!value) {
 		return false;
 	}

-	const { content } = value as Record<keyof OpenAPIV3.RequestBodyObject, unknown>;
+	const { content } = value as Record<keyof OpenAPIV3_1.RequestBodyObject, unknown>;
 	return content !== undefined;
 }

-function isResponseObject(value: unknown): value is OpenAPIV3.ResponseObject {
+function isResponseObject(value: unknown): value is OpenAPIV3_1.ResponseObject {
 	if (!value) {
 		return false;
 	}

-	const { description } = value as Record<keyof OpenAPIV3.ResponseObject, unknown>;
+	const { description } = value as Record<keyof OpenAPIV3_1.ResponseObject, unknown>;
 	return description !== undefined;
 }

@@ -330,7 +330,7 @@ async function main() {
 	await mkdir(generatePath, { recursive: true });

 	const openApiJsonPath = './api.json';
-	const openApiDocs = await SwaggerParser.validate(openApiJsonPath) as OpenAPIV3.Document;
+	const openApiDocs = await OpenAPIParser.parse(openApiJsonPath) as OpenAPIV3_1.Document;

 	const typeFileName = './built/autogen/types.ts';
 	await generateBaseTypes(openApiDocs, openApiJsonPath, typeFileName);
--- a/packages/misskey-js/src/autogen/apiClientJSDoc.ts
+++ b/packages/misskey-js/src/autogen/apiClientJSDoc.ts
@@ -1,6 +1,6 @@
 /*
 * version: 2023.12.2
- * generatedAt: 2024-01-11T14:29:04.817Z
+ * generatedAt: 2024-01-13T04:31:38.782Z
 */

 import type { SwitchCaseResponseType } from '../api.js';
--- a/packages/misskey-js/src/autogen/endpoint.ts
+++ b/packages/misskey-js/src/autogen/endpoint.ts
@@ -1,6 +1,6 @@
 /*
 * version: 2023.12.2
- * generatedAt: 2024-01-11T14:29:04.814Z
+ * generatedAt: 2024-01-13T04:31:38.778Z
 */

 import type {
--- a/packages/misskey-js/src/autogen/entities.ts
+++ b/packages/misskey-js/src/autogen/entities.ts
@@ -1,6 +1,6 @@
 /*
 * version: 2023.12.2
- * generatedAt: 2024-01-11T14:29:04.811Z
+ * generatedAt: 2024-01-13T04:31:38.775Z
 */

 import { operations } from './types.js';
--- a/packages/misskey-js/src/autogen/models.ts
+++ b/packages/misskey-js/src/autogen/models.ts
@@ -1,6 +1,6 @@
 /*
 * version: 2023.12.2
- * generatedAt: 2024-01-11T14:29:04.810Z
+ * generatedAt: 2024-01-13T04:31:38.773Z
 */

 import { components } from './types.js';
--- a/packages/misskey-js/src/autogen/types.ts
+++ b/packages/misskey-js/src/autogen/types.ts
@@ -3,7 +3,7 @@

 /*
 * version: 2023.12.2
- * generatedAt: 2024-01-11T14:29:04.681Z
+ * generatedAt: 2024-01-13T04:31:38.633Z
 */

 /**
@@ -3816,7 +3816,7 @@ export type components = {
      fileIds?: string[];
      files?: components['schemas']['DriveFile'][];
      tags?: string[];
-      poll?: Record<string, unknown> | null;
+      poll?: Record<string, never> | null;
      /**
       * Format: id
       * @example xxxxxxxxxx
@@ -3839,7 +3839,7 @@ export type components = {
      url?: string;
      reactionAndUserPairCache?: string[];
      clippedCount?: number;
-      myReaction?: Record<string, unknown> | null;
+      myReaction?: Record<string, never> | null;
    };
    NoteReaction: {
      /**