From b5c106ac4cdbe141c25b7ba6782f5ea32a7f96e1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= <freben@gmail.com>
Date: Wed, 27 Oct 2021 22:49:23 +0200
Subject: [PATCH] fix api export and test timeouts
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
---
 packages/backend-tasks/api-report.md                      | 4 +---
 .../backend-tasks/src/tasks/PluginTaskManagerImpl.test.ts | 1 +
 packages/backend-tasks/src/tasks/TaskManager.test.ts      | 1 +
 packages/backend-tasks/src/tasks/types.ts                 | 8 ++++++++
 4 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/packages/backend-tasks/api-report.md b/packages/backend-tasks/api-report.md
index 8f7209b9ed..2be69f8788 100644
--- a/packages/backend-tasks/api-report.md
+++ b/packages/backend-tasks/api-report.md
@@ -24,9 +24,7 @@ export interface TaskDefinition {
   timeout: Duration;
 }
 
-// Warning: (ae-missing-release-tag) "TaskFunction" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export type TaskFunction =
   | ((abortSignal: AbortSignal_2) => void | Promise<void>)
   | (() => void | Promise<void>);
diff --git a/packages/backend-tasks/src/tasks/PluginTaskManagerImpl.test.ts b/packages/backend-tasks/src/tasks/PluginTaskManagerImpl.test.ts
index 27fd1f9f3b..cbf754d5cf 100644
--- a/packages/backend-tasks/src/tasks/PluginTaskManagerImpl.test.ts
+++ b/packages/backend-tasks/src/tasks/PluginTaskManagerImpl.test.ts
@@ -56,6 +56,7 @@ describe('PluginTaskManagerImpl', () => {
           expect(fn).toBeCalled();
         });
       },
+      60_000,
     );
   });
 });
diff --git a/packages/backend-tasks/src/tasks/TaskManager.test.ts b/packages/backend-tasks/src/tasks/TaskManager.test.ts
index 43fe79709c..3f2d9dbc54 100644
--- a/packages/backend-tasks/src/tasks/TaskManager.test.ts
+++ b/packages/backend-tasks/src/tasks/TaskManager.test.ts
@@ -56,5 +56,6 @@ describe('TaskManager', () => {
         expect(fn).toBeCalled();
       });
     },
+    60_000,
   );
 });
diff --git a/packages/backend-tasks/src/tasks/types.ts b/packages/backend-tasks/src/tasks/types.ts
index 4cd33fd3e1..c717a17c3b 100644
--- a/packages/backend-tasks/src/tasks/types.ts
+++ b/packages/backend-tasks/src/tasks/types.ts
@@ -18,6 +18,14 @@ import { Duration } from 'luxon';
 import { AbortSignal } from 'node-abort-controller';
 import { z } from 'zod';
 
+/**
+ * A function that can be called as a scheduled task.
+ *
+ * It may optionally accept an abort signal argument. When the signal triggers,
+ * processing should abort and return as quickly as possible.
+ *
+ * @public
+ */
 export type TaskFunction =
   | ((abortSignal: AbortSignal) => void | Promise<void>)
   | (() => void | Promise<void>);