@flusys/nestjs-notification 6.0.1 → 6.1.0

package/cjs/services/notification-datasource.provider.spec.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+const _modules = require("@flusys/nestjs-shared/modules");
+const _notificationdatasourceprovider = require("./notification-datasource.provider");
+const _entities = require("../entities");
+function buildConfigService(overrides = {}) {
+    return {
+        isCompanyFeatureEnabled: jest.fn().mockReturnValue(false),
+        getDatabaseMode: jest.fn().mockReturnValue('single'),
+        isMultiTenant: jest.fn().mockReturnValue(false),
+        getJwtSecret: jest.fn().mockReturnValue(undefined),
+        getOptions: jest.fn().mockReturnValue({
+            bootstrapAppConfig: {
+                databaseMode: 'single',
+                enableCompanyFeature: false
+            },
+            config: {
+                defaultDatabaseConfig: {
+                    type: 'mysql',
+                    host: 'localhost',
+                    port: 3306,
+                    username: 'root',
+                    password: 'pass',
+                    database: 'flusys'
+                },
+                tenants: []
+            }
+        }),
+        ...overrides
+    };
+}
+describe('NotificationDataSourceProvider', ()=>{
+    let configService;
+    let provider;
+    beforeEach(()=>{
+        configService = buildConfigService();
+        provider = new _notificationdatasourceprovider.NotificationDataSourceProvider(configService, undefined);
+    });
+    describe('getEnableCompanyFeatureForTenant', ()=>{
+        it('returns the tenant override when the tenant explicitly enables the company feature', ()=>{
+            const result = provider.getEnableCompanyFeatureForTenant({
+                id: 'tenant-1',
+                database: 'tenant_db',
+                enableCompanyFeature: true
+            });
+            expect(result).toBe(true);
+            expect(configService.isCompanyFeatureEnabled).not.toHaveBeenCalled();
+        });
+        it('returns the tenant override when the tenant explicitly disables the company feature', ()=>{
+            const result = provider.getEnableCompanyFeatureForTenant({
+                id: 'tenant-1',
+                database: 'tenant_db',
+                enableCompanyFeature: false
+            });
+            expect(result).toBe(false);
+        });
+        it('falls back to the config service when the tenant has no override', ()=>{
+            configService.isCompanyFeatureEnabled.mockReturnValue(true);
+            const result = provider.getEnableCompanyFeatureForTenant(undefined);
+            expect(result).toBe(true);
+            expect(configService.isCompanyFeatureEnabled).toHaveBeenCalled();
+        });
+    });
+    describe('getNotificationEntities', ()=>{
+        it('returns [NotificationWithCompany] when enableCompanyFeature is explicitly true', async ()=>{
+            const entities = await provider.getNotificationEntities(true);
+            expect(entities).toEqual([
+                _entities.NotificationWithCompany
+            ]);
+        });
+        it('returns [Notification] when enableCompanyFeature is explicitly false', async ()=>{
+            const entities = await provider.getNotificationEntities(false);
+            expect(entities).toEqual([
+                _entities.Notification
+            ]);
+        });
+        it('falls back to the config service when enableCompanyFeature is not provided', async ()=>{
+            configService.isCompanyFeatureEnabled.mockReturnValue(true);
+            const entities = await provider.getNotificationEntities();
+            expect(entities).toEqual([
+                _entities.NotificationWithCompany
+            ]);
+            expect(configService.isCompanyFeatureEnabled).toHaveBeenCalled();
+        });
+    });
+    describe('createDataSourceFromConfig', ()=>{
+        it('resolves company-aware entities and delegates to the parent implementation', async ()=>{
+            configService.isCompanyFeatureEnabled.mockReturnValue(true);
+            const fakeDataSource = {};
+            const superSpy = jest.spyOn(_modules.MultiTenantDataSourceService.prototype, 'createDataSourceFromConfig').mockResolvedValue(fakeDataSource);
+            const config = {
+                type: 'mysql',
+                host: 'localhost',
+                port: 3306,
+                username: 'root',
+                password: 'pass',
+                database: 'flusys'
+            };
+            const result = await provider.createDataSourceFromConfig(config);
+            expect(result).toBe(fakeDataSource);
+            expect(superSpy).toHaveBeenCalledWith(config, [
+                _entities.NotificationWithCompany
+            ]);
+            superSpy.mockRestore();
+        });
+        it('resolves core entities when the company feature is disabled', async ()=>{
+            configService.isCompanyFeatureEnabled.mockReturnValue(false);
+            const fakeDataSource = {};
+            const superSpy = jest.spyOn(_modules.MultiTenantDataSourceService.prototype, 'createDataSourceFromConfig').mockResolvedValue(fakeDataSource);
+            const config = {
+                type: 'mysql',
+                host: 'localhost',
+                port: 3306,
+                username: 'root',
+                password: 'pass',
+                database: 'flusys'
+            };
+            await provider.createDataSourceFromConfig(config);
+            expect(superSpy).toHaveBeenCalledWith(config, [
+                _entities.Notification
+            ]);
+            superSpy.mockRestore();
+        });
+    });
+    describe('inherited configuration accessors', ()=>{
+        it('reports single database mode by default', ()=>{
+            expect(provider.getDatabaseMode()).toBe('single');
+            expect(provider.isMultiTenant()).toBe(false);
+        });
+        it('returns null for the current tenant when no request is bound', ()=>{
+            expect(provider.getCurrentTenant()).toBeNull();
+        });
+    });
+});

package/cjs/services/notification-helper.service.spec.js

@@ -0,0 +1,306 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+const _testing = require("@nestjs/testing");
+const _modules = require("@flusys/nestjs-shared/modules");
+const _enums = require("@flusys/nestjs-shared/enums");
+const _notificationhelperservice = require("./notification-helper.service");
+const _notificationconfigservice = require("./notification-config.service");
+const _notificationdatasourceprovider = require("./notification-datasource.provider");
+const _gateways = require("../gateways");
+const _entities = require("../entities");
+function createMockRepo() {
+    return {
+        save: jest.fn()
+    };
+}
+function createMockDataSource(repo) {
+    return {
+        getRepository: jest.fn().mockReturnValue(repo)
+    };
+}
+describe('NotificationHelperService', ()=>{
+    let mockCacheManager;
+    let mockUtilsService;
+    let mockConfigService;
+    let mockDataSourceProvider;
+    let mockGateway;
+    let mockRepo;
+    let mockDataSource;
+    async function buildService(withGateway = true) {
+        const providers = [
+            _notificationhelperservice.NotificationHelperService,
+            {
+                provide: 'CACHE_INSTANCE',
+                useValue: mockCacheManager
+            },
+            {
+                provide: _modules.UtilsService,
+                useValue: mockUtilsService
+            },
+            {
+                provide: _notificationconfigservice.NotificationConfigService,
+                useValue: mockConfigService
+            },
+            {
+                provide: _notificationdatasourceprovider.NotificationDataSourceProvider,
+                useValue: mockDataSourceProvider
+            }
+        ];
+        if (withGateway) {
+            providers.push({
+                provide: _gateways.NotificationGateway,
+                useValue: mockGateway
+            });
+        }
+        const module = await _testing.Test.createTestingModule({
+            providers
+        }).compile();
+        return module.get(_notificationhelperservice.NotificationHelperService);
+    }
+    beforeEach(()=>{
+        mockRepo = createMockRepo();
+        mockDataSource = createMockDataSource(mockRepo);
+        mockCacheManager = {};
+        mockUtilsService = {
+            clearCache: jest.fn().mockResolvedValue(undefined)
+        };
+        mockConfigService = {
+            isCompanyFeatureEnabled: jest.fn().mockReturnValue(false)
+        };
+        mockDataSourceProvider = {
+            getDataSource: jest.fn().mockResolvedValue(mockDataSource)
+        };
+        mockGateway = {
+            emitToUser: jest.fn(),
+            emitToUserInCompany: jest.fn(),
+            isUserOnline: jest.fn(),
+            getOnlineUserCount: jest.fn()
+        };
+    });
+    describe('send', ()=>{
+        it('saves the notification, clears the cache, and emits to the user in real time', async ()=>{
+            const service = await buildService();
+            const options = {
+                userId: 'user-1',
+                title: 'Hi',
+                message: 'body',
+                type: _enums.NotificationType.SUCCESS,
+                data: {
+                    a: 1
+                }
+            };
+            const saved = {
+                id: 'notif-1',
+                ...options,
+                isRead: false
+            };
+            mockRepo.save.mockResolvedValue(saved);
+            const result = await service.send(options);
+            expect(mockDataSource.getRepository).toHaveBeenCalledWith(_entities.Notification);
+            expect(mockRepo.save).toHaveBeenCalledWith(expect.objectContaining({
+                userId: 'user-1',
+                title: 'Hi',
+                isRead: false
+            }));
+            expect(mockUtilsService.clearCache).toHaveBeenCalledWith('notification', mockCacheManager);
+            expect(mockGateway.emitToUser).toHaveBeenCalledWith('user-1', 'notification:new', expect.objectContaining({
+                id: 'notif-1',
+                title: 'Hi'
+            }));
+            expect(result).toBe(saved);
+        });
+        it('defaults type to INFO and message/data to null when omitted', async ()=>{
+            const service = await buildService();
+            mockRepo.save.mockImplementation(async (entity)=>({
+                    id: 'notif-2',
+                    ...entity
+                }));
+            await service.send({
+                userId: 'user-1',
+                title: 'Only title'
+            });
+            expect(mockRepo.save).toHaveBeenCalledWith(expect.objectContaining({
+                type: _enums.NotificationType.INFO,
+                message: null,
+                data: null
+            }));
+        });
+        it('does not emit in real time when realtime is explicitly false', async ()=>{
+            const service = await buildService();
+            mockRepo.save.mockResolvedValue({
+                id: 'notif-3',
+                userId: 'user-1',
+                title: 'Silent'
+            });
+            await service.send({
+                userId: 'user-1',
+                title: 'Silent',
+                realtime: false
+            });
+            expect(mockGateway.emitToUser).not.toHaveBeenCalled();
+            expect(mockGateway.emitToUserInCompany).not.toHaveBeenCalled();
+        });
+        it('does not throw when no gateway is bound (gateway not registered)', async ()=>{
+            const service = await buildService(false);
+            mockRepo.save.mockResolvedValue({
+                id: 'notif-4',
+                userId: 'user-1',
+                title: 'No gateway'
+            });
+            await expect(service.send({
+                userId: 'user-1',
+                title: 'No gateway'
+            })).resolves.toBeDefined();
+        });
+        it('uses NotificationWithCompany and includes companyId when the company feature is enabled', async ()=>{
+            mockConfigService.isCompanyFeatureEnabled.mockReturnValue(true);
+            const service = await buildService();
+            mockRepo.save.mockImplementation(async (entity)=>({
+                    id: 'notif-5',
+                    ...entity
+                }));
+            await service.send({
+                userId: 'user-1',
+                title: 'Scoped',
+                companyId: 'company-1'
+            });
+            expect(mockDataSource.getRepository).toHaveBeenCalledWith(_entities.NotificationWithCompany);
+            expect(mockRepo.save).toHaveBeenCalledWith(expect.objectContaining({
+                companyId: 'company-1'
+            }));
+            expect(mockGateway.emitToUserInCompany).toHaveBeenCalledWith('user-1', 'company-1', 'notification:new', expect.any(Object));
+        });
+        it('omits companyId when the company feature is enabled but none was provided', async ()=>{
+            mockConfigService.isCompanyFeatureEnabled.mockReturnValue(true);
+            const service = await buildService();
+            mockRepo.save.mockImplementation(async (entity)=>({
+                    id: 'notif-6',
+                    ...entity
+                }));
+            await service.send({
+                userId: 'user-1',
+                title: 'No company'
+            });
+            const savedArg = mockRepo.save.mock.calls[0][0];
+            expect(savedArg.companyId).toBeUndefined();
+        });
+        it('reuses the same cached data source across multiple calls', async ()=>{
+            const service = await buildService();
+            mockRepo.save.mockResolvedValue({
+                id: 'notif-7',
+                userId: 'user-1',
+                title: 'A'
+            });
+            await service.send({
+                userId: 'user-1',
+                title: 'A'
+            });
+            await service.send({
+                userId: 'user-1',
+                title: 'B'
+            });
+            expect(mockDataSourceProvider.getDataSource).toHaveBeenCalledTimes(1);
+        });
+    });
+    describe('sendToMany', ()=>{
+        it('saves a notification for every user id and clears the cache once', async ()=>{
+            const service = await buildService();
+            const options = {
+                userIds: [
+                    'user-1',
+                    'user-2',
+                    'user-3'
+                ],
+                title: 'Broadcast'
+            };
+            mockRepo.save.mockImplementation(async (entities)=>entities.map((e, i)=>({
+                        id: `notif-${i}`,
+                        ...e
+                    })));
+            const result = await service.sendToMany(options);
+            expect(mockRepo.save).toHaveBeenCalledWith([
+                expect.objectContaining({
+                    userId: 'user-1'
+                }),
+                expect.objectContaining({
+                    userId: 'user-2'
+                }),
+                expect.objectContaining({
+                    userId: 'user-3'
+                })
+            ]);
+            expect(mockUtilsService.clearCache).toHaveBeenCalledTimes(1);
+            expect(result).toHaveLength(3);
+        });
+        it('handles an empty userIds array without saving or emitting', async ()=>{
+            const service = await buildService();
+            mockRepo.save.mockResolvedValue([]);
+            const result = await service.sendToMany({
+                userIds: [],
+                title: 'Nobody'
+            });
+            expect(mockRepo.save).toHaveBeenCalledWith([]);
+            expect(result).toEqual([]);
+        });
+        it('emits to each user asynchronously (after the microtask queue flushes) when realtime', async ()=>{
+            const service = await buildService();
+            mockRepo.save.mockImplementation(async (entities)=>entities.map((e, i)=>({
+                        id: `notif-${i}`,
+                        ...e
+                    })));
+            await service.sendToMany({
+                userIds: [
+                    'user-1',
+                    'user-2'
+                ],
+                title: 'Broadcast'
+            });
+            expect(mockGateway.emitToUser).not.toHaveBeenCalled();
+            await new Promise((resolve)=>setImmediate(resolve));
+            expect(mockGateway.emitToUser).toHaveBeenCalledTimes(2);
+            expect(mockGateway.emitToUser).toHaveBeenCalledWith('user-1', 'notification:new', expect.any(Object));
+            expect(mockGateway.emitToUser).toHaveBeenCalledWith('user-2', 'notification:new', expect.any(Object));
+        });
+        it('does not schedule emits when realtime is false', async ()=>{
+            const service = await buildService();
+            mockRepo.save.mockImplementation(async (entities)=>entities.map((e, i)=>({
+                        id: `notif-${i}`,
+                        ...e
+                    })));
+            await service.sendToMany({
+                userIds: [
+                    'user-1'
+                ],
+                title: 'Silent',
+                realtime: false
+            });
+            await new Promise((resolve)=>setImmediate(resolve));
+            expect(mockGateway.emitToUser).not.toHaveBeenCalled();
+        });
+    });
+    describe('isUserOnline', ()=>{
+        it('delegates to the gateway when present', async ()=>{
+            const service = await buildService();
+            mockGateway.isUserOnline.mockReturnValue(true);
+            expect(service.isUserOnline('user-1')).toBe(true);
+            expect(mockGateway.isUserOnline).toHaveBeenCalledWith('user-1');
+        });
+        it('returns false when no gateway is bound', async ()=>{
+            const service = await buildService(false);
+            expect(service.isUserOnline('user-1')).toBe(false);
+        });
+    });
+    describe('getOnlineUserCount', ()=>{
+        it('delegates to the gateway when present', async ()=>{
+            const service = await buildService();
+            mockGateway.getOnlineUserCount.mockReturnValue(5);
+            expect(service.getOnlineUserCount()).toBe(5);
+        });
+        it('returns 0 when no gateway is bound', async ()=>{
+            const service = await buildService(false);
+            expect(service.getOnlineUserCount()).toBe(0);
+        });
+    });
+});