feat: send overdue tasks email notification at 9:00 in the user's time zone

This commit is contained in:
kolaente 2022-06-12 21:24:16 +02:00
parent 2f25b48869
commit 7eb3b96a44
No known key found for this signature in database
GPG key ID: F40E70337AB24C9B
2 changed files with 78 additions and 36 deletions

View file

@ -19,37 +19,85 @@ package models
import ( import (
"time" "time"
"code.vikunja.io/api/pkg/user"
"code.vikunja.io/api/pkg/config" "code.vikunja.io/api/pkg/config"
"code.vikunja.io/api/pkg/cron" "code.vikunja.io/api/pkg/cron"
"code.vikunja.io/api/pkg/db" "code.vikunja.io/api/pkg/db"
"code.vikunja.io/api/pkg/log" "code.vikunja.io/api/pkg/log"
"code.vikunja.io/api/pkg/notifications" "code.vikunja.io/api/pkg/notifications"
"code.vikunja.io/api/pkg/user"
"code.vikunja.io/api/pkg/utils" "code.vikunja.io/api/pkg/utils"
"xorm.io/builder" "xorm.io/builder"
"xorm.io/xorm" "xorm.io/xorm"
) )
func getUndoneOverdueTasks(s *xorm.Session, now time.Time) (taskIDs []int64, err error) { func getUndoneOverdueTasks(s *xorm.Session, now time.Time) (usersWithTasks map[int64]*userWithTasks, err error) {
now = utils.GetTimeWithoutNanoSeconds(now) now = utils.GetTimeWithoutNanoSeconds(now)
nextMinute := now.Add(1 * time.Minute)
var tasks []*Task var tasks []*Task
err = s. err = s.
Where("due_date is not null and due_date < ?", now.Format(dbTimeFormat)). Where("due_date is not null and due_date < ?", nextMinute.Add(time.Hour*14).Format(dbTimeFormat)).
And("done = false"). And("done = false").
Find(&tasks) Find(&tasks)
if err != nil { if err != nil {
return return
} }
if len(tasks) == 0 {
return
}
var taskIDs []int64
for _, task := range tasks { for _, task := range tasks {
taskIDs = append(taskIDs, task.ID) taskIDs = append(taskIDs, task.ID)
} }
users, err := getTaskUsersForTasks(s, taskIDs, builder.Eq{"users.overdue_tasks_reminders_enabled": true})
if err != nil {
return return
} }
if len(users) == 0 {
return
}
uts := make(map[int64]*userWithTasks)
tzs := make(map[string]*time.Location)
for _, t := range users {
if t.User.Timezone == "" {
t.User.Timezone = config.GetTimeZone().String()
}
tz, exists := tzs[t.User.Timezone]
if !exists {
tz, err = time.LoadLocation(t.User.Timezone)
if err != nil {
return
}
tzs[t.User.Timezone] = tz
}
// If it is 9:00 for that current user, add the task to their list of overdue tasks
overdueMailTime := time.Date(now.Year(), now.Month(), now.Day(), 9, 0, 0, 0, tz)
isTimeForReminder := overdueMailTime.After(now) || overdueMailTime.Equal(now.In(tz))
wasTimeForReminder := overdueMailTime.Before(now.Add(time.Minute))
taskIsOverdueInUserTimezone := overdueMailTime.After(t.Task.DueDate.In(tz))
if isTimeForReminder && wasTimeForReminder && taskIsOverdueInUserTimezone {
_, exists := uts[t.User.ID]
if !exists {
uts[t.User.ID] = &userWithTasks{
user: t.User,
tasks: []*Task{},
}
}
uts[t.User.ID].tasks = append(uts[t.User.ID].tasks, t.Task)
}
}
return uts, nil
}
type userWithTasks struct { type userWithTasks struct {
user *user.User user *user.User
tasks []*Task tasks []*Task
@ -66,36 +114,18 @@ func RegisterOverdueReminderCron() {
return return
} }
err := cron.Schedule("0 8 * * *", func() { err := cron.Schedule("* * * * *", func() {
s := db.NewSession() s := db.NewSession()
defer s.Close() defer s.Close()
now := time.Now() now := time.Now()
taskIDs, err := getUndoneOverdueTasks(s, now) uts, err := getUndoneOverdueTasks(s, now)
if err != nil { if err != nil {
log.Errorf("[Undone Overdue Tasks Reminder] Could not get tasks with reminders in the next minute: %s", err) log.Errorf("[Undone Overdue Tasks Reminder] Could not get undone overdue tasks in the next minute: %s", err)
return return
} }
users, err := getTaskUsersForTasks(s, taskIDs, builder.Eq{"users.overdue_tasks_reminders_enabled": true}) log.Debugf("[Undone Overdue Tasks Reminder] Sending reminders to %d users", len(uts))
if err != nil {
log.Errorf("[Undone Overdue Tasks Reminder] Could not get task users to send them reminders: %s", err)
return
}
uts := make(map[int64]*userWithTasks)
for _, t := range users {
_, exists := uts[t.User.ID]
if !exists {
uts[t.User.ID] = &userWithTasks{
user: t.User,
tasks: []*Task{},
}
}
uts[t.User.ID].tasks = append(uts[t.User.ID].tasks, t.Task)
}
log.Debugf("[Undone Overdue Tasks Reminder] Sending reminders to %d users", len(users))
for _, ut := range uts { for _, ut := range uts {
var n notifications.Notification = &UndoneTasksOverdueNotification{ var n notifications.Notification = &UndoneTasksOverdueNotification{
@ -117,7 +147,6 @@ func RegisterOverdueReminderCron() {
} }
log.Debugf("[Undone Overdue Tasks Reminder] Sent reminder email for %d tasks to user %d", len(ut.tasks), ut.user.ID) log.Debugf("[Undone Overdue Tasks Reminder] Sent reminder email for %d tasks to user %d", len(ut.tasks), ut.user.ID)
continue
} }
}) })
if err != nil { if err != nil {

View file

@ -32,21 +32,34 @@ func TestGetUndoneOverDueTasks(t *testing.T) {
now, err := time.Parse(time.RFC3339Nano, "2018-01-01T01:13:00Z") now, err := time.Parse(time.RFC3339Nano, "2018-01-01T01:13:00Z")
assert.NoError(t, err) assert.NoError(t, err)
taskIDs, err := getUndoneOverdueTasks(s, now) tasks, err := getUndoneOverdueTasks(s, now)
assert.NoError(t, err) assert.NoError(t, err)
assert.Len(t, taskIDs, 0) assert.Len(t, tasks, 0)
}) })
t.Run("undone overdue", func(t *testing.T) { t.Run("undone overdue", func(t *testing.T) {
db.LoadAndAssertFixtures(t) db.LoadAndAssertFixtures(t)
s := db.NewSession() s := db.NewSession()
defer s.Close() defer s.Close()
now, err := time.Parse(time.RFC3339Nano, "2018-12-01T01:13:00Z") now, err := time.Parse(time.RFC3339Nano, "2018-12-01T09:00:00Z")
assert.NoError(t, err) assert.NoError(t, err)
taskIDs, err := getUndoneOverdueTasks(s, now) uts, err := getUndoneOverdueTasks(s, now)
assert.NoError(t, err) assert.NoError(t, err)
assert.Len(t, taskIDs, 1) assert.Len(t, uts, 1)
assert.Equal(t, int64(6), taskIDs[0]) assert.Len(t, uts[1].tasks, 2)
// The tasks don't always have the same order, so we only check their presence, not their position.
var task5Present bool
var task6Present bool
for _, t := range uts[1].tasks {
if t.ID == 5 {
task5Present = true
}
if t.ID == 6 {
task6Present = true
}
}
assert.Truef(t, task5Present, "expected task 5 to be present but was not")
assert.Truef(t, task6Present, "expected task 6 to be present but was not")
}) })
t.Run("done overdue", func(t *testing.T) { t.Run("done overdue", func(t *testing.T) {
db.LoadAndAssertFixtures(t) db.LoadAndAssertFixtures(t)
@ -55,8 +68,8 @@ func TestGetUndoneOverDueTasks(t *testing.T) {
now, err := time.Parse(time.RFC3339Nano, "2018-11-01T01:13:00Z") now, err := time.Parse(time.RFC3339Nano, "2018-11-01T01:13:00Z")
assert.NoError(t, err) assert.NoError(t, err)
taskIDs, err := getUndoneOverdueTasks(s, now) tasks, err := getUndoneOverdueTasks(s, now)
assert.NoError(t, err) assert.NoError(t, err)
assert.Len(t, taskIDs, 0) assert.Len(t, tasks, 0)
}) })
} }