Merge pull request #128 from microsoft/users/danhellem/fix-issue-69

Added description and resilency changes to link work item to pr. Use …

Author: danhellem

src/tools/workitems.ts

@@ -304,21 +304,20 @@ function configureWorkItemTools(
     WORKITEM_TOOLS.link_work_item_to_pull_request,
     "Link a single work item to an existing pull request.",
     {
-      project: z.string().describe,
+      project: z.string().describe("The name or ID of the Azure DevOps project."),
       repositoryId: z.string().describe("The ID of the repository containing the pull request. Do not use the repository name here, use the ID instead."),
       pullRequestId: z.number().describe("The ID of the pull request to link to."),
       workItemId: z.number().describe("The ID of the work item to link to the pull request."),
     },
     async ({ project, repositoryId, pullRequestId, workItemId }) => {
-      const connection = await connectionProvider();
-      const workItemTrackingApi = await connection.getWorkItemTrackingApi();
       try {
+        const connection = await connectionProvider();
+        const workItemTrackingApi = await connection.getWorkItemTrackingApi();
+            
         // Create artifact link relation using vstfs format
         // Format: vstfs:///Git/PullRequestId/{project}/{repositoryId}/{pullRequestId}
         const artifactPathValue = `${project}/${repositoryId}/${pullRequestId}`;
-        const vstfsUrl = `vstfs:///Git/PullRequestId/${encodeURIComponent(
-          artifactPathValue
-        )}`;
+        const vstfsUrl = `vstfs:///Git/PullRequestId/${encodeURIComponent(artifactPathValue)}`;
 
         // Use the PATCH document format for adding a relation
         const patchDocument = [
@@ -336,13 +335,17 @@ function configureWorkItemTools(
         ];
 
         // Use the WorkItem API to update the work item with the new relation
-        await workItemTrackingApi.updateWorkItem(
+        const workItem = await workItemTrackingApi.updateWorkItem(
           {},
           patchDocument,
           workItemId,
           project
         );
 
+        if (!workItem) {
+          return { content: [{ type: "text", text: "Work item update failed" }], isError: true };
+        }
+
         return {
           content: [
             {
@@ -359,27 +362,12 @@ function configureWorkItemTools(
             },
           ],
         };
-      } catch (error) {
-        console.error(
-          `Error linking work item ${workItemId} to PR ${pullRequestId}:`,
-          error
-        );
-
-        return {
-          content: [
-            {
-              type: "text",
-              text: JSON.stringify(
-                {
-                  workItemId,
-                  pullRequestId,
-                  success: false,
-                },
-                null,
-                2
-              ),
-            },
-          ],
+       } catch (error) {
+        const errorMessage = error instanceof Error ? error.message : 'Unknown error occurred';
+        
+        return { 
+          content: [{ type: "text", text: `Error linking work item to pull request: ${errorMessage}` }], 
+          isError: true
         };
       }
     }

test/src/tools/workitems.test.ts

@@ -526,7 +526,7 @@ describe("configureWorkItemTools", () => {
       if (!call)throw new Error("wit_link_work_item_to_pull_request tool not registered");
       const [, , , handler] = call;
 
-      (mockWorkItemTrackingApi.updateWorkItem as jest.Mock).mockResolvedValue([        
+      (mockWorkItemTrackingApi.updateWorkItem as jest.Mock).mockResolvedValue([
           _mockWorkItem,
       ]);
 
@@ -575,6 +575,71 @@ describe("configureWorkItemTools", () => {
         )
       );
     });
+
+    it("should handle errors from updateWorkItem and return a descriptive error", async () => {
+      configureWorkItemTools(server, tokenProvider, connectionProvider);
+      const call = (server.tool as jest.Mock).mock.calls.find(
+        ([toolName]) => toolName === "wit_link_work_item_to_pull_request"
+      );
+      
+      if (!call) throw new Error("wit_link_work_item_to_pull_request tool not registered");
+      
+      const [, , , handler] = call;
+      (mockWorkItemTrackingApi.updateWorkItem as jest.Mock).mockRejectedValue(new Error("API failure"));
+      
+      const params = {
+        project: "Contoso",
+        repositoryId: 12345,
+        pullRequestId: 67890,
+        workItemId: 131489,
+      };
+      const result = await handler(params);
+
+      expect(result.isError).toBe(true);
+      expect(result.content[0].text).toContain("API failure");
+    });
+
+    it("should encode special characters in project and repositoryId for vstfsUrl", async () => {
+      configureWorkItemTools(server, tokenProvider, connectionProvider);
+      const call = (server.tool as jest.Mock).mock.calls.find(
+        ([toolName]) => toolName === "wit_link_work_item_to_pull_request"
+      );
+      if (!call) throw new Error("wit_link_work_item_to_pull_request tool not registered");
+      
+      const [, , , handler] = call;
+      (mockWorkItemTrackingApi.updateWorkItem as jest.Mock).mockResolvedValue([
+        _mockWorkItem,
+      ]);
+      
+      const params = {
+        project: "Contoso Project",
+        repositoryId: "repo/with/slash",
+        pullRequestId: 67890,
+        workItemId: 131489,
+      };
+      const artifactPathValue = `${params.project}/${params.repositoryId}/${params.pullRequestId}`;
+      const vstfsUrl = `vstfs:///Git/PullRequestId/${encodeURIComponent(artifactPathValue)}`;
+      const document = [
+        {
+          op: "add",
+          path: "/relations/-",
+          value: {
+            rel: "ArtifactLink",
+            url: vstfsUrl,
+            attributes: {
+              name: "Pull Request",
+            },
+          },
+        },
+      ];
+      await handler(params);
+      expect(mockWorkItemTrackingApi.updateWorkItem).toHaveBeenCalledWith(
+        {},
+        document,
+        params.workItemId,
+        params.project,
+      );
+    });
   });
 
   describe("get_work_items_for_iteration tool", () => {