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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. package/dist/cjs/api/__tests__/api.test.js +5 -9
  2. package/dist/cjs/api/api.d.ts +3 -5
  3. package/dist/cjs/api/api.js +12 -10
  4. package/dist/cjs/cron/cron.d.ts +5 -5
  5. package/dist/cjs/cron/cron.js +26 -16
  6. package/dist/cjs/cron/cron.test.js +15 -11
  7. package/dist/cjs/database/database.d.ts +1 -2
  8. package/dist/cjs/database/database.js +5 -16
  9. package/dist/cjs/database/database.test.js +2 -2
  10. package/dist/cjs/database/database.types.d.ts +2 -2
  11. package/dist/cjs/database/index.d.ts +1 -0
  12. package/dist/cjs/database/index.js +1 -0
  13. package/dist/cjs/database/local-storage/local-storage.d.ts +3 -3
  14. package/dist/cjs/database/local-storage/local-storage.js +17 -8
  15. package/dist/cjs/database/local-storage/local-storage.test.js +7 -6
  16. package/dist/cjs/database/memory-storage/memory-storage.d.ts +4 -2
  17. package/dist/cjs/database/memory-storage/memory-storage.js +10 -5
  18. package/dist/cjs/database/memory-storage/memory-storage.test.js +2 -2
  19. package/dist/cjs/index.d.ts +7 -9
  20. package/dist/cjs/index.js +43 -21
  21. package/dist/cjs/index.test.js +168 -86
  22. package/dist/cjs/index.types.d.ts +4 -4
  23. package/dist/cjs/index.utils.d.ts +5 -2
  24. package/dist/cjs/index.utils.js +12 -4
  25. package/dist/cjs/types/index.d.ts +11 -1
  26. package/dist/cjs/utils/__tests__/check-environment.test.d.ts +1 -0
  27. package/dist/cjs/utils/__tests__/check-environment.test.js +30 -0
  28. package/dist/cjs/utils/__tests__/client-detection.test.d.ts +1 -0
  29. package/dist/cjs/utils/__tests__/client-detection.test.js +40 -0
  30. package/dist/cjs/utils/check-environment.d.ts +2 -0
  31. package/dist/cjs/utils/check-environment.js +17 -0
  32. package/dist/cjs/utils/client-detection.d.ts +8 -0
  33. package/dist/cjs/utils/client-detection.js +216 -0
  34. package/dist/cjs/utils/index.d.ts +3 -0
  35. package/dist/cjs/utils/index.js +19 -0
  36. package/dist/cjs/utils/stringyfy.d.ts +1 -0
  37. package/dist/cjs/utils/stringyfy.js +20 -0
  38. package/dist/esm/api/__tests__/api.test.js +5 -9
  39. package/dist/esm/api/api.d.ts +3 -5
  40. package/dist/esm/api/api.js +12 -10
  41. package/dist/esm/cron/cron.d.ts +5 -5
  42. package/dist/esm/cron/cron.js +17 -18
  43. package/dist/esm/cron/cron.test.js +15 -11
  44. package/dist/esm/database/database.d.ts +1 -2
  45. package/dist/esm/database/database.js +5 -16
  46. package/dist/esm/database/database.test.js +2 -2
  47. package/dist/esm/database/database.types.d.ts +2 -2
  48. package/dist/esm/database/index.d.ts +1 -0
  49. package/dist/esm/database/index.js +1 -0
  50. package/dist/esm/database/local-storage/local-storage.d.ts +3 -3
  51. package/dist/esm/database/local-storage/local-storage.js +17 -8
  52. package/dist/esm/database/local-storage/local-storage.test.js +7 -6
  53. package/dist/esm/database/memory-storage/memory-storage.d.ts +4 -2
  54. package/dist/esm/database/memory-storage/memory-storage.js +10 -5
  55. package/dist/esm/database/memory-storage/memory-storage.test.js +2 -2
  56. package/dist/esm/index.d.ts +7 -9
  57. package/dist/esm/index.js +36 -21
  58. package/dist/esm/index.test.js +199 -77
  59. package/dist/esm/index.types.d.ts +4 -4
  60. package/dist/esm/index.utils.d.ts +5 -2
  61. package/dist/esm/index.utils.js +21 -4
  62. package/dist/esm/types/index.d.ts +11 -1
  63. package/dist/esm/utils/__tests__/check-environment.test.d.ts +1 -0
  64. package/dist/esm/utils/__tests__/check-environment.test.js +30 -0
  65. package/dist/esm/utils/__tests__/client-detection.test.d.ts +1 -0
  66. package/dist/esm/utils/__tests__/client-detection.test.js +31 -0
  67. package/dist/esm/utils/check-environment.d.ts +2 -0
  68. package/dist/esm/utils/check-environment.js +17 -0
  69. package/dist/esm/utils/client-detection.d.ts +8 -0
  70. package/dist/esm/utils/client-detection.js +205 -0
  71. package/dist/esm/utils/index.d.ts +3 -0
  72. package/dist/esm/utils/index.js +19 -0
  73. package/dist/esm/utils/stringyfy.d.ts +1 -0
  74. package/dist/esm/utils/stringyfy.js +20 -0
  75. package/package.json +4 -4
@@ -12,19 +12,20 @@ const batch = {
12
12
  describe('LocalStorageDatabase', () => {
13
13
  let localStorageDatabase;
14
14
  beforeEach(() => {
15
- localStorageDatabase = new local_storage_1.LocalStorage();
15
+ localStorageDatabase = new local_storage_1.LocalStorage('test');
16
16
  });
17
17
  afterEach(() => {
18
18
  localStorage.clear();
19
19
  });
20
20
  it('should set an item in the database', async () => {
21
- await localStorageDatabase.setItem(batch);
22
- const database = JSON.parse(localStorage.getItem('YUNO_EVENT_LOGS') || '[]');
23
- expect(database).toContainEqual(batch);
21
+ const testKey = 'testKey';
22
+ await localStorageDatabase.setItem(batch, testKey);
23
+ const database = JSON.parse(localStorage.getItem('YUNO_EVENT_LOGS_test') || '[]');
24
+ expect(database).toEqual({ [testKey]: [batch] });
24
25
  });
25
26
  it('should get an item from the database', async () => {
26
- localStorage.setItem('YUNO_EVENT_LOGS', JSON.stringify([batch]));
27
+ localStorage.setItem('YUNO_EVENT_LOGS_test', JSON.stringify({ testKey: [batch] }));
27
28
  const result = await localStorageDatabase.getAllItems();
28
- expect(result).toEqual([batch]);
29
+ expect(result).toEqual({ testKey: [batch] });
29
30
  });
30
31
  });
@@ -4,8 +4,10 @@ export declare class MemoryStorage implements Database {
4
4
  #private;
5
5
  constructor();
6
6
  reset(): Promise<void>;
7
- setItem(item: Batch): Promise<void>;
7
+ setItem(item: Batch, publicApiKey: string): Promise<void>;
8
8
  getItem(id: string): Promise<Batch>;
9
9
  removeItem(id: string): Promise<void>;
10
- getAllItems(): Promise<Batch[]>;
10
+ getAllItems(): Promise<{
11
+ [x: string]: Batch[];
12
+ }>;
11
13
  }
@@ -16,13 +16,16 @@ exports.MemoryStorage = void 0;
16
16
  class MemoryStorage {
17
17
  constructor() {
18
18
  _MemoryStorage_items.set(this, void 0);
19
- __classPrivateFieldSet(this, _MemoryStorage_items, [], "f");
19
+ __classPrivateFieldSet(this, _MemoryStorage_items, {}, "f");
20
20
  }
21
21
  async reset() {
22
- __classPrivateFieldSet(this, _MemoryStorage_items, [], "f");
22
+ __classPrivateFieldSet(this, _MemoryStorage_items, {}, "f");
23
23
  }
24
- async setItem(item) {
25
- __classPrivateFieldGet(this, _MemoryStorage_items, "f").push(item);
24
+ async setItem(item, publicApiKey) {
25
+ if (__classPrivateFieldGet(this, _MemoryStorage_items, "f")[publicApiKey] === undefined) {
26
+ __classPrivateFieldGet(this, _MemoryStorage_items, "f")[publicApiKey] = [];
27
+ }
28
+ __classPrivateFieldGet(this, _MemoryStorage_items, "f")[publicApiKey].push(item);
26
29
  }
27
30
  getItem(id) {
28
31
  throw new Error('Method not implemented.' + id);
@@ -31,7 +34,9 @@ class MemoryStorage {
31
34
  throw new Error('Method not implemented.' + id);
32
35
  }
33
36
  getAllItems() {
34
- return Promise.resolve(__classPrivateFieldGet(this, _MemoryStorage_items, "f"));
37
+ const items = { ...__classPrivateFieldGet(this, _MemoryStorage_items, "f") };
38
+ this.reset();
39
+ return Promise.resolve(items);
35
40
  }
36
41
  }
37
42
  exports.MemoryStorage = MemoryStorage;
@@ -18,8 +18,8 @@ describe('MemoryStorage', () => {
18
18
  memoryStorage.reset();
19
19
  });
20
20
  it('should set an item in the database', async () => {
21
- await memoryStorage.setItem(batch);
21
+ await memoryStorage.setItem(batch, 'testKey');
22
22
  const database = await memoryStorage.getAllItems();
23
- expect(database).toEqual([batch]);
23
+ expect(database).toEqual({ testKey: [batch] });
24
24
  });
25
25
  });
@@ -1,15 +1,13 @@
1
1
  import { InitArgs } from './index.types';
2
- import './database';
3
2
  import { Event, Log } from './types';
4
- declare class EventLog {
3
+ export declare class EventLog {
5
4
  #private;
6
- init({ publicApiKey, platform, batchTime, enableEvents, enableLogs, debug }: InitArgs): void;
7
- event(eventArgs: Omit<Event, 'type'>): Promise<void> | undefined;
5
+ constructor({ organizationName, platform, batchTime, enableEvents, enableLogs, debug, }: InitArgs);
6
+ event(eventArgs: Omit<Event, 'type'>, publicApiKey: string): Promise<void> | undefined;
8
7
  logger: {
9
- error: (errorArgs: Omit<Log, 'level' | 'type'>) => Promise<void> | undefined;
10
- debug: (debugArgs: Omit<Log, 'level' | 'type'>) => Promise<void> | undefined;
11
- info: (infoArgs: Omit<Log, 'level' | 'type'>) => Promise<void> | undefined;
8
+ error: (errorArgs: Omit<Log, 'level' | 'type'>, publicApiKey: string) => Promise<void> | undefined;
9
+ debug: (debugArgs: Omit<Log, 'level' | 'type'>, publicApiKey: string) => Promise<void> | undefined;
10
+ info: (infoArgs: Omit<Log, 'level' | 'type'>, publicApiKey: string) => Promise<void> | undefined;
12
11
  };
12
+ sendBatch(): Promise<void>;
13
13
  }
14
- export declare const eventLog: EventLog;
15
- export {};
package/dist/esm/index.js CHANGED
@@ -10,43 +10,58 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
10
10
  if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
11
11
  return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
12
12
  };
13
- var _EventLog_enableEvents, _EventLog_enableLogs;
13
+ var _EventLog_enableEvents, _EventLog_enableLogs, _EventLog_api, _EventLog_database;
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.eventLog = void 0;
15
+ exports.EventLog = void 0;
16
16
  const api_1 = require("./api");
17
- require("./database");
18
17
  const cron_1 = require("./cron");
19
18
  const types_1 = require("./types");
20
19
  const database_1 = require("./database");
21
20
  const index_utils_1 = require("./index.utils");
22
21
  class EventLog {
23
- constructor() {
24
- _EventLog_enableEvents.set(this, false);
25
- _EventLog_enableLogs.set(this, false);
22
+ constructor({ organizationName, platform = 'web', batchTime, enableEvents = true, enableLogs = true, debug = false, }) {
23
+ _EventLog_enableEvents.set(this, void 0);
24
+ _EventLog_enableLogs.set(this, void 0);
25
+ _EventLog_api.set(this, void 0);
26
+ _EventLog_database.set(this, void 0);
26
27
  this.logger = {
27
- error: (errorArgs) => {
28
- return (0, index_utils_1.setLog)(errorArgs, types_1.Level.ERROR, __classPrivateFieldGet(this, _EventLog_enableLogs, "f"));
28
+ error: (errorArgs, publicApiKey) => {
29
+ return (0, index_utils_1.setLog)(errorArgs, types_1.Level.ERROR, __classPrivateFieldGet(this, _EventLog_enableLogs, "f"), __classPrivateFieldGet(this, _EventLog_database, "f"), publicApiKey, index_utils_1.browserClientInfo);
29
30
  },
30
- debug: (debugArgs) => {
31
- return (0, index_utils_1.setLog)(debugArgs, types_1.Level.DEBUG, __classPrivateFieldGet(this, _EventLog_enableLogs, "f"));
31
+ debug: (debugArgs, publicApiKey) => {
32
+ return (0, index_utils_1.setLog)(debugArgs, types_1.Level.DEBUG, __classPrivateFieldGet(this, _EventLog_enableLogs, "f"), __classPrivateFieldGet(this, _EventLog_database, "f"), publicApiKey, index_utils_1.browserClientInfo);
33
+ },
34
+ info: (infoArgs, publicApiKey) => {
35
+ return (0, index_utils_1.setLog)(infoArgs, types_1.Level.INFO, __classPrivateFieldGet(this, _EventLog_enableLogs, "f"), __classPrivateFieldGet(this, _EventLog_database, "f"), publicApiKey, index_utils_1.browserClientInfo);
32
36
  },
33
- info: (infoArgs) => {
34
- return (0, index_utils_1.setLog)(infoArgs, types_1.Level.INFO, __classPrivateFieldGet(this, _EventLog_enableLogs, "f"));
35
- }
36
37
  };
37
- }
38
- init({ publicApiKey, platform = 'web', batchTime, enableEvents, enableLogs, debug = false }) {
39
38
  __classPrivateFieldSet(this, _EventLog_enableEvents, enableEvents, "f");
40
39
  __classPrivateFieldSet(this, _EventLog_enableLogs, enableLogs, "f");
41
- api_1.api.init(publicApiKey, platform, debug);
42
- cron_1.cron.init(batchTime);
40
+ __classPrivateFieldSet(this, _EventLog_api, new api_1.Api(platform, debug), "f");
41
+ __classPrivateFieldSet(this, _EventLog_database, (0, database_1.databaseFactory)(organizationName), "f");
42
+ if (batchTime) {
43
+ new cron_1.Cron(batchTime, __classPrivateFieldGet(this, _EventLog_api, "f"), __classPrivateFieldGet(this, _EventLog_database, "f"));
44
+ }
43
45
  }
44
- event(eventArgs) {
46
+ event(eventArgs, publicApiKey) {
45
47
  if (!__classPrivateFieldGet(this, _EventLog_enableEvents, "f")) {
46
48
  return;
47
49
  }
48
- return database_1.database.setItem({ ...eventArgs, type: types_1.EventLogType.EVENT });
50
+ return __classPrivateFieldGet(this, _EventLog_database, "f").setItem({
51
+ os: index_utils_1.browserClientInfo === null || index_utils_1.browserClientInfo === void 0 ? void 0 : index_utils_1.browserClientInfo.os,
52
+ ...eventArgs,
53
+ type: types_1.EventLogType.EVENT,
54
+ }, publicApiKey);
55
+ }
56
+ async sendBatch() {
57
+ const items = await __classPrivateFieldGet(this, _EventLog_database, "f").getAllItems();
58
+ const keys = Object.keys(items);
59
+ if (keys.length) {
60
+ for (const key of keys) {
61
+ __classPrivateFieldGet(this, _EventLog_api, "f").sendBatch(items[key], key);
62
+ }
63
+ }
49
64
  }
50
65
  }
51
- _EventLog_enableEvents = new WeakMap(), _EventLog_enableLogs = new WeakMap();
52
- exports.eventLog = new EventLog();
66
+ exports.EventLog = EventLog;
67
+ _EventLog_enableEvents = new WeakMap(), _EventLog_enableLogs = new WeakMap(), _EventLog_api = new WeakMap(), _EventLog_database = new WeakMap();
@@ -1,9 +1,10 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ /* eslint-disable no-magic-numbers */
3
4
  const index_1 = require("./index");
4
- const database_1 = require("./database");
5
- const cron_1 = require("./cron");
6
- const PUBLIC_API_KEY = 'staging_gAAAAABj-NC2WEf3XA4lHnN6RfGbjETf6qL27jlU7c1tm01ERV-Y-E6ddee1QPyV_CA8cxjVlGy-qDNA2-mqa9msQlTJit-Fmbvv6f2AZdfbFd_CUo1stvixnF4_8MzM_IYVWYz7KK86VfEBvxNpjRCyp7BDef-QzrT1-yqa8HAYTuA1GU3Hjjo=';
5
+ const types_1 = require("./types");
6
+ const node_1 = require("msw/node");
7
+ const msw_1 = require("msw");
7
8
  const eventArgs = {
8
9
  source: 'test',
9
10
  event: 'testEvent',
@@ -15,92 +16,213 @@ const logArgs = {
15
16
  url: '',
16
17
  method: '',
17
18
  country: '',
18
- original_created_at: new Date().toISOString()
19
+ original_created_at: new Date().toISOString(),
20
+ };
21
+ const browserClientInfo = {
22
+ browser: 'jsdom',
23
+ browserMajorVersion: 20,
24
+ browserVersion: '20.0.3',
25
+ cookies: true,
26
+ mobile: false,
27
+ os: '-',
28
+ osVersion: '-',
29
+ screen: '',
19
30
  };
31
+ const metadata = {
32
+ browser_info: browserClientInfo,
33
+ };
34
+ const publicApiKey = 'prod_1';
35
+ let mockInterceptRequest = jest.fn();
36
+ const server = (0, node_1.setupServer)(
37
+ // Describe the requests to mock.
38
+ msw_1.rest.post('https://api.y.uno/v1/sdk/event-log/publish', (req, res, ctx) => {
39
+ mockInterceptRequest(req.body);
40
+ return res(ctx.status(200));
41
+ }));
20
42
  describe('EventLog', () => {
43
+ let eventLog;
44
+ beforeAll(() => {
45
+ mockInterceptRequest = jest.fn();
46
+ server.listen();
47
+ });
48
+ // Reset any request handlers that we may add during the tests,
49
+ // so they don't affect other tests.
50
+ afterEach(() => server.resetHandlers());
51
+ // Clean up after the tests are finished.
52
+ afterAll(() => server.close());
21
53
  beforeEach(() => {
22
- // Reset the database before each test
23
- // to ensure a clean slate
24
- index_1.eventLog.init({
25
- publicApiKey: PUBLIC_API_KEY,
26
- batchTime: 500,
27
- enableEvents: true,
28
- enableLogs: true,
54
+ eventLog = new index_1.EventLog({
55
+ organizationName: 'testOrg',
56
+ debug: false,
29
57
  });
30
- database_1.database.reset();
31
58
  });
32
- afterEach(async () => {
33
- await new Promise((resolve) => setTimeout(resolve, 1000));
34
- cron_1.cron.stop();
59
+ afterEach(() => {
60
+ jest.clearAllMocks();
35
61
  });
36
- it('should add an event to the database', async () => {
37
- index_1.eventLog.event(eventArgs);
38
- const events = await database_1.database.getAllItems();
39
- expect(events).toHaveLength(1);
40
- expect(events[0]).toMatchObject(eventArgs);
41
- });
42
- it('should not add an event to the database if events are disabled', async () => {
43
- index_1.eventLog.init({
44
- publicApiKey: PUBLIC_API_KEY,
45
- batchTime: 1000,
46
- enableEvents: false,
47
- enableLogs: true,
62
+ describe('event', () => {
63
+ it('should add an event to the database if events are enabled', async () => {
64
+ eventLog.event(eventArgs, publicApiKey);
65
+ eventLog.sendBatch();
66
+ await new Promise(process.nextTick);
67
+ expect(mockInterceptRequest).toHaveBeenCalledWith({
68
+ batch: [
69
+ { ...eventArgs, os: browserClientInfo.os, type: types_1.EventLogType.EVENT },
70
+ ],
71
+ });
48
72
  });
49
- index_1.eventLog.event(eventArgs);
50
- const events = await database_1.database.getAllItems();
51
- expect(events).toHaveLength(0);
52
- });
53
- it('should log an error', async () => {
54
- index_1.eventLog.logger.error(logArgs);
55
- index_1.eventLog.logger.error(logArgs);
56
- const events = await database_1.database.getAllItems();
57
- expect(events).toHaveLength(2);
58
- expect(events[0]).toMatchObject(logArgs);
59
- expect(events[1]).toMatchObject(logArgs);
60
- });
61
- it('should not log an error if logs are disabled', async () => {
62
- index_1.eventLog.init({
63
- publicApiKey: PUBLIC_API_KEY,
64
- batchTime: 1000,
65
- enableEvents: false,
66
- enableLogs: false,
73
+ it('should not add an event to the database if events are disabled', async () => {
74
+ const publicApiKey = 'testApiKey';
75
+ eventLog = new index_1.EventLog({
76
+ organizationName: 'testOrg',
77
+ enableEvents: false,
78
+ });
79
+ eventLog.event(eventArgs, publicApiKey);
80
+ eventLog.sendBatch();
81
+ await new Promise(process.nextTick);
82
+ expect(mockInterceptRequest).not.toHaveBeenCalled();
67
83
  });
68
- index_1.eventLog.logger.error(logArgs);
69
- const events = await database_1.database.getAllItems();
70
- expect(events).toHaveLength(0);
71
84
  });
72
- it('should log a debug message', async () => {
73
- index_1.eventLog.logger.debug(logArgs);
74
- const events = await database_1.database.getAllItems();
75
- expect(events).toHaveLength(1);
76
- expect(events[0]).toMatchObject(logArgs);
77
- });
78
- it('should not log a debug message if logs are disabled', async () => {
79
- index_1.eventLog.init({
80
- publicApiKey: PUBLIC_API_KEY,
81
- batchTime: 1000,
82
- enableEvents: false,
83
- enableLogs: false,
85
+ describe('logger', () => {
86
+ it('should add an error log to the database if logs are enabled', async () => {
87
+ eventLog.logger.error(logArgs, publicApiKey);
88
+ eventLog.sendBatch();
89
+ await new Promise(process.nextTick);
90
+ expect(mockInterceptRequest).toHaveBeenCalledWith({
91
+ batch: [
92
+ {
93
+ ...logArgs,
94
+ os: browserClientInfo.os,
95
+ metadata,
96
+ type: types_1.EventLogType.LOG,
97
+ level: types_1.Level.ERROR,
98
+ },
99
+ ],
100
+ });
101
+ });
102
+ it('should not add an error log to the database if logs are disabled', async () => {
103
+ const publicApiKey = 'testApiKey';
104
+ eventLog = new index_1.EventLog({
105
+ organizationName: 'testOrg',
106
+ enableEvents: true,
107
+ enableLogs: false,
108
+ debug: false,
109
+ });
110
+ eventLog.logger.error(logArgs, publicApiKey);
111
+ eventLog.sendBatch();
112
+ await new Promise(process.nextTick);
113
+ expect(mockInterceptRequest).not.toHaveBeenCalled();
114
+ });
115
+ it('should add a debug log to the database if logs are enabled', async () => {
116
+ eventLog.logger.debug(logArgs, publicApiKey);
117
+ eventLog.sendBatch();
118
+ await new Promise(process.nextTick);
119
+ expect(mockInterceptRequest).toHaveBeenCalledWith({
120
+ batch: [
121
+ {
122
+ ...logArgs,
123
+ os: browserClientInfo.os,
124
+ metadata,
125
+ type: types_1.EventLogType.LOG,
126
+ level: types_1.Level.DEBUG,
127
+ },
128
+ ],
129
+ });
130
+ });
131
+ it('should not add a debug log to the database if logs are disabled', async () => {
132
+ const publicApiKey = 'testApiKey';
133
+ eventLog = new index_1.EventLog({
134
+ organizationName: 'testOrg',
135
+ platform: 'web',
136
+ enableEvents: true,
137
+ enableLogs: false,
138
+ debug: false,
139
+ });
140
+ eventLog.logger.debug(logArgs, publicApiKey);
141
+ eventLog.sendBatch();
142
+ await new Promise(process.nextTick);
143
+ expect(mockInterceptRequest).not.toHaveBeenCalled();
144
+ });
145
+ it('should add an info log to the database if logs are enabled', async () => {
146
+ eventLog.logger.info(logArgs, publicApiKey);
147
+ eventLog.sendBatch();
148
+ await new Promise(process.nextTick);
149
+ expect(mockInterceptRequest).toHaveBeenCalledWith({
150
+ batch: [
151
+ {
152
+ ...logArgs,
153
+ os: browserClientInfo.os,
154
+ metadata,
155
+ type: types_1.EventLogType.LOG,
156
+ level: types_1.Level.INFO,
157
+ },
158
+ ],
159
+ });
160
+ });
161
+ it('should not add an info log to the database if logs are disabled', async () => {
162
+ eventLog = new index_1.EventLog({
163
+ organizationName: 'testOrg',
164
+ platform: 'web',
165
+ enableEvents: true,
166
+ enableLogs: false,
167
+ debug: false,
168
+ });
169
+ eventLog.sendBatch();
170
+ await new Promise(process.nextTick);
171
+ expect(mockInterceptRequest).not.toHaveBeenCalled();
84
172
  });
85
- index_1.eventLog.logger.debug(logArgs);
86
- const events = await database_1.database.getAllItems();
87
- expect(events).toHaveLength(0);
88
173
  });
89
- it('should log an info message', async () => {
90
- index_1.eventLog.logger.info(logArgs);
91
- const events = await database_1.database.getAllItems();
92
- expect(events).toHaveLength(1);
93
- expect(events[0]).toMatchObject(logArgs);
174
+ describe('sendBatch', () => {
175
+ it('should not send a batch of items to the API if there are no items in the database', async () => {
176
+ await eventLog.sendBatch();
177
+ await new Promise(process.nextTick);
178
+ expect(mockInterceptRequest).not.toHaveBeenCalled();
179
+ });
94
180
  });
95
- it('should not log an info message if logs are disabled', async () => {
96
- index_1.eventLog.init({
97
- publicApiKey: PUBLIC_API_KEY,
98
- batchTime: 1000,
99
- enableEvents: false,
100
- enableLogs: false,
181
+ describe('Cron', () => {
182
+ it('should send a batch of items to the API', async () => {
183
+ eventLog = new index_1.EventLog({
184
+ organizationName: 'testOrg',
185
+ platform: 'web',
186
+ batchTime: 1000,
187
+ enableEvents: true,
188
+ enableLogs: true,
189
+ debug: false,
190
+ });
191
+ await eventLog.event(eventArgs, publicApiKey);
192
+ await eventLog.logger.error(logArgs, publicApiKey);
193
+ await eventLog.logger.debug(logArgs, publicApiKey);
194
+ await eventLog.logger.info(logArgs, publicApiKey);
195
+ await new Promise((resolve) => setTimeout(resolve, 1200));
196
+ expect(mockInterceptRequest).toHaveBeenCalledWith({
197
+ batch: [
198
+ {
199
+ ...eventArgs,
200
+ os: browserClientInfo.os,
201
+ type: types_1.EventLogType.EVENT,
202
+ },
203
+ {
204
+ ...logArgs,
205
+ os: browserClientInfo.os,
206
+ metadata,
207
+ type: types_1.EventLogType.LOG,
208
+ level: types_1.Level.ERROR,
209
+ },
210
+ {
211
+ ...logArgs,
212
+ os: browserClientInfo.os,
213
+ metadata,
214
+ type: types_1.EventLogType.LOG,
215
+ level: types_1.Level.DEBUG,
216
+ },
217
+ {
218
+ ...logArgs,
219
+ os: browserClientInfo.os,
220
+ metadata,
221
+ type: types_1.EventLogType.LOG,
222
+ level: types_1.Level.INFO,
223
+ },
224
+ ],
225
+ });
101
226
  });
102
- index_1.eventLog.logger.info(logArgs);
103
- const events = await database_1.database.getAllItems();
104
- expect(events).toHaveLength(0);
105
227
  });
106
228
  });
@@ -1,8 +1,8 @@
1
1
  export type InitArgs = {
2
- publicApiKey: string;
3
- batchTime: number;
4
- enableEvents: boolean;
5
- enableLogs: boolean;
2
+ organizationName: string;
3
+ batchTime?: number;
4
+ enableEvents?: boolean;
5
+ enableLogs?: boolean;
6
6
  platform?: string;
7
7
  debug?: boolean;
8
8
  };
@@ -1,2 +1,5 @@
1
- import { Level, Log } from './types';
2
- export declare function setLog(logArgs: Omit<Log, 'level' | 'type'>, level: Level, enableLog: boolean): Promise<void> | undefined;
1
+ import { Database } from './database';
2
+ import { BrowserClientInfo, Level, Log } from './types';
3
+ export declare function setLog(logArgs: Omit<Log, 'level' | 'type'>, level: Level, enableLog: boolean, database: Database, publicApiKey: string, browserInfo: BrowserClientInfo | null): Promise<void> | undefined;
4
+ declare let browserClientInfo: BrowserClientInfo | null;
5
+ export { browserClientInfo };
@@ -1,12 +1,29 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.setLog = void 0;
4
- const database_1 = require("./database");
3
+ exports.browserClientInfo = exports.setLog = void 0;
5
4
  const types_1 = require("./types");
6
- function setLog(logArgs, level, enableLog) {
5
+ const utils_1 = require("./utils");
6
+ const utils_2 = require("./utils");
7
+ function setLog(logArgs, level, enableLog, database, publicApiKey, browserInfo) {
7
8
  if (!enableLog) {
8
9
  return;
9
10
  }
10
- return database_1.database.setItem({ ...logArgs, level, type: types_1.EventLogType.LOG });
11
+ return database.setItem({
12
+ os: browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.os,
13
+ ...logArgs,
14
+ metadata: {
15
+ ...logArgs.metadata,
16
+ browser_info: browserInfo,
17
+ },
18
+ level,
19
+ type: types_1.EventLogType.LOG,
20
+ }, publicApiKey);
11
21
  }
12
22
  exports.setLog = setLog;
23
+ let browserClientInfo = null;
24
+ exports.browserClientInfo = browserClientInfo;
25
+ if ((0, utils_1.isBrowser)()) {
26
+ (0, utils_2.clientDetection)().then((clientInfo) => {
27
+ exports.browserClientInfo = browserClientInfo = clientInfo;
28
+ });
29
+ }
@@ -23,7 +23,7 @@ export type Log = BaseEventLog & {
23
23
  response?: object | null;
24
24
  status_code?: string | null;
25
25
  trace_id?: string | null;
26
- metadata?: unknown | null;
26
+ metadata?: object | null;
27
27
  country?: string | null;
28
28
  organization_name?: string | null;
29
29
  level: Level;
@@ -38,4 +38,14 @@ export type Event = BaseEventLog & {
38
38
  headers?: object;
39
39
  };
40
40
  export type Batch = Log | Event;
41
+ export type BrowserClientInfo = {
42
+ screen: string;
43
+ browser: string;
44
+ browserVersion: string;
45
+ browserMajorVersion: number;
46
+ mobile: boolean;
47
+ os: string;
48
+ osVersion: string | number | undefined;
49
+ cookies: boolean;
50
+ };
41
51
  export {};
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const check_environment_1 = require("../check-environment");
4
+ describe('isLocalStorageEnabled', () => {
5
+ it('should return true if local storage is enabled', () => {
6
+ expect((0, check_environment_1.isLocalStorageEnabled)()).toBe(true);
7
+ });
8
+ it('should return false if local storage is disabled', () => {
9
+ const localStorageMock = {
10
+ getItem: jest.fn(() => null),
11
+ setItem: jest.fn(() => {
12
+ throw new Error('Local storage is disabled');
13
+ }),
14
+ removeItem: jest.fn(() => null),
15
+ };
16
+ Object.defineProperty(window, 'localStorage', {
17
+ value: localStorageMock,
18
+ });
19
+ expect((0, check_environment_1.isLocalStorageEnabled)()).toBe(false);
20
+ });
21
+ });
22
+ describe('isBrowser', () => {
23
+ it('should return true if running in a browser environment', () => {
24
+ expect((0, check_environment_1.isBrowser)()).toBe(true);
25
+ });
26
+ it('should return false if running in a non-browser environment', () => {
27
+ const isBrowserMock = new Function('try {return this===window;}catch(e){ return false;}').bind({});
28
+ expect(isBrowserMock()).toBe(false);
29
+ });
30
+ });
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ /* eslint-disable no-magic-numbers */
4
+ const client_detection_1 = require("../client-detection");
5
+ describe('clientDetection', () => {
6
+ it('should return an object with screen, browser, browserVersion, browserMajorVersion, mobile, os, osVersion, and cookies properties', async () => {
7
+ const result = await (0, client_detection_1.clientDetection)();
8
+ expect(result).toHaveProperty('screen');
9
+ expect(result).toHaveProperty('browser');
10
+ expect(result).toHaveProperty('browserVersion');
11
+ expect(result).toHaveProperty('browserMajorVersion');
12
+ expect(result).toHaveProperty('mobile');
13
+ expect(result).toHaveProperty('os');
14
+ expect(result).toHaveProperty('osVersion');
15
+ expect(result).toHaveProperty('cookies');
16
+ });
17
+ it('should correctly detect the browser and browser version', async () => {
18
+ const result = await (0, client_detection_1.clientDetection)();
19
+ expect(result.browser).toBe('jsdom');
20
+ expect(result.browserVersion).toBe('20.0.3');
21
+ expect(result.browserMajorVersion).toBeGreaterThanOrEqual(20);
22
+ });
23
+ it('should correctly detect whether the client is mobile', async () => {
24
+ const result = await (0, client_detection_1.clientDetection)();
25
+ expect(result.mobile).toBe(false);
26
+ });
27
+ it('should correctly detect whether cookies are enabled', async () => {
28
+ const result = await (0, client_detection_1.clientDetection)();
29
+ expect(result.cookies).toBe(true);
30
+ });
31
+ });
@@ -0,0 +1,2 @@
1
+ export declare function isLocalStorageEnabled(): boolean;
2
+ export declare const isBrowser: Function;