Request getting filtered by Replay integration.

[Kobby-Bawuah]

Environment

SaaS (https://sentry.io/)

Steps to Reproduce

A user reported that when their settings include the networkDetailAllowUrls integration, the requests to an example domain cease to appear in the Sentry network requests tab during a replay:

When the user has their setting as:

integrations: [ 
 new Replay(), 
 ], 

Then the domain requests show up (just no body).

As soon as the user specifies networkDetailAllowUrls, their example domain requests will stop showing up. So, a config like this makes the domain requests disappear from the Sentry network requests tab in a replay:

integrations: [ 
 new Replay({ 
 networkDetailAllowUrls: ['exampledomain.io'] 
 }), 
 ],

It's important to note that the issue may be related to how the Replay integration handles query parameters in the URL, particularly those involving URLs because it doesn't filter all domains added to the integration.

Please see Jira Sync for more information.

Expected Result

When the Replay integration includes the configuration parameter networkDetailAllowUrls: ['demodomain.io'], it is expected that requests to 'demodomain.io' should be visible in the Sentry network requests tab during a replay. Specifically, the integration should allow the specified URL to be processed without being blocked, ensuring accurate and complete replay of network requests.

Actual Result

Currently, when the networkDetailAllowUrls parameter includes 'demodomain.io', the requests to the specified URL with a URL as a query parameter are blocked. As a result, these requests do not appear in the Sentry network requests tab during a replay, leading to incomplete network data.

This behavior contradicts the expected functionality of the Replay integration, indicating a potential issue or bug in the integration logic.

Product Area

Replays

Link

No response

DSN

No response

Version

No response

┆Issue is synchronized with this Jira Improvement by Unito

[getsantry]

Routing to @getsentry/product-owners-replays for triage ⏲️

[getsantry]

Assigning to @getsentry/support for routing ⏲️

[billyvg]

@mydea another network request issue, there are more details in the zendesk ticket as well

[mydea]

Hey,

I wasn't able to reproduce this, and I can't really see any more information about this in the linked jira issue - don't have access to the zendesk ticket, not sure if there is more in there.

The networkDetailAllowUrls setting has (or should have, at least) no effect on generally capturing the breadcrumb. To further debug this, I'd need:

• The actual SDK init code
• Maybe a link to an example event where this is missing
• Maybe some more details on what request exactly is failing - e.g. the actual fetch or xhr code they use which is not captured (maybe it is something specific to the actual request, though not sure what that may be)

[dotdev-brendon]

UPDATE: Removing the query string did not actually fix the issue, so that assumption is not accurate. The only other real difference is that this request is a POST/XHR request vs GET/FETCH which are still showing.

+1 I can confirm that the exact issue is when the setting is being used, and the request includes a query string, then the requests are filtered from the network tab in session replays. They do still appear in the error bread crumbs though.

We can enable and disable the rules and see this consistent result/issues 100% of the time. Also our request just included a "?" at the end and no actual query string parameters.

With the setting commented out you can see requests to api.search.reactify.app:
https://industrie.sentry.io/replays/977029eaa9624157a00e401a398ec7a7/?f_n_search=reactify&project=4506114189688832&query=&referrer=%2Freplays%2F&statsPeriod=14d&t_main=network&yAxis=count%28%29

With the setting enabled, api requests are no longer included, note that the config and analytics subdomain requests still show as they don't include a query string:
https://industrie.sentry.io/replays/805c9086865d4902bc3f11d960ed09c1/?f_n_search=reactify&project=4506114189688832&query=&referrer=%2Freplays%2F&statsPeriod=1h&t_main=network&yAxis=count%28%29

Our init code, we have tried with extract URL matches, hostnames and regex and all produce the same result:

window.Sentry.init({
        dsn: "xxxxxx",
        integrations: [
          new window.Sentry.Replay({
            networkDetailAllowUrls: [/^.+\.search\.reactify\.app.*$/],
            networkRequestHeaders: ["x-reactify-shop","x-reactify-mode","x-reactify-client-id","x-reactify-client-version","x-reactify-ga"],
            networkResponseHeaders: ["x-reactify-cluster","x-reactify-shop","x-reactify-cache","x-reactify-cache-ttl","x-reactify-country","x-reactify-timezone"],
          }),
        ],
        replaysSessionSampleRate: 1.0,
        replaysOnErrorSampleRate: 1.0,
      });

Also adding or removing the headers does not change the result.

Request that's missing:

curl 'https://api.search.reactify.app/industrie-kids-primary/_msearch' \
  -H 'authority: api.search.reactify.app' \
  -H 'accept: application/json' \
  -H 'accept-language: en-GB,en-US;q=0.9,en;q=0.8,zh-TW;q=0.7,zh;q=0.6' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-ndjson' \
  -H 'dnt: 1' \
  -H 'origin: https://www.industriekids.com.au' \
  -H 'pragma: no-cache' \
  -H 'referer: https://www.industriekids.com.au/' \
  -H 'sec-ch-ua: "Chromium";v="118", "Google Chrome";v="118", "Not=A?Brand";v="99"' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'sec-ch-ua-platform: "macOS"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: cross-site' \
  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36' \
  -H 'x-reactify-client-id: theme' \
  -H 'x-reactify-client-version: 5.37.0' \
  -H 'x-reactify-ga: GA1.1.834222806.1697151060' \
  -H 'x-reactify-mode: collection' \
  -H 'x-reactify-shop: industrie-kids.myshopify.com' \
  --data-raw $'{"preference":"page"}\n{"query":{"bool":{"must":[{"bool":{"must":[{"bool":{"must_not":[{"nested":{"path":"curations","query":{"bool":{"must":[{"term":{"curations.collectionHandle.keyword":"online-warehouse-frenzy"}},{"term":{"curations.hidden":true}}]}}}}]}},{"match":{"published":true}},{"bool":{"should":[{"nested":{"path":"collections","query":{"term":{"collections.handle.keyword":"online-warehouse-frenzy"}}}},{"nested":{"path":"curations","query":{"term":{"curations.collectionHandle.keyword":"online-warehouse-frenzy"}}}}]}}]}}]}},"sort":[{"curations.position":{"unmapped_type":"long","order":"asc","nested":{"path":"curations","filter":{"term":{"curations.collectionHandle.keyword":"online-warehouse-frenzy"}}}}},{"_script":{"script":{"source":"(\u0021doc[params.field].empty && (int) Math.round(doc[params.field].value) > params.value) ? 1 : 0","params":{"field":"inventory_total","value":50},"lang":"painless"},"type":"number","order":"desc"}},{"collections.position":{"order":"asc","nested":{"path":"collections","filter":{"term":{"collections.handle.keyword":"online-warehouse-frenzy"}}}}}],"size":28,"_source":{"includes":["storefrontId","presentment_price_ranges","images","tags","variants.*","id","title","type","handle","image","variants.id","variants.presentment_prices","callout"],"excludes":["image"]},"from":0}\n' \
  --compressed

Request that shows:

curl 'https://config.search.reactify.app/?shop=industrie-kids.myshopify.com' \
-H 'authority: config.search.reactify.app' \
-H 'accept: */*' \
-H 'accept-language: en-GB,en-US;q=0.9,en;q=0.8,zh-TW;q=0.7,zh;q=0.6' \
-H 'cache-control: no-cache' \
-H 'dnt: 1' \
-H 'origin: https://www.industriekids.com.au' \
-H 'pragma: no-cache' \
-H 'referer: https://www.industriekids.com.au/' \
-H 'sec-ch-ua: "Chromium";v="118", "Google Chrome";v="118", "Not=A?Brand";v="99"' \
-H 'sec-ch-ua-mobile: ?0' \
-H 'sec-ch-ua-platform: "macOS"' \
-H 'sec-fetch-dest: empty' \
-H 'sec-fetch-mode: cors' \
-H 'sec-fetch-site: cross-site' \
-H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36' \
--compressed