Reread a response body from JavaScript's fetch
Asked Answered
I

4

45

fetch() returns promise which (if successful) resolves to a Response object. A very common thing to do is immediately call Response.json() to convert the response body to a JSON object.

If the response body isn't valid JSON, then the Response.json() promise fails with an error. The message is something along the lines of:

Unexpected token X in JSON at position 0

That's not very helpful when trying to diagnose the problem; ideally I'd like to be able to see the content from the server (which is often an error message).

However, it appears that you can only read the stream at Response.body once (at least in Chrome). (There's even a read-only Response.bodyUsed flag.) That has already happened when Response.json() tries to convert the body to JSON, so the body appears to be lost forever in the event of a JSON parsing failure.

Is there any way to recover the original response body... short of manually reading it (and then converting to JSON) when the original fetch Promise resolves?

Internecine answered 8/11, 2016 at 22:57 Comment(2)
You could call response.text() instead to read the returned data even if it's not valid JSON, and you can clone a response, but ideally your server should always return JSON when you expect JSON, even the errors should be returned as JSON.Jacksonjacksonville
See Also: Failed to execute 'json' on 'Response': body stream is lockedAnissa
S
49

Use Response.clone() to clone Response

let clone = response.clone();

Alternatively, use Response.body.getReader() which returns a ReadableStream to read Response as a stream, TextDecoder() to convert Uint8Array data stream to text.

Setback answered 8/11, 2016 at 23:3 Comment(6)
@CraigWalker See How can I append DOM elements as they stream in from the network?Setback
clone() looked like the answer, but it fails if you've already called .json(): "TypeError: Failed to execute 'clone' on 'Response': Response body is already used" So resp.text() followed by manual json parsing is one option, but +1 for Jaromanda's suggestion to clone() before calling json()!Ozenfant
@Ozenfant Yes, .clone() needs to be called before body is read. This is why javascript at Answer is response.clone(). Have you read the specification fetch.spec.whatwg.org/#body-mixin, fetch.spec.whatwg.org/#bodies, fetch.spec.whatwg.org/#dom-response-clone ?Setback
I'm getting Failed to execute 'clone' on 'Response': Response body is already usedEncephalitis
@Encephalitis Then Response.body has already been used at the code. Can you create a jsfiddle jsfiddle.net or plnkr plnkr.co to demonstrate?Setback
thanks @Setback for the answer , here is a working example if any one needed more help codesandbox.io/s/parcel-sandbox-5sy2hBrandt
D
13

I had to deal with an API that occasionally botched the JSON response - before returning response.json() I made a clone of the response object. using a catch block, I can determine if the error is a SyntaxError, and proceed to fix the error using the text result of the response clone

a little like this:

var brokenJson = function (url) {
    var responseCopy;
    return fetch(url)
    .then(function (response) {
        responseCopy = response.clone();
        return response.json();
    }).catch(function (err) {
        if (err instanceof SyntaxError) {
            return responseCopy.text()
            .then(function(data) {
                return fixJson(data);
            });
        }
        else {
            throw err;
        }
    }).then(function (json) {
        // do things
    });
};

fixJson is just a function that fixes the received data - in my case, when it was broken JSON, it was always broken the same way - I think it had an extra leading { or trailing } - can't recall

re-reading the question, you're more likely to want to log the error to the console rather than fix the json - easy rewrite:

var brokenJson = function (url) {
    var responseCopy;
    return fetch(url)
    .then(function (response) {
        responseCopy = response.clone();
        return response.json();
    }).catch(function (err) {
        if (err instanceof SyntaxError) {
            return responseCopy.text()
            .then(function(text) {
                console.error(text);
                throw err;
            });
        }
        else {
            throw err;
        }
    }).then(function (json) {
        // do things
    });
};
Dumb answered 8/11, 2016 at 23:5 Comment(0)
C
0

Assigning the response.json() to a variable and returning it worked for me. clone() was again saying its locked.

fetch("http://localhost:3000/watchlist")
    .then(response => {
      var res = response.json();
      return res;
    })
    .then(data => {
      console.log(data);
      this.setState({ data });
    });
Cloots answered 9/1, 2020 at 0:59 Comment(0)
C
-1

I used JSON.parse(response.resp.data) as somehow clone didn't work.

Centre answered 23/5, 2021 at 4:26 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.