質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.64%

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

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 1,756

KuruK

score 56

プロミス初心者です。
ローカルにある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

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

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+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を使えるようにするためだと思われます。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2019/05/24 09:01

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

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

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

    キャンセル

  • 2019/05/24 09:32

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

    streamPromise().then(resolve())

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

    キャンセル

  • 2019/05/24 15:42 編集

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

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.64%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る