メモログ

💡 Personal notes about somthing I'm interested in

TypeScriptとWebpackを使ってDynamic Importを行う

Webpackではバンドルするファイルを3つのアプローチで分けることができる。エントリーポイントを複数設けたり、webpack.config.jsにsplitChunksの設定を入れたりなどの他に、Dyanmic importを使うことでもファイルを分けることができる。詳しくはCode Splittingを参照。

Dyanmic importはES2015のimportが静的にライブラリを読み込むのに対して、動的に読み込む。たいていの場合普通のimportで事足りる一方、多言語用のファイルとか、普段は必要なくて全部読み込むとファイルサイズが大きくなるとか、なくてもまあ基本的な機能に問題ないみたいなものは必要なときに動的にファイルを読み込みたい場合もある。そういったときにDynamic Importを利用する。

Motivation and use cases

The existing syntactic forms for importing modules are static declarations. They accept a string literal as the module specifier, and introduce bindings into the local scope via a pre-runtime “linking” process. This is a great design for the 90% case, and supports important use cases such as static analysis, bundling tools, and tree shaking.

However, it’s also desirable to be able to dynamically load parts of a JavaScript application at runtime. This could be because of factors only known at runtime (such as the user’s language), for performance reasons (not loading code until it is likely to be used), or for robustness reasons (surviving failure to load a non-critical module). Such dynamic code-loading has a long history, especially on the web, but also in Node.js (to delay startup costs). The existing import syntax does not support such use cases.

Truly dynamic code loading also enables advanced scenarios, such as racing multiple modules against each other and choosing the first to successfully load.

Dyanmic import

実装的にはこんな感じになる(サンプルコード)。Dynamic importの部分があるとwebpackが自動的にcode splittingしてくれるけれど、splitされたチャンク名をつけたい場合はファイル名の前にコメントをつける。

import(/* webpackChunkName: "hello" */ './hello_world')
  .then(module => {
    const hello = new module.HelloWorld();
    hello.say();
  });

TypeScriptの場合は、Compiler OptionsでremoveCommentsをtrueにしていると、webpackがsplitする前にコメントを消してしまうのでremoveCommentsをfalseにする必要がある(Productionモードの場合、Webpackのminificationで最終的にコメントを消してくれる)。

Webpackはデフォルトでnode_modulesから読み込んだライブラリをvendorsのcacheGroupに分ける。Dynamic Importしたファイルでnode_modulesからライブラリを読み込んだりするとvendors~hello.jsみたいな名前でファイルを分割する。vendorsにファイルを分けたくない場合は、cacheGroupでvendorsの設定をfalseにする。

あと、cacheGroupの名前とchunkの名前の間のdelimiterはデフォルトで~になっている。通常これで問題ないけど、AWSのCloudFrontでcacheをinvalidateしようするとvalidなファイル名じゃないとエラーになるので、変更する必要がでるかもしれない。そういうときにはautomaticNameDelimiterの設定で変更することができる。

  optimization: {
    namedChunks: true,
    splitChunks: {
      automaticNameDelimiter: '-',
      cacheGroups: {
        vendors: false
      }
    }
  },

というメモ。