@groundcover/browser 2.2.0-rc.0 → 2.2.1

package/CHANGELOG.md

@@ -4,10 +4,14 @@ All notable changes to `@groundcover/browser` are documented here. This project
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and the
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format.
 
-## [2.2.0-rc.0] — 2026-11-05
+## [2.2.1] — 2026-11-15
 
-First release candidate of `2.2.0`. Issues for thrown or rejected values that aren't `Error`s start
-new groups once; see Changed.
+No changes to the SDK's behaviour from `2.2.0`: source comments and documentation only.
+
+## [2.2.0] — 2026-11-10
+
+Stable release of `2.2.0-rc.0`, with no changes since. Issues for thrown or rejected values that
+aren't `Error`s start new groups once; see Changed.
 
 ### Added
 
@@ -65,8 +69,8 @@ new groups once; see Changed.
 ## [2.1.1] — 2026-10-26
 
 Stable release of `2.1.1-rc.1`. Session replay takes its periodic full snapshot every 5 minutes
-instead of every 30 seconds. No configuration or API changes from `2.1.0`. `2.1.1-rc.0`, which tried
-moving checkouts to idle time instead, was not pursued.
+instead of every 30 seconds. No configuration or API changes from `2.1.0`. `2.1.1-rc.1` supersedes
+`2.1.1-rc.0`.
 
 The type declarations are byte-for-byte those of `2.1.0` and rc.1. The shipped JavaScript differs
 from rc.1 only in the text of the removed-option warnings below.
@@ -75,12 +79,11 @@ from rc.1 only in the text of the removed-option warnings below.
 
 - **Session replay's periodic full snapshot (rrweb's `checkoutEveryNms`) runs every 5 minutes**
   instead of every 30 seconds. Each checkout serializes the whole DOM synchronously, inside whichever
-  recorded event triggers it (often a click, input or scroll), and uploads the full tree; on a
-  ~7.8k-element dashboard that is ~50ms of main-thread work. 5 minutes matches other rrweb-based SDKs
-  (PostHog, Grafana Faro, and Amplitude's recommended setting), so checkouts run 10× less often and
-  send 10× fewer full snapshots. Every recording still starts with a full snapshot. A player that
-  seeks from the nearest earlier full snapshot may fetch more data to reach a point deep in a long
-  recording.
+  recorded event triggers it (often a click, input or scroll), and uploads the full tree; on a large
+  page that is tens of milliseconds of main-thread work. 5 minutes is a common interval for
+  rrweb-based recorders, so checkouts run 10× less often and send 10× fewer full snapshots. Every
+  recording still starts with a full snapshot. A player that seeks from the nearest earlier full
+  snapshot may fetch more data to reach a point deep in a long recording.
 - **The warnings for removed options point to this package's README on npm.** The console warnings
   for `enableMasking`, `maskFields` and `eventSampleRate` now name the README section to read
   ("Migrating to 1.0.0" or "Migrating from 1.x to 2.0.0") and link to the npm package page, instead
@@ -109,15 +112,14 @@ are otherwise unchanged.
   `preserveDrawingBuffer: true`).
 - **`fps` sets CPU cost and time resolution, not bytes.** rrweb re-encodes every canvas on every
   tick whether or not it changed, so the rate drives CPU even on a static page; a frame identical to
-  the previous one is dropped, so bytes grow only when content changes. On a six-chart test
-  dashboard, 1 fps used about 12% of a CPU core against about 35% at 4 fps, with the same bytes. A
-  canvas state shorter than `1/fps` seconds may not appear in the replay, so raise `fps` for
-  animated canvases.
+  the previous one is dropped, so bytes grow only when content changes. For scale, 4 fps costs a few
+  times the CPU of 1 fps for the same bytes. A canvas state shorter than `1/fps` seconds may not
+  appear in the replay, so raise `fps` for animated canvases.
 - **Changing `replay.canvas` through `updateConfig` restarts the active recording**, like
   `replay.blockedSelectors` and `privacy`. A partial update merges into the current canvas options,
   so `{ canvas: { fps: 8 } }` keeps capture enabled.
 - **README: canvas capture recipes** for dashboards, animated canvases, constrained bandwidth and
-  CPU-sensitive pages, with measured costs for scale.
+  CPU-sensitive pages, with costs for scale.
 
 ### Fixed
 
@@ -185,9 +187,9 @@ it, in the browser package or in the shared core it bundles; the version field a
 only differences in the package.
 
 A wire-level ordering fix — sessions could report a start time later than events they carried,
-producing negative durations in the RUM session drawer — plus two `enrichEvent` corrections found
-while closing it. No API change and no configuration change: the `/json/rum` envelope keeps the same
-shape, and only the value of `session_start_time` on a rotated session changes.
+producing negative session durations — plus two `enrichEvent` corrections. No API change and no
+configuration change: the `/json/rum` envelope keeps the same shape, and only the value of
+`session_start_time` on a rotated session changes.
 
 ### Fixed
 
@@ -238,10 +240,7 @@ structurally identical to 1.0.7, the published bundle contains the same 10 files
 `/json/rum` wire format is unchanged (pinned by a golden characterization suite). The generated
 declarations are no longer byte-for-byte identical to 1.0.7 — core's internal event types are now
 generic over the event vocabulary so the React Native package can extend it — but the exported
-surface is the same and `attributes.location` is still on the browser event map. The two behaviour
-changes below are the reason this shipped as an RC first rather than straight as a patch. The RC
-line was verified end-to-end against a live deployment (batches accepted, envelope matching the
-golden wire format, `attributes.location` intact, zero console errors).
+surface is the same and `attributes.location` is still on the browser event map.
 
 ### Changed
 
@@ -261,14 +260,12 @@ golden wire format, `attributes.location` intact, zero console errors).
 - **A passing `console.assert()` is no longer captured as a log.** `console.assert(cond, …)` prints
   nothing when `cond` is truthy, but the SDK recorded *every* call as a `log` event — so assertions
   that passed silently filled RUM with lines the console itself never showed. Only failing
-  assertions are captured now, matching the console's own semantics. Landed after `1.0.8-rc.7`,
-  alongside the React Native SDK, which hit this hard: RN's event-target shim asserts on every
-  DevTools-WebSocket event and stormed the listener.
+  assertions are captured now, matching the console's own semantics. Landed after `1.0.8-rc.7`.
 - **`groundcover.startNavigation()` / `endNavigation()` can no longer throw into your code.** The
   manual navigation API read `location.href` with no error boundary, so on a page with an
   instrumented or restricted `location` getter the exception propagated out of the SDK and into the
   caller's own stack. The automatic navigation path was already contained; these two now are as
-  well. Pre-existing since before the core extraction, and unrelated to it.
+  well.
 - **The current view's title is no longer discarded when view derivation fails.** The error boundary
   around the browser's view provider returned a hardcoded empty view, so a throw anywhere after the
   document title had already been read (a hostile `location` getter, a user-supplied redactor)
@@ -291,10 +288,10 @@ golden wire format, `attributes.location` intact, zero console errors).
 ### Internal
 
 - The platform-agnostic pipeline (config, session policy, event enrichment, batching, redaction,
-  transport) now lives in a private `@groundcover/rum-core` package, inlined into this bundle at
-  build time. It compiles with no DOM lib so platform coupling fails the build, and the network
-  send, storage, device metadata and view derivation are injected by this package. Groundwork for
-  the React Native SDK; no effect on the published browser artifact.
+  transport) now lives in `@groundcover/rum-core`, an unpublished workspace package, inlined into
+  this bundle at build time. It compiles with no DOM lib so platform coupling fails the build, and
+  the network send, storage, device metadata and view derivation are injected by this package.
+  Groundwork for the React Native SDK; no effect on the published browser artifact.
 
 ## [1.0.5]
 
@@ -338,8 +335,8 @@ golden wire format, `attributes.location` intact, zero console errors).
 
 ### Fixed
 
-- **README images now render on npm.** The logo used a relative path and the CI badge pointed at the
-  internal GitHub repo, so both 404'd on the npm package page. The logo is now served from the
+- **README images now render on npm.** The logo used a relative path and the CI badge pointed at a
+  private repository, so both 404'd on the npm package page. The logo is now served from the
   published package via jsDelivr and the CI-status badge was removed.
 
 ## [1.0.0]

package/README.md

@@ -62,7 +62,7 @@ one exception — it must be started explicitly with
 
 ```ts
 // Tie events to a user
-groundcover.identifyUser({ id: "u_123", email: "john@acme.com", organization: "acme" });
+groundcover.identifyUser({ id: "u_123", email: "user@example.com", organization: "acme" });
 
 // Capture a handled error
 groundcover.captureException(new Error("Checkout failed"), { feature: "checkout" });
@@ -247,10 +247,9 @@ previous one, so an unchanged canvas sends nothing between full snapshots. The s
 the time resolution: a canvas state that lasts less than `1/fps` seconds, such as a brief transition
 or a hover highlight, may not appear in the replay. Raise `fps` when those moments matter.
 
-For scale, on a test dashboard with six canvas charts on a 2× display, canvas capture added about
-280 KB/min while the charts were static and about 1 MB/min while they refreshed every 10 s. The
-recorder used about 12% of a CPU core at 1 fps and about 35% at 4 fps, with the same bytes. PNG at
-4 fps used about 10%.
+For scale, a dashboard with a handful of canvas charts adds a few hundred KB per minute while the
+charts are static and around 1 MB per minute while they redraw. The recorder's CPU cost grows with
+`fps` while the bytes stay the same, and PNG costs less CPU than webp at the same rate.
 
 Changing `replay.canvas` (or `replay.blockedSelectors`) via `updateConfig` restarts the active
 recording so the new options take effect at rrweb `record()` time. A partial `canvas` update merges
@@ -313,10 +312,9 @@ static imports before its body, so a client built at module scope is often const
 
 **`Request`-object calls are captured.** Clients that call
 `fetch(new Request(url, { method, body }))` (openapi-fetch does) carry the method and body on the
-`Request` rather than in an `init` argument; the SDK reads the method from either (since 1.0.4) and
-the request *body* from either (since 1.0.5). Method, URL, headers, status, request body, and
-response body are recorded. The `Request` body is read from a clone taken before the request is
-sent, so the app's copy is never consumed.
+`Request` rather than in an `init` argument; the SDK reads the method and the request *body* from
+either. Method, URL, headers, status, request body, and response body are recorded. The `Request`
+body is read from a clone taken before the request is sent, so the app's copy is never consumed.
 
 Request and response bodies are captured the same way: up to a size cap, with redaction applied
 *before* truncation so sensitive keys are always masked. A body larger than the cap is recorded as
@@ -554,8 +552,8 @@ All methods are available on the default export and on `window.groundcover`.
 
 ### Structured logs
 
-`groundcover.logger` mirrors Sentry’s `logger` pattern — one method per level, second arg is the
-attributes object. Nested objects are flattened to dotted keys:
+`groundcover.logger` has one method per level; the second argument is the attributes object.
+Nested objects are flattened to dotted keys:
 
 ```ts
 groundcover.logger.warn("Checkout failed", {
@@ -573,7 +571,7 @@ set by the SDK and can’t be overridden.
 ```ts
 groundcover.identifyUser({
   id: "u_123",
-  email: "john@acme.com",
+  email: "user@example.com",
   organization: "acme",
 });
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@groundcover/browser",
-  "version": "2.2.0-rc.0",
+  "version": "2.2.1",
   "description": "groundcover Real User Monitoring (RUM) SDK for the browser \u2014 performance, errors, logs, distributed tracing and session replay",
   "main": "dist/index.js",
   "module": "dist/index.mjs",