Ignore pages that are not main_frame loads

g

Author: bhollis

CHANGELOG.md

@@ -1,3 +1,7 @@
+## JSONView 3.1.0
+
+- Restricted JSONView to only act on main frame loads - this should prevent it from doing weird things to pages loaded in frames or via fetch/XHR. This should fix reported issues of JSONView causing trouble on Sharepoint sites.
+
 ## JSONView 3.0.2
 
 - Fixed a regression in Firefox where JSON not served as UTF-8 (which is technically invalid) caused ugly characters to display in the formatted JSON.

CONTRIBUTING.md

@@ -6,7 +6,7 @@ There are no hard and fast rules for what I will and will not accept - please ju
 
 - Adding new MIME types to the set supported by JSONView. I have [an open issue](https://github.com/bhollis/jsonview/issues/7) for how I'd like to see additional MIME types handled, and will not accept patches that add arbitrary new MIME types.
 - Adding new options. While I'm not opposed to adding an option if it really makes sense, the bar is very high for adding anything configurable to the add-on.
-- Interpreting JSON in any application-specific way. While in the past I've allowed a few feature additions that attempt to interpret JSON (such as recognizing and linkifying URLs), I want JSONView to be a general JSON viewer, and as such will reject any patch that seeks to priviledge specific interpretations of JSON structure.
+- Interpreting JSON in any application-specific way. While in the past I've allowed a few feature additions that attempt to interpret JSON (such as recognizing and linkifying URLs), I want JSONView to be a general JSON viewer, and as such will reject any patch that seeks to privilege specific interpretations of JSON structure.
 - Adding switches or options to the screen that shows JSON. I don't want to clutter up the JSON view itself with control panels and options, so anything that relies on adding such a thing is likely to be rejected.
 
 Please, don't let this discourage you! Just file an issue first so we can discuss the change you plan to make.

README.md

@@ -32,6 +32,7 @@ Before contributing to JSONView, make sure to read the [Contributing Guidelines]
 - Run `pnpm start` to build the extension.
 - In Firefox, go to `about:debugging#addons` in the address bar, check "Enable add-on debugging", select "Load Temporary Add-on", and choose the `jsonview/build-firefox/manifest.json` file.
 - In Chrome, Edge, etc., go to `edge://extensions/`, in the address bar, enable "Developer mode", select "Load Unpacked", and choose the `jsonview/build-chrome` folder.
+- Run `pnpm tests` to start a little webserver that serves all the JSON files in `./tests`.
 
 JSONView makes use of [TypeScript](https://www.typescriptlang.org/). I recommend [VSCode](https://code.visualstudio.com/) for editing the code - it will automatically prompt to install the correct extensions, and will highlight errors. All of the code that makes up the extension itself are in `src/`.
 

src/background-chrome.ts

@@ -13,7 +13,7 @@ function isRedirect(status: number) {
 }
 
 function detectJSON(event: chrome.webRequest.WebResponseHeadersDetails) {
-  if (!event.responseHeaders || isRedirect(event.statusCode)) {
+  if (!event.responseHeaders || event.type !== "main_frame" || isRedirect(event.statusCode)) {
     return;
   }
   for (const header of event.responseHeaders) {
@@ -34,7 +34,7 @@ function detectJSON(event: chrome.webRequest.WebResponseHeadersDetails) {
 chrome.webRequest.onHeadersReceived.addListener(
   detectJSON,
   { urls: ["<all_urls>"], types: ["main_frame"] },
-  ["responseHeaders"]
+  ["responseHeaders"],
 );
 
 // Listen for a message from the content script to decide whether to operate on

src/background-firefox.ts

@@ -13,7 +13,7 @@ function isRedirect(status: number) {
 }
 
 function detectJSON(event: chrome.webRequest.WebResponseHeadersDetails) {
-  if (!event.responseHeaders || isRedirect(event.statusCode)) {
+  if (!event.responseHeaders || event.type !== "main_frame" || isRedirect(event.statusCode)) {
     return;
   }
   for (const header of event.responseHeaders) {