‼️📅 Rewrite - notifScheduler.ts #1092
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shankari marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,286 @@ | ||
| import angular from 'angular'; | ||
| import React, { useEffect, useState } from "react"; | ||
| import { getConfig } from '../config/dynamicConfig'; | ||
| import useAppConfig from "../useAppConfig"; | ||
| import { addStatReading, statKeys } from '../plugin/clientStats'; | ||
| import { getUser, updateUser } from '../commHelper'; | ||
| import { logDebug } from "../plugin/logger"; | ||
| import { DateTime } from "luxon"; | ||
| import i18next from 'i18next'; | ||
|
|
||
| let scheduledPromise = new Promise<void>((rs) => rs()); | ||
| let scheduledNotifs = []; | ||
| let isScheduling = false; | ||
|
|
||
| // like python range() | ||
| function range(start, stop, step) { | ||
| let a = [start], b = start; | ||
| while (b < stop) | ||
| a.push(b += step || 1); | ||
| return a; | ||
| } | ||
|
|
||
| // returns an array of moment objects, for all times that notifications should be sent | ||
| const calcNotifTimes = (scheme, dayZeroDate, timeOfDay) => { | ||
| const notifTimes = []; | ||
| for (const s of scheme.schedule) { | ||
| // the days to send notifications, as integers, relative to day zero | ||
| const notifDays = range(s.start, s.end, s.intervalInDays); | ||
| for (const d of notifDays) { | ||
| const date = DateTime.fromFormat(dayZeroDate, 'yyyy-MM-dd').plus({ days: d}).toFormat('yyyy-MM-dd') | ||
| const notifTime = DateTime.fromFormat(date+' '+timeOfDay, 'yyyy-MM-dd HH:mm'); | ||
| notifTimes.push(notifTime); | ||
| } | ||
| } | ||
| return notifTimes; | ||
| } | ||
|
|
||
| // returns true if all expected times are already scheduled | ||
| const areAlreadyScheduled = (notifs, expectedTimes) => { | ||
| for (const t of expectedTimes) { | ||
| if (!notifs.some((n) => DateTime.fromMillis(n.trigger.at).equals(t))) { | ||
| return false; | ||
| } | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| /* remove notif actions as they do not work, can restore post routing migration */ | ||
| // const setUpActions = () => { | ||
| // const action = { | ||
| // id: 'action', | ||
| // title: 'Change Time', | ||
| // launch: true | ||
| // }; | ||
| // return new Promise((rs) => { | ||
| // cordova.plugins.notification.local.addActions('reminder-actions', [action], rs); | ||
| // }); | ||
| // } | ||
| function debugGetScheduled(prefix) { | ||
| window['cordova'].plugins.notification.local.getScheduled((notifs) => { | ||
| if (!notifs?.length) | ||
| return logDebug(`${prefix}, there are no scheduled notifications`); | ||
| const time = DateTime.fromMillis(notifs?.[0].trigger.at).toFormat('HH:mm'); | ||
| //was in plugin, changed to scheduler | ||
| scheduledNotifs = notifs.map((n) => { | ||
| const time = DateTime.fromMillis(n.trigger.at).toFormat('t'); | ||
| const date = DateTime.fromMillis(n.trigger.at).toFormat('DDD'); | ||
| return { | ||
| key: date, | ||
| val: time | ||
| } | ||
| }); | ||
| //have the list of scheduled show up in this log | ||
| logDebug(`${prefix}, there are ${notifs.length} scheduled notifications at ${time} first is ${scheduledNotifs[0].key} at ${scheduledNotifs[0].val}`); | ||
| }); | ||
| } | ||
|
|
||
| //new method to fetch notifications | ||
| const getScheduledNotifs = function() { | ||
| return new Promise((resolve, reject) => { | ||
| /* if the notifications are still in active scheduling it causes problems | ||
| anywhere from 0-n of the scheduled notifs are displayed | ||
| if actively scheduling, wait for the scheduledPromise to resolve before fetching prevents such errors | ||
| */ | ||
| if(isScheduling) | ||
| { | ||
| console.log("requesting fetch while still actively scheduling, waiting on scheduledPromise"); | ||
| scheduledPromise.then(() => { | ||
| getNotifs().then((notifs) => { | ||
| console.log("done scheduling notifs", notifs); | ||
| resolve(notifs); | ||
| }) | ||
| }) | ||
| } | ||
| else{ | ||
| getNotifs().then((notifs) => { | ||
| resolve(notifs); | ||
| }) | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| //get scheduled notifications from cordova plugin and format them | ||
| const getNotifs = function() { | ||
| return new Promise((resolve, reject) => { | ||
| window['cordova'].plugins.notification.local.getScheduled((notifs) => { | ||
| if (!notifs?.length){ | ||
| console.log("there are no notifications"); | ||
| resolve([]); //if none, return empty array | ||
| } | ||
|
|
||
| const notifSubset = notifs.slice(0, 5); //prevent near-infinite listing | ||
| let scheduledNotifs = []; | ||
| scheduledNotifs = notifSubset.map((n) => { | ||
| const time = DateTime.fromMillis(n.trigger.at).toFormat('t'); | ||
| const date = DateTime.fromMillis(n.trigger.at).toFormat('DDD'); | ||
| return { | ||
| key: date, | ||
| val: time | ||
| } | ||
| }); | ||
| resolve(scheduledNotifs); | ||
| }); | ||
| }) | ||
| } | ||
|
|
||
| // schedules the notifications using the cordova plugin | ||
| const scheduleNotifs = (scheme, notifTimes) => { | ||
|
There was a problem hiding this comment. You can also type |
||
| return new Promise<void>((rs) => { | ||
| isScheduling = true; | ||
| const localeCode = i18next.resolvedLanguage; | ||
| console.error("notifTimes: ", notifTimes, " - type: ", typeof(notifTimes)); | ||
| const nots = notifTimes.map((n) => { | ||
| console.error("n: ", n, " - type: ", typeof(n)); | ||
| const nDate = n.toDate(); | ||
| const seconds = nDate.getTime() / 1000; | ||
| return { | ||
| id: seconds, | ||
| title: scheme.title[localeCode], | ||
| text: scheme.text[localeCode], | ||
| trigger: {at: nDate}, | ||
| // actions: 'reminder-actions', | ||
| // data: { | ||
| // action: { | ||
| // redirectTo: 'root.main.control', | ||
| // redirectParams: { | ||
| // openTimeOfDayPicker: true | ||
| // } | ||
| // } | ||
| // } | ||
| } | ||
| }); | ||
| window['cordova'].plugins.notification.local.cancelAll(() => { | ||
| debugGetScheduled("After cancelling"); | ||
| window['cordova'].plugins.notification.local.schedule(nots, () => { | ||
| debugGetScheduled("After scheduling"); | ||
| isScheduling = false; | ||
| rs(); //scheduling promise resolved here | ||
| }); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| // determines when notifications are needed, and schedules them if not already scheduled | ||
| const update = async (reminderSchemes) => { | ||
|
There was a problem hiding this comment. I see you already accept |
||
| const { reminder_assignment, | ||
| reminder_join_date, | ||
| reminder_time_of_day} = await getReminderPrefs(reminderSchemes); | ||
| var scheme = {}; | ||
| try { | ||
| scheme = reminderSchemes[reminder_assignment]; | ||
| } catch (e) { | ||
| console.log("ERROR: Could not find reminder scheme for assignment " + reminderSchemes + " - " + reminder_assignment); | ||
| } | ||
|
There was a problem hiding this comment. Appreciate the addition of this catch block - but instead of |
||
| const notifTimes = calcNotifTimes(scheme, reminder_join_date, reminder_time_of_day); | ||
| return new Promise<void>((resolve, reject) => { | ||
| window['cordova'].plugins.notification.local.getScheduled((notifs) => { | ||
| if (areAlreadyScheduled(notifs, notifTimes)) { | ||
| logDebug("Already scheduled, not scheduling again"); | ||
| } else { | ||
| // to ensure we don't overlap with the last scheduling() request, | ||
| // we'll wait for the previous one to finish before scheduling again | ||
| scheduledPromise.then(() => { | ||
| if (isScheduling) { | ||
| console.log("ERROR: Already scheduling notifications, not scheduling again") | ||
| } else { | ||
| scheduledPromise = scheduleNotifs(scheme, notifTimes); | ||
| //enforcing end of scheduling to conisder update through | ||
| scheduledPromise.then(() => { | ||
| resolve(); | ||
| }) | ||
| } | ||
| }); | ||
| } | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| /* Randomly assign a scheme, set the join date to today, | ||
| and use the default time of day from config (or noon if not specified) | ||
| This is only called once when the user first joins the study | ||
| */ | ||
| const initReminderPrefs = (reminderSchemes) => { | ||
| // randomly assign from the schemes listed in config | ||
| const schemes = Object.keys(reminderSchemes); | ||
| const randAssignment = schemes[Math.floor(Math.random() * schemes.length)]; | ||
| const todayDate = DateTime.local().toFormat('yyyy-MM-dd'); | ||
| const defaultTime = reminderSchemes[randAssignment]?.defaultTime || '12:00'; | ||
| return { | ||
| reminder_assignment: randAssignment, | ||
| reminder_join_date: todayDate, | ||
| reminder_time_of_day: defaultTime, | ||
| }; | ||
| } | ||
|
|
||
| /* EXAMPLE VALUES - present in user profile object | ||
| reminder_assignment: 'passive', | ||
| reminder_join_date: '2023-05-09', | ||
| reminder_time_of_day: '21:00', | ||
| */ | ||
| // interface ReminderPrefs { | ||
| // reminder_assignment: string; | ||
| // reminder_join_date: string; | ||
| // reminder_time_of_day: string; | ||
| // } | ||
|
|
||
| const getReminderPrefs = async (reminderSchemes): Promise<any> => { | ||
| const user = await getUser(); | ||
| if (user?.reminder_assignment && | ||
| user?.reminder_join_date && | ||
| user?.reminder_time_of_day) { | ||
| console.log("User already has reminder prefs, returning them", user) | ||
| return user; | ||
| } | ||
| // if no prefs, user just joined, so initialize them | ||
| console.log("User just joined, Initializing reminder prefs") | ||
| const initPrefs = initReminderPrefs(reminderSchemes); | ||
| console.log("Initialized reminder prefs: ", initPrefs); | ||
| await setReminderPrefs(initPrefs, reminderSchemes); | ||
| return { ...user, ...initPrefs }; // user profile + the new prefs | ||
| } | ||
| const setReminderPrefs = async (newPrefs, reminderSchemes) => { | ||
| await updateUser(newPrefs) | ||
| const updatePromise = new Promise<void>((resolve, reject) => { | ||
| //enforcing update before moving on | ||
| update(reminderSchemes).then(() => { | ||
| resolve(); | ||
| }); | ||
| }); | ||
| // record the new prefs in client stats | ||
| getReminderPrefs(reminderSchemes).then((prefs) => { | ||
| // extract only the relevant fields from the prefs, | ||
| // and add as a reading to client stats | ||
| const { reminder_assignment, | ||
| reminder_join_date, | ||
| reminder_time_of_day} = prefs; | ||
| addStatReading(statKeys.REMINDER_PREFS, { | ||
| reminder_assignment, | ||
| reminder_join_date, | ||
| reminder_time_of_day | ||
| }).then(logDebug("Added reminder prefs to client stats")); | ||
| }); | ||
| return updatePromise; | ||
| } | ||
|
|
||
| export function useSchedulerHelper() { | ||
| const appConfig = useAppConfig(); | ||
| const [reminderSchemes, setReminderSchemes] = useState(); | ||
|
|
||
| useEffect(() => { | ||
| if (!appConfig) { | ||
| logDebug("No reminder schemes found in config, not scheduling notifications"); | ||
| return; | ||
| } | ||
| setReminderSchemes(appConfig.reminderSchemes); | ||
| }, [appConfig]); | ||
|
|
||
| //setUpActions(); | ||
| update(reminderSchemes); | ||
|
There was a problem hiding this comment. If you remove the React hook, you'll need to do this |
||
|
|
||
| return { | ||
| setReminderPrefs: (newPrefs) => setReminderPrefs(newPrefs, reminderSchemes), | ||
| getReminderPrefs: () => getReminderPrefs(reminderSchemes), | ||
| getScheduledNotifs: () => getScheduledNotifs(), | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. After seeing the code, I actually think this would be simpler and more concise without using a React hook. We already have access to the |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As you said, we'd ideally type this out properly. I understand if need to use
anyin the short term, but instead of adding ananyreturn type here, I think you should be able to do this at the place wheregetUser()is being called.Like so:
Let me know if that works!