Added tests for the task client and runner.

.github/workflows/test.yml

@@ -27,10 +27,5 @@ jobs:
         restore-keys: |
           ${{ runner.os }}-go-
 
-    - name: Start containers
-      run: |
-        docker-compose up -d
-        sleep 3
-
     - name: Test
-      run: go test -p 1 ./...
+      run: go test ./...

cmd/web/main.go

@@ -61,7 +61,7 @@ func main() {
 
 	// Start the task runner to execute queued tasks
 	ctx, cancel := context.WithCancel(context.Background())
-	c.Tasks.StartRunner(ctx)
+	go c.Tasks.StartRunner(ctx)
 
 	// Wait for interrupt signal to gracefully shut down the server with a timeout of 10 seconds.
 	quit := make(chan os.Signal, 1)

docker-compose.yml

@@ -1,18 +0,0 @@
-version: "3"
-
-services:
-  cache:
-    image: "redis:alpine"
-    container_name: pagoda_cache
-    ports:
-      - "127.0.0.1:6379:6379"
-  db:
-    # PG 16 is currently not supported https://github.com/ent/ent/issues/3750
-    image: postgres:15-alpine
-    container_name: pagoda_db
-    ports:
-      - "127.0.0.1:5432:5432"
-    environment:
-      - POSTGRES_USER=admin
-      - POSTGRES_PASSWORD=admin
-      - POSTGRES_DB=app

pkg/services/tasks.go

@@ -98,6 +98,7 @@ func NewTaskClient(cfg config.TasksConfig, db *sql.DB) (*TaskClient, error) {
 // StartRunner starts the scheduler service which adds scheduled tasks to the queue.
 // This must be running in order to execute queued tasked.
 // To stop the runner, cancel the context.
+// This is a blocking call.
 func (t *TaskClient) StartRunner(ctx context.Context) {
 	t.runner.Start(ctx)
 }

pkg/services/tasks_test.go

@@ -1,29 +1,69 @@
 package services
 
-// TODO
+import (
-//func TestTaskClient_New(t *testing.T) {
+	"context"
-//	now := time.Now()
+	"database/sql"
-//	tk := c.Tasks.
+	"github.com/stretchr/testify/assert"
-//		New("task1").
+	"github.com/stretchr/testify/require"
-//		Payload("payload").
+	"testing"
-//		Queue("queue").
+	"time"
-//		Periodic("@every 5s").
+)
-//		MaxRetries(5).
+
-//		Timeout(5 * time.Second).
+type testTask struct {
-//		Deadline(now).
+	Val int
-//		At(now).
+}
-//		Wait(6 * time.Second).
+
-//		Retain(7 * time.Second)
+func (t testTask) Name() string {
-//
+	return "test_task"
-//	assert.Equal(t, "task1", tk.typ)
+}
-//	assert.Equal(t, "payload", tk.payload.(string))
+
-//	assert.Equal(t, "queue", *tk.queue)
+func TestTaskClient_New(t *testing.T) {
-//	assert.Equal(t, "@every 5s", *tk.periodic)
+	var subCalled bool
-//	assert.Equal(t, 5, *tk.maxRetries)
+
-//	assert.Equal(t, 5*time.Second, *tk.timeout)
+	queue := NewQueue[testTask](func(ctx context.Context, task testTask) error {
-//	assert.Equal(t, now, *tk.deadline)
+		subCalled = true
-//	assert.Equal(t, now, *tk.at)
+		assert.Equal(t, 123, task.Val)
-//	assert.Equal(t, 6*time.Second, *tk.wait)
+		return nil
-//	assert.Equal(t, 7*time.Second, *tk.retain)
+	})
-//	assert.NoError(t, tk.Save())
+	c.Tasks.Register(queue)
-//}
+
+	task := testTask{Val: 123}
+
+	tx := &sql.Tx{}
+
+	op := c.Tasks.
+		New(task).
+		Wait(5 * time.Second).
+		Tx(tx)
+
+	// Check that the task op was built correctly
+	assert.Equal(t, task, op.task)
+	assert.Equal(t, tx, op.tx)
+	assert.Equal(t, 5*time.Second, *op.wait)
+
+	// Remove the transaction and delay so we can process the task immediately
+	op.tx, op.wait = nil, nil
+	err := op.Save()
+	require.NoError(t, err)
+
+	// Start the runner
+	ctx, cancel := context.WithCancel(context.Background())
+	go c.Tasks.StartRunner(ctx)
+	defer cancel()
+
+	// Check for up to 5 seconds if the task executed
+	start := time.Now()
+waitLoop:
+	for {
+		switch {
+		case subCalled:
+			break waitLoop
+		case time.Since(start) > (5 * time.Second):
+			break waitLoop
+		default:
+			time.Sleep(10 * time.Millisecond)
+		}
+	}
+
+	assert.True(t, subCalled)
+}

templates/pages/about.gohtml

@@ -19,7 +19,7 @@
                 <p>Warning</p>
             </div>
             <div class="message-body">
-                This route has caching enabled so hot-reloading in the local environment will not work. Check the Redis cache for a key matching the URL path.
+                This route has caching enabled so hot-reloading in the local environment will not work.
             </div>
         </article>
     {{- end}}