feat(analytics-browser): add "autocapture.networkTracking" plugin #1055

daniel-graham-amplitude · 2025-04-30T00:24:32Z

Summary

Add the network capture functionality to the SDK
Network Capture is done when user has set it on "config.autocapture" and they have set "config.networkTrackingOptions" (note: that the second condition of "networkTrackingOptions" being present is temporary, planning on doing a quiet release).

Checklist

Does your PR title have the correct title format?
Does your PR have a breaking change?: No

…/Amplitude-TypeScript into AMP-125616/network-package

Copilot

Pull Request Overview

This PR adds a new "autocapture.networkTracking" plugin to support network request tracking in the analytics-browser package.

Introduces a new networkTracking flag to the AutocaptureOptions interface.
Implements helper functions (isNetworkTrackingEnabled and getNetworkTrackingConfig) in default-tracking.ts.
Updates BrowserConfig and browser-client.ts to wire up the network tracking plugin.

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.

File	Description
packages/analytics-core/src/types/browser-config.ts	Adds networkTracking flag to autocapture configuration.
packages/analytics-browser/src/default-tracking.ts	Adds functions to enable and configure network tracking.
packages/analytics-browser/src/config.ts	Updates BrowserConfig to include networkTrackingOptions.
packages/analytics-browser/src/browser-client.ts	Integrates the new network tracking plugin based on configuration.

Files not reviewed (1)

packages/analytics-browser/package.json: Language not supported

packages/analytics-browser/src/browser-client.ts

Co-authored-by: Copilot <[email protected]>

- @amplitude/[email protected] - @amplitude/analytics-client-common@2.3.19-usenetworkcaptureinanalyticsbrowser-1.0 - @amplitude/[email protected] - @amplitude/plugin-autocapture-browser@1.2.1-usenetworkcaptureinanalyticsbrowser-1.0 - @amplitude/plugin-global-user-properties@1.2.52-usenetworkcaptureinanalyticsbrowser-1.0 - @amplitude/plugin-network-capture-browser@1.0.1-usenetworkcaptureinanalyticsbrowser-1.0 - @amplitude/plugin-page-view-tracking-browser@2.3.21-usenetworkcaptureinanalyticsbrowser-1.0 - @amplitude/plugin-session-replay-browser@1.16.2-usenetworkcaptureinanalyticsbrowser-1.0 - @amplitude/plugin-web-attribution-browser@2.1.45-usenetworkcaptureinanalyticsbrowser-1.0 - @amplitude/session-replay-browser@1.22.2-usenetworkcaptureinanalyticsbrowser-1.0

This reverts commit be04090.

Copilot

Pull Request Overview

This PR adds support for network tracking by introducing a new "networkTracking" option to the browser configuration and integrating it in the core tracking and plugin initialization code. Key changes include:

Adding the "networkTracking" property to the AutocaptureOptions interface.
Implementing the getNetworkTrackingConfig function and related tests.
Updating the BrowserConfig and browser-client to register the network tracking plugin.

Reviewed Changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/analytics-core/src/types/browser-config.ts	Adds the "networkTracking" option in the AutocaptureOptions interface.
packages/analytics-browser/test/default-tracking.test.ts	Introduces tests for the network tracking configuration.
packages/analytics-browser/test/browser-client.test.ts	Adds a test to ensure the network tracking plugin is called when enabled.
packages/analytics-browser/src/default-tracking.ts	Implements getNetworkTrackingConfig and isNetworkTrackingEnabled for network tracking.
packages/analytics-browser/src/config.ts	Passes networkTrackingOptions into the BrowserConfig constructor.
packages/analytics-browser/src/browser-client.ts	Adds registration of the network tracking plugin when enabled.
packages/analytics-browser/README.md	Updates the snippet code, reflecting minor adjustments.

Files not reviewed (1)

packages/analytics-browser/package.json: Language not supported

packages/analytics-browser/src/browser-client.ts

…/Amplitude-TypeScript into AMP-125616/use-network-capture-in-analytics-browser

jxiwang · 2025-05-01T22:16:41Z

packages/analytics-browser/src/browser-client.ts

@@ -154,6 +157,13 @@ export class AmplitudeBrowser extends AmplitudeCore implements BrowserClient {
      await this.add(autocapturePlugin(getElementInteractionsConfig(this.config))).promise;
    }

+    // TODO: the "this.config.networkTrackingOptions" should be taken out once we have
+    // beta tested network tracking
+    if (isNetworkTrackingEnabled(this.config.autocapture) && !!this.config.networkTrackingOptions) {


If this is taken out, then we all users that turn auto-capture on will start tracking network requests?

If it is taken out, then all users who have autocapture=true or autocapture.networkTracking=true will start tracking network requests.

Will they be able to set autocapture.networkTracking = false at the minimum?

Yeah, setting autocapture.networkTracking to false will disable it.

Awesome thanks for confirming!

jxiwang

LGTM, just one question

daniel-graham-amplitude added 18 commits April 29, 2025 09:08

again

7cd49f8

refactor: move network-capture to a new package

34aec43

chore: fix build issue

271bf31

chore: fix new package again

5ed68ab

chore: make autocapture browser simpler

8ba3a0f

chore: update lockfile

914b158

again

a21cd76

again

42435ca

again

aa0c476

again

840f95b

again

a995ff1

Merge branch 'AMP-125616/network-autocapture' of github.com:amplitude…

4ae9a49

…/Amplitude-TypeScript into AMP-125616/network-package

remove pre-release

0355d43

Merge branch 'AMP-125616/network-autocapture' of github.com:amplitude…

4ebb23c

…/Amplitude-TypeScript into AMP-125616/network-package

again

40f066d

fix: lint fix

6e5465c

again

1ec17e6

feat: add networkTracking plugin to analytics-browser

d0505a6

daniel-graham-amplitude marked this pull request as draft April 30, 2025 00:24

daniel-graham-amplitude changed the base branch from main to AMP-125616/network-package April 30, 2025 00:24

daniel-graham-amplitude requested a review from Copilot April 30, 2025 00:25

Copilot AI reviewed Apr 30, 2025

View reviewed changes

packages/analytics-browser/src/browser-client.ts Outdated Show resolved Hide resolved

daniel-graham-amplitude and others added 6 commits April 29, 2025 17:27

fix typo this.config.defaultTracking to this.config.autocapture

97969c3

Co-authored-by: Copilot <[email protected]>

add test coverage

cca9a08

fix: unit test coverage fix

c78f166

add README.md

df563c6

Revert "chore(release): publish"

3a36c74

This reverts commit be04090.

daniel-graham-amplitude requested a review from jxiwang May 1, 2025 15:18

daniel-graham-amplitude assigned Dogfalo May 1, 2025

daniel-graham-amplitude unassigned Dogfalo May 1, 2025

daniel-graham-amplitude requested review from Dogfalo and Copilot May 1, 2025 15:19

Copilot AI reviewed May 1, 2025

View reviewed changes

packages/analytics-browser/src/browser-client.ts Outdated Show resolved Hide resolved

daniel-graham-amplitude marked this pull request as ready for review May 1, 2025 15:26

Base automatically changed from AMP-125616/network-package to AMP-125616/network-autocapture May 1, 2025 16:07

daniel-graham-amplitude added 2 commits May 1, 2025 09:11

Merge branch 'AMP-125616/network-autocapture' of github.com:amplitude…

0b9b380

…/Amplitude-TypeScript into AMP-125616/use-network-capture-in-analytics-browser

again

e082e93

jxiwang reviewed May 1, 2025

View reviewed changes

jxiwang approved these changes May 1, 2025

View reviewed changes

daniel-graham-amplitude merged commit ca244f9 into AMP-125616/network-autocapture May 1, 2025
4 checks passed

daniel-graham-amplitude deleted the AMP-125616/use-network-capture-in-analytics-browser branch May 1, 2025 23:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(analytics-browser): add "autocapture.networkTracking" plugin #1055

feat(analytics-browser): add "autocapture.networkTracking" plugin #1055

Uh oh!

daniel-graham-amplitude commented Apr 30, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

jxiwang May 1, 2025

Uh oh!

daniel-graham-amplitude May 1, 2025

Uh oh!

jxiwang May 1, 2025

Uh oh!

daniel-graham-amplitude May 1, 2025

Uh oh!

jxiwang May 1, 2025

Uh oh!

jxiwang left a comment

Uh oh!

Uh oh!

Uh oh!

feat(analytics-browser): add "autocapture.networkTracking" plugin #1055

feat(analytics-browser): add "autocapture.networkTracking" plugin #1055

Uh oh!

Conversation

daniel-graham-amplitude commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

jxiwang May 1, 2025

Choose a reason for hiding this comment

Uh oh!

daniel-graham-amplitude May 1, 2025

Choose a reason for hiding this comment

Uh oh!

jxiwang May 1, 2025

Choose a reason for hiding this comment

Uh oh!

daniel-graham-amplitude May 1, 2025

Choose a reason for hiding this comment

Uh oh!

jxiwang May 1, 2025

Choose a reason for hiding this comment

Uh oh!

jxiwang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

daniel-graham-amplitude commented Apr 30, 2025 •

edited

Loading