Chrome Extension - How to get HTTP Response Body?

JavascriptGoogle Chrome-Extension

Javascript Problem Overview


It seems to be difficult problem (or impossible??). I want to get and read HTTP Response, caused by HTTP Request in browser, under watching Chrome Extension background script. We can get HTTP Request Body in this way

chrome.webRequest.onBeforeRequest.addListener(function(data){
    // data contains request_body
},{'urls':[]},['requestBody']);

I also checked these stackoverflows

Is there any clever way to get HTTP Response Body in Chrome Extension?

Javascript Solutions


Solution 1 - Javascript

I can't find better way then this anwser.

https://stackoverflow.com/questions/8939467/chrome-extension-to-read-http-response

The answer told how to get response headers and display in another page.But there is no body info in the response obj(see event-responseReceived). If you want to get response body without another page, try this.

var currentTab;
var version = "1.0";

chrome.tabs.query( //get current Tab
	{
		currentWindow: true,
		active: true
	},
	function(tabArray) {
		currentTab = tabArray[0];
		chrome.debugger.attach({ //debug at current tab
			tabId: currentTab.id
		}, version, onAttach.bind(null, currentTab.id));
	}
)


function onAttach(tabId) {

	chrome.debugger.sendCommand({ //first enable the Network
		tabId: tabId
	}, "Network.enable");

	chrome.debugger.onEvent.addListener(allEventHandler);

}


function allEventHandler(debuggeeId, message, params) {

	if (currentTab.id != debuggeeId.tabId) {
		return;
	}

	if (message == "Network.responseReceived") { //response return 
		chrome.debugger.sendCommand({
			tabId: debuggeeId.tabId
		}, "Network.getResponseBody", {
			"requestId": params.requestId
		}, function(response) {
			// you get the response body here!
			// you can close the debugger tips by:
			chrome.debugger.detach(debuggeeId);
		});
	}

}

I think it's useful enough for me and you can use chrome.debugger.detach(debuggeeId)to close the ugly tip.

sorry, mabye not helpful... ^ ^

Solution 2 - Javascript

This is definitely something that is not provided out of the box by the Chrome Extension ecosystem. But, I could find a couple of ways to get around this but both come with their own set of drawbacks.

The first way is:

  1. Use a content script to inject our own custom script.
  2. Use the custom script to extend XHR's native methods to read the response.
  3. Add the response to the web page's DOM inside a hidden (not display: none) element.
  4. Use the content script to read the hidden response.

The second way is to create a DevTools extension which is the only extension that provides an API to read each request.

I have penned down both the methods in a detailed manner in a blog post here.

Let me know if you face any issues! :)

Solution 3 - Javascript

There is now a way in a Chrome Developer Tools extension, and sample code can be seen here: blog post.

In short, here is an adaptation of his sample code:

chrome.devtools.network.onRequestFinished.addListener(request => {
  request.getContent((body) => {
    if (request.request && request.request.url) {
      if (request.request.url.includes('facebook.com')) {

         //continue with custom code
         var bodyObj = JSON.parse(body);//etc.
      }
}
});
});

Solution 4 - Javascript

I show my completed code if it can be some help. I added the underscore to get the request url, thanks

//background.js
import _, { map } from 'underscore';

var currentTab;
var version = "1.0";

chrome.tabs.onActivated.addListener(activeTab => {
    currentTab&&chrome.debugger.detach({tabId:currentTab.tabId});
    currentTab = activeTab;
    chrome.debugger.attach({ //debug at current tab
        tabId: currentTab.tabId
    }, version, onAttach.bind(null, currentTab.tabId));
});

function onAttach(tabId) {
    chrome.debugger.sendCommand({ //first enable the Network
        tabId: tabId
    }, "Network.enable");
    chrome.debugger.onEvent.addListener(allEventHandler);
}

function allEventHandler(debuggeeId, message, params) {
    if (currentTab.tabId !== debuggeeId.tabId) {
        return;
    }
    if (message === "Network.responseReceived") { //response return
        chrome.debugger.sendCommand({
            tabId: debuggeeId.tabId
        }, "Network.getResponseBody", {
            "requestId": params.requestId
            //use underscore to add callback a more argument, passing params down to callback
        }, _.partial(function(response,params) {
            // you get the response body here!
            console.log(response.body,params.response.url);
            // you can close the debugger tips by:
            // chrome.debugger.detach(debuggeeId);
        },_,params));
    }
}

I also find there is a bug in chrome.debugger.sendCommand. If I have two requests with same URI but different arguments. such as:

The second one will not get the corrected responseBody, it will show:

Chrome Extension: "Unchecked runtime.lastError: {"code":-32000,"message":"No resource with given identifier found"}

But I debugger directly in background devtools, it get the second one right body.

chrome.debugger.sendCommand({tabId:2},"Network.getResponseBody",{requestId:"6932.574"},function(response){console.log(response.body)})

So there is no problem with tabId and requestId. Then I wrap the chrome.debugger.sendCommand with setTimeout, it will get the first and second responseBody correctly.

if (message === "Network.responseReceived") { //response return            
console.log(params.response.url,debuggeeId.tabId,params.requestId)
        setTimeout(()=>{
            chrome.debugger.sendCommand({
                tabId: debuggeeId.tabId
            }, "Network.getResponseBody", {
                "requestId": params.requestId
                //use underscore to add callback a more argument, passing params down to callback
            }, _.partial(function(response,params,debuggeeId) {
                // you get the response body here!
                console.log(response.body,params.response.url);
                // you can close the debugger tips by:
                // chrome.debugger.detach(debuggeeId);
            },_,params,debuggeeId));
        },800)
    
}

I think the setTimeout is not the perfect solution, can some one give help? thanks.

Solution 5 - Javascript

To get a XHR response body you can follow the instructions in this answer.

To get a FETCH response body you can check Solution 3 in this article and also this answer. Both get the response body without using chrome.debugger.

In a nutshell, you need to inject the following function into the page from the content script using the same method used for the XHR requests.

const constantMock = window.fetch;
 window.fetch = function() {
    return new Promise((resolve, reject) => {
        constantMock.apply(this, arguments)
            .then((response) => {
                if (response) {
                    response.clone().json() //the response body is a readablestream, which can only be read once. That's why we make a clone here and work with the clone
                    .then( (json) => {
                        console.log(json);
                        //Do whatever you want with the json
                        resolve(response);
                    })
                    .catch((error) => {
                        console.log(error);
                        reject(response);
                    })
                }
                else {
                    console.log(arguments);
                    console.log('Undefined Response!');
                    reject(response);
                }
            })
            .catch((error) => {
                console.log(error);
                reject(response);
            })
    })
}

If response.clone().json() does not work, you can try response.clone().text()

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
Questionotiai10View Question on Stackoverflow
Solution 1 - JavascriptliyangreadyView Answer on Stackoverflow
Solution 2 - JavascriptTarun DugarView Answer on Stackoverflow
Solution 3 - JavascriptJohnP2View Answer on Stackoverflow
Solution 4 - JavascriptAnson HwangView Answer on Stackoverflow
Solution 5 - JavascriptKaloView Answer on Stackoverflow