環境情報

ODC Studio (Version 1.4.25)

参考

ODC向けのAI Mentor Systemがリリースされたので現時点（2024/09/24）の情報をメモ（個人ブログ）

Manage technical debt in ODC - ODC Documentation（公式ドキュメント）

以下でパターンという言葉が出てくるが、AIMSで解析結果として挙がってくる問題点のパターンを示す。
たとえば、Security Categoryのパターンであれば、Security findings - ODC Documentationの下に解説ページがある。

事前準備

ODC Portal上で、AIMSを有効にしておく（手順はHow ODC Code quality works > Activating AIMS on your Organization - ODC Documentationを参照）
ODC Studioで問題が発生するAppをPublishして12時間あける
割り当てられたOrganization RoleにAI Mentor Systems用の権限を持たせておく

ページを開く

ODC Portalを開き、ANALYZE > Code qualityのリンクをクリック。

担当するAppで絞り込みを行う

以下のような構成のページが開く。
①：フィルタ（特定のAppや修正者で絞り込みができる）
②：影響度で分類されたパターンのリスト
③：②で選択されたパターンが検出されたAppのリスト。Appを展開すると、App内の該当箇所リストが表示される

↑のスクリーンショットでは、修正者で絞り込んでいる。
（権限を絞り込んだユーザーを用意できないので推測だが）一般的には開発するAppにのみOrganization Roleがついているので、絞り込むまでもなく自分の担当Appのみが表示されるはず。

指摘内容を確認

試しに1つ指摘を確認して対応してみる。
①のリンクで指摘箇所の詳細ページが開くのでここをクリック。なお、②はドキュメントにはODC Studioで該当箇所を開くと書かれているが、2024/09/28時点ではAppまでは開くが該当箇所は開かなかった。

詳細ページ。

Location: どのAppのどの要素に対する指摘か
Activity: 発見からStatus変更やコメント追加の履歴
How to Resolve: 指摘されたパターンを解消する方法を説明するポップアップを表示する

対応

問題点を修正する

前のステップで表示したポップアップを読んで対応方法を把握する。
ざっくりいうと、Expose REST API認証をかけないと危険なのでSecurity > AuthenticationプロパティをBasicかCustomにして保護しましょう、という指摘。

わかりにくければパターンのドキュメントには修正箇所のスクリーンショットもついている： Exposed REST services without authentication - ODC Documentation

というわけで、この指摘に対する対応としては、対象のExpose REST APIのSecurity > AuthenticationプロパティをNone以外にすれば良い。

変更したらPublish。次のAIMSによるチェックが行われるまで待つ。
次のチェック時間は、Code qualityページのタイトル右に表示される（下のスクリーンショットの場合は4時間後）。

Statusを変更

もう1つの対応方法として、指摘の一覧からStatusを変更する方法がある。

例えば、権限エラーも含めた、復帰不能エラーを表示する画面は認証を付けたくないという場合に、StatusをDismissにする。
Dismissは、その指摘は無視するという意味。Snoozedはしばらく対処を保留するというStatus。

反映を確認する

次回チェックが行われたあとで確認すると以下の通り、最初にプログラム変更で対応した指摘は消え、Status変更で対応した指摘はそのまま残っている。

想定される開発者の作業フロー

業務時間中にAppを開発・修正してPublish
翌朝AIMSの指摘をチェックして対応を検討（このとき、検索条件としてStatus=Openを適用）
修正する必要があれば、次の開発に取り掛かる前に直しておく