コードベースからReact.jsを削除し、UIインタラクティビティのためにHtmxを採用する
Removing React.js from the codebase and adapting Htmx for UI interactivity (misago-project.org)
要約
Misagoプロジェクトでは、DjangoテンプレートとReact.jsコンポーネントの二重管理による開発の複雑化やパフォーマンス低下といった課題に直面していました。この記事では、これらの問題を解決するため、サーバーサイドレンダリングされたHTMLでUIの一部を動的に更新できるHTMXへの移行計画について説明しています。これにより、JavaScriptへの依存を減らし、開発効率とパフォーマンスの向上が期待されます。
全文翻訳
MisagoプロジェクトにおけるReact.jsの削除とHTMXへのUIインタラクティビティの適応
Misagoの現在の動作は以下の通りです。
1. `https://misago-project.org` にアクセスします。
2. Djangoビューがスレッド一覧を表示するためのデータを収集します。
3. Djangoビューは、スレッド一覧のほぼ完全なHTMLと、そのHTMLのレンダリングに使用された同じデータのJSONを含むテンプレートをレンダリングします。フォームは無効化されており、インタラクティビティはありません。
4. JavaScriptがダウンロードされます。
5. JavaScriptが実行され、ページのbodyに埋め込まれたJSONを読み込み、DjangoテンプレートからレンダリングされたHTMLの大部分を[React.js](http://react.js/)コンポーネントからのHTMLに置き換えます。ボタンがアクティブになり、UIのタイムスタンプが更新されます。
このアプローチにはいくつかの問題があります。
- Misagoの多くのページが二重に実装されています。DjangoテンプレートとReact.jsコンポーネントの両方です。
- HTMLのカスタマイズを開始した人々は、Djangoテンプレートを編集しても、その変更がReact.js HTMLによって上書きされてしまうため、苦労しています。なぜなら、彼らはReact.jsのカスタマイズも必要だと知らなかったからです。
- ユーザーとゲストの両方がアクセスできる各ビューは、Djangoビューとテンプレート、そしてAPIとJSONシリアライザーを必要とするReact.jsルートとコンポーネントの両方で二重に行う必要があります。
- React.jsアプリのためにデータを事前に準備するJSONシリアライゼーションは、レスポンス生成を遅くします。
- 翻訳メッセージの大部分が重複しており、
django.poとdjangojs.poの両方のファイルに存在します。JavaScriptの翻訳ファイルは、初期ダウンロードサイズも増加させます。 - 大量のJavaScriptは、特に古くて遅いモバイルデバイスでパフォーマンスを低下させる可能性があります。
- プラグインがページのカスタムHTMLを置き換えたり挿入したりできるようにするには、それらのプラグインがDjangoテンプレートとReact.jsコンポーネントの両方を実装する必要があります。また、Misagoは
misago-dockerの一部としてサイトビルドのJavaScriptビルドステップを実装する必要があります。プラグイン開発者は両方を理解する必要があります。
この問題に対して、私は2つの解決策を検討しました。
- Djangoビューとテンプレートを廃止し、検索エンジンボットを満足させるための最小限のバージョンのみを維持します。APIの実装に注力し、すべてのUIをReact.jsアプリにします。
- DjangoをAPIに限定し、サーバーサイドレンダリングを行うJavaScriptフレームワーク、例えばNext.jsやRemix.run.を使用します。
しかし、ここで重要な点があります。世の中には、サーバー側で可能な限りレンダリングし、クライアント側ではJavaScriptを使用してインタラクティビティを向上させるという古い方法を依然として採用しているフォーラムソフトウェアがたくさんあります。そして、人々はそれで満足しています。このアプローチには、上記のどの問題もありません。
インターネットフォーラムソフトウェアには多くのインタラクティビティがありますが、このインタラクティビティはページの特定の部分に限定されています。モデレーションアクション、スレッドの購読、返信の作成、最新通知の表示、投票などです。これらすべては、React.jsなしでも達成可能であり、私たちがフルページリロードを回避すべきだと判断するずっと前から、そのように達成されていました。
では、HTMXとは何でしょうか? HTMXは、開発者がHTMLの一部を、インタラクション時に新しいサーバーレンダリングHTMLで置き換え可能な動的な島として指定できる、非常に小さなライブラリです。例えば、実際のスレッドのリストは、そのような(大きな)島の一つです。Djangoテンプレートに少量のHTMXを含めることで、スレッドリストの現在のカテゴリを変更すると、選択されたカテゴリの新しいスレッドリストのHTMLだけをDjangoから取得できます。これにより、ナビゲーションバーの検索結果など、ページの他のHTMX部分(例:既に読み込まれた検索結果)は変更されません。Misagoのバックエンドコードは、HTMXからのリクエストがあった場合に、フルページではなく、この島のためだけのHTMLを返すように変更するだけで済みます。JSONシリアライゼーションを行ったり、専用のJavaScriptやReact.js.を書いたりする必要はありません。
HTMXは、20年前にjQueryで行った$.get("url", "#outlet")を宣言的に行う方法です。あるいはRails Turbolinksのようなものです。これを書くことになるとは思いませんが、無限スクロールが嫌いな場合や、そうでなくても物事をシンプルに保ちたい場合には、フォーラムソフトウェアにとってこれが最良の方法です。
- 管理パネルをSPAに移行しないことも決定しました。現在、作業の90%を処理する再利用可能なDjangoビューが多数あり、管理画面に新しいページを追加するには、適切なベースビューを選択し、空白を埋め、1つまたは数個のフォームを定義し、それらのための非常に基本的なテンプレートを作成するだけで済みます。残りは自動的に行われ、私はそれが気に入っています。
React.jsからHTMXへの移行には多大な労力がかかりますが、複数の小さなステップとして実行できます。例えば、あるリリースでナビゲーションバーをHTMXに移行し、次にスレッドリスト、次にスレッドページ、さらにユーザープロフィールなどを移行します。しかし、プラグイン/パーミッション/新しいパーサーはまだ先に完了する必要があります。そのため、HTMXへの移行は2024年後半まで待つ必要があります。私はそれで構いません。なぜなら、最新のBootstrapに移行したいと考えており、そこの開発者たちは素晴らしいものを開発しているからです。
- 参考までに、Misago 0.39からのJavaScriptサイズです。
vendor.js: 679kb, 214kb gzipped
misago.js: 615kb, 124kb gzipped
django-i18n.js: 102kb, 25.4kb gzipped
MisagoのJavaScriptには、遅延ロードされるものも含まれています。
hljs.js: 144kb, 49kb gzipped
zxcvbn.js: 820kb, 430kb gzipped
React.js(およびその他のJavaScript依存関係)をMisagoから削除し始めると、これらの数値に戻る予定です。
-
また、Misagoの一部がReact.jsを持たず、HTMXも持たない移行期間が発生する可能性があることを警告する必要があります。これは実質的に「マルチページアプリケーション」になります。これは恐ろしく聞こえるかもしれませんが、ユーザーオプションページなどでリンクをクリックしたりフォームを送信したりすると、ページ全体がリロードされるだけです。しかし、フルページリロードが絶対に耐えられない場合、例えば投稿に「いいね!」を付けたり、投票したりする場合には、プレースホルダーAJAX(または単にHTMXを使用)を記述します。
-
フォーラムオプションページが「アカウント設定」に置き換えられました。この新しいページは完全にDjangoビューで作成されており、一部のページでは動的な更新のためにHTMXを使用しています。
JavaScriptサイズの変更:
misago.js: 578kb, 107kb gzipped (37kb/17kb削減)
JavaScriptサイズの変更:
misago.js: 530kb, 99kb gzipped (48kb/8kb削減)