学習し、自分なりに噛み砕いて、書き出すブログ。

fs.exists()がdeprecatedになった理由

wearefractal/vinyl-fs の dest(folder, [opt]) が出力先のディレクトリが無い場合でも、そのディレクトリを作ってくれないということで、自分で「ディレクトリの有無を確認して、無い場合はディレクトリを作る」という処理を作る必要がでてきました。

そこで File System Node.js v4.1.0 Manual & Documentation を見て、ディレクトリの有無を確認するのに使えそうな fs.exists() という API を見つけたのですが、「Deprecated: Use fs.stat or fs.access instead.」ということで、他の API を使うように書かれていました。

「ファイルの有無を確認する API が deprecated になるのはなぜ？」と思い、これは何かあると思って少し調べてみたのでまとめておこうと思います。

本題

まず fs.exists() ですが、ドキュメントを見ると以下のようなコードが載っています。

fs.exists('/etc/passwd', function (exists) {
  console.log(exists ? "it's there" : 'no passwd!');
});

この中の callback 関数を見ると、引数として、与えられたパスが存在しているかどうかを示す真偽値が入っていますが、この引数の形式が他の File System の API のように err が第一引数になっていないため、規則に沿っていないということで、fs.exists does not follow node conventions · Issue #8369 · nodejs/node-v0.x-archive という issue が作られています。

しかし、二つ目のコメントで事態が変化しています。

fs.exists does not follow node conventions · Issue #8369 · nodejs/node-v0.x-archive

この二つ目のコメントについては id:yosuke_furukawa のツイートを見たほうがどういうことか分かりやすいかもしれません。

このツイートの「存在チェックした後で消されたらどうするの」というのを処理の流れに落としこむと、fs.exists() で与えられたパスが存在しているか確認し、fs.exists() の callback 関数内で fs.unlinkSync(path) としてファイルを削除した後に、callback 関数の exists 引数を使って exists が true だったら、ファイルを開くというソースコードを書いて実行すると no such file or directory のエラーが出力されます。

実際のソースコードは以下の通りとなります。これなら fs.open(path, "r", callback) として、callback 関数内でファイルの有無によって、処理を分けたほうが入れ子が浅くなりそうで良さそうです。

話を「Node の規則に沿っていないという issue が作られた」というところに戻すと、issue でやりとりがあった後、fs: deprecate exists() and existsSync() by cjihrig · Pull Request #8418 · nodejs/node-v0.x-archive という Pull Request が作られます。

この Pull Request は元のタイトルが「 fs: add errback style support to exists()」とあるように、互換性を保ちつつ、callback 関数の第一引数に error が入るようにしたものがコミットされていました。

Pull Request 内でコードレビューがおこなわれ、Function.length のパフォーマンスが悪いという指摘があったりしたのですが、それらの指摘を踏まえて Pull Request を open した cjihrig 氏はいくつか提案をしています(何もしない、互換性がある、または壊す形で第一引数の err をサポートする)。

しかし、再び事態が変わります。fs.exists() を deprecate にして代わりに fs.access() を使うようにするというコメントがされました。

そして、そのコメントが流れを変えて、fs.exists() は第一引数の err がサポートされることなく deprecated になりました。

それが、以下のツイートに繋がるのではと思います。

まとめ

ということで、「ディレクトリの有無を確認して、無い場合はディレクトリを作る」という処理を作る必要が出てきて、その有無の確認のために fs.exists() を使おうとしたら deprecated になっていて、なぜだろうと思っていろいろと調べたら、なんとなく fs.exists() が deprecated になった経緯が分かって勉強になったという話でした。

また、これを通じて「ディレクトリの有無を確認して、無い場合はディレクトリを作る」という処理は「ディレクトリを作るように試み、既に存在したら(エラーになったら)作らない」という処理になりました。

具体的なソースコードとしては、最初は fs.exists() を使っていたため、以下のようなソースコードになっていました。

ですが、これを「ディレクトリを作るように試み、既に存在したら(エラーになったら)作らない」という考え方で書き換えて以下のようにしました。

結果的に、fs.exists() という deprecated になった API を使う必要がなくなり、また入れ子も浅くなりソースコードも短くなりました。