change return object for broker observe function

Signed-off-by: Brian Fletcher <brian@roadie.io>

plugins/scaffolder-backend/api-report.md

@@ -369,7 +369,9 @@ export interface TaskBroker {
         events: SerializedTaskEvent[];
       },
     ) => void,
-  ): () => void;
+  ): {
+    unsubscribe: () => void;
+  };
   // (undocumented)
   vacuumTasks(timeoutS: { timeoutS: number }): Promise<void>;
 }

plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts

@@ -178,7 +178,7 @@ export class StorageTaskBroker implements TaskBroker {
       error: Error | undefined,
       result: { events: SerializedTaskEvent[] },
     ) => void,
-  ): () => void {
+  ): { unsubscribe: () => void } {
     const { taskId } = options;
 
     let cancelled = false;
@@ -205,7 +205,7 @@ export class StorageTaskBroker implements TaskBroker {
       }
     })();
 
-    return unsubscribe;
+    return { unsubscribe };
   }
 
   async vacuumTasks(timeoutS: { timeoutS: number }): Promise<void> {

plugins/scaffolder-backend/src/scaffolder/tasks/types.ts

@@ -166,7 +166,7 @@ export interface TaskBroker {
       error: Error | undefined,
       result: { events: SerializedTaskEvent[] },
     ) => void,
-  ): () => void;
+  ): { unsubscribe: () => void };
   get(taskId: string): Promise<SerializedTask>;
 }
 

plugins/scaffolder-backend/src/service/router.ts

@@ -258,7 +258,7 @@ export async function createRouter(
       });
 
       // After client opens connection send all events as string
-      const unsubscribe = taskBroker.observe(
+      const { unsubscribe } = taskBroker.observe(
         { taskId, after },
         (error, { events }) => {
           if (error) {