Skip to content

Commit 72cd641

Browse files
Tiberriver256Tiberriver256
committed
feat: implement manage work item link handler
Add feature to manage work item links Allows adding, removing, and updating links between work items
1 parent 1b4ddff commit 72cd641

File tree

11 files changed

+516
-0
lines changed

11 files changed

+516
-0
lines changed

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,9 @@ For repository-specific tool documentation, see the [Repositories Tools Guide](d
164164

165165
- `get_work_item`: Retrieve a work item by ID
166166
- `create_work_item`: Create a new work item
167+
- `update_work_item`: Update an existing work item
168+
- `list_work_items`: List work items in a project
169+
- `manage_work_item_link`: Add, remove, or update links between work items
167170

168171
## Contributing
169172

‎project-management/task-management/doing.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎project-management/task-management/done.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,45 @@
11
## Completed Tasks
22

3+
- [x] **Task 1.0**: Implement `manage_work_item_link` handler with tests
4+
- **Role**: Full-Stack Developer
5+
- **Phase**: Completed
6+
- **Notes**:
7+
- Work item links in Azure DevOps represent relationships between work items
8+
- Common link types include:
9+
- Hierarchy links (Parent/Child)
10+
- Related links
11+
- Dependency links (Predecessor/Successor)
12+
- Custom link types specific to the organization
13+
- Azure DevOps API provides the following for work item links:
14+
- Work Item Relation Types API: Lists available link types
15+
- Work Items API: Can create/update work items with links via JSON Patch operations
16+
- Reporting Work Item Links API: Can retrieve work item link information
17+
- Creating a link requires:
18+
- Source work item ID
19+
- Target work item ID
20+
- Relation type reference name (e.g., "System.LinkTypes.Hierarchy-Forward")
21+
- Links are managed via JSON Patch document with operations like:
22+
- "add" operation to add a link
23+
- "remove" operation to remove a link
24+
- The `manage_work_item_link` handler supports:
25+
- Adding a link between two work items
26+
- Removing a link between two work items
27+
- Updating a link type (removing existing and adding new)
28+
- Implementation:
29+
- Created schema for handler parameters
30+
- Implemented handler function that creates the appropriate JSON patch document
31+
- Added proper error handling and validation
32+
- Added unit and integration tests
33+
- Updated documentation
34+
- **Sub-tasks**:
35+
- [x] Research Azure DevOps API for work item link management
36+
- [x] Define schema for the handler (inputs and outputs)
37+
- [x] Create test cases for the handler
38+
- [x] Implement the handler
39+
- [x] Ensure proper error handling and validation
40+
- [x] Write and run both unit and integration tests
41+
- **Completed**: March 31, 2024
42+
343
- [x] **Task 2.6**: Implement `list_work_items` handler with tests
444

545
- **Role**: Full-Stack Developer

‎src/features/work-items/index.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ export * from './list-work-items';
77
export * from './get-work-item';
88
export * from './create-work-item';
99
export * from './update-work-item';
10+
export * from './manage-work-item-link';

‎src/features/work-items/manage-work-item-link/feature.spec.int.ts‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
import { WebApi } from 'azure-devops-node-api';
2+
import { manageWorkItemLink } from './feature';
3+
import { createWorkItem } from '../create-work-item/feature';
4+
import {
5+
getTestConnection,
6+
shouldSkipIntegrationTest,
7+
} from '../../../shared/test/test-helpers';
8+
import { CreateWorkItemOptions } from '../types';
9+
10+
// Note: These tests will be skipped in CI due to missing credentials
11+
// They are meant to be run manually in a dev environment with proper Azure DevOps setup
12+
describe('manageWorkItemLink integration', () => {
13+
let connection: WebApi | null = null;
14+
let projectName: string;
15+
let sourceWorkItemId: number | null = null;
16+
let targetWorkItemId: number | null = null;
17+
18+
beforeAll(async () => {
19+
// Get a real connection using environment variables
20+
connection = await getTestConnection();
21+
projectName = process.env.AZURE_DEVOPS_DEFAULT_PROJECT || 'DefaultProject';
22+
23+
// Skip setup if integration tests should be skipped
24+
if (shouldSkipIntegrationTest() || !connection) {
25+
return;
26+
}
27+
28+
try {
29+
// Create source work item for link tests
30+
const sourceOptions: CreateWorkItemOptions = {
31+
title: `Source Work Item for Link Tests ${new Date().toISOString()}`,
32+
description:
33+
'Source work item for integration tests of manage-work-item-link',
34+
};
35+
36+
const sourceWorkItem = await createWorkItem(
37+
connection,
38+
projectName,
39+
'Task',
40+
sourceOptions,
41+
);
42+
43+
// Create target work item for link tests
44+
const targetOptions: CreateWorkItemOptions = {
45+
title: `Target Work Item for Link Tests ${new Date().toISOString()}`,
46+
description:
47+
'Target work item for integration tests of manage-work-item-link',
48+
};
49+
50+
const targetWorkItem = await createWorkItem(
51+
connection,
52+
projectName,
53+
'Task',
54+
targetOptions,
55+
);
56+
57+
// Store the work item IDs for the tests
58+
if (sourceWorkItem && sourceWorkItem.id !== undefined) {
59+
sourceWorkItemId = sourceWorkItem.id;
60+
}
61+
if (targetWorkItem && targetWorkItem.id !== undefined) {
62+
targetWorkItemId = targetWorkItem.id;
63+
}
64+
} catch (error) {
65+
console.error('Failed to create work items for link tests:', error);
66+
}
67+
});
68+
69+
test('should add a link between two existing work items', async () => {
70+
// Skip if integration tests should be skipped or if work items weren't created
71+
if (
72+
shouldSkipIntegrationTest() ||
73+
!connection ||
74+
!sourceWorkItemId ||
75+
!targetWorkItemId
76+
) {
77+
return;
78+
}
79+
80+
// Act & Assert - should not throw
81+
const result = await manageWorkItemLink(connection, projectName, {
82+
sourceWorkItemId,
83+
targetWorkItemId,
84+
operation: 'add',
85+
relationType: 'System.LinkTypes.Related',
86+
comment: 'Link created by integration test',
87+
});
88+
89+
// Assert
90+
expect(result).toBeDefined();
91+
expect(result.id).toBe(sourceWorkItemId);
92+
});
93+
94+
test('should handle non-existent work items gracefully', async () => {
95+
// Skip if integration tests should be skipped or if no connection
96+
if (shouldSkipIntegrationTest() || !connection) {
97+
return;
98+
}
99+
100+
// Use a very large ID that's unlikely to exist
101+
const nonExistentId = 999999999;
102+
103+
// Act & Assert - should throw an error for non-existent work item
104+
await expect(
105+
manageWorkItemLink(connection, projectName, {
106+
sourceWorkItemId: nonExistentId,
107+
targetWorkItemId: nonExistentId,
108+
operation: 'add',
109+
relationType: 'System.LinkTypes.Related',
110+
}),
111+
).rejects.toThrow(/[Ww]ork [Ii]tem.*not found|does not exist/);
112+
});
113+
114+
test('should handle non-existent relationship types gracefully', async () => {
115+
// Skip if integration tests should be skipped or if work items weren't created
116+
if (
117+
shouldSkipIntegrationTest() ||
118+
!connection ||
119+
!sourceWorkItemId ||
120+
!targetWorkItemId
121+
) {
122+
return;
123+
}
124+
125+
// Act & Assert - should throw an error for non-existent relation type
126+
await expect(
127+
manageWorkItemLink(connection, projectName, {
128+
sourceWorkItemId,
129+
targetWorkItemId,
130+
operation: 'add',
131+
relationType: 'NonExistentLinkType',
132+
}),
133+
).rejects.toThrow(/[Rr]elation|[Ll]ink|[Tt]ype/); // Error may vary, but should mention relation/link/type
134+
});
135+
});

‎src/features/work-items/manage-work-item-link/feature.spec.unit.ts‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
import { manageWorkItemLink } from './feature';
2+
import { AzureDevOpsResourceNotFoundError } from '../../../shared/errors';
3+
4+
describe('manageWorkItemLink', () => {
5+
let mockConnection: any;
6+
let mockWitApi: any;
7+
8+
const projectId = 'test-project';
9+
const sourceWorkItemId = 123;
10+
const targetWorkItemId = 456;
11+
const relationType = 'System.LinkTypes.Related';
12+
const newRelationType = 'System.LinkTypes.Hierarchy-Forward';
13+
const comment = 'Test link comment';
14+
15+
beforeEach(() => {
16+
mockWitApi = {
17+
updateWorkItem: jest.fn(),
18+
};
19+
20+
mockConnection = {
21+
getWorkItemTrackingApi: jest.fn().mockResolvedValue(mockWitApi),
22+
serverUrl: 'https://dev.azure.com/test-org',
23+
};
24+
});
25+
26+
test('should add a work item link', async () => {
27+
// Setup
28+
const updatedWorkItem = {
29+
id: sourceWorkItemId,
30+
fields: { 'System.Title': 'Test' },
31+
};
32+
mockWitApi.updateWorkItem.mockResolvedValue(updatedWorkItem);
33+
34+
// Execute
35+
const result = await manageWorkItemLink(mockConnection, projectId, {
36+
sourceWorkItemId,
37+
targetWorkItemId,
38+
operation: 'add',
39+
relationType,
40+
comment,
41+
});
42+
43+
// Verify
44+
expect(mockConnection.getWorkItemTrackingApi).toHaveBeenCalled();
45+
expect(mockWitApi.updateWorkItem).toHaveBeenCalledWith(
46+
{}, // customHeaders
47+
[
48+
{
49+
op: 'add',
50+
path: '/relations/-',
51+
value: {
52+
rel: relationType,
53+
url: `${mockConnection.serverUrl}/_apis/wit/workItems/${targetWorkItemId}`,
54+
attributes: { comment },
55+
},
56+
},
57+
],
58+
sourceWorkItemId,
59+
projectId,
60+
);
61+
expect(result).toEqual(updatedWorkItem);
62+
});
63+
64+
test('should remove a work item link', async () => {
65+
// Setup
66+
const updatedWorkItem = {
67+
id: sourceWorkItemId,
68+
fields: { 'System.Title': 'Test' },
69+
};
70+
mockWitApi.updateWorkItem.mockResolvedValue(updatedWorkItem);
71+
72+
// Execute
73+
const result = await manageWorkItemLink(mockConnection, projectId, {
74+
sourceWorkItemId,
75+
targetWorkItemId,
76+
operation: 'remove',
77+
relationType,
78+
});
79+
80+
// Verify
81+
expect(mockConnection.getWorkItemTrackingApi).toHaveBeenCalled();
82+
expect(mockWitApi.updateWorkItem).toHaveBeenCalledWith(
83+
{}, // customHeaders
84+
[
85+
{
86+
op: 'remove',
87+
path: `/relations/+[rel=${relationType};url=${mockConnection.serverUrl}/_apis/wit/workItems/${targetWorkItemId}]`,
88+
},
89+
],
90+
sourceWorkItemId,
91+
projectId,
92+
);
93+
expect(result).toEqual(updatedWorkItem);
94+
});
95+
96+
test('should update a work item link', async () => {
97+
// Setup
98+
const updatedWorkItem = {
99+
id: sourceWorkItemId,
100+
fields: { 'System.Title': 'Test' },
101+
};
102+
mockWitApi.updateWorkItem.mockResolvedValue(updatedWorkItem);
103+
104+
// Execute
105+
const result = await manageWorkItemLink(mockConnection, projectId, {
106+
sourceWorkItemId,
107+
targetWorkItemId,
108+
operation: 'update',
109+
relationType,
110+
newRelationType,
111+
comment,
112+
});
113+
114+
// Verify
115+
expect(mockConnection.getWorkItemTrackingApi).toHaveBeenCalled();
116+
expect(mockWitApi.updateWorkItem).toHaveBeenCalledWith(
117+
{}, // customHeaders
118+
[
119+
{
120+
op: 'remove',
121+
path: `/relations/+[rel=${relationType};url=${mockConnection.serverUrl}/_apis/wit/workItems/${targetWorkItemId}]`,
122+
},
123+
{
124+
op: 'add',
125+
path: '/relations/-',
126+
value: {
127+
rel: newRelationType,
128+
url: `${mockConnection.serverUrl}/_apis/wit/workItems/${targetWorkItemId}`,
129+
attributes: { comment },
130+
},
131+
},
132+
],
133+
sourceWorkItemId,
134+
projectId,
135+
);
136+
expect(result).toEqual(updatedWorkItem);
137+
});
138+
139+
test('should throw error when work item not found', async () => {
140+
// Setup
141+
mockWitApi.updateWorkItem.mockResolvedValue(null);
142+
143+
// Execute and verify
144+
await expect(
145+
manageWorkItemLink(mockConnection, projectId, {
146+
sourceWorkItemId,
147+
targetWorkItemId,
148+
operation: 'add',
149+
relationType,
150+
}),
151+
).rejects.toThrow(AzureDevOpsResourceNotFoundError);
152+
});
153+
154+
test('should throw error when update operation missing newRelationType', async () => {
155+
// Execute and verify
156+
await expect(
157+
manageWorkItemLink(mockConnection, projectId, {
158+
sourceWorkItemId,
159+
targetWorkItemId,
160+
operation: 'update',
161+
relationType,
162+
// newRelationType is missing
163+
}),
164+
).rejects.toThrow('New relation type is required for update operation');
165+
});
166+
});

0 commit comments

Comments
 (0)