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.

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

Add an example that shows how to polyfill XHR in an extension #1343

Merged
merged 4 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
1 change: 1 addition & 0 deletions functional-samples/libraries-xhr-in-sw/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dist
17 changes: 17 additions & 0 deletions functional-samples/libraries-xhr-in-sw/README.md
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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it'd be good to explain a bit more what you're doing here (including links to relevant sections).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

added more


In this sample, we are using a "library" that exports a function called [`fetchTitle`](./src/lib/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](./src/index.js#L1) a [shim](./src/lib/xhr-shim.js), and then [set the global `XMLHttpRequest` to it](./src/index.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.
15 changes: 15 additions & 0 deletions functional-samples/libraries-xhr-in-sw/background.js
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}`
});
});
});
17 changes: 17 additions & 0 deletions functional-samples/libraries-xhr-in-sw/manifest.json
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"
}
}
Loading