From c1ac4e6292b70a78cc17e2dda16f0475fed20b55 Mon Sep 17 00:00:00 2001
From: hum <65712791+hum@users.noreply.github.com>
Date: Mon, 15 Jan 2024 20:02:33 +0100
Subject: [PATCH] feat: add EndTime

---
 scheduler.go |  6 ++++++
 task.go      | 18 ++++++++++++++++++
 2 files changed, 24 insertions(+)

diff --git a/scheduler.go b/scheduler.go
index ea38acf..ac8bd39 100644
--- a/scheduler.go
+++ b/scheduler.go
@@ -118,6 +118,12 @@ func (s *Scheduler) execTask(task *task, runOnce bool) {
 			}
 
 			task.timer = time.AfterFunc(tick, func() {
+				// Make sure to check if the end time has not been exceeded
+				if task.EndTime != nil && time.Now().After(*task.EndTime) {
+					s.RemoveTask(task.ID)
+					return
+				}
+
 				go task.run()
 				defer func() {
 					if !runOnce {
diff --git a/task.go b/task.go
index 7e5153c..3e73180 100644
--- a/task.go
+++ b/task.go
@@ -19,6 +19,9 @@ type TaskOpts struct {
 	// Offsets the initial startup to a given start time. By default it will start immediately on schedule.
 	StartTime time.Time
 
+	// Restricts the time boundary of the runtime to an end date. By default it is unbound.
+	EndTime time.Time
+
 	// Interval for Fn's execution within the scheduler. This is the function's tick.
 	Interval time.Duration
 
@@ -42,6 +45,9 @@ type task struct {
 	// Offsets the initial startup to a given start time. By default it will start immediately on schedule.
 	StartTime time.Time
 
+	// Restricts the time boundary of the runtime to an end date. By default it is unbound.
+	EndTime *time.Time
+
 	// Interval for Fn's execution within the scheduler. This is the function's tick.
 	Interval time.Duration
 
@@ -82,14 +88,26 @@ func NewTask(opts TaskOpts) *task {
 
 		// Internal context for the task. Used for cancellation.
 		ctx, cancel = context.WithCancel(context.Background())
+
+		endTime *time.Time
 	)
 
+	// If EndTime is not set, it defaults to 0001-01-01 00:00:00 +0000 UTC
+	if !opts.EndTime.IsZero() {
+		// Only allow end time if it is in the future
+		if opts.EndTime.Before(time.Now()) {
+			panic(fmt.Sprintf("task was scheduled to end in the past: %s", opts.EndTime.String()))
+		}
+		endTime = &opts.EndTime
+	}
+
 	return &task{
 		ID:        taskid,
 		Fn:        opts.Fn,
 		ErrFn:     opts.ErrFn,
 		Interval:  opts.Interval,
 		StartTime: opts.StartTime,
+		EndTime:   endTime,
 		cron:      cronExpr,
 		ctx:       ctx,
 		cancel:    cancel,