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

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

ただいまの
回答率

90.21%

Fetch API で XMLHttpRequest の progress イベントと同等の機能を実現するには?

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 3,612

think49

score 14390

 XMLHttpRequest

XMLHttpRequest でプログレスバーに進捗状況を表しつつ、ダウンロードするコードを書きます。
(※このコードは「XMLHttpRequest Living Standard」の6.4節のコードを参考にしました。)

<progress id="download"></progress>

<script>
'use strict';
var progressBar = document.getElementById('download'),
    xhr = new XMLHttpRequest;

xhr.open('GET', 'test.csv', true);

xhr.addEventListener('progress', function (event) {
  if (event.lengthComputable) {
    progressBar.max = event.total;
    progressBar.value = event.loaded;
  }
}, false);

xhr.addEventListener('loadend', function (event) {
  progressBar.value = event.loaded;
}, false);

xhr.send();
</script>

 Fetch API

Fetch API でも XMLHttpRequest と同様のコードを書こうとしますが、progress イベントを捕捉する方法が分かりません。

'use strict';
fetch('test.txt').then(function (response) {
  response.text().then(function (string) {
    console.log(string);
  });
});

 Fetch API で出来ない事

仕様書を見る限りでは見つけられなかったのですが、そもそも、Fetch API にはイベントの概念がなく、同様のコードを書く事は出来ないのでしょうか。
本件以外にも「XMLHttpRequest で出来て Fetch API では実現できない機能」があれば教えて頂けると有り難いです。

 参考リンク

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

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

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

    クリップを取り消します

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

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

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

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

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

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

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

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

    質問の評価を下げる

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

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

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

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

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

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

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

    詳細な説明はこちら

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

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

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

回答 1

checkベストアンサー

+2

think49さんの推測通り、Fetch APIには、おそらくイベントの概念はないのではないでしょうか。
どちらかというと、Streamなどを用いて、Fetch APIを使ってprogress イベントを実装するようなイメージではないかと思います。

upload progress? · Issue #21 · whatwg/fetch
に、以下のようにあるところから判断しました。

The native fetch() API implemented by browsers does not use XMLHttpRequest underneath. 
The eventual API for progress is building something on https://streams.spec.whatwg.org/ 
which https://github.com/yutakahirano/fetch-with-streams/ is adding to fetch().

ダウンロード(応答)の進捗については、
Fetch Standard (日本語訳) 6. fetch API
に記述されている

ボディデータを漸進的に受信したいなら:

という箇所にあるコードをもとにすると、一応プログレスバーに進捗は出すことができました。
(ファイルの内容は読み捨ててますが。。)

fetch('test.txt').then(function(response) {
    var contentLength = response.headers.get("Content-Length")
    consume(response.body.getReader(), contentLength);
});

function consume(reader, contentLength) {
    var progressBar = document.getElementById('download');
    var total = 0;
    return pump();

    function pump() {
        reader.read().then(function(result) {
            var done = result.done;
            var value = result.value;
            if (done) {
                progressBar.value = total;
                return;
            }
            total += value.byteLength;

            progressBar.max = contentLength;
            progressBar.value = total;

            return pump();
        })
    }
}

 Fetch API で出来ない事

Fetch Standard (日本語訳) 6. fetch API

fetch() メソッドは、リソースを fetch するための,比較的 低レベルの API である。 
XMLHttpRequest より少しばかり基盤的部分を対象にする 
— 現時点では、いつ要請の進捗(応答の進捗ではなく)が来たかを報告する機能を欠いているが。

とあるところから、アップロード(要請)の進捗については、現状その機能がないようです。

 参考リンク

Now that I think about it, I couldn't find any API related to download/upload progress events with the Fetch API. If that's the case, it means it's an actual regression to XMLHTTPRequest.
You can access the stream as it's coming in using fetch - would that let you do progress? Seems like it would.

Limitations
- Promises don't have finally/always method- there is a workaround
- There is neither abort method nor a timeout property for fetch()
- fetch() (as Promise- based standard) doesn't have ability to provide onProgress() callback- so you cannot process a response by chunks
- Haven't found clear info about doing synchronous fetching
but, most of all, it's not provided, because even in such case onSuccess and onReject callbacks would be invoked on the next tick- due to Promise nature.

Soon you'll be able to provide a stream as the body of a request, but the open question is whether the consumption of that stream relates to bytes uploaded.

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2016/07/07 22:09

    ありがとうございます。
    期待通りの結果は得られましたが、stream を理解するのに時間がかかりそうです。
    response.body が ReadableStream であることまでは突き止めました。
    https://triple-underscore.github.io/Streams-ja.html#rs-class
    おそらく、Streamはデータを少しずつロードして reader.read().then() を再帰呼び出ししているイメージでしょうか。
    コードから実動作を何となく想像できるものの仕様書から動作を理解できるまでではなく、もやもやしている状況です。
    Streamの基礎的な部分を解説している資料がもっとあるといいのですが…。

    キャンセル

  • 2016/07/08 07:33

    http://jxck.hatenablog.com/entry/whatwg-stream

    に解説がありましたが、これはどうでしょうか?

    キャンセル

  • 2016/07/09 07:35

    ありがとうございます。大体理解できました。
    詳細な事柄は徐々に習得していきたいと思います。

    キャンセル

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

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