"zipファイルを解凍する"をawaitしたい

Question

プロミス初心者です。
ローカルにあるzipフォルダを解凍してから、展開されたフォルダを読み込みたいです。
それをするために、zipフォルダを解凍するをawaitしてから展開されたフォルダを読み込みたく思い、
awatiできるunzip関数を作りました。

使用するライブラリは以下です。

bluebird
https://www.npmjs.com/package/bluebird

unzipper
https://www.npmjs.com/package/unzipper

fs-extra
https://www.npmjs.com/package/fs-extra

// unzip module

import fs from 'fs-extra'
import unzipper from 'unzipper'
import Promise from 'bluebird'

export default ({ inputDirPath, outputFilePath }) => {
  return new Promise(async (resolve, reject, onCancel) => {
    try {
      await streamPromise(fs.createReadStream(inputDirPath).pipe(unzipper.Extract({ path: outputFilePath })))
      resolve()
    } catch (error) {
      reject(error)
    }
  })
}

const streamPromise = (stream) => {
  return new Promise((resolve, reject) => {
    stream.on('end', () => {
      resolve('end')
    })
    stream.on('finish', () => {
      resolve('finish')
    })
    stream.on('error', (error) => {
      reject(error)
    })
  })
}

最初は

export default ({ inputDirPath, outputFilePath }) => {
  return new Promise(async (resolve, reject, onCancel) => {
    try {
      await fs.createReadStream(inputDirPath).pipe(unzipper.Extract({ path: outputFilePath }))
      resolve()
    } catch (error) {
      reject(error)
    }
  })
}

このように書いてしまって、fs.createReadStreamの返り値はPromiseじゃなくてstream?だからawaitができず、resolveがfs.createReadStreamを追い越してしまっていました...。

そこで、

https://github.com/jprichardson/node-fs-extra/issues/433

こちらの記事を参考にしてみたら、１つ目のコードでうまくいきました。
しかし、streamPromise関数のことなど、全然理解できてません。
またストリームというものもよく理解できてません。
これは一体どういうことなのでしょうか。
なぜawaitができるのでしょうか。

Answer 1

そもそもawaitは普通promiseに対して使うもので、promiseがresolveするまで待ち、その値を取り出すというものです。一応promiseについて説明すると、promiseは非同期処理を行いやすくするためのものであり、処理が完了するとresolve、失敗するとrejectすることが期待されています。

streamはpromiseではないため変換する必要があり、それをしているのがstreamPromiseです。new Promise()でpromiseを作る方法が分からない場合は適当に検索してください。例えばこれです。

Promise再入門① Promise基本編 - Qiita

今の場合zipファイルの書き込みが終了したタイミングでresolveしたいわけですが、streamPromiseの引数となっているfs.createReadStream(inputDirPath).pipe(unzipper.Extract({ path: outputFilePath }))について少し考える必要があります。

streamは流れるデータを扱うためのものですが、writableとreadableの2種類あります。writableは流れるデータを受け取るもの、readableはデータを発生させるものです。今の場合感覚的に言うとfs.createReadStream(inputDirPath)で作られたreadble stream(Aとする)はファイルの内容を送り出し、unzipper.Extract({ path: outputFilePath })は受け取ったデータをunzipしてファイルに書き込むwritable stream(Bとする)です。これらを.pipeメソッドでつなげることで、ファイルをunzipしてファイルに書き込む、というのを実現しています。.pipe()の返り値はその引数そのままなので、streamPromiseが受け取るのはBとなります。

Aのデータが尽きてendイベントが発生すると、pipeされたBでいずれfinishイベントが発生する(ことが期待される)ので、このタイミングでresolveすればいいことになります。同様に、エラーが発生するとerrorイベントが発生するのでこのときにrejectすればいいです。promiseと異なりstreamは.onでイベントリスナーを設定するので、質問文にあるコードのようになります。

endイベントもリッスンしている理由は、writable streamでもreadable streamでもstreamPromiseを使えるようにするためだと思われます。

Comments

[退会済みユーザー]

とても丁寧な回答ありがとうございます。
なるほどです、
https://qiita.com/tfrcm/items/1dfe4265c36bea903ab3

こちらの記事にあるように、セットタイムアウトのなかでリゾルブを読んでいるのが、今回で言う

stream.onの中でリゾルブを呼ぶに当たるのですね…

[退会済みユーザー]

あと、ストリームプロミス関数をawaitしてからresolveじゃなくて、

streamPromise().then(resolve())

という書き方も多分できますよね

[karamarimo]

streamPromise().then(resolve)
ですね。
もっというと new Promise( ) 自体必要ありません。下のようにしても、resolveの値が変わる以外の違いはありません。
export default ({ inputDirPath, outputFilePath }) => {
return streamPromise(fs.createReadStream(inputDirPath).pipe(unzipper.Extract({ path: outputFilePath })))
}