[MM-8497] Ability to set Do Not Disturb for a specified period of time (#16067)

* Add support for timed DND status

- accept a date time value in api query when dnd mode for user needs to be unset
- Create a new function to handle SetDNDStatus calls
- Create a scheduled task to unset dnd mode to wahtever mode was before setting it to DND

* update schema version

* Model changes to make fields more intuitive

- move dndendtime to status model
- add new field prev status in status to keep track of previous status of user
- update db migration function
- make use of prevstatus and dndendtime from status model

* set prev status and dndendtime appropriately after unsetting dnd mode

* add json tag for dndendtime

* unset dnd status only if not changed manually by user

* update dnd statuses after server restart

* make app-layers

* fix failing tests

* don't create sched task when setting status to DND

* get only expired statuses from db

- convert end time from any timezone to utc
- store dnd end time in unix format for usability reasons

* run update dnd status only on leader

* make mocks

* fix tests

* run UpdateDNDStatusOfUsers as recurring task

* save all statuses at once in db and update UpdateDNDStatusOfUsers logic

* add app method to get timezone of user

* store dnd end time in context.Params

* set max size of prevstatus

* update status model to take endtime input as string and store in db as unix time(int64)

* Add tests for SetStatusDoNotDisturbTimed

* if dnd_end_time is not passed the call old api to set dnd mode

* fix tests

* new plugin api to use new timed dnd mode

* get and update rows in a single db query

* dnd end time will be stored in request body and not route param

* exclude statuses which has dndendtimeunix < 0

* update and get the updated dnd statuses in single db query

* add updated status to cache

* DNDEndTimeUnix and PrevStatus need not to be visible to users

* update db schema version for migration

* Keep Status and PrevStatus varchar size same

* add test to verify status is restored after dnd end time expires

* expect endtime in utc from client

- remove store method GetTimezone as no longer needed
- add documentation for SetStatusDoNotDisturbTimed

* reduce sleep time for dnd timed restore test

* more appropriate name for new api to update user status

* update db migration function

* parse and validate time before potentially triggering db query to get status of user

* add migration changes in to existing upgrade function

* not supporting un-timed dnd status via api

* don't call Srv.Store directly, call via app layer

* rename dndendtime to statuscleartime to make it suitable for custom status usage as well

* Revert "rename dndendtime to statuscleartime to make it suitable for custom status usage as well"

This reverts commit fa69152d9a3db18f1c59b34c878fb7ce494440b5.

* mysql doesn't support RETURNING clause so add tx to get and update statuses

* add UpdateDNDStatusOfUsers mock in tests

* update store mock import path

* add mock in storelib

* Add status mocks to empty store

* Close the task during server shutdown

* Do not cancel a nil task

* update squirrel queries

* remove untimed dnd test

* start recurring task to unset statuses on leadership change

* set dndTask to nil after cancelling it upon server shutdown

* new recurring task which starts at nearest rounded time of the interval

* mock Get() call for status

* return updated statuses in case of mysql

* remove unneccessary code

* add Get() mock to empty store

* fix mocking for once and all

* address review comments

fix mysql updateStatus fn

protect dndTask with mutex

minor refactors

* move runDNDStatusExpireJob to server.go and pass App as arg instead of method receiver

* frontend will send endtime in unix epoch format so get rid of double representation

* scan for all fields and not just two

* add some tests and fix review comments

* remove extra sql query and create needed result in go

* add storetest for UpdateExpiredDNDStatuses

* add migrations to latest version

* update min supported version

* add comment to fix a bug in future

* update test to expect 1 status in return

* rename UpdateUserStatusWithDNDTimeout to SetUserStatusTimedDND

* rename DNDEndTimeUnix to DNDEndTime

* cast int to int64 for equality

* fix tests and error handling

* move updating values to retrieved statuses fields outside sql transaction

* move migrations to 5.36

Co-authored-by: Agniva De Sarker <agnivade@yahoo.co.in>
Co-authored-by: Mattermod <mattermod@users.noreply.github.com>

model/scheduled_task.go

@@ -11,42 +11,65 @@ import (
 type TaskFunc func()
 
 type ScheduledTask struct {
-	Name      string        `json:"name"`
-	Interval  time.Duration `json:"interval"`
-	Recurring bool          `json:"recurring"`
-	function  func()
-	cancel    chan struct{}
-	cancelled chan struct{}
+	Name                 string        `json:"name"`
+	Interval             time.Duration `json:"interval"`
+	Recurring            bool          `json:"recurring"`
+	function             func()
+	cancel               chan struct{}
+	cancelled            chan struct{}
+	fromNextIntervalTime bool
 }
 
 func CreateTask(name string, function TaskFunc, timeToExecution time.Duration) *ScheduledTask {
-	return createTask(name, function, timeToExecution, false)
+	return createTask(name, function, timeToExecution, false, false)
 }
 
 func CreateRecurringTask(name string, function TaskFunc, interval time.Duration) *ScheduledTask {
-	return createTask(name, function, interval, true)
+	return createTask(name, function, interval, true, false)
 }
 
-func createTask(name string, function TaskFunc, interval time.Duration, recurring bool) *ScheduledTask {
+func CreateRecurringTaskFromNextIntervalTime(name string, function TaskFunc, interval time.Duration) *ScheduledTask {
+	return createTask(name, function, interval, true, true)
+}
+
+func createTask(name string, function TaskFunc, interval time.Duration, recurring bool, fromNextIntervalTime bool) *ScheduledTask {
 	task := &ScheduledTask{
-		Name:      name,
-		Interval:  interval,
-		Recurring: recurring,
-		function:  function,
-		cancel:    make(chan struct{}),
-		cancelled: make(chan struct{}),
+		Name:                 name,
+		Interval:             interval,
+		Recurring:            recurring,
+		function:             function,
+		cancel:               make(chan struct{}),
+		cancelled:            make(chan struct{}),
+		fromNextIntervalTime: fromNextIntervalTime,
 	}
 
 	go func() {
 		defer close(task.cancelled)
 
-		ticker := time.NewTicker(interval)
+		var firstTick <-chan time.Time
+		var ticker *time.Ticker
+
+		if task.fromNextIntervalTime {
+			currTime := time.Now()
+			first := currTime.Truncate(interval)
+			if first.Before(currTime) {
+				first = first.Add(interval)
+			}
+			firstTick = time.After(time.Until(first))
+			ticker = &time.Ticker{C: nil}
+		} else {
+			firstTick = nil
+			ticker = time.NewTicker(interval)
+		}
 		defer func() {
 			ticker.Stop()
 		}()
 
 		for {
 			select {
+			case <-firstTick:
+				ticker = time.NewTicker(interval)
+				function()
 			case <-ticker.C:
 				function()
 			case <-task.cancel: