feat: Add Email Notifications for Limit Warnings (#47)

apps/dashboard-api/src/__tests__/project.controller.test.js

@@ -0,0 +1,103 @@
+'use strict';
+
+const mongoose = require('mongoose');
+
+// Mock @urbackend/common first to mock Project and cache utilities
+const mockProjectSave = jest.fn();
+const mockProjectFindOne = jest.fn();
+
+jest.mock('@urbackend/common', () => ({
+    Project: { 
+        findOne: mockProjectFindOne 
+    },
+    deleteProjectById: jest.fn().mockResolvedValue(true)
+}));
+
+const { updateNotificationSettings } = require('../controllers/project.controller');
+
+describe('project.controller - updateNotificationSettings', () => {
+    let mockReq;
+    let mockRes;
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+
+        mockReq = {
+            params: { projectId: '60c72b2f9b1d8b001c8e4b52' },
+            user: { _id: 'ownerId123' },
+            body: {}
+        };
+
+        mockRes = {
+            status: jest.fn().mockReturnThis(),
+            json: jest.fn()
+        };
+    });
+
+    test('should return 400 if email payload is missing', async () => {
+        mockReq.body = {}; // no 'email' property
+        await updateNotificationSettings(mockReq, mockRes);
+
+        expect(mockRes.status).toHaveBeenCalledWith(400);
+        expect(mockRes.json).toHaveBeenCalledWith({ error: "Missing 'email' settings in body" });
+    });
+
+    test('should return 404 if project is not found or not owned by user', async () => {
+        mockReq.body = { email: { enabled: true } };
+        mockProjectFindOne.mockResolvedValueOnce(null);
+
+        await updateNotificationSettings(mockReq, mockRes);
+
+        expect(mockRes.status).toHaveBeenCalledWith(404);
+        expect(mockRes.json).toHaveBeenCalledWith({ error: "Project not found or access denied." });
+    });
+
+    test('should successfully update notification settings and save the project', async () => {
+        const incomingEmailSettings = {
+            enabled: true,
+            storage: { type: 'absolute', absoluteLimit: 1000 },
+            database: { type: 'percentage', thresholds: [50, 75] }
+        };
+
+        mockReq.body = { email: incomingEmailSettings };
+
+        const mockProjectDoc = {
+            _id: '60c72b2f9b1d8b001c8e4b52',
+            notificationSettings: {
+                email: {
+                    enabled: false
+                }
+            },
+            markModified: jest.fn(),
+            save: mockProjectSave
+        };
+
+        mockProjectFindOne.mockResolvedValueOnce(mockProjectDoc);
+        mockProjectSave.mockResolvedValueOnce(mockProjectDoc);
+
+        await updateNotificationSettings(mockReq, mockRes);
+
+        // Expect the object to be updated with merged settings
+        expect(mockProjectDoc.notificationSettings.email).toMatchObject(incomingEmailSettings);
+
+        // Since we provided storage/database, markModified should be called
+        expect(mockProjectDoc.markModified).toHaveBeenCalledWith('notificationSettings');
+        expect(mockProjectSave).toHaveBeenCalled();
+
+        expect(mockRes.json).toHaveBeenCalledWith({
+            success: true,
+            settings: mockProjectDoc.notificationSettings
+        });
+    });
+
+    test('should handle validation errors or save failures gracefully', async () => {
+        mockReq.body = { email: { enabled: true } };
+
+        mockProjectFindOne.mockRejectedValueOnce(new Error('DB Connection Failed'));
+
+        await updateNotificationSettings(mockReq, mockRes);
+
+        expect(mockRes.status).toHaveBeenCalledWith(500);
+        expect(mockRes.json).toHaveBeenCalledWith({ error: 'DB Connection Failed' });
+    });
+});

apps/dashboard-api/src/controllers/project.controller.js

@@ -1159,3 +1159,37 @@ module.exports.updateCollectionRls = async (req, res) => {
         res.status(500).json({ error: err.message });
     }
 }
+
+// PATCH REQ FOR NOTIFICATION SETTINGS
+module.exports.updateNotificationSettings = async (req, res) => {
+    try {
+        const { projectId } = req.params;
+        const { email } = req.body; // { enabled: true, storage: {...}, database: {...} }
+
+        if (!email) {
+            return res.status(400).json({ error: "Missing 'email' settings in body" });
+        }
+
+        const project = await Project.findOne({ _id: projectId, owner: req.user._id });
+        if (!project) return res.status(404).json({ error: "Project not found or access denied." });
+
+        project.notificationSettings = {
+            ...project.notificationSettings,
+            email: {
+                ...project.notificationSettings?.email,
+                ...email,
+            }
+        };
+
+        if (email.storage || email.database) {
+             project.markModified('notificationSettings');
+        }
+
+        await project.save();
+
+        await deleteProjectById(projectId);
+        res.json({ success: true, settings: project.notificationSettings });
+    } catch (err) {
+        res.status(500).json({ error: err.message });
+    }
+};

apps/dashboard-api/src/routes/projects.js

@@ -28,7 +28,8 @@ const {
     analytics,
     updateAllowedDomains,
     toggleAuth,
-    updateCollectionRls
+    updateCollectionRls,
+    updateNotificationSettings
 } = require("../controllers/project.controller")
 
 const { createAdminUser, resetPassword, getUserDetails, updateAdminUser, listUserSessions, revokeUserSession } = require('../controllers/userAuth.controller');
@@ -105,6 +106,9 @@ router.patch('/:projectId/auth/toggle', authMiddleware, verifyEmail, toggleAuth)
 // PATCH REQ FOR COLLECTION RLS SETTINGS
 router.patch('/:projectId/collections/:collectionName/rls', authMiddleware, verifyEmail, updateCollectionRls);
 
+// PATCH REQ FOR NOTIFICATION SETTINGS
+router.patch('/:projectId/notification-settings', authMiddleware, verifyEmail, updateNotificationSettings);
+
 // ADMIN AUTH ROUTES
 const {checkAuthEnabled} = require('@urbackend/common');
 const {loadProjectForAdmin} = require('@urbackend/common');