Angularによる開発をできるだけ型安全にするためのKabukuでの取り組み
はじめに
こんにちは、フロントエンド担当の速水です。
Kabuku では CostPRO という製造業の加工原価見積もりを行う SaaS を提供しており、 UI の開発には Angular を使用しています。
開発をしていく上で型を検査しデータ不整合を事前に検知したくなることもあると思います。
ただ、Angular で開発する際に、設定次第ではテンプレートで扱う変数の型がanyになることや型が不整合でもエラーが発生しないことがありえます。そのため、実行前のエラー検知が困難になることがあります。
そこで、今回は Angular を使用する際にできるだけ型安全にするために実行したことをまとめようと思います。
実行した内容
テンプレート型チェックの厳格モードを一部有効にしました。それに伴い新たに発生した型エラーに対してngIfを用いて適切に型を絞り込むように修正を行いました。
オプションを使用することで、テンプレート型チェックの厳密性を設定できます（詳しい説明はこちらに記述されています）。
Angular 9 以降では、 Ivy 有効時に限り、テンプレート型チェックをより厳格化するオプションが利用可能になりました。 Cost PRO 開発は Angular 8 で始めたため、コードベースは新しい型チェックに対応していませんでした。幸い Angular のアップデートには何とかしがみつけており、 Angular 11 で Ivy 有効という状態でした。今回、テンプレート型チェック厳格化オプションを有効化し、エラーに対処しようと試みました。
全てのチェックの有効化は断念しましたが、いくつかのチェックを有効にしたことで、これまで検出できなかった型の不整合をみつけることができました。
有効にするために試みたことと生じた型エラーについて情報を共有したいと思います。
テンプレート型チェックの一部オプションの有効化
テンプレート型チェックを有効にするために、どのようなことをしたのかをまとめていきます。
まず、最初に試みたことはstrictTemplates: trueを設定し厳格な型チェックを有効にすることでした。これは Ivy が有効のときのみ指定可能なオプションであり、テンプレート型チェックについて細かく設定できるオプションとなっています。
ところが、有効にするとエラーが大量に発生してしまい、解消するには時間が必要そうでした。そのため最初の施策としては断念しました。
有効にするのは難しくても段階的にでも型チェックが効くようにしてできるだけ不整合を減らすことができたら嬉しそうです。上記で挙げたページを参照したところ、オプションを個別に指定して有効化できることがわかります。そこで、いくつかのオプションを有効にして型チェックを厳しくすることにしました。
有効にしたのは以下の 6 つのオプションです（各オプションの詳細な説明は型チェックの説明に記載されています）。
- fullTemplateTypeCheck
- strictDomLocalRefTypes
- strictOutputEventTypes
- strictNullInputTypes
- strictAttributeTypes
- strictSafeNavigationTypes
上記のオプションを有効にしたことで、埋め込みビューのチェックの有効、DOM 要素へのローカル参照の型、@Outputと受け取るコンポーネントで型が不一致している箇所、@Inputのnullチェック、テキスト属性の@Inputのチェック、ナビゲーション操作の戻り値の型チェックを行えるようになりました。これにより今までレビューで見落とされてしまっていた不整合が機械的に検知できるようになり嬉しい状態と言えそうです。
strictTemplatesを有効にした時に起きたエラーの紹介
今回、strictTemplates を有効にすることはできなかったのですが、発生した型エラーの一部は修正を行なっています。その際に気になったエラーについて一部を紹介したいと思います。
共有するエラーの内容としては次の二つです。
- AsyncPipe を利用した箇所で
nullを含んだユニオン型になる - NgSwitch を使用した箇所ではユニオン型が絞り込まれず不整合扱いになる
AsyncPipeを利用した箇所でnullを含んだユニオン型になる
RxJS の Observable をテンプレートにバインディングする際に AsyncPipe を用いていました。ただ、AsyncPipe には初期値がnullになるという問題点を抱えています。これにより、AsyncPipe を用いている箇所では同期的に値が与えられる箇所であっても nullを含んだユニオン型となってしまいます。
この問題に対する解決方法として、
テンプレート型チェックのページでは、 non-null assertions を使用することを一例としてあげています。
ただ、non-null assertions では型を握りつぶしてしまうことになり、のちにnullやundefinedを含む型となってしまっても型チェックをすり抜けてしまう恐れがあるのでできるだけ使用を避けたいです。
CostPRO での修正としては、AsyncPipe でバインディングした値に対してngIfを使用し、subscribe した値がnullでないことを保証するように書き直しました。
NgSwitchを使用した箇所ではユニオン型が絞り込まれず不整合扱いになる
Angular には NgSwitch というディレクティブがあり、以下のように使うことで値に応じて表示するテンプレート切り替えることができます。
<div [ngSwitch]="switch_expression">
<!--switch_expressionが*ngSwitchCaseと同じ箇所のdivを表示 -->
<div *ngSwitchCase="match_expression_1">...</div>
<div *ngSwitchCase="match_expression_2">...</div>
<div *ngSwitchCase="match_expression_3">...</div>
<!--どれにも該当しない場合 -->
<div *ngSwitchDefault>...</div>
</div>
値に応じて変化するテンプレートを記述できるので便利ではあるのですが、NgSwitch では型の絞り込みができず型の不整合が起こり得ます。
TypeScript では switch を使うことで型の絞り込みを行うことができ、たとえば以下の例では型エラーが起きません。
interface A {
type: 'a';
value: string;
}
interface B {
type: 'b';
value: {
prop1: string;
};
}
function typeNarrowingTest(test: A | B) {
switch (test.type) {
case 'a':
console.log(test.value);
break;
case 'b': // Bと判別されているためprop1にアクセスしてもエラーが起きない
console.log(test.value.prop1);
break;
}
}
しかし、NgSwitch では型が絞り込まれないため、以下の記述では型エラーとなります。
// interface A, Bは上の例と同じ型を使用
class NgSwitchTest {
test!: A | B;
}
<div [ngSwitch]="test.type">
<div *ngSwitchCase="’a’">{{test.value}}</div>
<!-- 次のエラーが表示される。
Property 'prop1' does not exist on type
'string | { prop1: string; }' -->
<div *ngSwitchCase="’b’">{{test.value.prop1}}</div>
</div>
NgSwitch で型の絞り込みができないかと調べたところ、型の絞り込みをしたいという要望が出ていたのですが、issue のタグが under consideration でまだ検討中みたいです 。
issue のコメントによると以下のように書くことで NgSwitch を使いながら型を絞り込むやり方はあるみたいです。
<div [ngSwitch]="true">
<!-- isA/Bは各型のユーザー定義のTypeGuard-->
<div *ngSwitchCase="isA(test)">{{test.value}}</div>
<div *ngSwitchCase="isB(test)">{{test.value.prop1}}</div>
</div>
ただ、[ngSwitch]="true"と true のみを指定しており何の値で絞り込みたいのかがわかりづらくなると感じたこと、そして別途 TypeGuard を用意する必要があり、やや記述量が増えて面倒と感じたため、今回はngIfを使うように書き直すようにしました。
<div *ngIf="test.type === ’a’">{{test.value}}</div>
<div *ngIf="test.type === ’b’">{{test.value.prop1}}</div>
さいごに
上記のようにテンプレート型エラーを直しオプションを有効にすることでより厳格に型を扱うように試みました。
実行した内容としては NgIf を愚直に使って、抜けていた型の絞り込みをひたすらに行う形となりました。
記事内であげたオプションを有効にすることはできたのですが、strictTemplatesオプションに関してはまだ有効にすることできない状態です。なので、もう少しこの型直しの旅を続けていく必要がありそうです。
このような型の修正は途中から行うとかなり量が増えて大変になると思います。なので、新規開発時は初めから strictTemplatesを有効にするのが良いと思います（Angular12 で新規に開発をする場合はデフォルトで true になっていると思います）。
テンプレートの型チェック以外にもリアクティブフォームを使っている箇所がanyになるなどの型の改良点はまだまだあるので、引き続き型安全にできるように取り組んでいく予定です。
その他の記事
Other Articles
2022/06/03
拡張子に Web アプリを関連付ける File Handling API の使い方
2022/03/22<selectmenu> タグできる子; <select> に代わるカスタマイズ可能なドロップダウンリスト
2022/03/02
Java 15 のテキストブロックを横目に C# 11 の生文字列リテラルを眺めて ECMAScript String dedent プロポーザルを想う
2021/09/30
さようなら、Node.js
2021/09/30
Union 型を含むオブジェクト型を代入するときに遭遇しうるTypeScript型チェックの制限について
2021/09/16
[ECMAScript] Pipe operator 論争まとめ – F# か Hack か両方か
2021/07/05
TypeScript v4.3 の機能を使って immutable ライブラリの型付けを頑張る
2021/06/25
Denoでwasmを動かすだけの話
2021/05/18
DOMMatrix: 2D / 3D 変形（アフィン変換）の行列を扱う DOM API
2021/03/29
GoのWASMがライブラリではなくアプリケーションであること
2021/03/26
Pythonプロジェクトの共通のひな形を作る
2021/03/25
インラインスタイルと Tailwind CSS と Tailwind CSS 入力補助ライブラリと Tailwind CSS in JS
2021/03/23
Serverless NEGを使ってApp Engineにカスタムドメインをワイルドカードマッピング
2021/01/07
esbuild の機能が足りないならプラグインを自作すればいいじゃない
2020/08/26
TypeScriptで関数の部分型を理解しよう
2020/06/16
[Web フロントエンド] esbuild が爆速すぎて webpack / Rollup にはもう戻れない
2020/03/19
[Web フロントエンド] Elm に心折れ Mint に癒しを求める
2020/02/28
さようなら、TypeScript enum
2020/02/14
受付のLooking Glassに加えたひと工夫
2020/01/28
カブクエンジニア開発合宿に行ってきました 2020冬
2020/01/30
Renovateで依存ライブラリをリノベーションしよう 〜 Bitbucket編 〜
2019/12/27
Cloud Tasks でも deferred ライブラリが使いたい
2019/12/25
*, ::before, ::after { flex: none; }
2019/12/21
Top-level awaitとDual Package Hazard
2019/12/20
Three.jsからWebGLまで行きて帰りし物語
2019/12/18
Three.jsに入門＋手を検出してAR.jsと組み合わせてみた
2019/12/04
WebXR AR Paint その２
2019/11/06
GraphQLの入門書を翻訳しました
2019/09/20
Kabuku Connect 即時見積機能のバックエンド開発
2019/08/14
Maker Faire Tokyo 2019でARゲームを出展しました
2019/07/25
夏休みだョ！WebAssembly Proposal全員集合！！
2019/07/08
鵜呑みにしないで！ —— 書籍『クリーンアーキテクチャ』所感 ≪null 篇≫
2019/07/03
W3C Workshop on Web Games参加レポート
2019/06/28
TypeScriptでObject.assign()に正しい型をつける
2019/06/25
カブクエンジニア開発合宿に行ってきました 2019夏
2019/06/21
Hola! KubeCon Europe 2019の参加レポート
2019/06/19
Clean Resume きれいな環境できれいな履歴書を作成する
2019/05/20
[Web フロントエンド] 状態更新ロジックをフレームワークから独立させる
2019/04/16
C++のenable_shared_from_thisを使う
2019/04/12
OpenAPI 3 ファーストな Web アプリケーション開発（Python で API 編）
2019/04/08
WebGLでレイマーチングを使ったCSGを実現する
2019/03/29
その1 Jetson TX2でk3s(枯山水)を動かしてみた
2019/04/02
『エンジニア採用最前線』に感化されて2週間でエンジニア主導の求人票更新フローを構築した話
2019/03/27
任意のブラウザ上でJestで書いたテストを実行する
2019/02/08
TypeScript で “radian” と “degree” を間違えないようにする
2019/02/05
Python3でGoogle Cloud ML Engineをローカルで動作する方法
2019/01/18
SIGGRAPH Asia 2018 参加レポート
2019/01/08
お正月だョ！ECMAScript Proposal全員集合！！
2019/01/08
カブクエンジニア開発合宿に行ってきました 2018秋
2018/12/25
OpenAPI 3 ファーストな Web アプリケーション開発（環境編）
2018/12/23
いまMLKitカスタムモデル（TF Lite）は使えるのか
2018/12/21
[IoT] Docker on JetsonでMQTTを使ってCloud IoT Coreと通信する
2018/12/11
TypeScriptで実現する型安全な多言語対応（Angularを例に）
2018/12/05
GASでCompute Engineの時間に応じた自動停止/起動ツールを作成する 〜GASで簡単に好きなGoogle APIを叩く方法〜
2018/12/02
single quotes な Black を vendoring して packaging
2018/11/14
3次元データに2次元データの深層学習の技術(Inception V3, ResNet)を適用
2018/11/04
Node Knockout 2018 に参戦しました
2018/10/24
SIGGRAPH 2018参加レポート-後編（VR/AR）
2018/10/11
Angular 4アプリケーションをAngular 6に移行する
2018/10/05
SIGGRAPH 2018参加レポート-特別編（VR@50）
2018/10/03
Three.jsでVRしたい
2018/10/02
SIGGRAPH 2018参加レポート-前編
2018/09/27
ズーム可能なSVGを実装する方法の解説
2018/09/25
Kerasを用いた複数入力モデル精度向上のためのTips
2018/09/21
競技プログラミングの勉強会を開催している話
2018/09/19
Ladder Netwoksによる半教師あり学習
2018/08/10
「Maker Faire Tokyo 2018」に出展しました
2018/08/02
Kerasを用いた複数時系列データを1つの深層学習モデルで学習させる方法
2018/07/26
Apollo GraphQLでWebサービスを開発してわかったこと
2018/07/19
【深層学習】時系列データに対する１次元畳み込み層の出力を可視化
2018/07/11
きたない requirements.txt から Pipenv への移行
2018/06/26
CSS Houdiniを味見する
2018/06/25
不確実性を考慮した時系列データ予測
2018/06/20
Google Colaboratory を自分のマシンで走らせる
2018/06/18
Go言語でWebAssembly
2018/06/15
カブクエンジニア開発合宿に行ってきました 2018春
2018/06/08
2018 年の tree shaking
2018/06/07
隠れマルコフモデル 入門
2018/05/30
DASKによる探索的データ分析(EDA)
2018/05/10
TensorFlowをソースからビルドする方法とその効果
2018/04/23
EGLとOpenGLを使用するコードのビルド方法〜libGLからlibOpenGLへ
2018/04/23
技術書典4にサークル参加してきました
2018/04/13
Python で Cura をバッチ実行するためには
2018/04/04
ARCoreで3Dプリント風エフェクトを実現する〜呪文による積層造形映像制作の舞台裏〜
2018/04/02
深層学習を用いた時系列データにおける異常検知
2018/04/01
音声ユーザーインターフェースを用いた新方式積層造形装置の提案
2018/03/31
Container builderでコンテナイメージをBuildしてSlackで結果を受け取る開発スタイルが捗る
2018/03/23
ngUpgrade を使って AngularJS から Angular に移行
2018/03/14
Three.jsのパフォーマンスTips
2018/02/14
C++17の新機能を試す〜その1「3次元版hypot」
2018/01/17
時系列データにおける異常検知
2018/01/11
異常検知の基礎
2018/01/09
three.ar.jsを使ったスマホAR入門
2017/12/17
Python OpenAPIライブラリ bravado-core の発展的な使い方
2017/12/15
WebAssembly（wat）を手書きする
2017/12/14
AngularJS を Angular に移行: ng-annotate 相当の機能を TypeScrpt ファイルに適用
2017/12/08
Android Thingsで4足ロボットを作る ~ Android ThingsとPCA9685でサーボ制御)
2017/12/06
Raspberry PIとDialogflow & Google Cloud Platformを利用した、3Dプリンターボット(仮)の開発 (概要編)
2017/11/20
カブクエンジニア開発合宿に行ってきました 2017秋
2017/10/19
Android Thingsを使って3Dプリント戦車を作ろう ① ハードウェア準備編
2017/10/13
第2回 魁！！ GPUクラスタ on GKE ~PodからGPUを使う編~
2017/10/05
第1回 魁！！ GPUクラスタ on GKE ~GPUクラスタ構築編~
2017/09/13
「Maker Faire Tokyo 2017」に出展しました。
2017/09/11
PyConJP2017に参加しました
2017/09/08
bravado-coreによるOpenAPIを利用したPythonアプリケーション開発
2017/08/23
OpenAPIのご紹介
2017/08/18
EuroPython2017で2名登壇しました。
2017/07/26
3DプリンターでLチカ
2017/07/03
Three.js r86で何が変わったのか
2017/06/21
3次元データへの深層学習の適用
2017/06/01
カブクエンジニア開発合宿に行ってきました 2017春
2017/05/08
Three.js r85で何が変わったのか
2017/04/10
GCPのGPUインスタンスでレンダリングを高速化
2017/02/07
Three.js r84で何が変わったのか
2017/01/27
Google App EngineのFlexible EnvironmentにTmpfsを導入する
2016/12/21
Three.js r83で何が変わったのか
2016/12/02
Three.jsでのクリッピング平面の利用
2016/11/08
Three.js r82で何が変わったのか
2016/12/17
SIGGRAPH 2016 レポート
2016/11/02
カブクエンジニア開発合宿に行ってきました 2016秋
2016/10/28
PyConJP2016 行きました
2016/10/17
EuroPython2016で登壇しました
2016/10/13
Angular 2.0.0ファイナルへのアップグレード
2016/10/04
Three.js r81で何が変わったのか
2016/09/14
カブクのエンジニアインターンシッププログラムについての詩
2016/09/05
カブクのエンジニアインターンとして3ヶ月でやった事 〜高橋知成の場合〜
2016/08/30
Three.js r80で何が変わったのか
2016/07/15
Three.js r79で何が変わったのか
2016/06/02
Vulkanを試してみた
2016/05/20
MakerGoの作り方
2016/05/08
TensorFlow on DockerでGPUを使えるようにする方法
2016/04/27
Blenderの3DデータをMinecraftに送りこむ
2016/04/20
Tensorflowを使ったDeep LearningにおけるGPU性能調査
関連職種
Recruit