feat: 実行時にレスポンスの型チェックを行うように #2619
Conversation
|
🚀 プレビュー用ページを作成しました 🚀 更新時点でのコミットハッシュ： |
src/store/proxy.ts
Outdated
| import { EngineInfo } from "@/type/preload"; | ||
| import Ajv, { ValidateFunction } from "ajv"; |
There was a problem hiding this comment.
ちなみにzodでできたりしないですかね？
（依存を減らしたい）
There was a problem hiding this comment.
zodはjson schemaを扱えませんね。
方法としてはjson-schema-to-zodを走らせるツールをtools下に生やすのが現実的かも？（それを作るなら一緒にopenapi generatorも走らせたい気持ちがある）
There was a problem hiding this comment.
あーそうか。。
それを作るなら一緒にopenapi generatorも走らせたい
これってpackage.jsonでインストールしてるgeneratorのことですかね？それとも自作とか？
（自作だと流石に避けたい）
うーーーーん メンテが結構大変かもな気がしてきました。
ちょっと別のとこでコメントします！
There was a problem hiding this comment.
これってpackage.jsonでインストールしてるgeneratorのことですかね？それとも自作とか？
package.jsonのやつですね。イメージとしてはpnpm run tools:update-openapi http://localhost:50021をするとopenapi-generator-cliとかが走るイメージ。
src/store/proxy.ts
Outdated
| } | ||
|
|
||
| /** OpenAPIのレスポンスを検証する */ | ||
| function createValidateOpenApiResponse() { |
There was a problem hiding this comment.
ちょっとこの量のコードをここに加えるのはメンテ性下がる気がするので（今更ですが。。。）、このファイルをsrc/store/proxy/index.tsに移して、この関数をsrc/store/proxy/以下のファイルに移動するのはどうでしょう？
src/store/proxy.ts
Outdated
| /** | ||
| * OpenAPIのスキーマを修正する。 | ||
| * | ||
| * 具体的には以下の変更を行う： | ||
| * - `$ref`の参照先を`#/components/schemas/`から`openapi.json#/definitions/`に変更する | ||
| * - オブジェクトのプロパティ名をキャメルケースに変換する | ||
| */ | ||
| function patchOpenApiJson<T extends Record<string, unknown>>(schema: T): T { | ||
| return inner(cloneWithUnwrapProxy(schema)) as T; | ||
|
|
||
| function inner(schema: Record<string, unknown>): Record<string, unknown> { | ||
| if (schema["$ref"] != null) { | ||
| const ref = schema["$ref"]; | ||
| if (typeof ref === "string") { | ||
| schema["$ref"] = ref.replace( | ||
| "#/components/schemas/", | ||
| "openapi.json#/definitions/", | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| if ( |
There was a problem hiding this comment.
こーーーーれちょっとメンテだいぶしんどい気がしますね･････････
openapiの何かが変わったときにこのあたりでエラー出ると、触れる人がかなり少ない気が。。。。。
補助ツールとかではなくエディタで、かつエンジン→エディタのメインストリームなのでもう少し硬いコードを書きたい気もします。
壊れたときに @sevenc-nanashi さんがかなり率先的に助けてくれる、とかならギリ行けるかも･･････？
実は本当に必要なのはsupported featureのとこだけのバリデータなのでは、という気もしてきました。。。
ちょっと結論出てないのですが、とりあえず相談まで 🙇
|
念のためのメモ |
内容
タイトル通りです。
関連 Issue
スクリーンショット・動画など
（なし）
その他
（なし）