zudo-panel-designer docs
GitHub リポジトリ

検索したい単語を入力

いつでも検索バーを開ける

防御的パース

parsePanelConfig()packages/core/src/serialize.ts)は、任意の JSON を、エディタが 読み込める DocState へと戻します。この関数は決して例外を投げないように書かれています。 なぜなら、その入力は、ユーザーが手編集した JSON、古いエクスポート、あるいは別のツールが 生成した JSON など何であってもよく、必ずしも正しい形の PanelConfig とは限らないからです。

Note

各フィールドは、ドキュメント全体を検証して最初の不正な値で拒否するのではなく、個別に防御されます——クランプ、デフォルト化、または破棄されます。1 つの不正なフィールドは、 インポート全体を沈めるのではなく、緩やかに劣化します。

トップレベルの入力

Input結果
プレーンオブジェクトでない(null、プリミティブ、配列、関数など)完全に createDefaultDoc() にフォールバックする。
layers を欠いたプレーンオブジェクトlayers[] になる。
layers はあるが配列でない[] として扱われる。
認識されないトップレベルのキー黙って無視される——パース後の DocState には現れない。

panelHp

parseHp()input.hp を読み取り、トップレベルの hp が無い場合は input.panel.hp に フォールバックします。値が受け入れられるのは、それが 0 より大きい有限の数値である場合だけです。 それ以外——欠落、非数値、NaNInfinity、文字列、ゼロ、負の値——は、意味をなさない パネル寸法をそのまま伝播させるのではなく、DEFAULT_PANEL_HP(新規ドキュメントで使われるのと 同じデフォルト)にフォールバックします。

hp と食い違う、手編集された panel.widthMm / panel.heightMm は、インポート時に 無視されます——これらのフィールドは参考用の出力にすぎず(PanelConfig フォーマット を参照)、ドキュメントが再シリアライズされるときには常に hp から再計算されます。

レイヤー

layers 配列の各エントリは、parseLayer() によって独立してパースされます。

  • オブジェクトでないエントリnull、数値、文字列など)は、配列内から破棄されます。

  • 認識されない type——shape / pattern / path / text / image 以外の値——は、 推測されるのではなく破棄されます。

  • id——空でない文字列であれば保持され、そうでなければ mintId('layer') で新しい id が 生成されます。

  • name——文字列であれば保持され、そうでなければ "" がデフォルトになります。

  • hidden——真偽値の場合のみ保持され、そうでなければパース後のレイヤーからこのフィールドは 完全に省略されます(false に設定されるのではありません)。

  • レイヤーごとの余分・未知のフィールドは破棄されます——パース後のレイヤーオブジェクトには 残りません。

レイヤータイプ別のフィールドごとのフォールバック

Layer typeField不正入力時の挙動
allcolor / fill / strokeちょうど 012 以外の値は 0(黒)にクランプされる。
すべての数値フィールド(xywidthheightsizeMmstrokeWidth など)数値でない、または有限でない値は 0 がデフォルトになる。
allrotation有限の数値の場合のみ保持され、そうでなければフィールドは省略される(デフォルトの回転は書き込まれない)。
shapeshape"ellipse" 以外はすべて "rect" がデフォルトになる。
patternpatternType認識できなくてもそのまま保持される——core は、それを検証するパターンレジストリに依存していない(ラウンドトリップ を参照)。文字列でない値は "unknown" がデフォルトになる。
patternparamsプレーンオブジェクトでなければ → {}。そうでなければ、キーごとに数値かつ有限の値のみが残り、数値でないエントリ(ネストしたオブジェクトを含む)は破棄される。
pathpoints配列でなければ → []。プレーンオブジェクトでない各点は、(パス全体を失敗させるのではなく)配列から取り除かれる。
pathpoints[].hin / houtxy の両方が有限の数値である場合のみ保持され、そうでなければハンドルは省略される。
pathextraSubpaths入力が配列である場合のみ設定される(各サブパスは points と同じ方法でパースされる)。存在・非存在——空配列であっても——は、正規化して消し去られるのではなく正確に保持されるため、ラウンドトリップは正確なまま保たれる。
pathclosed入力がちょうど true の場合のみ true。それ以外はすべて false になる。
pathfill / strokenullnull のまま。それ以外はすべて、上記の color のクランプを通る。
textcontent / fontFamily文字列でない値は "" がデフォルトになる。
imagesrc文字列でない値は "" がデフォルトになる。

これが重要な理由

パースが決して例外を投げないため、エディタ(および @zpd/core を再利用するあらゆるもの)は、 「この JSON を読み込む」処理を全域関数として扱えます。最悪の場合でも、未処理の例外ではなく 安全なドキュメントへと劣化します。ただし、どのようにフォールバックするかは入力の形によって 異なります。

  • オブジェクトでない不正な入力null、プリミティブ、配列、関数など)は、createDefaultDoc() へ完全にフォールバックします——新規セッションが開始するのと同じドキュメントで、ドットグリッド レイヤーもそのまま含まれます。

  • フィールドが欠落・不正なプレーンオブジェクト——空オブジェクト {} を含む——は、フィールド ごとに修復されます。panelHpDEFAULT_PANEL_HP になり、layers[] になります。これは 新規セッションのドキュメントではありません。デフォルトのパネル寸法は持ちますが、レイヤー リストは空で、ドットグリッドレイヤーはありません。

これは packages/core/src/serialize.test.ts で直接検証されています。parsePanelConfignull42'not json'true[]、素の関数といった入力を与えて、それぞれが決して例外を 投げず createDefaultDoc() に等しいことをアサートし、さらに parsePanelConfig({}) が正の panelHp と空の layers 配列を返すことを個別に確認しています。