@24i/bigscreen-sdk 1.0.39 → 1.0.40-alpha.2687

package/packages/logger/src/loggers/SentryLogger/README.md

@@ -1,98 +1,98 @@
----
-id: README
-title: Sentry Logger
-hide_title: true
-sidebar_label: Sentry Logger
----
-
-# Sentry Logger
-
-Sentry integration for SmartApps BIGscreen logger tools.
-
-## Config
-
-```ts
-type Config = {
-    sentryOptions: Sentry.BrowserOptions;
-    storage?: IStorage;
-    loggerEnvironment?: SentryLoggerEnvironment;
-};
-
-const defaultConfig: LoggerBaseConfig<Partial<Config>> = {
-    name: 'SentryLogger',
-};
-```
-
-- `sentryOptions` - Sentry configuration (<https://docs.sentry.io/platforms/javascript/configuration/options/>).
-- `storage` - Currently used storage instance (default: [LocalStorage](../../../../storage/README.md)).
-- `loggerEnvironment` - Information about the environment that is sent to the logger.
-
-    ```ts
-    interface SentryLoggerEnvironment {
-        [key: string]: string;
-        device: string;
-        platformName: string;
-        platformVersion: string;
-        serialNumber: string;
-        firmware: string;
-        macAddress: string;
-        flavour: string;
-        resolution: string;
-        player: string;
-    }
-    ```
-
-## Useful Methods
-
-- `setUser(user: Sentry.User): void` - Sets unique identity in Sentry (e.g. Login).
-- `removeUser(): void` - Removes user identity (e.g. Logout).
-- `addBreadcrumb(breadcrumb: Sentry.Breadcrumb): void` - Records small pieces of structured data that is attached to a log message.
-- `setTag(key: string, value: string): void` - Sets string pairs that are both indexed and searchable.
-- `clearScope(): void` - Clears current scope (breadcrumbs, extras, tags...).
-
-## Sentry
-
-If you need to import the Sentry.io library (because of e.g. types or integration), you should do it directly from
-Sentry Logger. This avoids potential Sentry.io version incompatibilities and at the same time, you can use this Sentry instance (which is used by Sentry Logger) and perform custom operations on it.
-
-```ts
-import { Sentry } from '@24i/bigscreen-sdk/logger/SentryLogger'
-```
-
-## Example
-
-```ts
-import { device } from '@24i/bigscreen-sdk/device';
-import { SentryLogger, Sentry } from '@24i/bigscreen-sdk/logger/SentryLogger'
-import { HTML5Video } from '@24i/player-html5';
-import { APP_CONFIG_ID, APP_RESOLUTION } from '../../configNxgTV';
-
-const loggerEnvironment = {
-    device: await device.getDeviceName(),
-    platformName: await device.getPlatformName(),
-    platformVersion: await device.getPlatformVersion(),
-    serialNumber: await device.getUuid(),
-    firmware: await device.getFirmware(),
-    macAddress: await device.getMacAddress(),
-    flavour: APP_CONFIG_ID,
-    resolution: APP_RESOLUTION,
-    player: `${HTML5Video.playerName} ${HTML5Video.version}`,
-};
-
-const sentryConfig = {
-    mute: environment === 'development',
-    storage: Storage,
-    sentryOptions: {
-        dsn: 'https://fake-dsn@sentry.24imedia.tv/1',
-        release: `fake-app@0.0.1`,
-        integrations: [new Sentry.Integrations.Breadcrumbs({
-            fetch: false,
-        })],
-    },
-    loggerEnvironment,
-};
-
-const sentryLogger = new SentryLogger(sentryConfig);
-
-sentryLogger.info('Data refreshed', { category: 'api', additionalData: { statusCode: 200 } });
-```
+---
+id: README
+title: Sentry Logger
+hide_title: true
+sidebar_label: Sentry Logger
+---
+
+# Sentry Logger
+
+Sentry integration for SmartApps BIGscreen logger tools.
+
+## Config
+
+```ts
+type Config = {
+    sentryOptions: Sentry.BrowserOptions;
+    storage?: IStorage;
+    loggerEnvironment?: SentryLoggerEnvironment;
+};
+
+const defaultConfig: LoggerBaseConfig<Partial<Config>> = {
+    name: 'SentryLogger',
+};
+```
+
+- `sentryOptions` - Sentry configuration (<https://docs.sentry.io/platforms/javascript/configuration/options/>).
+- `storage` - Currently used storage instance (default: [LocalStorage](../../../../storage/README.md)).
+- `loggerEnvironment` - Information about the environment that is sent to the logger.
+
+    ```ts
+    interface SentryLoggerEnvironment {
+        [key: string]: string;
+        device: string;
+        platformName: string;
+        platformVersion: string;
+        serialNumber: string;
+        firmware: string;
+        macAddress: string;
+        flavour: string;
+        resolution: string;
+        player: string;
+    }
+    ```
+
+## Useful Methods
+
+- `setUser(user: Sentry.User): void` - Sets unique identity in Sentry (e.g. Login).
+- `removeUser(): void` - Removes user identity (e.g. Logout).
+- `addBreadcrumb(breadcrumb: Sentry.Breadcrumb): void` - Records small pieces of structured data that is attached to a log message.
+- `setTag(key: string, value: string): void` - Sets string pairs that are both indexed and searchable.
+- `clearScope(): void` - Clears current scope (breadcrumbs, extras, tags...).
+
+## Sentry
+
+If you need to import the Sentry.io library (because of e.g. types or integration), you should do it directly from
+Sentry Logger. This avoids potential Sentry.io version incompatibilities and at the same time, you can use this Sentry instance (which is used by Sentry Logger) and perform custom operations on it.
+
+```ts
+import { Sentry } from '@24i/bigscreen-sdk/logger/SentryLogger'
+```
+
+## Example
+
+```ts
+import { device } from '@24i/bigscreen-sdk/device';
+import { SentryLogger, Sentry } from '@24i/bigscreen-sdk/logger/SentryLogger'
+import { HTML5Video } from '@24i/player-html5';
+import { APP_CONFIG_ID, APP_RESOLUTION } from '../../configNxgTV';
+
+const loggerEnvironment = {
+    device: await device.getDeviceName(),
+    platformName: await device.getPlatformName(),
+    platformVersion: await device.getPlatformVersion(),
+    serialNumber: await device.getUuid(),
+    firmware: await device.getFirmware(),
+    macAddress: await device.getMacAddress(),
+    flavour: APP_CONFIG_ID,
+    resolution: APP_RESOLUTION,
+    player: `${HTML5Video.playerName} ${HTML5Video.version}`,
+};
+
+const sentryConfig = {
+    mute: environment === 'development',
+    storage: Storage,
+    sentryOptions: {
+        dsn: 'https://fake-dsn@sentry.24imedia.tv/1',
+        release: `fake-app@0.0.1`,
+        integrations: [new Sentry.Integrations.Breadcrumbs({
+            fetch: false,
+        })],
+    },
+    loggerEnvironment,
+};
+
+const sentryLogger = new SentryLogger(sentryConfig);
+
+sentryLogger.info('Data refreshed', { category: 'api', additionalData: { statusCode: 200 } });
+```

package/packages/logger/src/loggers/SentryLogger/Sentry.ts

@@ -1,2 +1,2 @@
-export * as Sentry from '@sentry/browser';
-export { ErrorEvent } from '@sentry/types';
+export * as Sentry from '@sentry/browser';
+export { ErrorEvent } from '@sentry/types';

package/packages/logger/src/loggers/SentryLogger/SentryLogger.ts

@@ -1,179 +1,179 @@
-import { forEach } from '@24i/bigscreen-sdk/perf-utils/array';
-import { IStorage, Storage as DefaultStorage } from '@24i/bigscreen-sdk/storage';
-import { LogOptions, LogLevel, SentryLoggerEnvironment, XhrBreadcrumbData } from '../../types';
-import { getFormattedMemoryHeapInfo, getFormattedUsedLocalStorageSize } from '../../utils';
-import { LoggerBase, Config as LoggerBaseConfig } from '../LoggerBase';
-import { Sentry, ErrorEvent } from './Sentry';
-
-type Config = {
-    sentryOptions: Sentry.BrowserOptions;
-    storage?: IStorage;
-    loggerEnvironment?: SentryLoggerEnvironment;
-};
-
-const defaultConfig: LoggerBaseConfig<Partial<Config>> = {
-    name: 'SentryLogger',
-};
-
-const contextKeys = {
-    DEVICE_INFO: 'Device Info',
-    APPLICATION: 'Application',
-    MEMORY_INFO: 'Memory Info',
-    ADDITIONAL_INFO: 'Additional Info',
-    ADDITIONAL_DATA: 'Additional Data',
-};
-
-const SentryLevelsMap: Partial<Record<Sentry.SeverityLevel, LogLevel>> = {
-    debug: 'debug',
-    info: 'info',
-    warning: 'warn',
-    error: 'error',
-};
-
-export class SentryLogger extends LoggerBase {
-    private storage = DefaultStorage;
-
-    constructor(config: LoggerBaseConfig<Config>) {
-        super({ ...defaultConfig, ...config });
-        const { storage, sentryOptions, loggerEnvironment } = config;
-
-        this.init(sentryOptions);
-        if (storage) this.setStorage(storage);
-        if (loggerEnvironment) this.setLoggerEnvironment(loggerEnvironment);
-    }
-
-    init(options: Sentry.BrowserOptions) {
-        const { beforeSend, ...restOptions } = options;
-        Sentry.init({
-            ...restOptions,
-            beforeSend: async (event: ErrorEvent, hint: Sentry.EventHint) => {
-                if (this.mute) return null;
-                await this.sendMemoryInfo(event);
-                return beforeSend ? beforeSend(event, hint) : event;
-            },
-        });
-    }
-
-    debug(message: string, options?: LogOptions) {
-        this.logMessage('debug', message, options);
-    }
-
-    info(message: string, options?: LogOptions) {
-        this.logMessage('info', message, options);
-    }
-
-    warn(message: string, options?: LogOptions) {
-        this.logMessage('warning', message, options);
-    }
-
-    error(message: string, options?: LogOptions) {
-        this.logMessage('error', message, options);
-    }
-
-    setStorage(storage: IStorage) {
-        this.storage = storage;
-    }
-
-    setLoggerEnvironment(loggerEnvironment: SentryLoggerEnvironment) {
-        const {
-            device,
-            platformName,
-            platformVersion,
-            serialNumber,
-            firmware,
-            macAddress,
-            flavour,
-            resolution,
-            player,
-            ...moreInfo
-        } = loggerEnvironment;
-        const application = { flavour, resolution, player };
-        const deviceInfo = {
-            device, platformName, platformVersion, serialNumber, firmware, macAddress,
-        };
-
-        Sentry.configureScope((scope) => {
-            scope.setContext(contextKeys.APPLICATION, application);
-            scope.setContext(contextKeys.DEVICE_INFO, deviceInfo);
-            if (Object.keys(moreInfo).length !== 0) {
-                scope.setContext(contextKeys.ADDITIONAL_INFO, moreInfo);
-            }
-        });
-        forEach(Object.keys(loggerEnvironment), (key) => this.setTag(key, loggerEnvironment[key]));
-    }
-
-    setUser(user: Sentry.User) {
-        Sentry.configureScope((scope) => {
-            scope.setUser(user);
-        });
-    }
-
-    removeUser() {
-        Sentry.configureScope((scope) => {
-            scope.setUser(null);
-        });
-    }
-
-    addBreadcrumb(breadcrumb: Sentry.Breadcrumb) {
-        Sentry.configureScope((scope) => {
-            scope.addBreadcrumb(breadcrumb);
-        });
-    }
-
-    /**
-     * An alternative option for xhr breadcrumbs
-     * The default xhr breadcrumbs integration must be disabled in init method:
-     * integrations: [ new Sentry.Integrations.Breadcrumbs({ xhr: false }) ]
-     */
-    addXhrBreadcrumb(xhrBreadcrumbData: XhrBreadcrumbData) {
-        const breadcrumb = {
-            category: 'xhr',
-            type: 'http',
-            data: xhrBreadcrumbData,
-        };
-        this.addBreadcrumb(breadcrumb);
-    }
-
-    setTag(key: string, value: string) {
-        Sentry.configureScope((scope) => {
-            scope.setTag(key, value);
-        });
-    }
-
-    clearScope() {
-        Sentry.configureScope((scope) => {
-            scope.clear();
-        });
-    }
-
-    private async sendMemoryInfo(event: Sentry.Event) {
-        const memoryHeapInfo = getFormattedMemoryHeapInfo();
-        const usedLocalStorage = await getFormattedUsedLocalStorageSize(this.storage);
-        const memoryInfo = { memoryHeapInfo, usedLocalStorage };
-        if (!event.contexts) event.contexts = {};
-        event.contexts = { ...event.contexts, ...{ [contextKeys.MEMORY_INFO]: memoryInfo } };
-    }
-
-    private async logMessage(
-        level: Partial<Sentry.SeverityLevel>,
-        message: string,
-        { category, additionalData }: LogOptions = {},
-    ) {
-        if (this.isMuted() || this.isBlockedByLevel(SentryLevelsMap[level]!)) return;
-
-        Sentry.withScope((scope) => {
-            let logMessage = message;
-            if (category) {
-                const categoryUpperCase = category.toUpperCase();
-                logMessage = `[${categoryUpperCase}] ${message}`;
-                scope.setTag('category', categoryUpperCase);
-            }
-            if (additionalData) {
-                if (additionalData.message) logMessage += ` - ${additionalData.message}`;
-                scope.setExtra(contextKeys.ADDITIONAL_DATA, JSON.stringify(additionalData));
-            }
-            Sentry.captureMessage(logMessage, level);
-        });
-        await Sentry.flush();
-    }
-}
+import { forEach } from '@24i/bigscreen-sdk/perf-utils/array';
+import { IStorage, Storage as DefaultStorage } from '@24i/bigscreen-sdk/storage';
+import { LogOptions, LogLevel, SentryLoggerEnvironment, XhrBreadcrumbData } from '../../types';
+import { getFormattedMemoryHeapInfo, getFormattedUsedLocalStorageSize } from '../../utils';
+import { LoggerBase, Config as LoggerBaseConfig } from '../LoggerBase';
+import { Sentry, ErrorEvent } from './Sentry';
+
+type Config = {
+    sentryOptions: Sentry.BrowserOptions;
+    storage?: IStorage;
+    loggerEnvironment?: SentryLoggerEnvironment;
+};
+
+const defaultConfig: LoggerBaseConfig<Partial<Config>> = {
+    name: 'SentryLogger',
+};
+
+const contextKeys = {
+    DEVICE_INFO: 'Device Info',
+    APPLICATION: 'Application',
+    MEMORY_INFO: 'Memory Info',
+    ADDITIONAL_INFO: 'Additional Info',
+    ADDITIONAL_DATA: 'Additional Data',
+};
+
+const SentryLevelsMap: Partial<Record<Sentry.SeverityLevel, LogLevel>> = {
+    debug: 'debug',
+    info: 'info',
+    warning: 'warn',
+    error: 'error',
+};
+
+export class SentryLogger extends LoggerBase {
+    private storage = DefaultStorage;
+
+    constructor(config: LoggerBaseConfig<Config>) {
+        super({ ...defaultConfig, ...config });
+        const { storage, sentryOptions, loggerEnvironment } = config;
+
+        this.init(sentryOptions);
+        if (storage) this.setStorage(storage);
+        if (loggerEnvironment) this.setLoggerEnvironment(loggerEnvironment);
+    }
+
+    init(options: Sentry.BrowserOptions) {
+        const { beforeSend, ...restOptions } = options;
+        Sentry.init({
+            ...restOptions,
+            beforeSend: async (event: ErrorEvent, hint: Sentry.EventHint) => {
+                if (this.mute) return null;
+                await this.sendMemoryInfo(event);
+                return beforeSend ? beforeSend(event, hint) : event;
+            },
+        });
+    }
+
+    debug(message: string, options?: LogOptions) {
+        this.logMessage('debug', message, options);
+    }
+
+    info(message: string, options?: LogOptions) {
+        this.logMessage('info', message, options);
+    }
+
+    warn(message: string, options?: LogOptions) {
+        this.logMessage('warning', message, options);
+    }
+
+    error(message: string, options?: LogOptions) {
+        this.logMessage('error', message, options);
+    }
+
+    setStorage(storage: IStorage) {
+        this.storage = storage;
+    }
+
+    setLoggerEnvironment(loggerEnvironment: SentryLoggerEnvironment) {
+        const {
+            device,
+            platformName,
+            platformVersion,
+            serialNumber,
+            firmware,
+            macAddress,
+            flavour,
+            resolution,
+            player,
+            ...moreInfo
+        } = loggerEnvironment;
+        const application = { flavour, resolution, player };
+        const deviceInfo = {
+            device, platformName, platformVersion, serialNumber, firmware, macAddress,
+        };
+
+        Sentry.configureScope((scope) => {
+            scope.setContext(contextKeys.APPLICATION, application);
+            scope.setContext(contextKeys.DEVICE_INFO, deviceInfo);
+            if (Object.keys(moreInfo).length !== 0) {
+                scope.setContext(contextKeys.ADDITIONAL_INFO, moreInfo);
+            }
+        });
+        forEach(Object.keys(loggerEnvironment), (key) => this.setTag(key, loggerEnvironment[key]));
+    }
+
+    setUser(user: Sentry.User) {
+        Sentry.configureScope((scope) => {
+            scope.setUser(user);
+        });
+    }
+
+    removeUser() {
+        Sentry.configureScope((scope) => {
+            scope.setUser(null);
+        });
+    }
+
+    addBreadcrumb(breadcrumb: Sentry.Breadcrumb) {
+        Sentry.configureScope((scope) => {
+            scope.addBreadcrumb(breadcrumb);
+        });
+    }
+
+    /**
+     * An alternative option for xhr breadcrumbs
+     * The default xhr breadcrumbs integration must be disabled in init method:
+     * integrations: [ new Sentry.Integrations.Breadcrumbs({ xhr: false }) ]
+     */
+    addXhrBreadcrumb(xhrBreadcrumbData: XhrBreadcrumbData) {
+        const breadcrumb = {
+            category: 'xhr',
+            type: 'http',
+            data: xhrBreadcrumbData,
+        };
+        this.addBreadcrumb(breadcrumb);
+    }
+
+    setTag(key: string, value: string) {
+        Sentry.configureScope((scope) => {
+            scope.setTag(key, value);
+        });
+    }
+
+    clearScope() {
+        Sentry.configureScope((scope) => {
+            scope.clear();
+        });
+    }
+
+    private async sendMemoryInfo(event: Sentry.Event) {
+        const memoryHeapInfo = getFormattedMemoryHeapInfo();
+        const usedLocalStorage = await getFormattedUsedLocalStorageSize(this.storage);
+        const memoryInfo = { memoryHeapInfo, usedLocalStorage };
+        if (!event.contexts) event.contexts = {};
+        event.contexts = { ...event.contexts, ...{ [contextKeys.MEMORY_INFO]: memoryInfo } };
+    }
+
+    private async logMessage(
+        level: Partial<Sentry.SeverityLevel>,
+        message: string,
+        { category, additionalData }: LogOptions = {},
+    ) {
+        if (this.isMuted() || this.isBlockedByLevel(SentryLevelsMap[level]!)) return;
+
+        Sentry.withScope((scope) => {
+            let logMessage = message;
+            if (category) {
+                const categoryUpperCase = category.toUpperCase();
+                logMessage = `[${categoryUpperCase}] ${message}`;
+                scope.setTag('category', categoryUpperCase);
+            }
+            if (additionalData) {
+                if (additionalData.message) logMessage += ` - ${additionalData.message}`;
+                scope.setExtra(contextKeys.ADDITIONAL_DATA, JSON.stringify(additionalData));
+            }
+            Sentry.captureMessage(logMessage, level);
+        });
+        await Sentry.flush();
+    }
+}

package/packages/logger/src/loggers/SentryLogger/index.ts

@@ -1,2 +1,2 @@
-export { SentryLogger } from './SentryLogger';
-export { Sentry } from './Sentry';
+export { SentryLogger } from './SentryLogger';
+export { Sentry } from './Sentry';

package/packages/logger/src/loggers/SentryLogger/mock.ts

@@ -1,6 +1,6 @@
-import { Sentry } from './Sentry';
-
-jest.mock('./Sentry');
-
-export { SentryLogger } from './SentryLogger';
-export { Sentry };
+import { Sentry } from './Sentry';
+
+jest.mock('./Sentry');
+
+export { SentryLogger } from './SentryLogger';
+export { Sentry };

package/packages/logger/src/loggers/index.ts

@@ -1,2 +1,2 @@
-export { ConsoleLogger } from './ConsoleLogger';
-export { SentryLogger } from './SentryLogger';
+export { ConsoleLogger } from './ConsoleLogger';
+export { SentryLogger } from './SentryLogger';