Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added chrome.debugger to monitor network requests #44

Merged
merged 9 commits into from
Jul 21, 2023
Merged

Added chrome.debugger to monitor network requests #44

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3df16da
Added chrome.debugger to monitor network requests
juskek Jul 19, 2023
eb579ae
refactor: Record bytes transferred using Network.loadingFinished event
juskek Jul 20, 2023
e9f6c69
refactor: record bytes using on a request by request basis (does not …
juskek Jul 20, 2023
a1da0aa
revert: use loadingFinished instead, removed unnecessary functions
juskek Jul 20, 2023
7de7b2d
fix(chrome.debugger): Error: Debugger is not attached to the tab with…
juskek Jul 21, 2023
315e91f
Removed chrome.webRequest permissions
juskek Jul 21, 2023
75dc4e1
refactor:Added typing
juskek Jul 21, 2023
2d42293
fix: stop throwing error "Debugger is not attached" when calculation …
juskek Jul 21, 2023
69b6924
refactor: type cast error instead of conditional check
juskek Jul 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions public/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
"default_popup": "popup.html"
},
"permissions": [
"webRequest",
"tabs",
"storage"
"storage",
"debugger"
],
"host_permissions": [
"*://*/*/"
Expand Down
79 changes: 51 additions & 28 deletions src/background/background.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
import { IBytesRepository } from "../data/bytes/IBytesRepository";
import {
catchPostRequestBodySize,
catchRequestHeaderSize,
catchResponseSize,
} from "./webRequestListeners";
import { addBytesTransferred } from "./backgroundHelpers";

chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
chrome.runtime.onMessage.addListener(async (message, sender, sendResponse) => {
if (message === "getBytesTransferred") {
sendResponse(IBytesRepository.instance.getBytesTransferred());
}
Expand All @@ -15,33 +11,60 @@ chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
if (message.command === "startRecordingBytesTransferred") {
IBytesRepository.instance.clearBytesTransferred();

chrome.webRequest.onBeforeRequest.addListener(
catchPostRequestBodySize,
{ urls: ["<all_urls>"], tabId },
["requestBody"]
);
chrome.webRequest.onBeforeSendHeaders.addListener(
catchRequestHeaderSize,
{ urls: ["<all_urls>"], tabId },
["requestHeaders"]
);
chrome.webRequest.onCompleted.addListener(
catchResponseSize,
{ urls: ["<all_urls>"], tabId },
["responseHeaders"]
);
chrome.debugger.attach({ tabId: tabId }, "1.2", () => {
chrome.debugger.sendCommand(
{ tabId: tabId },
"Network.enable",
{},
() => {
if (chrome.runtime.lastError) {
console.error(chrome.runtime.lastError);
}
}
);
});

sendResponse(true);
}

if (message.command === "stopRecordingBytesTransferred") {
chrome.webRequest.onCompleted.removeListener(catchResponseSize);
chrome.webRequest.onBeforeRequest.removeListener(
catchPostRequestBodySize
);
chrome.webRequest.onBeforeSendHeaders.removeListener(
catchRequestHeaderSize
);
try {
await chrome.debugger.detach({ tabId: tabId });
} catch (e: unknown) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When is e not an Error?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is always going to be an error -
It's typed as unknown because I don't think typing in catch clauses are allowed yet

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case, I'd probably remove the if condition and just type cast it as an Error

if (e instanceof Error) {
if (
e.message ===
`Debugger is not attached to the tab with id: ${tabId}.`
) {
console.warn(
`Tried to detach debugger from tab (tabId: ${tabId}) when there was none attached. `
);
return;
}
throw e;
}
throw e;
}
sendResponse(true);
}
return true;
});

type NetworkParamsType = {
encodedDataLength?: number;
};

chrome.debugger.onEvent.addListener(
(source, method: string, params: NetworkParamsType | undefined) => {
switch (method) {
case "Network.loadingFinished": {
if (params?.encodedDataLength && params.encodedDataLength > 0) {
addBytesTransferred(params.encodedDataLength);
}
break;
}
default:
break;
}
}
);
27 changes: 27 additions & 0 deletions src/background/backgroundHelpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { IBytesRepository } from "../data/bytes/IBytesRepository";

export const addBytesTransferred = async (bytes: number) => {
IBytesRepository.instance.addBytesTransferred(bytes);

try {
await chrome.runtime.sendMessage({
command: {
bytesTransferredChanged:
IBytesRepository.instance.getBytesTransferred(),
},
});
} catch (e: unknown) {
if (e instanceof Error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SImilar error question here

if (
e.message ===
"Could not establish connection. Receiving end does not exist."
) {
console.warn(
`Error Caught: ${e}\nIf popup is open and this error is seen in the console, debugging is required.`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Debugging is required as soon as you have an error, isn't it? We should maybe consider it the other way around "if popup is closed then the error is ok"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can catch this error by checking if (popup is closed && could not establish connection), but checking if the popup is closed requires chrome.runtime.getContexts()

  • This is a new api that recently got proposed, and the only example I have found where it is used is here
  • The example has "minimum_chrome_version": "116", while the current stable version is 115, so I think we can leave it for now and catch it properly when 116 is out image

);
}
} else {
throw e;
}
}
};
48 changes: 0 additions & 48 deletions src/background/getWebRequestSizeHelpers.ts
View file
Open in desktop

This file was deleted.

65 changes: 0 additions & 65 deletions src/background/webRequestListeners.ts
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion src/view/popup/usePopup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ export const usePopup = () => {
}
try {
await calculationsRepository.setOngoingCalculation(true);
backgroundStopRecordingBytes();
} catch (e: unknown) {
if (e instanceof Error) {
setError(e.message);
Expand Down