📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
Revert "sending error objects to the server"
Blue Mouse0632563dd70e
diff --git a/src/Lib.ts b/src/Lib.tsindex f96712a04..cf14fc53a 100644--- a/src/Lib.ts+++ b/src/Lib.ts@@ -57,21 +57,6 @@ export interface IPageViewPayload {prev: string | null | undefined}-// Partial user-editable error payload-export interface IErrorEventPayload {- name: string- message: string | null | undefined- lineno: number | null | undefined- colno: number | null | undefined- filename: string | null | undefined-}--export interface IInternalErrorEventPayload extends IErrorEventPayload {- lc: string | undefined- tz: string | undefined- pg: string | null | undefined-}-interface IPerfPayload {dns: numbertls: number@@ -91,14 +76,6 @@ export interface PageActions {stop: () => void}-/**- * The object returned by `trackErrors()`, used to stop tracking errors.- */-export interface ErrorActions {- /** Stops the tracking of errors. */- stop: () => void-}-export interface PageData {/** Current URL path. */path: string@@ -107,25 +84,6 @@ export interface PageData {actions: PageActions}-export interface ErrorOptions {- /**- * A number that indicates how many errors should be sent to the server.- * Accepts values between 0 and 1. For example, if set to 0.5 - only ~50% of errors will be sent to Swetrix.- * For testing, we recommend setting this value to 1. For production, you should configure it depending on your needs as each error event counts towards your plan.- *- * The default value for this option is 1.- */- sampleRate?: number-- /**- * Callback to edit / prevent sending errors.- *- * @param payload - The error payload.- * @returns The edited payload or `false` to prevent sending the error event. If `true` is returned, the payload will be sent as-is.- */- callback?: (payload: IInternalErrorEventPayload) => Partial<IInternalErrorEventPayload> | boolean-}-export interface PageViewsOptions {/*** If set to `true`, only unique events will be saved.@@ -157,7 +115,7 @@ export interface PageViewsOptions {callback?: (payload: IPageViewPayload) => Partial<IPageViewPayload> | boolean}-export const defaultActions = {+export const defaultPageActions = {stop() {},}@@ -166,86 +124,12 @@ const DEFAULT_API_HOST = 'https://api.swetrix.com/log'export class Lib {private pageData: PageData | null = nullprivate pageViewsOptions: PageViewsOptions | null | undefined = null- private errorsOptions: ErrorOptions | null | undefined = nullprivate perfStatsCollected: Boolean = falseprivate activePage: string | null = null- private errorListenerExists = falseconstructor(private projectID: string, private options?: LibOptions) {this.trackPathChange = this.trackPathChange.bind(this)this.heartbeat = this.heartbeat.bind(this)- this.captureError = this.captureError.bind(this)- }-- captureError(event: ErrorEvent): void {- if (typeof this.errorsOptions?.sampleRate === 'number' && this.errorsOptions.sampleRate > Math.random()) {- return- }-- this.submitError({- // The file in which error occured.- filename: event.filename,-- // The line of code error occured on.- lineno: event.lineno,-- // The column of code error occured on.- colno: event.colno,-- // Name of the error, if not exists (i.e. it's a custom thrown error). The initial value of name is "Error", but just in case lets explicitly set it here too.- name: event.error?.name || 'Error',-- // Description of the error. By default, we use message from Error object, is it does not contain the error name- // (we want to split error name and message so we could group them together later in dashboard).- // If message in error object does not exist - lets use a message from the Error event itself.- message: event.error?.message || event.message,- })- }-- trackErrors(options?: ErrorOptions): ErrorActions {- if (this.errorListenerExists || !this.canTrack()) {- return defaultActions- }-- this.errorsOptions = options-- window.addEventListener('error', this.captureError)- this.errorListenerExists = true-- return {- stop: () => {- window.removeEventListener('error', this.captureError)- },- }- }-- submitError(payload: IErrorEventPayload, evokeCallback?: boolean): void {- const privateData = {- pid: this.projectID,- }-- const errorPayload = {- pg: this.activePage,- lc: getLocale(),- tz: getTimezone(),- ...payload,- }-- if (evokeCallback && this.errorsOptions?.callback) {- const callbackResult = this.errorsOptions.callback(errorPayload)-- if (callbackResult === false) {- return- }-- if (callbackResult && typeof callbackResult === 'object') {- Object.assign(errorPayload, callbackResult)- }- }-- Object.assign(errorPayload, privateData)-- this.sendRequest('error', errorPayload)}track(event: TrackEventOptions): void {@@ -269,7 +153,7 @@ export class Lib {trackPageViews(options?: PageViewsOptions): PageActions {if (!this.canTrack()) {- return defaultActions+ return defaultPageActions}if (this.pageData) {diff --git a/src/index.ts b/src/index.tsindex 4a570a09a..ddaee8568 100644--- a/src/index.ts+++ b/src/index.ts@@ -1,14 +1,4 @@-import {- Lib,- LibOptions,- TrackEventOptions,- PageViewsOptions,- ErrorOptions,- PageActions,- ErrorActions,- defaultActions,- IErrorEventPayload,-} from './Lib'+import { Lib, LibOptions, TrackEventOptions, PageViewsOptions, PageActions, defaultPageActions } from './Lib'export let LIB_INSTANCE: Lib | null = null@@ -41,15 +31,17 @@ export function track(event: TrackEventOptions): void {}/**- * With this function you are able to automatically track pageviews across your application.+ * With this function you are able to track any custom events you want.+ * You should never send any identifiable data (like User ID, email, session cookie, etc.) as an event name.+ * The total number of track calls and their conversion rate will be saved.*- * @param {PageViewsOptions} options Pageviews tracking options.+ * @param {PageViewsOptions} options The options related to the custom event.* @returns {PageActions} The actions related to the tracking. Used to stop tracking pages.*/export function trackViews(options?: PageViewsOptions): Promise<PageActions> {return new Promise((resolve) => {if (!LIB_INSTANCE) {- resolve(defaultActions)+ resolve(defaultPageActions)return}@@ -65,35 +57,6 @@ export function trackViews(options?: PageViewsOptions): Promise<PageActions> {})}-/**- * With this function you are able to track any custom events you want.- * You should never send any identifiable data (like User ID, email, session cookie, etc.) as an event name.- * The total number of track calls and their conversion rate will be saved.- *- * @param {PageViewsOptions} options The options related to the custom event.- * @returns {PageActions} The actions related to the tracking. Used to stop tracking pages.- */-export function trackErrors(options?: ErrorOptions): ErrorActions {- if (!LIB_INSTANCE) {- return defaultActions- }-- return LIB_INSTANCE.trackErrors(options)-}--/**- * This function is used to manually track an error event.- * It's useful if you want to track specific errors in your application.- *- * @param payload Swetrix error object to send.- * @returns void- */-export function trackError(payload: IErrorEventPayload): void {- if (!LIB_INSTANCE) return-- LIB_INSTANCE.submitError(payload, false)-}-/*** This function is used to manually track a page view event.* It's useful if your application uses esoteric routing which is not supported by Swetrix by default.