Merge branch 'SER-1897' of https://github.com/Countly/countly-server into SER-1897

Author: ayasayadi1

frontend/express/public/javascripts/countly/countly.auth.js

@@ -39,7 +39,7 @@
         }
 
         if (!member.global_admin) {
-            var isPermissionObjectExistForAccessType = (typeof member.permission[accessType] === "object" && typeof member.permission[accessType][app_id] === "object");
+            var isPermissionObjectExistForAccessType = (member.permission && typeof member.permission[accessType] === "object" && typeof member.permission[accessType][app_id] === "object");
 
             var memberHasAllFlag = member.permission && member.permission[accessType] && member.permission[accessType][app_id] && member.permission[accessType][app_id].all;
             var memberHasAllowedFlag = false;
@@ -96,7 +96,7 @@
             return false;
         }
         if (!member.global_admin) {
-            var isPermissionObjectExistForRead = (typeof member.permission.r === "object" && typeof member.permission.r[app_id] === "object");
+            var isPermissionObjectExistForRead = (member.permission && typeof member.permission.r === "object" && typeof member.permission.r[app_id] === "object");
             // TODO: make here better. create helper method for these checks
             var memberHasAllFlag = member.permission && member.permission.r && member.permission.r[app_id] && member.permission.r[app_id].all;
             var memberHasAllowedFlag = false;

plugins/alerts/README.md

@@ -1,6 +1,6 @@
 # Alerts plugin
 
-The Alerts plugin is designed to monitor various metrics and events within the Countly analytics platform. It provides a structured way to set up alerts for different types of data, ensuring that users are notified when specific conditions are met. Below is a detailed breakdown of the plugin's file structure and its components:
+The Alerts plugin in Countly is a reactive tool designed to keep you informed about critical changes in your application’s metrics, even when you’re not monitoring dashboards. It sends email notifications when specific conditions on important metrics are met, enabling you to respond quickly to potential issues. This feature helps ensure your app maintains high performance and provides a positive user experience by alerting you to areas that may need immediate attention.
 
 ## File structure
 File structure follows usual Countly plugin structure
@@ -41,6 +41,17 @@ alerts/
 └── tests.js                                    # plugin tests
 ```
 
+## Key Features
+
+- **Customizable Alerts:** Define specific conditions for metrics such as crashes, cohorts, data points, events, Net Promoter Score (NPS), online users, rating, revenue, sessions, surveys, users, and views. Get notified whenever these conditions are met.
+- **Real-Time Notifications:** Receive email alerts for immediate awareness of changes in your metrics.
+- **Detailed Monitoring:** Track a broad range of metrics, including user engagement, performance, user feedback, and error rates.
+- **Easy Setup:** Simple configuration allows you to set and customize alerts quickly to fit your needs.
+
+## Example Use Case
+
+Imagine you’ve released a new version of your app. Although it passed all tests, some critical bugs may still slip through. These bugs might prevent users from fully using the app. By setting up alerts for sudden spikes in crashes or decreased user activity, you can catch these issues early and work to resolve them, ensuring minimal disruption.
+
 ## Generate alerts job
 
 Job name: alerts:monitor

plugins/alerts/api/api.js

@@ -44,7 +44,11 @@ const PERIOD_TO_TEXT_EXPRESSION_MAPPER = {
         if (typeof alertID === 'string') {
             alertID = common.db.ObjectID(alertID);
         }
-        common.db.collection("jobs").remove({ 'data.alertID': alertID }, function() {
+        common.db.collection("jobs").remove({ 'data.alertID': alertID }, function(err) {
+            if (err) {
+                log.e('delete job failed, alertID:', alertID, err);
+                return;
+            }
             log.d('delete job, alertID:', alertID);
             if (callback) {
                 callback();
@@ -241,8 +245,8 @@ const PERIOD_TO_TEXT_EXPRESSION_MAPPER = {
                 );
             }
             catch (err) {
-                log.e('Parse alert failed', alertConfig);
-                common.returnMessage(params, 500, "Failed to create an alert");
+                log.e('Parse alert failed', alertConfig, err);
+                common.returnMessage(params, 500, "Failed to create an alert" + err.message);
             }
         });
         return true;
@@ -284,8 +288,8 @@ const PERIOD_TO_TEXT_EXPRESSION_MAPPER = {
                 );
             }
             catch (err) {
-                log.e('delete alert failed', alertID);
-                common.returnMessage(params, 500, "Failed to delete an alert");
+                log.e('delete alert failed', alertID, err);
+                common.returnMessage(params, 500, "Failed to delete an alert" + err.message);
             }
         });
         return true;
@@ -411,8 +415,8 @@ const PERIOD_TO_TEXT_EXPRESSION_MAPPER = {
                 });
             }
             catch (err) {
-                log.e('get alert list failed');
-                common.returnMessage(params, 500, "Failed to get alert list");
+                log.e('get alert list failed', err);
+                common.returnMessage(params, 500, "Failed to get alert list" + err.message);
             }
         });
         return true;

plugins/compliance-hub/README.md

@@ -27,4 +27,18 @@ compliance-hub/
 ├── package.json
 ├── README.md
 └── tests.js                                  # plugin tests
-```
+```
+
+## Key Features
+
+- **Collect User Consents:** Prompt first-time users to consent to data collection, detailing which types of data (e.g., sessions, crashes, views) will be collected. No data is sent unless the user opts in.
+- **Manage User Requests:** The "Consents" tab (available in Enterprise Edition) lets admins view and fulfill user requests for data export or deletion.
+- **SDK Integration:** Countly SDKs (iOS, Android, Node.js, Web) support flexible consent management, allowing opt-in/opt-out on a per-feature basis. SDKs default to opt-in for backward compatibility but can be configured to require opt-in consent at initialization.
+
+## Using the Compliance Hub
+
+Access the Compliance Hub via Main Menu > Utilities > Compliance Hub. The Compliance Hub offers the following views:
+1. **Metrics View:** Track opt-ins and opt-outs across various features (e.g., sessions, crashes) over time in a time-series graph.
+2. **Users View:** List users with consent histories. Each entry shows user ID, device info, app version, and consent types. Options include viewing consent history, exporting user data, and purging data if required.
+3. **Consent History:** A complete list of all opt-in and opt-out actions across metrics, allowing for easy tracking.
+4. **Export/Purge History:** See a record of all data export and deletion actions for compliance tracking.

plugins/hooks/api/api.js

@@ -272,7 +272,6 @@ plugins.register("/permissions/features", function(ob) {
 plugins.register("/i/hook/save", function(ob) {
     let paramsInstance = ob.params;
 
-
     validateCreate(ob.params, FEATURE_NAME, function(params) {
         let hookConfig = params.qstring.hook_config;
         if (!hookConfig) {
@@ -283,50 +282,57 @@ plugins.register("/i/hook/save", function(ob) {
         try {
             hookConfig = JSON.parse(hookConfig);
             hookConfig = sanitizeConfig(hookConfig);
-            if (!(common.validateArgs(hookConfig, CheckHookProperties(hookConfig)))) {
-                common.returnMessage(params, 400, 'Not enough args');
-                return true;
-            }
+            if (hookConfig) {
+                // Null check for hookConfig
+                if (!(common.validateArgs(hookConfig, CheckHookProperties(hookConfig)))) {
+                    common.returnMessage(params, 400, 'Not enough args');
+                    return true;
+                }
 
-            if (hookConfig.effects && !validateEffects(hookConfig.effects)) {
-                common.returnMessage(params, 400, 'Invalid configuration for effects');
-                return true;
-            }
+                if (hookConfig.effects && !validateEffects(hookConfig.effects)) {
+                    common.returnMessage(params, 400, 'Invalid configuration for effects');
+                    return true;
+                }
 
-            if (hookConfig._id) {
-                const id = hookConfig._id;
-                delete hookConfig._id;
-                return common.db.collection("hooks").findAndModify(
-                    { _id: common.db.ObjectID(id) },
-                    {},
-                    {$set: hookConfig},
-                    {new: true},
-                    function(err, result) {
-                        if (!err) {
-                            // Audit log: Hook updated
-                            if (result && result.value) {
-                                plugins.dispatch("/systemlogs", {
-                                    params: params,
-                                    action: "hook_updated",
-                                    data: {
-                                        updatedHookID: result.value._id,
-                                        updatedBy: params.member._id,
-                                        updatedHookName: result.value.name
-                                    }
-                                });
+                if (hookConfig._id) {
+                    const id = hookConfig._id;
+                    delete hookConfig._id;
+                    return common.db.collection("hooks").findAndModify(
+                        { _id: common.db.ObjectID(id) },
+                        {},
+                        {$set: hookConfig},
+                        {new: true},
+                        function(err, result) {
+                            if (!err) {
+                                // Audit log: Hook updated
+                                if (result && result.value) {
+                                    plugins.dispatch("/systemlogs", {
+                                        params: params,
+                                        action: "hook_updated",
+                                        data: {
+                                            updatedHookID: result.value._id,
+                                            updatedBy: params.member._id,
+                                            updatedHookName: result.value.name
+                                        }
+                                    });
+                                }
+                                else {
+                                    common.returnMessage(params, 500, "No result found");
+                                }
+                                common.returnOutput(params, result && result.value);
                             }
                             else {
-                                common.returnMessage(params, 500, "No result found");
+                                common.returnMessage(params, 500, "Failed to save an hook");
                             }
-                            common.returnOutput(params, result && result.value);
                         }
-                        else {
-                            common.returnMessage(params, 500, "Failed to save an hook");
-                        }
-                    });
+                    );
+                }
+
+            }
+            if (hookConfig) {
+                hookConfig.createdBy = params.member._id; // Accessing property now with proper check
+                hookConfig.created_at = new Date().getTime();
             }
-            hookConfig.createdBy = params.member._id;
-            hookConfig.created_at = new Date().getTime();
             return common.db.collection("hooks").insert(
                 hookConfig,
                 function(err, result) {
@@ -496,8 +502,8 @@ plugins.register("/o/hook/list", function(ob) {
             });
         }
         catch (err) {
-            log.e('get hook list failed');
-            common.returnMessage(params, 500, "Failed to get hook list");
+            log.e('get hook list failed', err);
+            common.returnMessage(params, 500, "Failed to get hook list" + err.message);
         }
     }, paramsInstance);
     return true;
@@ -545,6 +551,9 @@ plugins.register("/i/hook/status", function(ob) {
                 data: { updatedHooksCount: Object.keys(statusList).length, requestedBy: params.member._id }
             });
             common.returnOutput(params, true);
+        }).catch(function(err) {
+            log.e('Failed to update hook statuses: ', err);
+            common.returnMessage(params, 500, "Failed to update hook statuses: " + err.message);
         });
     }, paramsInstance);
     return true;
@@ -593,8 +602,8 @@ plugins.register("/i/hook/delete", function(ob) {
             );
         }
         catch (err) {
-            log.e('delete hook failed', hookID);
-            common.returnMessage(params, 500, "Failed to delete an hook");
+            log.e('delete hook failed', hookID, err);
+            common.returnMessage(params, 500, "Failed to delete an hook" + err.message);
         }
     }, paramsInstance);
     return true;
@@ -608,43 +617,54 @@ plugins.register("/i/hook/test", function(ob) {
         let hookConfig = params.qstring.hook_config;
         if (!hookConfig) {
             common.returnMessage(params, 400, 'Invalid hookConfig');
-            return true;
+            return;
         }
 
         try {
             hookConfig = JSON.parse(hookConfig);
+            if (!hookConfig) {
+                common.returnMessage(params, 400, 'Parsed hookConfig is invalid');
+                return;
+            }
             hookConfig = sanitizeConfig(hookConfig);
             const mockData = JSON.parse(params.qstring.mock_data);
 
             if (!(common.validateArgs(hookConfig, CheckHookProperties(hookConfig)))) {
-                common.returnMessage(params, 403, "hook config invalid");
+                common.returnMessage(params, 403, "hook config invalid" + JSON.stringify(hookConfig));
+                return; // Add return to exit early
             }
 
+            // Null check for effects
             if (hookConfig.effects && !validateEffects(hookConfig.effects)) {
                 common.returnMessage(params, 400, 'Config invalid');
-                return true;
+                return; // Add return to exit early
             }
 
+
             // trigger process            
             log.d(JSON.stringify(hookConfig), "[hook test config]");
             const results = [];
 
             // build mock data
             const trigger = hookConfig.trigger;
+            if (!trigger) {
+                common.returnMessage(params, 400, 'Trigger is missing');
+                return;
+            }
             hookConfig._id = null;
+
             log.d("[hook test mock data]", mockData);
             const obj = {
                 is_mock: true,
                 params: mockData,
                 rule: hookConfig
             };
-
             log.d("[hook test config data]", obj);
             const t = new Triggers[trigger.type]({
                 rules: [hookConfig],
             });
 
-            // out put trigger result
+            // output trigger result
             const triggerResult = await t.process(obj);
             log.d("[hook trigger test result]", triggerResult);
             results.push(JSON.parse(JSON.stringify(triggerResult)));
@@ -675,8 +695,8 @@ plugins.register("/i/hook/test", function(ob) {
             return false;
         }
         catch (e) {
-            log.e("hook test error", e);
-            common.returnMessage(params, 503, "Hook test failed.");
+            log.e("hook test error", e, hookConfig);
+            common.returnMessage(params, 503, "Hook test failed." + e.message);
             return;
         }
     }, paramsInstance);

plugins/hooks/tests.js

@@ -136,6 +136,16 @@ describe('Testing Hooks', function() {
                         done();
                     });
             });
+            it('should fail to fetch hook details with invalid hook ID', function(done) {
+                const invalidHookId = "invalid-id"; // Invalid hook ID
+                request.get(getRequestURL('/o/hook/list') + '&id=' + invalidHookId)
+                    .expect(404) // Not found error for invalid hook ID
+                    .end(function(err, res) {
+                        // Test response
+                        res.body.should.have.property('hooksList').which.is.an.Array().and.have.lengthOf(0);
+                        done();
+                    });
+            });
         });