The ARDoCo Tool Landscape: REST API, TraceView, and TraceViz for Architecture Traceability

技術要約：ARDoCo ツールランドスケープ

問題の背景
ソフトウェア開発は、自然言語によるソフトウェアアーキテクチャ文書（SAD）、形式的なソフトウェアアーキテクチャモデル（SAM）、およびソースコードという、異なる抽象化レベルにわたる相互に関連したアーティファクトを生成します。これらのアーティファクト間の一貫性とトレーサビリティを維持することは、メンテナンス、変更影響分析、および進化において極めて重要です。しかし、手動でのトレースリンクの維持は、手間がかかり、エラーが発生しやすい作業です。自動化されたトレーサビリティリンク回復（TLR）は不可欠ですが、既存の ARDoCo アプローチ（SWATTR、ArCoTL、TransArC、LiSSA）は、歴史的に Java ライブラリまたはコマンドラインツールとしてのみ提供されてきました。この技術的な障壁は、ツールの設定や実行に関する専門知識を持たないアーキテクトや開発者による採用を妨げ、最先端の TLR の実用的な展開を制限しています。

手法とツールランドスケープ
アルゴリズム研究と実用的なアプリケーションの間のギャップを埋めるため、著者らは、ARDoCo TLR ファミリーを公開する 3 つの補完的なインターフェースからなる、公開デプロイされたツールランドスケープを提示しています。

1. ARDoCo REST API: Spring Boot ベースのバックエンドであり、HTTP エンドポイントを介して 4 つの TLR パイプラインへのプログラムによるアクセスを提供します。パフォーマンスを最適化するために、非同期実行と結果のキャッシュ（Redis による）をサポートしています。公開されているパイプラインは以下の通りです：

   • SAD-SAM: SWATTR（NLP およびヒューリスティック）を利用し、テキストエンティティのモデル欠落（TEAM）およびモデルエンティティのテキスト欠落（MEAT）の不一致を検出します。
   • SAM-Code: ArCoTL（中間表現およびテキスト類似性）を利用します。
   • SAD-Code (Direct): ArDoCode（SAM を介さずに SW 直接に SWATTR のヒューリスティックを適用）を利用します。
   • Transitive SAD-SAM-Code: TransArC（SWATTR と ArCoTL を推移的に合成）を利用します。
     API は構造化された JSON を返し、探索用の統合された Swagger UI も含まれています。

2. TraceView: Next.js と React で構築された、インストール不要のブラウザベースのフロントエンドであり、アーキテクトや非開発者に最適化されています。アーティファクト（SAD、SAM、コード）のアップロードと TLR パイプラインの設定を行うためのガイド付きウィザードを備えています。コアとなるインターフェースは、SAD、SAM、およびソースコードをサイドバイサイドで可視化できるマルチパネルのインタラクティブなビューを提供します。要素を選択すると、リンクされた対応物と検出された不一致がすべてのパネルでハイライトされ、クロスアーティファクト間のナビゲーションを容易にします。

3. TraceViz: 開発者、特に SAD-Code TLR に最適化された Visual Studio Code 拡張機能です。トレースリンクをカラーのガターマーカーとして IDE 上に直接オーバーレイ表示します。主な機能は以下の通りです：

   • ナビゲーション: Quick Pick メニューまたは CodeLens を介して、ドキュメントの文章からリンクされたコードファイルへの移動（およびその逆）をワンクリックで行えます。
   • ソース非依存性: REST API（ArDoCode/TransArC）からのリンク、外部ツールからの CSV インポート、および LiSSA（検索拡張生成アプローチ）のローカル実行をサポートしています。
   • 視覚的最適化: 適切な場合にはパーファイルマーカーをディレクトリレベルのドットに集約してノイズを軽減し、最大 2 つのトレースリンクセットのサイドバイサイド比較を可能にします。

主な貢献

• アクセシビリティ: このランドスケープは、複雑なライブラリベースの TLR アルゴリズムを、ほとんど、あるいは全くローカルインストールの必要がないアクセシブルなツールへと変貌させ、異なるユーザーペルソナ（インテグレーター、アーキテクト、および開発者）に対応させています。
• 統一されたバックエンド: REST API は共有計算エンジンとして機能し、ブラウザと IDE インターフェース間での一貫性を確保すると同時に、サードパーティによる統合を可能にします。
• IDE 内の可視化: TraceViz は、外部レポートを超えて、開発者の編集コンテキスト内で直接トレーサビリティを可視化するという新しいアプローチを導入しています。

結果と評価

• アルゴリズムの性能: 基盤となる TLR アルゴリズムは、5 つのオープンソース Java プロジェクト（MediaStore、TeaStore、TEAMMATES、BigBlueButton、JabRef）のベンチマークで評価されました。結果は、SWATTR が SAD-SAM で F1 スコア 0.81、ArCoTL が SAM-Code で 0.98、TransArC が SAD-Code で 0.82 を達成し、ArDoCode のベースライン（F1 = 0.37）を大幅に上回っていることを示しています。不一致検出（MEAT）は F1 スコア 0.89 を達成しました。
• ユーザー調査 (TraceViz): 博士課程の学生、修士課程の卒業生、および業界の開発者 $n=7$ 名を対象とした、思考発話法による予備的な調査により、TraceViz の有用性を評価しました。参加者は、可視化がある場合とない場合で、TEAMMATES プロジェクトに関するソフトウェア理解タスクを実行しました。
  • 7 名中 6 名の参加者が、可視化がタスク完了に役立つと感じました。
  • 7 名全員が、それが理解プロセスをサポートしていることに同意しました。
  • 定性的フィードバックでは、可視化がない場合、ユーザーは反復的な手動のツリー探索に頼っていましたが、TraceViz は関連するファイルへの直接ジャンプを可能にしたことが示されました。
  • 3 名の参加者が実世界の文脈でのツール使用の意向を示し、他の参加者はオンボーディングや大規模なコードベースのナビゲーションへの可能性を指摘しました。

意義
本論文は、このツールランドスケープが、基礎となるアルゴリズムの技術的な複雑さによって以前は排除されていた、より幅広い層のアーキテクト、開発者、およびツールインテグレーターに対して、最先端の TLR を利用可能にすることを主張しています。ブラウザベースの探索ツール（TraceView）と IDE 統合型の可視化（TraceViz）を提供することで、著者らは、自動化されたトレーサビリティが実際に効果的に展開できることを示しています。予備的なユーザー調査は、これらのリンクを IDE 内で直接可視化することが、ソフトウェア理解タスクにおける開発者の理解度と効率を向上させることを示唆しています。今後の課題は、LLM ベースのアプローチ（LiSSA、ExArch）をランドスケープに統合すること、およびより大規模な対照実験を実施することです。