@tracelog/lib 0.0.8 → 0.2.0

package/dist/cjs/managers/config.manager.js

@@ -5,90 +5,159 @@ const constants_1 = require("../constants");
 const types_1 = require("../types");
 const utils_1 = require("../utils");
 const logging_1 = require("../utils/logging");
+/**
+ * Configuration manager responsible for loading and merging application configuration.
+ *
+ * Handles three configuration sources:
+ * 1. Default configuration (fallback values)
+ * 2. API configuration (server-side settings)
+ * 3. App configuration (client initialization settings)
+ *
+ * Supports special project IDs for development and testing:
+ * - 'skip': Bypasses all network calls, uses defaults
+ * - 'localhost:PORT': Loads config from local development server
+ */
 class ConfigManager {
+    /**
+     * Gets complete configuration by merging default, API, and app configurations.
+     *
+     * @param apiUrl - Base URL for the configuration API
+     * @param appConfig - Client-side configuration from init()
+     * @returns Promise<Config> - Merged configuration object
+     */
     async get(apiUrl, appConfig) {
-        if (appConfig.id === types_1.SpecialProjectId.HttpSkip) {
-            logging_1.debugLog.debug('ConfigManager', 'Using special project id');
-            return this.getDefaultConfig(appConfig);
+        // Handle skip mode - no network calls
+        if (appConfig.id === types_1.SpecialProjectId.Skip) {
+            return this.createDefaultConfig(appConfig);
         }
-        logging_1.debugLog.debug('ConfigManager', 'Loading config from API', { apiUrl, projectId: appConfig.id });
-        const config = await this.load(apiUrl, appConfig, appConfig.id === types_1.SpecialProjectId.HttpLocal);
-        logging_1.debugLog.info('ConfigManager', 'Config loaded successfully', {
+        const config = await this.loadFromApi(apiUrl, appConfig);
+        const { config: normalizedConfig } = (0, utils_1.normalizeConfig)(config);
+        logging_1.debugLog.info('ConfigManager', 'Configuration loaded', {
             projectId: appConfig.id,
-            mode: config.mode,
-            hasExcludedPaths: !!config.excludedUrlPaths?.length,
-            hasGlobalMetadata: !!config.globalMetadata,
+            mode: normalizedConfig.mode,
+            hasTags: !!normalizedConfig.tags?.length,
+            hasExclusions: !!normalizedConfig.excludedUrlPaths?.length,
         });
-        return config;
+        return normalizedConfig;
     }
-    async load(apiUrl, appConfig, useLocalServer) {
+    /**
+     * Loads configuration from API and merges with app config.
+     */
+    async loadFromApi(apiUrl, appConfig) {
         try {
-            const configUrl = useLocalServer ? `${window.location.origin}/config` : this.getUrl(apiUrl);
-            if (!configUrl) {
-                throw new Error('Config URL is not valid or not allowed');
-            }
-            const response = await fetch(configUrl, {
+            const configUrl = this.buildConfigUrl(apiUrl, appConfig);
+            const headers = this.buildHeaders(appConfig);
+            const response = await (0, utils_1.fetchWithTimeout)(configUrl, {
                 method: 'GET',
-                headers: { 'Content-Type': 'application/json' },
+                headers,
+                timeout: constants_1.REQUEST_TIMEOUT_MS,
             });
             if (!response.ok) {
-                const error = `HTTP ${response.status}: ${response.statusText}`;
-                logging_1.debugLog.error('ConfigManager', 'Config API request failed', {
-                    status: response.status,
-                    statusText: response.statusText,
-                    configUrl,
-                });
-                throw new Error(error);
-            }
-            const rawData = await response.json();
-            if (rawData === undefined || rawData === null || typeof rawData !== 'object' || Array.isArray(rawData)) {
-                logging_1.debugLog.error('ConfigManager', 'Invalid config API response format', {
-                    responseType: typeof rawData,
-                    isArray: Array.isArray(rawData),
-                });
-                throw new Error('Invalid config API response: expected object');
-            }
-            const safeApiConfig = (0, utils_1.sanitizeApiConfig)(rawData);
-            const apiConfig = { ...constants_1.DEFAULT_API_CONFIG, ...safeApiConfig };
-            const mergedConfig = { ...apiConfig, ...appConfig };
-            // Check if qaMode=true is in URL and automatically set mode to 'qa'
-            const urlParameters = new URLSearchParams(window.location.search);
-            const isQaMode = urlParameters.get('qaMode') === 'true';
-            if (isQaMode && !mergedConfig.mode) {
-                mergedConfig.mode = types_1.Mode.QA;
-                logging_1.debugLog.info('ConfigManager', 'QA mode enabled via URL parameter');
+                throw new Error(`HTTP ${response.status}: ${response.statusText}`);
             }
-            const errorSampling = Object.values(types_1.Mode).includes(mergedConfig.mode)
-                ? 1
-                : (mergedConfig.errorSampling ?? 0.1);
-            const finalConfig = { ...mergedConfig, errorSampling };
-            return finalConfig;
+            const rawData = await this.parseJsonResponse(response);
+            return this.mergeConfigurations(rawData, appConfig);
         }
         catch (error) {
             const errorMessage = error instanceof Error ? error.message : 'Unknown error';
-            logging_1.debugLog.error('ConfigManager', 'Failed to load config', { error: errorMessage, apiUrl });
-            throw new Error(`Failed to load config: ${errorMessage}`);
+            logging_1.debugLog.error('ConfigManager', 'Failed to load configuration', {
+                error: errorMessage,
+                apiUrl,
+                projectId: appConfig.id,
+            });
+            throw new Error(`Configuration load failed: ${errorMessage}`);
+        }
+    }
+    /**
+     * Builds the configuration URL based on project type and QA mode.
+     */
+    buildConfigUrl(apiUrl, appConfig) {
+        const isLocalhost = appConfig.id.startsWith(types_1.SpecialProjectId.Localhost);
+        if (isLocalhost) {
+            this.validateLocalhostProjectId(appConfig.id);
+            return `http://${appConfig.id}/config`;
+        }
+        const baseUrl = `${apiUrl}/config`;
+        const isQaMode = this.isQaModeEnabled();
+        return isQaMode ? `${baseUrl}?qaMode=true` : baseUrl;
+    }
+    /**
+     * Builds request headers based on project configuration.
+     */
+    buildHeaders(appConfig) {
+        const headers = {
+            'Content-Type': 'application/json',
+        };
+        if (appConfig.id.startsWith(types_1.SpecialProjectId.Localhost)) {
+            headers['X-TraceLog-Project'] = appConfig.id;
+        }
+        return headers;
+    }
+    /**
+     * Parses and validates JSON response from config API.
+     */
+    async parseJsonResponse(response) {
+        const contentType = response.headers.get('content-type');
+        if (!contentType?.includes('application/json')) {
+            throw new Error('Invalid response content-type, expected JSON');
+        }
+        const rawData = await response.json();
+        if (!rawData || typeof rawData !== 'object' || Array.isArray(rawData)) {
+            throw new Error('Invalid response format, expected object');
         }
+        return rawData;
     }
-    getUrl(apiUrl) {
-        const urlParameters = new URLSearchParams(window.location.search);
-        const isQaMode = urlParameters.get('qaMode') === 'true';
-        let configUrl = `${apiUrl}/config`;
-        if (isQaMode) {
-            configUrl += '?qaMode=true';
+    /**
+     * Validates localhost project ID format and port range.
+     */
+    validateLocalhostProjectId(projectId) {
+        if (!ConfigManager.LOCALHOST_PATTERN.test(projectId)) {
+            throw new Error(`Invalid localhost format. Expected 'localhost:PORT', got '${projectId}'`);
         }
-        if (!(0, utils_1.isValidUrl)(configUrl)) {
-            logging_1.debugLog.clientError('ConfigManager', 'Invalid config URL provided', { configUrl });
-            throw new Error('Config URL is not valid or not allowed');
+        const port = parseInt(projectId.split(':')[1], 10);
+        if (port < 1 || port > 65535) {
+            throw new Error(`Port must be between 1 and 65535, got ${port}`);
         }
-        return configUrl;
     }
-    getDefaultConfig(appConfig) {
-        return (0, constants_1.DEFAULT_CONFIG)({
+    /**
+     * Checks if QA mode is enabled via URL parameter.
+     */
+    isQaModeEnabled() {
+        const params = new URLSearchParams(window.location.search);
+        return params.get('qaMode') === 'true';
+    }
+    /**
+     * Merges API configuration with app configuration and applies mode-specific settings.
+     */
+    mergeConfigurations(rawApiConfig, appConfig) {
+        const safeApiConfig = (0, utils_1.sanitizeApiConfig)(rawApiConfig);
+        const apiConfig = { ...constants_1.DEFAULT_API_CONFIG, ...safeApiConfig };
+        const mergedConfig = (0, constants_1.DEFAULT_CONFIG)({ ...appConfig, ...apiConfig });
+        const { config: normalizedConfig } = (0, utils_1.normalizeConfig)(mergedConfig);
+        // Apply QA mode if enabled via URL parameter
+        if (this.isQaModeEnabled() && !normalizedConfig.mode) {
+            normalizedConfig.mode = types_1.Mode.QA;
+            logging_1.debugLog.info('ConfigManager', 'QA mode enabled via URL parameter');
+        }
+        // Set error sampling based on mode
+        const errorSampling = Object.values(types_1.Mode).includes(normalizedConfig.mode)
+            ? 1 // Full sampling for debug/qa modes
+            : (normalizedConfig.errorSampling ?? 0.1); // Default sampling for production
+        return { ...normalizedConfig, errorSampling };
+    }
+    /**
+     * Creates default configuration for skip mode and fallback scenarios.
+     */
+    createDefaultConfig(appConfig) {
+        const defaultConfig = (0, constants_1.DEFAULT_CONFIG)({
             ...appConfig,
             errorSampling: 1,
-            ...(Object.values(types_1.SpecialProjectId).includes(appConfig.id) && { mode: types_1.Mode.DEBUG }),
+            ...(appConfig.id === types_1.SpecialProjectId.Skip && { mode: types_1.Mode.DEBUG }),
         });
+        const { config } = (0, utils_1.normalizeConfig)(defaultConfig);
+        return config;
     }
 }
 exports.ConfigManager = ConfigManager;
+ConfigManager.LOCALHOST_PATTERN = /^localhost:\d{1,5}$/;
+ConfigManager.PRODUCTION_DOMAINS = [/^https:\/\/.*\.tracelog\.app$/, /^https:\/\/.*\.tracelog\.dev$/];

package/dist/cjs/managers/event.manager.d.ts

@@ -1,61 +1,82 @@
 import { EventData } from '../types';
+import { Emitter } from '../utils';
 import { StateManager } from './state.manager';
 import { StorageManager } from './storage.manager';
 import { GoogleAnalyticsIntegration } from '../integrations/google-analytics.integration';
+/**
+ * EventManager - Core event tracking and queue management
+ *
+ * Responsibilities:
+ * - Track user events (clicks, scrolls, page views, custom events)
+ * - Queue events and batch send them to the analytics API
+ * - Handle deduplication of similar events
+ * - Manage event sending intervals and retry logic
+ * - Integrate with Google Analytics when configured
+ */
 export declare class EventManager extends StateManager {
     private readonly googleAnalytics;
-    private readonly samplingManager;
-    private readonly tagsManager;
     private readonly dataSender;
-    private readonly storageManager;
+    private readonly emitter;
     private eventsQueue;
-    private lastEvent;
-    private eventsQueueIntervalId;
-    private intervalActive;
-    private failureCount;
-    private readonly MAX_FAILURES;
-    private circuitOpen;
-    private circuitOpenTime;
-    private backoffDelay;
-    private circuitResetTimeoutId;
-    private readonly eventFingerprints;
-    private readonly PERSISTENCE_KEY;
-    constructor(storeManager: StorageManager, googleAnalytics?: GoogleAnalyticsIntegration | null);
-    track({ type, page_url, from_page_url, scroll_data, click_data, custom_event, web_vitals, session_end_reason, session_start_recovered, }: Partial<EventData>): void;
+    private lastEventFingerprint;
+    private lastEventTime;
+    private sendIntervalId;
+    constructor(storeManager: StorageManager, googleAnalytics?: GoogleAnalyticsIntegration | null, emitter?: Emitter | null);
+    /**
+     * Recovers persisted events from localStorage
+     * Should be called after initialization to recover any events that failed to send
+     */
+    recoverPersistedEvents(): Promise<void>;
+    /**
+     * Track user events with automatic deduplication and queueing
+     */
+    track({ type, page_url, from_page_url, scroll_data, click_data, custom_event, web_vitals, error_data, session_end_reason, session_start_recovered, }: Partial<EventData>): void;
     stop(): void;
-    private processAndSend;
-    private trackGoogleAnalyticsEvent;
-    private initEventsQueueInterval;
+    /**
+     * Flush all queued events immediately (async)
+     */
     flushImmediately(): Promise<boolean>;
+    /**
+     * Flush all queued events immediately (sync)
+     */
     flushImmediatelySync(): boolean;
+    /**
+     * Queue management and sending intervals
+     */
     getQueueLength(): number;
-    private sendEventsQueue;
-    private buildEventsPayload;
-    private clearQueueInterval;
-    private getEventFingerprint;
-    private isDuplicatedEvent;
+    private clearSendInterval;
     /**
-     * Cleans up old fingerprints to prevent memory leaks
+     * Shared flush implementation for both sync and async modes
      */
-    private cleanupOldFingerprints;
+    private flushEvents;
     /**
-     * Opens the circuit breaker with time-based recovery and event persistence
+     * Send queued events to the API
      */
-    private openCircuitBreaker;
+    private sendEventsQueue;
     /**
-     * Resets the circuit breaker and attempts to restore persisted events
+     * Build the payload for sending events to the API
+     * Includes basic deduplication and sorting
      */
-    private resetCircuitBreaker;
+    private buildEventsPayload;
     /**
-     * Persists current events queue to localStorage for recovery
+     * Helper methods for event processing
      */
-    private persistEventsToStorage;
+    private buildEventPayload;
+    private isEventExcluded;
+    private isDuplicateEvent;
+    private createEventFingerprint;
+    private createEventSignature;
+    private addToQueue;
+    private startSendInterval;
+    private handleGoogleAnalyticsIntegration;
+    private shouldSample;
+    private removeProcessedEvents;
     /**
-     * Restores events from localStorage if available and not expired
+     * Emit event for external listeners
      */
-    private restoreEventsFromStorage;
+    private emitEvent;
     /**
-     * Clears persisted events from localStorage
+     * Emit events queue for external listeners
      */
-    private clearPersistedEvents;
+    private emitEventsQueue;
 }