-
Notifications
You must be signed in to change notification settings - Fork 8.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add an example that shows how to polyfill XHR in an extension (#1343)
* add an example that shows how to polyfill XHR in an extension * updates from feedback * update based on third party OSS requirements * update readme links
- Loading branch information
1 parent
b939ca2
commit d2fd736
Showing
12 changed files
with
1,384 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
dist |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Using XHR in Service Workers | ||
|
||
This sample demonstrates how to use code that relies on XHR within a extension's background service worker. | ||
|
||
## Overview | ||
|
||
The default background environment for extensions is the service worker. As a result, it only has direct access to [Fetch](https://developer.mozilla.org/docs/Web/API/Fetch_API/Using_Fetch). If you want to use a library that is built with XHR, this will not work by default. However, you can usually monkeypatch the expected behavior by polyfilling XHR. This sample shows an example of how you can use build tools to automatically inject a polyfill for XHR that covers most common XHR use cases, allowing for seamless integration into your extension. | ||
|
||
In this sample, we are using a "library" that exports a function called [`fetchTitle`](./third_party/fetchTitle.js). For the fiction of this sample, this is a dependency we _must_ use, but we are unable to change ourselves. Unfortunately, it uses XHR. In order to make this work, we [import](./background.js#L1) a [shim](./third_party/xhr-shim/xhr-shim.js), and then [set the global `XMLHttpRequest` to it](./background.js#L4). | ||
|
||
This is all packaged by a build system, in this case [Rollup](https://rollupjs.org/). | ||
|
||
## Running this extension | ||
|
||
1. Clone this repository | ||
2. Run `npm install` in this folder to install all dependencies. | ||
3. Run `npm run build` to bundle the extension. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
import xhrShim from './third_party/xhr-shim/xhr-shim.js'; | ||
import fetchTitle from './third_party/fetchTitle.js'; | ||
|
||
globalThis.XMLHttpRequest = xhrShim; | ||
|
||
chrome.action.onClicked.addListener(({ windowId, url }) => { | ||
chrome.sidePanel.open({ windowId }); | ||
|
||
fetchTitle(url, (err, title) => { | ||
chrome.sidePanel.setOptions({ | ||
enabled: true, | ||
path: `./sidePanel/index.html?title=${title}` | ||
}); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
{ | ||
"name": "Fetching Titles", | ||
"version": "0.1", | ||
"manifest_version": 3, | ||
"description": "This extension fetches the titles of all the tabs in the current window and displays them in a side panel.", | ||
"background": { | ||
"service_worker": "dist/background.js" | ||
}, | ||
"permissions": ["activeTab", "sidePanel"], | ||
"host_permissions": ["<all_urls>"], | ||
"side_panel": { | ||
"default_path": "sidepanel/index.html" | ||
}, | ||
"action": { | ||
"default_title": "Fetch the title of the current tab" | ||
} | ||
} |
Oops, something went wrong.