@yuno-payments/sdk-event-log 0.3.0-beta.8 → 1.0.0-beta.0

package/dist/cjs/index.test.js

@@ -9,10 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-magic-numbers */
 const index_1 = require("./index");
-const database_1 = require("./database");
-const cron_1 = require("./cron");
-const PUBLIC_API_KEY = 'staging_gAAAAABj-NC2WEf3XA4lHnN6RfGbjETf6qL27jlU7c1tm01ERV-Y-E6ddee1QPyV_CA8cxjVlGy-qDNA2-mqa9msQlTJit-Fmbvv6f2AZdfbFd_CUo1stvixnF4_8MzM_IYVWYz7KK86VfEBvxNpjRCyp7BDef-QzrT1-yqa8HAYTuA1GU3Hjjo=';
+const types_1 = require("./types");
+const node_1 = require("msw/node");
+const msw_1 = require("msw");
 const eventArgs = {
     source: 'test',
     event: 'testEvent',
@@ -24,92 +25,173 @@ const logArgs = {
     url: '',
     method: '',
     country: '',
-    original_created_at: new Date().toISOString()
+    original_created_at: new Date().toISOString(),
+};
+const browserClientInfo = {
+    browser: 'jsdom',
+    browserMajorVersion: 20,
+    browserVersion: '20.0.3',
+    cookies: true,
+    mobile: false,
+    os: '-',
+    osVersion: '-',
+    screen: '',
 };
+const metadata = {
+    browser_info: browserClientInfo,
+};
+const publicApiKey = 'prod_1';
+let mockInterceptRequest = jest.fn();
+const server = (0, node_1.setupServer)(
+// Describe the requests to mock.
+msw_1.rest.post('https://api.y.uno/v1/sdk/event-log/publish', (req, res, ctx) => {
+    mockInterceptRequest(req.body);
+    return res(ctx.status(200));
+}));
 describe('EventLog', () => {
+    let eventLog;
+    beforeAll(() => {
+        mockInterceptRequest = jest.fn();
+        server.listen();
+    });
+    // Reset any request handlers that we may add during the tests,
+    // so they don't affect other tests.
+    afterEach(() => server.resetHandlers());
+    // Clean up after the tests are finished.
+    afterAll(() => server.close());
     beforeEach(() => {
-        // Reset the database before each test
-        // to ensure a clean slate
-        index_1.eventLog.init({
-            publicApiKey: PUBLIC_API_KEY,
-            batchTime: 500,
-            enableEvents: true,
-            enableLogs: true,
+        eventLog = new index_1.EventLog({
+            organizationName: 'testOrg',
+            debug: false,
         });
-        database_1.database.reset();
     });
-    afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
-        yield new Promise((resolve) => setTimeout(resolve, 1000));
-        cron_1.cron.stop();
-    }));
-    it('should add an event to the database', () => __awaiter(void 0, void 0, void 0, function* () {
-        index_1.eventLog.event(eventArgs);
-        const events = yield database_1.database.getAllItems();
-        expect(events).toHaveLength(1);
-        expect(events[0]).toMatchObject(eventArgs);
-    }));
-    it('should not add an event to the database if events are disabled', () => __awaiter(void 0, void 0, void 0, function* () {
-        index_1.eventLog.init({
-            publicApiKey: PUBLIC_API_KEY,
-            batchTime: 1000,
-            enableEvents: false,
-            enableLogs: true,
-        });
-        index_1.eventLog.event(eventArgs);
-        const events = yield database_1.database.getAllItems();
-        expect(events).toHaveLength(0);
-    }));
-    it('should log an error', () => __awaiter(void 0, void 0, void 0, function* () {
-        index_1.eventLog.logger.error(logArgs);
-        index_1.eventLog.logger.error(logArgs);
-        const events = yield database_1.database.getAllItems();
-        expect(events).toHaveLength(2);
-        expect(events[0]).toMatchObject(logArgs);
-        expect(events[1]).toMatchObject(logArgs);
-    }));
-    it('should not log an error if logs are disabled', () => __awaiter(void 0, void 0, void 0, function* () {
-        index_1.eventLog.init({
-            publicApiKey: PUBLIC_API_KEY,
-            batchTime: 1000,
-            enableEvents: false,
-            enableLogs: false,
-        });
-        index_1.eventLog.logger.error(logArgs);
-        const events = yield database_1.database.getAllItems();
-        expect(events).toHaveLength(0);
-    }));
-    it('should log a debug message', () => __awaiter(void 0, void 0, void 0, function* () {
-        index_1.eventLog.logger.debug(logArgs);
-        const events = yield database_1.database.getAllItems();
-        expect(events).toHaveLength(1);
-        expect(events[0]).toMatchObject(logArgs);
-    }));
-    it('should not log a debug message if logs are disabled', () => __awaiter(void 0, void 0, void 0, function* () {
-        index_1.eventLog.init({
-            publicApiKey: PUBLIC_API_KEY,
-            batchTime: 1000,
-            enableEvents: false,
-            enableLogs: false,
-        });
-        index_1.eventLog.logger.debug(logArgs);
-        const events = yield database_1.database.getAllItems();
-        expect(events).toHaveLength(0);
-    }));
-    it('should log an info message', () => __awaiter(void 0, void 0, void 0, function* () {
-        index_1.eventLog.logger.info(logArgs);
-        const events = yield database_1.database.getAllItems();
-        expect(events).toHaveLength(1);
-        expect(events[0]).toMatchObject(logArgs);
-    }));
-    it('should not log an info message if logs are disabled', () => __awaiter(void 0, void 0, void 0, function* () {
-        index_1.eventLog.init({
-            publicApiKey: PUBLIC_API_KEY,
-            batchTime: 1000,
-            enableEvents: false,
-            enableLogs: false,
-        });
-        index_1.eventLog.logger.info(logArgs);
-        const events = yield database_1.database.getAllItems();
-        expect(events).toHaveLength(0);
-    }));
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+    describe('event', () => {
+        it('should add an event to the database if events are enabled', () => __awaiter(void 0, void 0, void 0, function* () {
+            eventLog.event(eventArgs, publicApiKey);
+            eventLog.sendBatch();
+            yield new Promise(process.nextTick);
+            expect(mockInterceptRequest).toHaveBeenCalledWith({
+                batch: [
+                    Object.assign(Object.assign({}, eventArgs), { os: browserClientInfo.os, type: types_1.EventLogType.EVENT }),
+                ],
+            });
+        }));
+        it('should not add an event to the database if events are disabled', () => __awaiter(void 0, void 0, void 0, function* () {
+            const publicApiKey = 'testApiKey';
+            eventLog = new index_1.EventLog({
+                organizationName: 'testOrg',
+                enableEvents: false,
+            });
+            eventLog.event(eventArgs, publicApiKey);
+            eventLog.sendBatch();
+            yield new Promise(process.nextTick);
+            expect(mockInterceptRequest).not.toHaveBeenCalled();
+        }));
+    });
+    describe('logger', () => {
+        it('should add an error log to the database if logs are enabled', () => __awaiter(void 0, void 0, void 0, function* () {
+            eventLog.logger.error(logArgs, publicApiKey);
+            eventLog.sendBatch();
+            yield new Promise(process.nextTick);
+            expect(mockInterceptRequest).toHaveBeenCalledWith({
+                batch: [
+                    Object.assign(Object.assign({}, logArgs), { os: browserClientInfo.os, metadata, type: types_1.EventLogType.LOG, level: types_1.Level.ERROR }),
+                ],
+            });
+        }));
+        it('should not add an error log to the database if logs are disabled', () => __awaiter(void 0, void 0, void 0, function* () {
+            const publicApiKey = 'testApiKey';
+            eventLog = new index_1.EventLog({
+                organizationName: 'testOrg',
+                enableEvents: true,
+                enableLogs: false,
+                debug: false,
+            });
+            eventLog.logger.error(logArgs, publicApiKey);
+            eventLog.sendBatch();
+            yield new Promise(process.nextTick);
+            expect(mockInterceptRequest).not.toHaveBeenCalled();
+        }));
+        it('should add a debug log to the database if logs are enabled', () => __awaiter(void 0, void 0, void 0, function* () {
+            eventLog.logger.debug(logArgs, publicApiKey);
+            eventLog.sendBatch();
+            yield new Promise(process.nextTick);
+            expect(mockInterceptRequest).toHaveBeenCalledWith({
+                batch: [
+                    Object.assign(Object.assign({}, logArgs), { os: browserClientInfo.os, metadata, type: types_1.EventLogType.LOG, level: types_1.Level.DEBUG }),
+                ],
+            });
+        }));
+        it('should not add a debug log to the database if logs are disabled', () => __awaiter(void 0, void 0, void 0, function* () {
+            const publicApiKey = 'testApiKey';
+            eventLog = new index_1.EventLog({
+                organizationName: 'testOrg',
+                platform: 'web',
+                enableEvents: true,
+                enableLogs: false,
+                debug: false,
+            });
+            eventLog.logger.debug(logArgs, publicApiKey);
+            eventLog.sendBatch();
+            yield new Promise(process.nextTick);
+            expect(mockInterceptRequest).not.toHaveBeenCalled();
+        }));
+        it('should add an info log to the database if logs are enabled', () => __awaiter(void 0, void 0, void 0, function* () {
+            eventLog.logger.info(logArgs, publicApiKey);
+            eventLog.sendBatch();
+            yield new Promise(process.nextTick);
+            expect(mockInterceptRequest).toHaveBeenCalledWith({
+                batch: [
+                    Object.assign(Object.assign({}, logArgs), { os: browserClientInfo.os, metadata, type: types_1.EventLogType.LOG, level: types_1.Level.INFO }),
+                ],
+            });
+        }));
+        it('should not add an info log to the database if logs are disabled', () => __awaiter(void 0, void 0, void 0, function* () {
+            eventLog = new index_1.EventLog({
+                organizationName: 'testOrg',
+                platform: 'web',
+                enableEvents: true,
+                enableLogs: false,
+                debug: false,
+            });
+            eventLog.sendBatch();
+            yield new Promise(process.nextTick);
+            expect(mockInterceptRequest).not.toHaveBeenCalled();
+        }));
+    });
+    describe('sendBatch', () => {
+        it('should not send a batch of items to the API if there are no items in the database', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield eventLog.sendBatch();
+            yield new Promise(process.nextTick);
+            expect(mockInterceptRequest).not.toHaveBeenCalled();
+        }));
+    });
+    describe('Cron', () => {
+        it('should send a batch of items to the API', () => __awaiter(void 0, void 0, void 0, function* () {
+            eventLog = new index_1.EventLog({
+                organizationName: 'testOrg',
+                platform: 'web',
+                batchTime: 1000,
+                enableEvents: true,
+                enableLogs: true,
+                debug: false,
+            });
+            yield eventLog.event(eventArgs, publicApiKey);
+            yield eventLog.logger.error(logArgs, publicApiKey);
+            yield eventLog.logger.debug(logArgs, publicApiKey);
+            yield eventLog.logger.info(logArgs, publicApiKey);
+            yield new Promise((resolve) => setTimeout(resolve, 1200));
+            expect(mockInterceptRequest).toHaveBeenCalledWith({
+                batch: [
+                    Object.assign(Object.assign({}, eventArgs), { os: browserClientInfo.os, type: types_1.EventLogType.EVENT }),
+                    Object.assign(Object.assign({}, logArgs), { os: browserClientInfo.os, metadata, type: types_1.EventLogType.LOG, level: types_1.Level.ERROR }),
+                    Object.assign(Object.assign({}, logArgs), { os: browserClientInfo.os, metadata, type: types_1.EventLogType.LOG, level: types_1.Level.DEBUG }),
+                    Object.assign(Object.assign({}, logArgs), { os: browserClientInfo.os, metadata, type: types_1.EventLogType.LOG, level: types_1.Level.INFO }),
+                ],
+            });
+        }));
+    });
 });

package/dist/cjs/index.types.d.ts

@@ -1,8 +1,8 @@
 export type InitArgs = {
-    publicApiKey: string;
-    batchTime: number;
-    enableEvents: boolean;
-    enableLogs: boolean;
+    organizationName: string;
+    batchTime?: number;
+    enableEvents?: boolean;
+    enableLogs?: boolean;
     platform?: string;
     debug?: boolean;
 };

package/dist/cjs/index.utils.d.ts

@@ -1,2 +1,5 @@
-import { Level, Log } from './types';
-export declare function setLog(logArgs: Omit<Log, 'level' | 'type'>, level: Level, enableLog: boolean): Promise<void> | undefined;
+import { Database } from './database';
+import { BrowserClientInfo, Level, Log } from './types';
+export declare function setLog(logArgs: Omit<Log, 'level' | 'type'>, level: Level, enableLog: boolean, database: Database, publicApiKey: string, browserInfo: BrowserClientInfo | null): Promise<void> | undefined;
+declare let browserClientInfo: BrowserClientInfo | null;
+export { browserClientInfo };

package/dist/cjs/index.utils.js

@@ -1,12 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setLog = void 0;
-const database_1 = require("./database");
+exports.browserClientInfo = exports.setLog = void 0;
 const types_1 = require("./types");
-function setLog(logArgs, level, enableLog) {
+const utils_1 = require("./utils");
+const utils_2 = require("./utils");
+function setLog(logArgs, level, enableLog, database, publicApiKey, browserInfo) {
     if (!enableLog) {
         return;
     }
-    return database_1.database.setItem(Object.assign(Object.assign({}, logArgs), { level, type: types_1.EventLogType.LOG }));
+    return database.setItem(Object.assign(Object.assign({ os: browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.os }, logArgs), { metadata: Object.assign(Object.assign({}, logArgs.metadata), { browser_info: browserInfo }), level, type: types_1.EventLogType.LOG }), publicApiKey);
 }
 exports.setLog = setLog;
+let browserClientInfo = null;
+exports.browserClientInfo = browserClientInfo;
+if ((0, utils_1.isBrowser)()) {
+    (0, utils_2.clientDetection)().then((clientInfo) => {
+        exports.browserClientInfo = browserClientInfo = clientInfo;
+    });
+}

package/dist/cjs/types/index.d.ts

@@ -23,7 +23,7 @@ export type Log = BaseEventLog & {
     response?: object | null;
     status_code?: string | null;
     trace_id?: string | null;
-    metadata?: unknown | null;
+    metadata?: object | null;
     country?: string | null;
     organization_name?: string | null;
     level: Level;
@@ -38,4 +38,14 @@ export type Event = BaseEventLog & {
     headers?: object;
 };
 export type Batch = Log | Event;
+export type BrowserClientInfo = {
+    screen: string;
+    browser: string;
+    browserVersion: string;
+    browserMajorVersion: number;
+    mobile: boolean;
+    os: string;
+    osVersion: string | number | undefined;
+    cookies: boolean;
+};
 export {};

package/dist/cjs/utils/__tests__/check-environment.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/utils/__tests__/check-environment.test.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const check_environment_1 = require("../check-environment");
+describe('isLocalStorageEnabled', () => {
+    it('should return true if local storage is enabled', () => {
+        expect((0, check_environment_1.isLocalStorageEnabled)()).toBe(true);
+    });
+    it('should return false if local storage is disabled', () => {
+        const localStorageMock = {
+            getItem: jest.fn(() => null),
+            setItem: jest.fn(() => {
+                throw new Error('Local storage is disabled');
+            }),
+            removeItem: jest.fn(() => null),
+        };
+        Object.defineProperty(window, 'localStorage', {
+            value: localStorageMock,
+        });
+        expect((0, check_environment_1.isLocalStorageEnabled)()).toBe(false);
+    });
+});
+describe('isBrowser', () => {
+    it('should return true if running in a browser environment', () => {
+        expect((0, check_environment_1.isBrowser)()).toBe(true);
+    });
+    it('should return false if running in a non-browser environment', () => {
+        const isBrowserMock = new Function('try {return this===window;}catch(e){ return false;}').bind({});
+        expect(isBrowserMock()).toBe(false);
+    });
+});

package/dist/cjs/utils/__tests__/client-detection.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/utils/__tests__/client-detection.test.js

@@ -0,0 +1,40 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-magic-numbers */
+const client_detection_1 = require("../client-detection");
+describe('clientDetection', () => {
+    it('should return an object with screen, browser, browserVersion, browserMajorVersion, mobile, os, osVersion, and cookies properties', () => __awaiter(void 0, void 0, void 0, function* () {
+        const result = yield (0, client_detection_1.clientDetection)();
+        expect(result).toHaveProperty('screen');
+        expect(result).toHaveProperty('browser');
+        expect(result).toHaveProperty('browserVersion');
+        expect(result).toHaveProperty('browserMajorVersion');
+        expect(result).toHaveProperty('mobile');
+        expect(result).toHaveProperty('os');
+        expect(result).toHaveProperty('osVersion');
+        expect(result).toHaveProperty('cookies');
+    }));
+    it('should correctly detect the browser and browser version', () => __awaiter(void 0, void 0, void 0, function* () {
+        const result = yield (0, client_detection_1.clientDetection)();
+        expect(result.browser).toBe('jsdom');
+        expect(result.browserVersion).toBe('20.0.3');
+        expect(result.browserMajorVersion).toBeGreaterThanOrEqual(20);
+    }));
+    it('should correctly detect whether the client is mobile', () => __awaiter(void 0, void 0, void 0, function* () {
+        const result = yield (0, client_detection_1.clientDetection)();
+        expect(result.mobile).toBe(false);
+    }));
+    it('should correctly detect whether cookies are enabled', () => __awaiter(void 0, void 0, void 0, function* () {
+        const result = yield (0, client_detection_1.clientDetection)();
+        expect(result.cookies).toBe(true);
+    }));
+});

package/dist/cjs/utils/check-environment.d.ts

@@ -0,0 +1,2 @@
+export declare function isLocalStorageEnabled(): boolean;
+export declare const isBrowser: Function;

package/dist/cjs/utils/check-environment.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBrowser = exports.isLocalStorageEnabled = void 0;
+function isLocalStorageEnabled() {
+    try {
+        const key = '__yuno_storage__test';
+        window.localStorage.setItem(key, 'test_value');
+        window.localStorage.removeItem(key);
+        return true;
+    }
+    catch (e) {
+        return false;
+    }
+}
+exports.isLocalStorageEnabled = isLocalStorageEnabled;
+// https://stackoverflow.com/questions/17575790/environment-detection-node-js-or-browser
+exports.isBrowser = new Function('try {return this===window;}catch(e){ return false;}');

package/dist/cjs/utils/client-detection.d.ts

@@ -0,0 +1,8 @@
+import { BrowserClientInfo } from '../types';
+/**
+ * JavaScript Client Detection
+ * (C) viazenetti GmbH (Christian Ludwig)
+ * https://stackoverflow.com/questions/9514179/how-to-find-the-operating-system-details-using-javascript
+ * this package is better but too weighty: https://www.npmjs.com/package/ua-parser-js
+ */
+export declare function clientDetection(): Promise<BrowserClientInfo>;