Angular 4アプリケーションをAngular 6に移行する

2018/10/11
このエントリーをはてなブックマークに追加


初めまして! カブクでアルバイトをしている長瀬です。普段はWebフロントエンド関連の業務をしています。
先日、Angular 4.3.6で動いていたアプリケーションを6.1.0へ移行した際に得られた知見を共有します。Angular/Angular CLI 6への移行に関する日本語記事は、すでに以下をはじめとするすばらしい記事が世に出ています(私も参考にさせていただきました)。

この記事では、上記の記事で紹介されている内容(移行手順や移行により改善されたこと)に加えて、
– swagger-codegen(openapi-generator)を利用している場合に便利かもしれないtips
– Node.js向けにのみビルドされた、古いJSライブラリを使っている場合に必要となるかもしれない対応

を紹介します。同じような構成の方の参考になれば幸いです。

なお、Angularはすでに予定通り7.0.0-rc1をリリースしています。(移行作業を始めてから色々あり、だいぶ時間が経ってしまいました…)今後アップグレードを検討されている方はAngular7のリリース状況をチェックするようにしてください。

tl;dr

  • Angular 4.3.6 -> Angular 6.1.0でビルド時間とバンドルサイズが大幅に改善された
  • OpenAPI 2対応のswagger-codegenを利用しており、サーバサイドの実装の都合等でOpenAPI 3への移行ができない場合は、custom templateを使うと良い

移行のモチベーション

そもそも、移行はなぜ必要だったのかというと、

という理由があったためです。また、Angularが依存しているRxJSなどのライブラリもメジャーアップデートがされており、それらに追従したいというモチベーションもありました。

やること

冒頭に挙げたfa11enprinceさんの記事でも紹介されているのですが、Angularには移行前・移行後のバージョンを指定すると移行作業のチェックリストを生成してくれる便利ツールがあります。

https://update.angular.io/

主にこれを利用して移行作業を進めていきました。ただし、update.angular.ioが教えてくれる手順はあくまで大まかなものであり、タスクによっては別途作業の詳細を調べる必要があるかもしれません。以降は私が移行作業で詰まった内容の一部を紹介します。

@angular/cliのアップグレード

update.angular.ioが教えてくれたタスクの1つに、"angular-cliをアップグレードし、angular.json(旧angular-cli.json)を新しい形式に書き換える"というものがあります。

丁寧にコマンドまで紹介してくれているのですが、このコマンドを使うよりも、冒頭で紹介したlacoさんの記事で紹介されているやり方を使うほうが良いです。

まずプロジェクトローカルのAngular CLIをアップデートする
yarn add --dev @angular/cli@^6.0.0-rc.2
ng updateコマンドでプロジェクトをv6用にマイグレーションする
ng update @angular/cli --migrate-only --from=1.7.3

いずれの操作でもangular-cli.jsonが自動で新フォーマット(angular.json)に変換されるのですが、--from= というフラグでバージョンを指定してやると移行に失敗する(設定の一部が引き継がれず漏れてしまう)可能性が低くなるためです。

今回移行したアプリケーションはかなり細かく angular-cli.json を設定していたため、--from を指定してもなお引き継がれなかった設定があり、schema.jsonを読んで手動で設定ファイルを編集しました…

schema.json は文字通りangular.json のスキーマについて記述したJSONファイルで、プロパティのdescriptionやtype等がわかります。エディタでの開発者支援や、今回のように設定ファイルを編集する際の参考にもなります。)

RxJSのアップグレード

Angularが依存しているRxJSも、メジャーアップデートによりbreaking changesがありました。よって既存のコードの修正が必要になるわけですが、@angular/cliと同様に、rxjs-tslint パッケージが提供するcliコマンドによってある程度は自動で修正してくれます。

npm install -g rxjs-tslint
rxjs-5-to-6-migrate -p src/tsconfig.app.json

自動で修正してくれなかった箇所については、頑張る必要があります…

swagger-codegenを利用している場合の対応

弊社では多くのプロダクトにswagger-codegenを利用しています。今回移行するアプリケーションでは、swagger-codegenのAngular2用テンプレート(APIのスキーマに基づいて、TypeScriptの型定義等のファイルを自動生成するためのコード)を利用していました。当然移行に際してテンプレートもAngular6に対応する必要があるのですが、作業当時はswagger-codegenがAngular6に対応していませんでした(この記事を執筆し始めた日の5日前に対応されました)。

このとき、openapi-generatorというswagger-codegenのフォークは早くもAngular6に対応しており、当初はswagger-codegenからopenapi-generatorに移行してそのテンプレートを利用するつもりでした。しかし、APIサーバ側で利用しているPython向けのOpenAPIツールである、Yelp/bravado-coreがOpenAPI 3に対応していませんでした。よって、当時の段階では移行は不可能だとわかりました。

そこで、swagger-codegenのカスタムテンプレートという機能を利用して、OpenAPI 2互換のswagger-codegenでも、Angular6に対応したコードを自動生成できるようにしました。

swagger-codegenにおけるカスタムテンプレートの利用

カスタムテンプレートの解説については、すでにこちらなど多くの優れた日本語記事が公開されています。大まかに言うと、既存のテンプレートの一部を上書きして使えるようにする機能です。

今回は、RxJS, Angularのアップデートによって破壊的変更があった箇所を修正するなどの用途で使いました。

テンプレートファイルはあるディレクトリ(custom_tmplとします)にまとめて配置し、次のようにして使います。

java -jar ${SWAGGER_CODEGEN} generate -i spec.json -l typescript-angular -o ./ng_client -c config.json -t custom_tmpl

-l でテンプレートの種類を指定し、-t でカスタムテンプレートファイルが存在するディレクトリを指定しています。

カスタムテンプレートファイルは、-l で指定したテンプレートのうち、上書きしたいテンプレートファイル名の拡張子を.mustacheに置き換えたファイル名で書いていきます。たとえば、テンプレートのpackage.jsonをAngular6向けに書き換えたカスタムテンプレートはpackage.mustacheとなり、以下のような内容になります。

{
  "name": "{{{npmName}}}",
  "version": "{{{npmVersion}}}",
  "description": "swagger client for {{{npmName}}}",
  "author": "Swagger Codegen Contributors",
  "keywords": [
    "swagger-client"
  ],
  "license": "UNLICENSED",
  {{#useNgPackagr}}
  "scripts": {
    "build": "ng-packagr -p ng-package.json"
  },
  {{/useNgPackagr}}
  {{^useNgPackagr}}
  "main": "dist/index.js",
  "module": "dist/index.js",  
  "typings": "dist/index.d.ts",
  "scripts": {
    "build": "ngc",
    "postinstall": "npm run build"
  },
  {{/useNgPackagr}}
  "peerDependencies": {
    "@angular/core": "^6.1.0",
    "@angular/http": "^6.1.0",
    "@angular/common": "^6.1.0",
    "@angular/compiler-cli": "^6.1.0",
    "core-js": "^2.4.1",
    "reflect-metadata": "^0.1.3",
    "rxjs": "^6.2.2",
    "zone.js": "0.8.14"
  },
  "devDependencies": {
    "@angular/compiler-cli": "^6.1.0",
    "@angular/compiler": "^6.1.0",
    "@angular/core": "^6.1.0",
    "@angular/http": "^6.1.0",
    "@angular/common": "^6.1.0",
    "@angular/compiler": "^6.1.0",
    "@angular/platform-browser": "^6.1.0",{{#useNgPackagr}}
    "ng-packagr": {{#useOldNgPackagr}}"^1.6.0"{{/useOldNgPackagr}}{{^useOldNgPackagr}}"^2.4.1"{{/useOldNgPackagr}},{{/useNgPackagr}}
    "rxjs": "^6.2.2",
    "zone.js": "0.8.14",
    "typescript": "~2.9.2"
  }{{#npmRepository}},{{/npmRepository}}
{{#npmRepository}}
  "publishConfig": {
    "registry": "{{{npmRepository}}}"
  }
{{/npmRepository}}
}

他のテンプレートファイルについても、RxJSのpipe()を使うよう書き換えるなどして、Angular6 compatibleなカスタムテンプレートを用意しました。

その他の依存パッケージのアップグレード(およびそれに伴う修正)

TypeScript

RxJSのほかにAngularが依存しているパッケージとして、TypeScriptがあります。

Angular 2.x, 4.xなどのバージョンから移行する場合は、それに伴ってTSのバージョンも大きく上がる場合があり、コンパイルエラーが発生する可能性もあります。そうした場合には tsconfig.json で一時的に当該ルールを無効にするなどして応急処置をするとよいでしょう。

Node.jsのshimに依存した古い外部ライブラリ

angular-cliは、内部でwebpack/node-libs-browserを利用してNode.js向けライブラリが使えるようにしていました。しかし、移行後の6.xではこのshimが導入されなくなっており、いまだにブラウザ向けビルドを提供していないライブラリ(古いまま更新されていないOSSのライブラリなど)のビルドに失敗するという現象が確認されました。具体的にはjszipというライブラリです。

対処法として、当初はjszipが依存していたNode.jsのstreamをそのまま依存に追加していたのですが、ほかのエンジニアの方がjszipのソースコードに以下のような記載があることを教えてくれました。

We use "readable-stream" to get a consistent behavior between nodejs versions but bundlers often have a shim for "stream". Using this shim greatly improve the compatibility and greatly reduce the final size of the bundle

バンドラがstreamのshimを提供する場合は、互換性とバンドル後のファイルサイズの点でそちらを使うべきだとあります。node-libs-browserのREADMEを読むと、streamのshimはsubstack/stream-browserifyのようですので、代わりにそちらを依存に追加しました。

成果

移行により、期待していたコンパイラの性能向上が反映されているか検証しました。

移行前移行後
ビルド所要時間(s)116.4937.72
main.bundle.jsのファイルサイズ(MB)2.01.3

コンパイラのパフォーマンスアップが有意に効いているようです。なお、移行したアプリケーションのコンポーネント数は115個でした。

最後に

移行作業は思っていたよりたいへんで一筋縄ではいかない作業もありましたが、カブクの優秀なエンジニアの皆様の助けをお借りし、なんとか移行作業を終えられました。日本でAngularの最新バージョンに食らいつき続けている会社さんは珍しいと思います(特にAngularJS -> Angularの移行は骨が折れるので…)。

カブクではAngular6で開発したいエンジニアを大募集中! だそうです!

その他の記事

Other Articles

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/04/02
『エンジニア採用最前線』に感化されて2週間でエンジニア主導の求人票更新フローを構築した話

2019/03/29
その1 Jetson TX2でk3s(枯山水)を動かしてみた

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/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
【深層学習】時系列データに対する1次元畳み込み層の出力を可視化

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

バックエンドエンジニア(Python・Go)

業務内容

当ポジションは弊社Webサービスのバックエンド機能設計及び実装を担当します。 サービス毎の開発チームで2週間スプリントのスクラム開発を実施しています。 週次で開発チームミーティングを実施し、実装設計の相談や工数見積もりを行います。 全ての開発コードはレビューと自動テストによって品質を保っています。 また、リファクタリングやフレームワークのバージョンアップも開発フローに組込み、技術的負債を放置しない開発を目指しています。

フロントエンドエンジニア(TypeScript)

業務内容

当ポジションは弊社Webサービスのフロントエンド機能設計及び実装を担当します。 サービス毎の開発チームで2週間スプリントのスクラム開発を実施しています。 週次で開発チームミーティングを実施し、実装設計の相談や工数見積もりを行います。 全ての開発コードはレビューと自動テストによって品質を保っています。 また、リファクタリングやフレームワークのバージョンアップも開発フローに組込み、技術的負債を放置しない開発を目指しています。

機械学習エンジニア

業務内容

センサーデータの分析モデルの調査・研究・開発。 Kabuku Connectの製造データ(3D、2D)から情報を抽出するモデルの構築。 データの前処理や学習、ハイパーパラメータチューニング、獲得モデルの評価、プロダクションのデータパイプラインとの連携をお願いします。

インターン(Webエンジニア)

業務内容

業務から独立した、調査・研究系のタスクをおまかせしています。コードレビュー、 社内での報告会、 ブログ記事執筆を通して着実にスキルアップしていただくことを目指しています。 (希望があれば、プロダクトの開発業務もおまかせします。)

→
←

お客様のご要望に「Kabuku」はお応えいたします。
ぜひお気軽にご相談ください。

お電話でも受け付けております
03-6380-2750
営業時間:09:30~18:00
※土日祝は除く