HN 日本語サマリー

← 一覧へ戻る
プログラミング

レンダリングされたことのないReactコンポーネントの編集

Editing React components that never rendered (blog.crossui.com)

9 pointsby linb1 コメント

要約

開発ツールがコードベースを理解する方法には、実行時のイントロスペクションと静的なAST解析の2つがあります。CrossUI Studioが採用する静的なAST解析は、アプリがクラッシュした場合でもコード構造を分析できるため、レンダリングに失敗したコードのデバッグや編集に優れています。このアプローチにより、実行時の状態に依存せず、コードの構造(AST)を基盤としてコンポーネントを孤立して編集できます。

全文翻訳

レンダリングされないReactコンポーネントの編集

[画像: Editing React components that never rendered]

約7分で読めます · エンジニアリング

ツールがあなたのReactコードの形状を学習するには、2つの方法しかありません。どちらを選ぶかによって、ツールの最も重要な特性が決まります。それは、最も必要としている瞬間に利用可能かどうかです。

コードベースを知る2つの方法

ランタイムイントロスペクションは、実行中のアプリを監視します。React DevTools、プロファイラー、エラーオーバーレイなどは、アプリのマウント後にライブのファイバーツリーを読み取ります。これはより豊富な情報を提供します。実際のプロップ値、実際の状態、実際にレンダリングされたものを知ることができます。しかし、それらすべては一つの条件に依存しています。アプリが最初に正常に実行される必要があります。レンダリングが失敗した瞬間、それらは沈黙します。何もマウントされていないので、検査するものがありません。そして、初期化に失敗したモジュールは、定義上、それらには見えません。

静的AST解析はソースコードを読み取ります。各ファイルを抽象構文木(AST)にパースし、何も実行せずに構造(すべてのJSXノード、すべてのインポート、すべてのプロップ)を直接読み取ります。ある意味では貧弱です。変数が午後2時4分に何を持っていたかを教えてくれません。なぜなら、何も実行されなかったからです。しかし、それはランタイムツールには真似できない特性を持っています。それは、一度も正常にレンダリングされたことのないコードでも機能するということです。

ほとんどの開発者ツールは、最初のモデルに基づいています。私たちは、React用のビジュアルエディタであるCrossUI Studioを、意図的に2番目のモデルに基づいて構築しました。この記事は、その制約がなぜ全体的なポイントになったのかについてです。

ツールがあなたを見捨てるとき

この決定を形作ったシナリオを以下に示します。あるコンポーネントが何もレンダリングしません。スタックトレースはそのコンポーネントを指していますが、本当の失敗は5つのインポート下、解決されなかった動的インポート、更新されたピア依存関係、最初のアクセス時にundefinedになる循環参照です。コンポーネントは無実です。それが間接的に引き込んでいるものが原因です。

これはまさに、コードの構造を理解する必要が最も高まる瞬間です。どのファイルが何をインポートしているか、どこで壊れているか、周囲のコードがどのようになっているか。そして、それはまさにすべてのランタイムツールが沈黙する瞬間です。なぜなら、アプリがレンダリングされなかったからです。DevToolsは何も表示しません。プロファイラーはプロファイルするレンダリングがありません。エラーオーバーレイは行番号を提供しますが、その周囲のコードの形状は提供しません。それらはすべてアプリが最初に実行されることを必要としますが、問題全体はそれが実行されないということです。

コードの構造を最も見たいと思うその瞬間に、ランタイムツールはそれを提供することを拒否します。

静的ASTツールにはそのような依存関係はありません。ファイルを開いたときにファイルをパースしました。それはインポートグラフ全体を描画し、壊れたモジュールを指し示し、周囲のコードを表示することができます。アプリは完全にクラッシュしていてもです。壊れたページは行き止まりではありません。それはエントリーポイントです。

実行できないものを編集する

同じ特性が、より奇妙なものを解き放ちます。レンダリングされないコンポーネント、一度も開いたことのないファイル内のコンポーネントを編集することです。

通常のビジュアルエディタが、.map()の中に存在する<Card>をレンダリングするために何が必要かを考えてみてください。そのCardをキャンバスに配置するには、itemが何であるかを知る必要があります。そしてitemは、実際のデータが流れるループの中で、ランタイムにのみ存在します。ランタイムベースのエディタは、そのCardを単独でレンダリングすることはできません。それを供給するためのライブなitemが存在しないからです。そのため、ほとんどのビジュアルエディタは、.map()の中には全く入らないように静かに拒否します。

ASTから作業することで、問題は再定義されます。実行中のループは必要ありません。必要なのはノードです。ファイルをパースし、マップコールバック内のJSXを見つけ、そのサブツリーを単独でレンダリングします。欠けている唯一のものはitemの値です。そのため、アプリにそれを生成させるのではなく、あなたにそれを尋ねます(パネル内の小さなモック)。Cardは、ライブで、実際のテーマ設定とともに、単独でレンダリングされます。

そして、理解の単位がマウントされたコンポーネントではなくASTノードであるため、ドリルダウンはファイルの境界で止まりません。別のファイルからインポートされた子コンポーネントは、グラフ内の別のエッジにすぎません。インポートをたどり、そのファイルをパースし、そのノードをレンダリングします。あなたは、一度も開いたことのないどこかに定義されたコンポーネントを編集しています。そして、全体として一度もレンダリングされなかったかもしれないアプリを編集しています。

制約のコスト

これらはすべて無料ではありません。そうでないふりをするのは不誠実でしょう。静的解析は、ランタイム知識を諦めることで、無条件の可用性を購入します。

  • 完全に動的なインポートは解決できません。 ランタイムで計算されるパスを持つimport('./pages/' + name)は、静的に解決できません。推測する代わりにエッジをマークします。
  • 構造は見えますが、値は見えません。 ASTは、AIPanelがTreeSitterに到達することを示しますが、特定のレンダリングでパーサーが何を返したかは教えてくれません。モックデータが実際のデータの代わりになります。それを再生するわけではありません。
  • 特殊な解決には設定が必要です。 標準的でないバンドラーエイリアスやモノレポのパスマジックは、tsconfig/jsconfigを読み取れる場合に最もよく解決されます。それがない場合、一部のエッジは生の指定子にフォールバックします。

これらは実際の境界です。しかし、それらのどれもコアな約束に触れていないことに注意してください。ツールは、コードが実行される必要がなかったため、行き詰まったときにそこにあります。

なぜこれが多くのアイデアではなく、一つのアイデアなのか

クラッシュを生き延びる依存関係グラフ、マップ内の編集ドリルダウン、クロスファイルナビゲーション、ワンライン差分。これらは外部から見ると別々の機能のように見えます。それらはすべて同じ決定を異なる角度から見たものです。パースされたソースを真実の源として扱い、すべてのサーフェスをそのASTのビューにするということです。

キャンバスはASTのビューです。プロップインスペクターはASTのビューです。依存関係グラフは、ファイル間のASTのビューです。それらのどれも、正常なレンダリングに依存していません。なぜなら、それらのどれもランタイムに基づいて構築されていないからです。それはファイバーツリーにフックするよりも構築が難しいものです。そして、それはランタイム、そしてそれに基づいて構築されたすべてが沈黙する瞬間に、ツールを生き続けさせるものなのです。

→ 実際のプロジェクトを開く — 意図的に深いインポートを壊してみて、構造がまだレンダリングされるのを見てください。