@flareapp/js 2.7.0 → 2.9.0

package/README.md

@@ -51,6 +51,23 @@ flare.logger.info('Checkout started', { cartId: cart.id, total: cart.total });
 Logs are buffered and batched, and flushed when the tab is hidden so buffered logs survive a page unload. The optional
 second argument is structured, searchable attributes.
 
+## What happens when someone leaves the page
+
+Logs and spans are batched, so there's usually something unsent when a visitor leaves. The client flushes it when
+the tab is hidden or the page closes.
+
+Browsers cap what you can send at that moment: roughly 64KB across every request still in flight. The client stays
+under 60KB, and logs and spans share that budget.
+
+Switching tabs is safe. Hiding a tab triggers the same flush, and whatever didn't fit goes out when the visitor
+comes back.
+
+If nothing fits, the batch is still sent, as a normal request instead of a keepalive one. That usually lands, but
+it can be cancelled if the page closes right then.
+
+You'll only hit the limit on pages that produce a lot of telemetry before the visitor leaves. Log less on those
+pages rather than raising the limits.
+
 ## Documentation
 
 Full documentation on configuration, hooks, context, breadcrumbs, solution providers, and more is available

package/dist/browser.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_catchWindowErrors = require('./catchWindowErrors-2a2z2zr2.cjs');
+const require_catchWindowErrors = require('./catchWindowErrors-cR2D7kju.cjs');
 let _flareapp_core = require("@flareapp/core");
 
 //#region src/browser.ts
@@ -10,12 +10,62 @@ var Flare = class extends _flareapp_core.Flare {
 			name: "@flareapp/js",
 			version: require_catchWindowErrors.CLIENT_VERSION
 		});
+		this.setFramework({ name: _flareapp_core.FrameworkName.Js });
+	}
+	/** Held so a later disable can give the mutation slot back. */
+	removeTracingSubscription = null;
+	stopBreadcrumbs = null;
+	configure(config) {
+		const wasTracing = this.config.enableTracing;
+		const wasBreadcrumbs = this.config.enableBreadcrumbs;
+		super.configure(config);
+		const nowTracing = this.config.enableTracing;
+		const nowBreadcrumbs = this.config.enableBreadcrumbs;
+		if (!wasBreadcrumbs && nowBreadcrumbs) this.stopBreadcrumbs = require_catchWindowErrors.startBreadcrumbs({
+			config: () => this.config,
+			record: (type, attributes, startTimeUnixNano) => this.addBreadcrumb(type, attributes, startTimeUnixNano)
+		});
+		else if (wasBreadcrumbs && !nowBreadcrumbs) {
+			this.stopBreadcrumbs?.();
+			this.stopBreadcrumbs = null;
+		}
+		if (!wasTracing && nowTracing) {
+			this.removeTracingSubscription = require_catchWindowErrors.withRequestPatches(() => require_catchWindowErrors.traceRequests(this, require_catchWindowErrors.browserUrlContext()));
+			require_catchWindowErrors.startBrowserTracing(this);
+		} else if (wasTracing && !nowTracing) {
+			require_catchWindowErrors.stopBrowserTracing();
+			this.removeTracingSubscription?.();
+			this.removeTracingSubscription = null;
+		}
+		return this;
 	}
 };
 
 //#endregion
 exports.BrowserFlushScheduler = require_catchWindowErrors.BrowserFlushScheduler;
+Object.defineProperty(exports, 'BrowserSpanType', {
+  enumerable: true,
+  get: function () {
+    return _flareapp_core.BrowserSpanType;
+  }
+});
 exports.FetchFileReader = require_catchWindowErrors.FetchFileReader;
 exports.Flare = Flare;
+exports.absoluteHref = require_catchWindowErrors.absoluteHref;
+exports.absoluteUrl = require_catchWindowErrors.absoluteUrl;
+exports.activeComponentRoot = require_catchWindowErrors.activeComponentRoot;
 exports.catchWindowErrors = require_catchWindowErrors.catchWindowErrors;
-exports.collectBrowser = require_catchWindowErrors.collectBrowser;
+exports.collectBrowser = require_catchWindowErrors.collectBrowser;
+exports.createFlareResolver = require_catchWindowErrors.createFlareResolver;
+exports.currentHref = require_catchWindowErrors.currentHref;
+exports.currentPath = require_catchWindowErrors.currentPath;
+exports.instrumentOnce = require_catchWindowErrors.instrumentOnce;
+exports.insulate = require_catchWindowErrors.insulate;
+exports.nowNano = require_catchWindowErrors.nowNano;
+exports.recordComponentSpan = require_catchWindowErrors.recordComponentSpan;
+exports.registerNavigationSource = require_catchWindowErrors.registerNavigationSource;
+exports.reserveSpanId = require_catchWindowErrors.reserveSpanId;
+exports.resolveComponentParent = require_catchWindowErrors.resolveComponentParent;
+exports.resolveHref = require_catchWindowErrors.resolveHref;
+exports.routeName = require_catchWindowErrors.routeName;
+exports.safeInvoke = require_catchWindowErrors.safeInvoke;

package/dist/browser.d.cts

@@ -1,9 +1,13 @@
-import { i as catchWindowErrors, n as FetchFileReader, r as collectBrowser, t as BrowserFlushScheduler } from "./BrowserFlushScheduler-CR7L8-z6.cjs";
-import { Api, ContextCollector, FileReader, Flare as Flare$1, ScopeProvider } from "@flareapp/core";
+import { C as FetchFileReader, E as createFlareResolver, S as BrowserFlushScheduler, T as catchWindowErrors, _ as currentPath, a as nowNano, b as NavigationSource, c as resolveComponentParent, d as insulate, f as safeInvoke, g as currentHref, h as registerNavigationSource, i as activeComponentRoot, l as TrackTeardown, m as absoluteUrl, n as ComponentSpanRecord, o as recordComponentSpan, p as absoluteHref, r as ComponentTraceContext, s as reserveSpanId, t as BrowserSpanType, u as instrumentOnce, v as resolveHref, w as collectBrowser, x as RouteName, y as routeName } from "./spanTypes-TMgJEZ7G.cjs";
+import { Api, Config, ContextCollector, FileReader, Flare as Flare$1, ScopeProvider } from "@flareapp/core";
 
 //#region src/browser.d.ts
 declare class Flare extends Flare$1 {
   constructor(api?: Api, contextCollector?: ContextCollector, fileReader?: FileReader, scopeProvider?: ScopeProvider);
+  /** Held so a later disable can give the mutation slot back. */
+  private removeTracingSubscription;
+  private stopBreadcrumbs;
+  configure(config: Partial<Config>): this;
 }
 //#endregion
-export { BrowserFlushScheduler, FetchFileReader, Flare, catchWindowErrors, collectBrowser };
+export { BrowserFlushScheduler, BrowserSpanType, type ComponentSpanRecord, type ComponentTraceContext, FetchFileReader, Flare, type NavigationSource, type RouteName, type TrackTeardown, absoluteHref, absoluteUrl, activeComponentRoot, catchWindowErrors, collectBrowser, createFlareResolver, currentHref, currentPath, instrumentOnce, insulate, nowNano, recordComponentSpan, registerNavigationSource, reserveSpanId, resolveComponentParent, resolveHref, routeName, safeInvoke };

package/dist/browser.d.mts

@@ -1,9 +1,13 @@
-import { i as catchWindowErrors, n as FetchFileReader, r as collectBrowser, t as BrowserFlushScheduler } from "./BrowserFlushScheduler-CZiDvxtf.mjs";
-import { Api, ContextCollector, FileReader, Flare as Flare$1, ScopeProvider } from "@flareapp/core";
+import { C as FetchFileReader, E as createFlareResolver, S as BrowserFlushScheduler, T as catchWindowErrors, _ as currentPath, a as nowNano, b as NavigationSource, c as resolveComponentParent, d as insulate, f as safeInvoke, g as currentHref, h as registerNavigationSource, i as activeComponentRoot, l as TrackTeardown, m as absoluteUrl, n as ComponentSpanRecord, o as recordComponentSpan, p as absoluteHref, r as ComponentTraceContext, s as reserveSpanId, t as BrowserSpanType, u as instrumentOnce, v as resolveHref, w as collectBrowser, x as RouteName, y as routeName } from "./spanTypes-7-nEycOc.mjs";
+import { Api, Config, ContextCollector, FileReader, Flare as Flare$1, ScopeProvider } from "@flareapp/core";
 
 //#region src/browser.d.ts
 declare class Flare extends Flare$1 {
   constructor(api?: Api, contextCollector?: ContextCollector, fileReader?: FileReader, scopeProvider?: ScopeProvider);
+  /** Held so a later disable can give the mutation slot back. */
+  private removeTracingSubscription;
+  private stopBreadcrumbs;
+  configure(config: Partial<Config>): this;
 }
 //#endregion
-export { BrowserFlushScheduler, FetchFileReader, Flare, catchWindowErrors, collectBrowser };
+export { BrowserFlushScheduler, BrowserSpanType, type ComponentSpanRecord, type ComponentTraceContext, FetchFileReader, Flare, type NavigationSource, type RouteName, type TrackTeardown, absoluteHref, absoluteUrl, activeComponentRoot, catchWindowErrors, collectBrowser, createFlareResolver, currentHref, currentPath, instrumentOnce, insulate, nowNano, recordComponentSpan, registerNavigationSource, reserveSpanId, resolveComponentParent, resolveHref, routeName, safeInvoke };

package/dist/browser.mjs

@@ -1,5 +1,5 @@
-import { a as BrowserFlushScheduler, i as collectBrowser, n as CLIENT_VERSION, r as FetchFileReader, t as catchWindowErrors } from "./catchWindowErrors-CSc-dC37.mjs";
-import { Api, Flare as Flare$1, GlobalScopeProvider } from "@flareapp/core";
+import { C as currentHref, D as absoluteHref, E as routeName, O as absoluteUrl, S as registerNavigationSource, T as resolveHref, _ as BrowserFlushScheduler, a as recordComponentSpan, b as browserUrlContext, c as startBrowserTracing, d as instrumentOnce, f as insulate, g as collectBrowser, h as FetchFileReader, i as nowNano, l as stopBrowserTracing, m as CLIENT_VERSION, n as createFlareResolver, o as reserveSpanId, p as safeInvoke, r as activeComponentRoot, s as resolveComponentParent, t as catchWindowErrors, u as BrowserSpanType, v as startBreadcrumbs, w as currentPath, x as withRequestPatches, y as traceRequests } from "./catchWindowErrors-C0gSVGiF.mjs";
+import { Api, Flare as Flare$1, FrameworkName, GlobalScopeProvider } from "@flareapp/core";
 
 //#region src/browser.ts
 var Flare = class extends Flare$1 {
@@ -9,8 +9,36 @@ var Flare = class extends Flare$1 {
 			name: "@flareapp/js",
 			version: CLIENT_VERSION
 		});
+		this.setFramework({ name: FrameworkName.Js });
+	}
+	/** Held so a later disable can give the mutation slot back. */
+	removeTracingSubscription = null;
+	stopBreadcrumbs = null;
+	configure(config) {
+		const wasTracing = this.config.enableTracing;
+		const wasBreadcrumbs = this.config.enableBreadcrumbs;
+		super.configure(config);
+		const nowTracing = this.config.enableTracing;
+		const nowBreadcrumbs = this.config.enableBreadcrumbs;
+		if (!wasBreadcrumbs && nowBreadcrumbs) this.stopBreadcrumbs = startBreadcrumbs({
+			config: () => this.config,
+			record: (type, attributes, startTimeUnixNano) => this.addBreadcrumb(type, attributes, startTimeUnixNano)
+		});
+		else if (wasBreadcrumbs && !nowBreadcrumbs) {
+			this.stopBreadcrumbs?.();
+			this.stopBreadcrumbs = null;
+		}
+		if (!wasTracing && nowTracing) {
+			this.removeTracingSubscription = withRequestPatches(() => traceRequests(this, browserUrlContext()));
+			startBrowserTracing(this);
+		} else if (wasTracing && !nowTracing) {
+			stopBrowserTracing();
+			this.removeTracingSubscription?.();
+			this.removeTracingSubscription = null;
+		}
+		return this;
 	}
 };
 
 //#endregion
-export { BrowserFlushScheduler, FetchFileReader, Flare, catchWindowErrors, collectBrowser };
+export { BrowserFlushScheduler, BrowserSpanType, FetchFileReader, Flare, absoluteHref, absoluteUrl, activeComponentRoot, catchWindowErrors, collectBrowser, createFlareResolver, currentHref, currentPath, instrumentOnce, insulate, nowNano, recordComponentSpan, registerNavigationSource, reserveSpanId, resolveComponentParent, resolveHref, routeName, safeInvoke };