![require(esm) Backported to Node.js 20, Paving the Way for ESM-Only Packages](https://cdn.sanity.io/images/cgdhsj6q/production/be8ab80c8efa5907bc341c6fefe9aa20d239d890-1600x1097.png?w=400&fit=max&auto=format)
Security News
require(esm) Backported to Node.js 20, Paving the Way for ESM-Only Packages
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
@openreplay/tracker-fetch
Advanced tools
This plugin allows you to capture fetch
payloads and inspect them later on while replaying session recordings. This is very useful for understanding and fixing issues.
npm i @openreplay/tracker-fetch
Use the provided fetch
method from the plugin instead of the one built-in.
import tracker from '@openreplay/tracker';
import trackerFetch from '@openreplay/tracker-fetch';
const tracker = new OpenReplay({
projectKey: PROJECT_KEY
});
const fetch = tracker.use(trackerFetch(options)); // check list of available options below
tracker.start();
fetch('https://myapi.com/').then(response => console.log(response.json()));
Follow the below example if your app is SSR. Ensure tracker.start()
is called once the app is started (in useEffect
or componentDidMount
).
import OpenReplay from '@openreplay/tracker/cjs';
import trackerFetch from '@openreplay/tracker-fetch/cjs';
const tracker = new OpenReplay({
projectKey: PROJECT_KEY
});
const fetch = tracker.use(trackerFetch(options)); // check list of available options below
//...
function MyApp() {
useEffect(() => { // use componentDidMount in case of React Class Component
tracker.start();
fetch('https://myapi.com/').then(response => console.log(response.json()));
}, [])
//...
}
trackerFetch({
overrideGlobal: boolean;
failuresOnly: boolean;
sessionTokenHeader: string;
ignoreHeaders: Array<string> | boolean;
sanitiser: (RequestResponseData) => RequestResponseData | null;
})
overrideGlobal
: Overrides the default window.fetch
. Default: false
.failuresOnly
: Captures requests having 4xx-5xx HTTP status code. Default: false
.sessionTokenHeader
: In case you have enabled some of our backend integrations (i.e. Sentry), you can use this option to specify the header name (i.e. 'X-OpenReplay-SessionToken'). This latter gets appended automatically to each fetch request to contain the OpenReplay sessionToken's value. Default: undefined
.ignoreHeaders
: Helps define a list of headers you don't wish to capture. Set its value to false
to capture all of them (true
if none). Default: ['Cookie', 'Set-Cookie', 'Authorization']
so sensitive headers won't be captured.sanitiser
: Sanitise sensitive data from fetch request/response or ignore request comletely. You can redact fields on the request object by modifying then returning it from the function:interface RequestData {
body: BodyInit | null | undefined; // whatewer you've put in the init.body in fetch(url, init)
headers: Record<string, string>;
}
interface ResponseData {
body: string | Object | null; // Object if response is of JSON type
headers: Record<string, string>;
}
interface RequestResponseData {
readonly status: number;
readonly method: string;
url: string;
request: RequestData;
response: ResponseData;
}
sanitiser: (data: RequestResponseData) => { // sanitise the body or headers
if (data.url === "/auth") {
data.request.body = null
}
if (data.request.headers['x-auth-token']) { // can also use ignoreHeaders option instead
data.request.headers['x-auth-token'] = 'SANITISED';
}
// Sanitise response
if (data.status < 400 && data.response.body.token) {
data.response.body.token = "<TOKEN>"
}
return data
}
// OR
sanitiser: data => { // ignore requests that start with /secure
if (data.url.startsWith("/secure")) {
return null
}
return data
}
// OR
sanitiser: data => { // sanitise request url: replace all numbers
data.url = data.url.replace(/\d/g, "*")
return data
}
Having trouble setting up this plugin? please connect to our Discord and get help from our community.
FAQs
Tracker plugin for fetch requests recording
The npm package @openreplay/tracker-fetch receives a total of 239 weekly downloads. As such, @openreplay/tracker-fetch popularity was classified as not popular.
We found that @openreplay/tracker-fetch demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.