Skip to content

Commit 220db14

Browse files
ar2rsawseenar2rsawseen
authored
Merge pull request #5571 from Countly/SER-1907-improvements-on-alerts
[SER-1907] Improvements on alerts
2 parents 24e6545 + c8aa0ea commit 220db14

File tree

13 files changed

+86
-98
lines changed

13 files changed

+86
-98
lines changed

‎plugins/alerts/api/alertModules/cohorts.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const commonLib = require("../parts/common-lib.js");
99
const { ObjectId } = require('mongodb');
1010

1111
module.exports.check = async function({ alertConfigs: alert, done, scheduledTo: date }) {
12-
const app = await common.db.collection("apps").findOne({ _id: ObjectId(alert.selectedApps[0]) });
12+
const app = await common.readBatcher.getOne("apps", { _id: new ObjectId(alert.selectedApps[0]) });
1313
if (!app) {
1414
log.e(`App ${alert.selectedApps[0]} couldn't be found`);
1515
return done();
@@ -22,7 +22,7 @@ module.exports.check = async function({ alertConfigs: alert, done, scheduledTo:
2222

2323
if (compareType === commonLib.COMPARE_TYPE_ENUM.MORE_THAN) {
2424
if (metricValue > compareValue) {
25-
await commonLib.trigger({ alert, app, metricValue, date });
25+
await commonLib.trigger({ alert, app, metricValue, date }, log);
2626
}
2727
}
2828
else {
@@ -38,7 +38,7 @@ module.exports.check = async function({ alertConfigs: alert, done, scheduledTo:
3838
: change <= -compareValue;
3939

4040
if (shouldTrigger) {
41-
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore });
41+
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore }, log);
4242
}
4343
}
4444

‎plugins/alerts/api/alertModules/dataPoints.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ module.exports.check = async function({ alertConfigs: alert, done, scheduledTo:
1414
const selectedApp = alert.selectedApps[0];
1515
let apps;
1616
if (selectedApp === "all") {
17-
apps = await common.db.collection("apps").find().toArray();
17+
apps = await common.readBatcher.getMany("apps", {});
1818
}
1919
else {
20-
apps = [await common.db.collection("apps").findOne({ _id: ObjectId(selectedApp) })];
20+
apps = [await common.readBatcher.getOne("apps", { _id: new ObjectId(selectedApp) })];
2121
}
2222

2323
for (let app of apps) {
@@ -33,7 +33,7 @@ module.exports.check = async function({ alertConfigs: alert, done, scheduledTo:
3333

3434
if (compareType === commonLib.COMPARE_TYPE_ENUM.MORE_THAN) {
3535
if (metricValue > compareValue) {
36-
await commonLib.trigger({ alert, app, metricValue, date });
36+
await commonLib.trigger({ alert, app, metricValue, date }, log);
3737
}
3838
}
3939
else {
@@ -49,7 +49,7 @@ module.exports.check = async function({ alertConfigs: alert, done, scheduledTo:
4949
: change <= -compareValue;
5050

5151
if (shouldTrigger) {
52-
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore });
52+
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore }, log);
5353
}
5454
}
5555
}

‎plugins/alerts/api/alertModules/events.js‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,8 @@ const METRIC_TO_PROPERTY_MAP = {
2121

2222
const AVERAGE_METRICS = ["average sum", "average duration"];
2323

24-
/**
25-
* Alert triggering logic
26-
* @param {Alert} alert - alert document
27-
* @param {function} done - callback function
28-
* @param {Date} date - scheduled date for the alert (job.next)
29-
*/
3024
module.exports.check = async({ alertConfigs: alert, done, scheduledTo: date }) => {
31-
const app = await common.db.collection("apps").findOne({ _id: ObjectId(alert.selectedApps[0]) });
25+
const app = await common.readBatcher.getOne("apps", { _id: new ObjectId(alert.selectedApps[0]) });
3226
if (!app) {
3327
log.e(`App ${alert.selectedApps[0]} couldn't be found`);
3428
return done();
@@ -55,7 +49,7 @@ module.exports.check = async({ alertConfigs: alert, done, scheduledTo: date }) =
5549

5650
if (compareType === commonLib.COMPARE_TYPE_ENUM.MORE_THAN) {
5751
if (metricValue > compareValue) {
58-
await commonLib.trigger({ alert, app, metricValue, date });
52+
await commonLib.trigger({ alert, app, metricValue, date }, log);
5953
}
6054
}
6155
else {
@@ -81,7 +75,7 @@ module.exports.check = async({ alertConfigs: alert, done, scheduledTo: date }) =
8175
: change <= -compareValue;
8276

8377
if (shouldTrigger) {
84-
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore });
78+
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore }, log);
8579
}
8680
}
8781
done();
@@ -97,7 +91,7 @@ module.exports.getEventMetricByDate = getEventMetricByDate;
9791
* @param {string} metric - c, s, dur
9892
* @param {Date} date - date of the value you're looking for
9993
* @param {string} period - hourly|daily|monthly
100-
* @param {object} segments - segmentation filter. e.g. {Category:"Electronics"}
94+
* @param {object=} segments - segmentation filter. e.g. {Category:"Electronics"}
10195
* @returns {Promise<number|undefined>} - a promise resolves to metric value or undefined
10296
*/
10397
async function getEventMetricByDate(app, event, metric, date, period, segments) {

‎plugins/alerts/api/alertModules/nps.js‎

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,9 @@ module.exports.triggerByEvent = triggerByEvent;
1616
*/
1717
async function triggerByEvent(payload) {
1818
const allEvents = payload?.events;
19-
const appKey = payload?.app_key;
20-
if (!Array.isArray(allEvents) || !appKey) {
21-
return;
22-
}
19+
const app = payload?.app;
2320

24-
const app = await common.db.collection("apps").findOne({ key: appKey });
25-
if (!app) {
21+
if (!Array.isArray(allEvents) || !app) {
2622
return;
2723
}
2824

@@ -34,22 +30,28 @@ async function triggerByEvent(payload) {
3430
);
3531

3632
for (let event of validNPSEvents) {
37-
const alert = await common.db.collection("alerts").findOne({
33+
const alerts = await common.readBatcher.getMany("alerts", {
3834
selectedApps: app._id.toString(),
3935
alertDataSubType2: event.segmentation.widget_id,
4036
alertDataType: "nps",
4137
alertDataSubType: commonLib.TRIGGERED_BY_EVENT.nps,
4238
});
43-
if (!alert) {
39+
40+
if (!alerts || !alerts.length) {
4441
continue;
4542
}
4643

47-
await commonLib.trigger({ alert, app, date: new Date }, log);
44+
// trigger all alerts
45+
await Promise.all(alerts.map(alert => commonLib.trigger({
46+
alert,
47+
app,
48+
date: new Date,
49+
}, log)));
4850
}
4951
}
5052

5153
module.exports.check = async function({ alertConfigs: alert, done, scheduledTo: date }) {
52-
const app = await common.db.collection("apps").findOne({ _id: ObjectId(alert.selectedApps[0]) });
54+
const app = await common.readBatcher.getOne("apps", { _id: new ObjectId(alert.selectedApps[0]) });
5355
if (!app) {
5456
log.e(`App ${alert.selectedApps[0]} couldn't be found`);
5557
return done();
@@ -62,7 +64,7 @@ module.exports.check = async function({ alertConfigs: alert, done, scheduledTo:
6264

6365
if (compareType === commonLib.COMPARE_TYPE_ENUM.MORE_THAN) {
6466
if (metricValue > compareValue) {
65-
await commonLib.trigger({ alert, app, metricValue, date });
67+
await commonLib.trigger({ alert, app, metricValue, date }, log);
6668
}
6769
}
6870
else {
@@ -78,7 +80,7 @@ module.exports.check = async function({ alertConfigs: alert, done, scheduledTo:
7880
: change <= -compareValue;
7981

8082
if (shouldTrigger) {
81-
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore });
83+
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore }, log);
8284
}
8385
}
8486

@@ -91,7 +93,7 @@ module.exports.check = async function({ alertConfigs: alert, done, scheduledTo:
9193
* @param {string} nps - _id of the from feedback_widgets
9294
* @param {Date} date - date of the value you're looking for
9395
* @param {string} period - hourly|daily|monthly
94-
* @param {string} score - detractor|passive|promoter
96+
* @param {string=} score - detractor|passive|promoter
9597
* @returns {Promise<number|undefined>} - a promise resolves to metric value or undefined
9698
*/
9799
async function getResponsesByDate(app, nps, date, period, score) {
@@ -132,13 +134,16 @@ async function getResponsesByDate(app, nps, date, period, score) {
132134
* Calculates the sum of all valid responses inside a nps{app_id} date record.
133135
* @param {object} scope - object scope: Daily or hourly object from db
134136
* @param {string} nps - feedback_widgets _id
135-
* @param {string} score - detractor|passive|promoter
137+
* @param {string=} score - detractor|passive|promoter
136138
* @returns {number|undefined} - number of valid responses
137139
*/
138140
function sumOfAllResponses(scope, nps, score) {
139141
if (!scope) {
140142
return;
141143
}
144+
if (!score) {
145+
score = "detractor|passive|promoter";
146+
}
142147

143148
const recordKeyReg = new RegExp("\\*\\*\\d{1,2}\\*\\*" + nps + "\\*\\*(" + score + ")$");
144149
let numberOfResponses;
@@ -161,9 +166,9 @@ function sumOfAllResponses(scope, nps, score) {
161166

162167
/*
163168
(async function() {
164-
const app = { _id: ObjectId("65c1f875a12e98a328d5eb9e"), timezone: "Europe/Istanbul" };
165-
const nps = "65c383fcb46a4d172d7c5911";
166-
const date = new Date("2024-02-07T12:00:00.000Z");
169+
const app = {name: "test", _id: new ObjectId("6600901a71159e99a3434253"), timezone: "Europe/Istanbul", plugins: null };
170+
const nps = "6600909ed476e1837317dc52";
171+
const date = new Date("2024-09-16T12:00:00.000Z");
167172
168173
let data = await getResponsesByDate(app, nps, date, "monthly");
169174
console.log("monthly:", data);

‎plugins/alerts/api/alertModules/rating.js‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,9 @@ module.exports.triggerByEvent = triggerByEvent;
1818
*/
1919
async function triggerByEvent(payload) {
2020
const allEvents = payload?.events;
21-
const appKey = payload?.app_key;
22-
if (!Array.isArray(allEvents) || !appKey) {
23-
return;
24-
}
21+
const app = payload?.app;
2522

26-
const app = await common.db.collection("apps").findOne({ key: appKey });
27-
if (!app) {
23+
if (!Array.isArray(allEvents) || !app) {
2824
return;
2925
}
3026

@@ -35,22 +31,28 @@ async function triggerByEvent(payload) {
3531
);
3632

3733
for (let event of validRatingEvents) {
38-
const alert = await common.db.collection("alerts").findOne({
34+
const alerts = await common.readBatcher.getMany("alerts", {
3935
selectedApps: app._id.toString(),
4036
alertDataSubType2: event.segmentation.widget_id,
4137
alertDataType: "rating",
4238
alertDataSubType: commonLib.TRIGGERED_BY_EVENT.rating,
4339
});
44-
if (!alert) {
40+
41+
if (!alerts || !alerts.length) {
4542
continue;
4643
}
4744

48-
await commonLib.trigger({ alert, app, date: new Date }, log);
45+
// trigger all alerts
46+
await Promise.all(alerts.map(alert => commonLib.trigger({
47+
alert,
48+
app,
49+
date: new Date,
50+
}, log)));
4951
}
5052
}
5153

5254
module.exports.check = async function({ alertConfigs: alert, done, scheduledTo: date }) {
53-
const app = await common.db.collection("apps").findOne({ _id: ObjectId(alert.selectedApps[0]) });
55+
const app = await common.readBatcher.getOne("apps", { _id: new ObjectId(alert.selectedApps[0]) });
5456
if (!app) {
5557
log.e(`App ${alert.selectedApps[0]} couldn't be found`);
5658
return done();
@@ -73,7 +75,7 @@ module.exports.check = async function({ alertConfigs: alert, done, scheduledTo:
7375

7476
if (compareType === commonLib.COMPARE_TYPE_ENUM.MORE_THAN) {
7577
if (metricValue > compareValue) {
76-
await commonLib.trigger({ alert, app, metricValue, date });
78+
await commonLib.trigger({ alert, app, metricValue, date }, log);
7779
}
7880
}
7981
else {
@@ -89,7 +91,7 @@ module.exports.check = async function({ alertConfigs: alert, done, scheduledTo:
8991
: change <= -compareValue;
9092

9193
if (shouldTrigger) {
92-
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore });
94+
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore }, log);
9395
}
9496
}
9597

‎plugins/alerts/api/alertModules/revenue.js‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,9 @@ const PAYING_USER_PROP_KEY = "p";
2222
* - average revenue per user
2323
* - average revenue per paying user
2424
* - # of paying users
25-
* @param {Alert} alert - alert document
26-
* @param {function} done - callback function
27-
* @param {Date} date - scheduled date for the alert (job.next)
2825
*/
2926
module.exports.check = async({ alertConfigs: alert, done, scheduledTo: date }) => {
30-
const app = await common.db.collection("apps").findOne({ _id: ObjectId(alert.selectedApps[0]) });
27+
const app = await common.readBatcher.getOne("apps", { _id: new ObjectId(alert.selectedApps[0]) });
3128
if (!app) {
3229
log.e(`App ${alert.selectedApps[0]} couldn't be found`);
3330
return done();
@@ -40,7 +37,7 @@ module.exports.check = async({ alertConfigs: alert, done, scheduledTo: date }) =
4037

4138
if (compareType === commonLib.COMPARE_TYPE_ENUM.MORE_THAN) {
4239
if (metricValue > compareValue) {
43-
await commonLib.trigger({ alert, app, metricValue, date });
40+
await commonLib.trigger({ alert, app, metricValue, date }, log);
4441
}
4542
}
4643
else {
@@ -56,7 +53,7 @@ module.exports.check = async({ alertConfigs: alert, done, scheduledTo: date }) =
5653
: change <= -compareValue;
5754

5855
if (shouldTrigger) {
59-
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore });
56+
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore }, log);
6057
}
6158
}
6259
done();

‎plugins/alerts/api/alertModules/sessions.js‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,8 @@ const METRIC_ENUM = {
1414
AVG_SESSION_DURATION: "average session duration",
1515
};
1616

17-
/**
18-
* Alert triggering logic
19-
* @param {Alert} alert - alert document
20-
* @param {function} done - callback function
21-
* @param {Date} date - scheduled date for the alert (job.next)
22-
*/
2317
module.exports.check = async({ alertConfigs: alert, done, scheduledTo: date }) => {
24-
const app = await common.db.collection("apps").findOne({ _id: ObjectId(alert.selectedApps[0]) });
18+
const app = await common.readBatcher.getOne("apps", { _id: new ObjectId(alert.selectedApps[0]) });
2519
if (!app) {
2620
log.e(`App ${alert.selectedApps[0]} couldn't be found`);
2721
return done();
@@ -51,7 +45,7 @@ module.exports.check = async({ alertConfigs: alert, done, scheduledTo: date }) =
5145

5246
if (compareType === commonLib.COMPARE_TYPE_ENUM.MORE_THAN) {
5347
if (metricValue > compareValue) {
54-
await commonLib.trigger({ alert, app, metricValue, date });
48+
await commonLib.trigger({ alert, app, metricValue, date }, log);
5549
}
5650
}
5751
else {
@@ -67,7 +61,10 @@ module.exports.check = async({ alertConfigs: alert, done, scheduledTo: date }) =
6761
if (!numberOfSessionsBefore) {
6862
return done();
6963
}
70-
const sessionDuration = await getSessionMetricByDate(app, "d", before, period);
64+
let sessionDuration = await getSessionMetricByDate(app, "d", before, period);
65+
if (typeof sessionDuration !== "number") {
66+
sessionDuration = 0;
67+
}
7168
metricValueBefore = sessionDuration / numberOfSessionsBefore / 60;
7269
}
7370

@@ -81,7 +78,7 @@ module.exports.check = async({ alertConfigs: alert, done, scheduledTo: date }) =
8178
: change <= -compareValue;
8279

8380
if (shouldTrigger) {
84-
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore });
81+
await commonLib.trigger({ alert, app, date, metricValue, metricValueBefore }, log);
8582
}
8683
}
8784

0 commit comments

Comments
 (0)