All files / logging log-dispatcher.service.ts

89.58% Statements 43/48
83.33% Branches 15/18
66.66% Functions 10/15
90.9% Lines 40/44

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 1736x 6x 6x 6x 6x           6x         6x                   6x 16x 16x 16x 16x       16x 16x       16x     16x 1x       16x 13x               13x 11x               2x 1x 1x               6x                             7x 6x     7x                   7x     7x 14x 11x 11x     1x                   1x   2x   1x   1x                                   6x                                       6x            
import { LogEntry, LogLevel, LogProvider, LogStorageProvider, isStorageProvider } from './log-provider.interface';
import { sanitizeLogEntry } from './log-sanitizer';
import { ConsoleLogProvider } from './providers/console-log.provider';
import { isPlatformBrowser } from '@angular/common';
import { inject, Injectable, InjectionToken, PLATFORM_ID } from '@angular/core';
 
/**
 * Injection token for log providers
 * Use provideLogProviders() to configure
 */
export const LOG_PROVIDERS = new InjectionToken<LogProvider[]>('LOG_PROVIDERS');
 
/**
 * Injection token for production mode flag
 */
export const LOG_PRODUCTION_MODE = new InjectionToken<boolean>('LOG_PRODUCTION_MODE', {
    providedIn: 'root',
    factory: () => false,
});
 
/**
 * Central log dispatcher service
 * Distributes log entries to all registered providers
 */
@Injectable({ providedIn: 'root' })
export class LogDispatcher {
    private readonly platformId = inject(PLATFORM_ID);
    private readonly isBrowser = isPlatformBrowser(this.platformId);
    private readonly isProduction = inject(LOG_PRODUCTION_MODE);
    private readonly injectedProviders = inject(LOG_PROVIDERS, {
        optional: true,
    });
 
    private readonly providers: LogProvider[] = [];
    private currentUrl = '';
 
    constructor() {
        // Always add console provider
        this.providers.push(new ConsoleLogProvider(this.isProduction, this.isBrowser));
 
        // Add any injected providers
        if (this.injectedProviders) {
            this.providers.push(...this.injectedProviders);
        }
 
        // Track current URL for log entries
        if (this.isBrowser) {
            this.currentUrl = window.location.pathname;
        }
    }
 
    /**
     * Register a new log provider
     */
    registerProvider(provider: LogProvider): void {
        if (!this.providers.some(p => p.name === provider.name)) {
            this.providers.push(provider);
        }
    }
 
    /**
     * Unregister a log provider by name
     */
    unregisterProvider(name: string): void {
        const index = this.providers.findIndex(p => p.name === name);
        Eif (index !== -1) {
            this.providers.splice(index, 1);
        }
    }
 
    /**
     * Get all registered providers
     */
    getProviders(): readonly LogProvider[] {
        return this.providers;
    }
 
    /**
     * Get the first available storage provider (for log export)
     */
    getStorageProvider(): LogStorageProvider | undefined {
        return this.providers.find((p): p is LogStorageProvider => isStorageProvider(p) && p.isAvailable);
    }
 
    /**
     * Dispatch a log entry to all available providers
     */
    dispatch(level: LogLevel, message: string, context?: string, data?: unknown): void {
        // Update current URL on each log (in case of navigation)
        if (this.isBrowser) {
            this.currentUrl = window.location.pathname;
        }
 
        const entry: LogEntry = {
            level,
            message,
            context,
            data,
            timestamp: new Date(),
            url: this.currentUrl || undefined,
        };
 
        // Sanitize sensitive data before dispatching
        const sanitizedEntry = sanitizeLogEntry(entry);
 
        // Dispatch to all available providers
        for (const provider of this.providers) {
            if (provider.isAvailable) {
                try {
                    provider.log(sanitizedEntry);
                } catch (error) {
                    // Avoid infinite loops - don't log provider errors
                    console.error(`LogDispatcher: Error in provider '${provider.name}'`, error);
                }
            }
        }
    }
 
    /**
     * Flush all providers that support buffering
     */
    async flush(): Promise<void> {
        const flushPromises = this.providers
            .filter(
                (p): p is LogProvider & { flush: () => Promise<void> } => p.isAvailable && typeof p.flush === 'function'
            )
            .map(p => p.flush());
 
        await Promise.all(flushPromises);
    }
}
 
/**
 * Provider function to configure log providers
 * @param providers - Array of LogProvider instances or types
 *
 * @example
 * ```typescript
 * // In app.config.ts
 * export const appConfig: ApplicationConfig = {
 *     providers: [
 *         provideLogProviders([indexedDBLogProvider]),
 *     ],
 * };
 * ```
 */
export function provideLogProviders(providers: LogProvider[]) {
    return {
        provide: LOG_PROVIDERS,
        useValue: providers,
    };
}
 
/**
 * Provider function to set production mode for logging
 *
 * @example
 * ```typescript
 * // In app.config.ts
 * export const appConfig: ApplicationConfig = {
 *     providers: [
 *         provideLogProductionMode(environment.production),
 *     ],
 * };
 * ```
 */
export function provideLogProductionMode(isProduction: boolean) {
    return {
        provide: LOG_PRODUCTION_MODE,
        useValue: isProduction,
    };
}