Merge pull request #193 from patptrs/hotfix/fix-complete-task

🐛 Fix completeTask function in task package
d-velop · Apr 10, 2024 · 292df49 · 292df49
2 parents 92d2ba0 + bdea7eb
commit 292df49
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 14 deletions.
diff --git a/packages/task/src/tasks/complete-task/complete-task.spec.ts b/packages/task/src/tasks/complete-task/complete-task.spec.ts
@@ -1,5 +1,5 @@
 import { DvelopContext } from "@dvelop-sdk/core";
-import { HttpResponse } from "../../utils/http";
+import { HttpResponse, TaskError } from "../../utils/http";
 import { CompleteTaskParams, _completeTaskFactory } from "./complete-task";
 
 describe("completeTaskFactory", () => {
@@ -19,7 +19,7 @@ describe("completeTaskFactory", () => {
     };
 
     params = {
-      location: "HiItsMeLocation"
+      location: "/task/tasks/HiItsMeLocation"
     };
   });
 
@@ -31,8 +31,7 @@ describe("completeTaskFactory", () => {
     expect(mockHttpRequestFunction).toHaveBeenCalledTimes(1);
     expect(mockHttpRequestFunction).toHaveBeenCalledWith(context, {
       method: "POST",
-      url: params.location,
-      follows: ["completion"],
+      url: "/task/tasks/HiItsMeLocation/completionState",
       data: {
         complete: true
       }
@@ -52,4 +51,28 @@ describe("completeTaskFactory", () => {
     expect(mockTransformFunction).toHaveBeenCalledTimes(1);
     expect(mockTransformFunction).toHaveBeenCalledWith(response, context, params);
   });
+
+  it("invalid location should throw an error", async () => {
+    const completeTask = _completeTaskFactory(mockHttpRequestFunction, mockTransformFunction);
+    await expect(() => completeTask(context, {
+      location: "/some/faulty/location"
+    })).rejects.toThrow(TaskError);
+  });
+
+  it("should work with location with request parameters", async () => {
+
+    const completeTask = _completeTaskFactory(mockHttpRequestFunction, mockTransformFunction);
+    await completeTask(context, {
+      location: "/task/tasks/HiItsMeLocation?foo=bar&baz=foo"
+    });
+
+    expect(mockHttpRequestFunction).toHaveBeenCalledTimes(1);
+    expect(mockHttpRequestFunction).toHaveBeenCalledWith(context, {
+      method: "POST",
+      url: "/task/tasks/HiItsMeLocation/completionState",
+      data: {
+        complete: true
+      }
+    });
+  });
 });
diff --git a/packages/task/src/tasks/complete-task/complete-task.ts b/packages/task/src/tasks/complete-task/complete-task.ts
@@ -1,5 +1,5 @@
 import { DvelopContext } from "@dvelop-sdk/core";
-import { HttpConfig, HttpResponse, _defaultHttpRequestFunction } from "../../utils/http";
+import {HttpConfig, HttpResponse, _defaultHttpRequestFunction, TaskError} from "../../utils/http";
 
 /**
  * Parameters for the {@link completeTask}-function.
@@ -21,16 +21,21 @@ export function _completeTaskFactory<T>(
   transformFunction: (response: HttpResponse, context: DvelopContext, params: CompleteTaskParams) => T,
 ): (context: DvelopContext, params: CompleteTaskParams) => Promise<T> {
   return async (context: DvelopContext, params: CompleteTaskParams) => {
+    const matches: RegExpExecArray | null = /^\/task\/tasks\/(?<id>[^?]*)\??.*$/i.exec(params.location);
+    if (matches) {
+      const id = matches.groups?.id;
 
-    const response: HttpResponse = await httpRequestFunction(context, {
-      method: "POST",
-      url: params.location,
-      follows: ["completion"],
-      data: {
-        complete: true
-      }
-    });
-    return transformFunction(response, context, params);
+      const response: HttpResponse = await httpRequestFunction(context, {
+        method: "POST",
+        url: `/task/tasks/${id}/completionState`,
+        data: {
+          complete: true
+        }
+      });
+      return transformFunction(response, context, params);
+    } else {
+      throw new TaskError(`Failed to parse task id from '${params.location}'`);
+    }
   };
 }