feat: add parentId support for threaded comment replies (#407) (#415)

- Add parentId parameter to AddComment interface in version2 and version3
- Include parentId in request body for addComment method in both API versions
- Update CHANGELOG.md with enhancement entries crediting @lukiffer

This allows users to reply to existing comments by providing the parentId
of the comment they want to reply to, enabling threaded comment functionality.

Author: MrRefactoring

CHANGELOG.md

@@ -6,6 +6,8 @@
 
 * Updated dependencies
 * Improved JSDoc coverage and quality
+* Refactored integration tests to use global setup/teardown for better performance and reliability
+* Wrapped all integration tests in describe blocks for better organization
 
 ### Bug Fixes
 
@@ -44,6 +46,11 @@
 * **WorkflowSchemes**
   * Added `WorkflowSchemes.switchWorkflowSchemeForProject`
 
+#### Enhancements
+
+* **IssueComments**
+  * Added `parentId` parameter to `IssueComments.addComment` to support threaded comment replies. Thanks to [lukiffer](https://github.com/lukiffer) for requesting this feature ([#407](https://github.com/MrRefactoring/jira.js/issues/407)).
+
 #### Deprecations
 
 * Marked `JiraExpressions.evaluateJiraExpression` as deprecated
@@ -90,6 +97,11 @@
 * **WorkflowSchemes**
   * Added `WorkflowSchemes.switchWorkflowSchemeForProject`
 
+#### Enhancements
+
+* **IssueComments**
+  * Added `parentId` parameter to `IssueComments.addComment` to support threaded comment replies. Thanks to [lukiffer](https://github.com/lukiffer) for requesting this feature ([#407](https://github.com/MrRefactoring/jira.js/issues/407)).
+
 #### Deprecations
 
 * Marked `JiraExpressions.evaluateJiraExpression` as deprecated

package.json

@@ -94,7 +94,7 @@
     "doc": "typedoc --name \"Jira.js - Jira Cloud API library\" --out docs ./src/index.ts --favicon https://bad37fb3-cb50-4e0b-9035-a3e09e8afb3b.selstorage.ru/jira.js%2Ffavicon.svg",
     "test": "pnpm run build:tests && pnpm run test:unit && pnpm run test:integration",
     "test:unit": "vitest run tests/unit --sequence.concurrent",
-    "test:integration": "vitest run tests/integration --bail=1 --no-file-parallelism --max-concurrency 1 -c vitest.config.mts --hookTimeout 100000 --testTimeout 100000",
+    "test:integration": "VITEST_MODE=integration vitest run tests/integration --bail=1 --no-file-parallelism --max-concurrency 1 --hookTimeout 100000 --testTimeout 100000",
     "replace:all": "pnpm run replace:fixExpansionMarkup && pnpm run replace:permissions:version2 && pnpm run replace:permissions:version3 && pnpm run replace:pagination:version2 && pnpm run replace:pagination:version3 && pnpm run replace:async:version2 && pnpm run replace:async:version3 && pnpm run replace:expansion:version2 && pnpm run replace:expansion:version3 && pnpm run replace:ordering:version2 && pnpm run replace:ordering:version3 && pnpm run replace:groupMember:version2 && pnpm run replace:workflowPaginated:version2 && pnpm run replace:attachment:serviceDesk && pnpm run replace:priority:version3 && pnpm run replace:projectAvatar:version3 && pnpm run replace:issueType:version3 && pnpm run replace:issueType:version2 && pnpm run replace:projectAvatar:version2 && pnpm run replace:priority:version2 && pnpm run replace:projectCreate:agile && pnpm run replace:filterCreate:agile",
     "replace:permissions:version2": "grep -rl \"(#permissions)\" ./src/version2 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#permissions)/g'",
     "replace:permissions:version3": "grep -rl \"(#permissions)\" ./src/version3 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#permissions)/g'",

src/version2/issueComments.ts

@@ -158,6 +158,7 @@ export class IssueComments {
         id: parameters.id,
         jsdAuthorCanSeeRequest: parameters.jsdAuthorCanSeeRequest,
         jsdPublic: parameters.jsdPublic,
+        parentId: parameters.parentId,
         properties: parameters.properties,
         renderedBody: parameters.renderedBody,
         self: parameters.self,

src/version2/parameters/addComment.ts

@@ -9,4 +9,6 @@ export interface AddComment extends Comment {
    * rendered in HTML.
    */
   expand?: string;
+  /** The ID of the comment to which you're replying. */
+  parentId?: string;
 }

src/version3/issueComments.ts

@@ -172,6 +172,7 @@ export class IssueComments {
         id: parameters.id,
         jsdAuthorCanSeeRequest: parameters.jsdAuthorCanSeeRequest,
         jsdPublic: parameters.jsdPublic,
+        parentId: parameters.parentId,
         properties: parameters.properties,
         renderedBody: parameters.renderedBody,
         self: parameters.self,

src/version3/parameters/addComment.ts

@@ -14,4 +14,6 @@ export interface AddComment extends Omit<Comment, 'body'> {
    * Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/).
    */
   comment?: string | Document;
+  /** The ID of the comment to which you're replying. */
+  parentId?: string;
 }

tests/integration/agile/sprint.test.ts

@@ -1,90 +1,82 @@
-import { afterAll, beforeAll, test } from 'vitest';
+import { describe, test } from 'vitest';
 import type { AgileModels } from '@jirajs';
 import { Constants } from '@tests/integration/constants';
 import {
-  createAgileProject,
-  deleteAgileProject,
   getAgileClient,
   getVersion3Client,
 } from '@tests/integration/utils';
 
-const client = getAgileClient();
+describe.sequential('Sprint', () => {
+  const client = getAgileClient();
 
-let board: AgileModels.Board | undefined;
-let sprint: AgileModels.Sprint;
+  let board: AgileModels.Board | undefined;
+  let sprint: AgileModels.Sprint;
 
-beforeAll(async () => {
-  await createAgileProject();
-});
-
-afterAll(async () => {
-  await deleteAgileProject();
-});
-
-test.sequential.skip('should create new sprint', async ({ expect }) => {
-  const boards = await client.board.getAllBoards({ name: Constants.testAgileProjectKey });
+  test.sequential.skip('should create new sprint', async ({ expect }) => {
+    const boards = await client.board.getAllBoards({ name: Constants.testAgileProjectKey });
 
-  expect(boards.total).toBe(1);
+    expect(boards.total).toBe(1);
 
-  [board] = boards.values;
+    [board] = boards.values;
 
-  // @ts-expect-error Wrong typings
-  sprint = await client.sprint.createSprint({
-    name: 'New sprint',
     // @ts-expect-error Wrong typings
-    originBoardId: board.id,
+    sprint = await client.sprint.createSprint({
+      name: 'New sprint',
+      // @ts-expect-error Wrong typings
+      originBoardId: board.id,
+    });
+
+    expect(!!sprint).toBeTruthy();
+    expect(sprint.name).toBe('New sprint');
+    expect(sprint.state).toBe('future');
   });
 
-  expect(!!sprint).toBeTruthy();
-  expect(sprint.name).toBe('New sprint');
-  expect(sprint.state).toBe('future');
-});
-
-test.sequential.skip('should create and move task to sprint', async ({ expect }) => {
-  const issue = await getVersion3Client().issues.createIssue({
-    fields: {
-      summary: 'Test task',
-      project: {
-        key: Constants.testAgileProjectKey,
+  test.sequential.skip('should create and move task to sprint', async ({ expect }) => {
+    const issue = await getVersion3Client().issues.createIssue({
+      fields: {
+        summary: 'Test task',
+        project: {
+          key: Constants.testAgileProjectKey,
+        },
+        issuetype: {
+          name: 'Task',
+        },
       },
-      issuetype: {
-        name: 'Task',
-      },
-    },
-  });
+    });
 
-  await client.backlog.moveIssuesToBacklog({
-    issues: [issue.key],
-  });
+    await client.backlog.moveIssuesToBacklog({
+      issues: [issue.key],
+    });
+
+    await client.sprint.moveIssuesToSprintAndRank({
+      sprintId: sprint.id,
+      issues: [issue.key],
+    });
 
-  await client.sprint.moveIssuesToSprintAndRank({
-    sprintId: sprint.id,
-    issues: [issue.key],
+    expect(!!issue).toBeTruthy();
   });
 
-  expect(!!issue).toBeTruthy();
-});
+  test.sequential.skip('should return issues for sprint', async ({ expect }) => {
+    const { issues } = await client.sprint.getIssuesForSprint({
+      sprintId: sprint.id,
+    });
 
-test.sequential.skip('should return issues for sprint', async ({ expect }) => {
-  const { issues } = await client.sprint.getIssuesForSprint({
-    sprintId: sprint.id,
+    expect(!!issues).toBeTruthy();
+    expect(issues[0].fields?.summary).toBe('Test task');
   });
 
-  expect(!!issues).toBeTruthy();
-  expect(issues[0].fields?.summary).toBe('Test task');
-});
+  test.sequential.skip('should partially update sprint', async ({ expect }) => {
+    const newSprint = await client.sprint.partiallyUpdateSprint({
+      sprintId: sprint.id,
+      state: 'active',
+      startDate: new Date(),
+      endDate: new Date(Date.now() + 1000),
+    });
 
-test.sequential.skip('should partially update sprint', async ({ expect }) => {
-  const newSprint = await client.sprint.partiallyUpdateSprint({
-    sprintId: sprint.id,
-    state: 'active',
-    startDate: new Date(),
-    endDate: new Date(Date.now() + 1000),
+    expect(newSprint.state).toBe('active');
   });
 
-  expect(newSprint.state).toBe('active');
-});
-
-test.sequential.skip('should remove sprint', async () => {
-  await client.sprint.deleteSprint({ sprintId: sprint.id });
+  test.sequential.skip('should remove sprint', async () => {
+    await client.sprint.deleteSprint({ sprintId: sprint.id });
+  });
 });

tests/integration/setup.ts

@@ -0,0 +1,46 @@
+import 'dotenv/config';
+import { createAgileProject } from './utils/createAgileProject';
+import { createSoftwareProject } from './utils/createSoftwareProject';
+import { deleteAgileProject } from './utils/deleteAgileProject';
+import { deleteSoftwareProject } from './utils/deleteSoftwareProject';
+
+export default async function setup() {
+  console.log('Setting up integration test environment...');
+
+  try {
+    await deleteSoftwareProject();
+    console.log('[1/4] Cleaned up existing software project');
+  } catch {
+    console.error('[1/4] No existing software project to clean up');
+  }
+
+  try {
+    await deleteAgileProject();
+    console.log('[2/4] Cleaned up existing agile project');
+  } catch {
+    console.error('[2/4] No existing agile project to clean up');
+  }
+
+  try {
+    await createSoftwareProject();
+    console.log('[3/4] Software project created successfully');
+  } catch (error) {
+    console.error('[3/4] Failed to create software project:', error);
+    throw error;
+  }
+
+  try {
+    await createAgileProject();
+    console.log('[4/4] Agile project created successfully');
+  } catch (error) {
+    console.error('[4/4] Failed to create agile project:', error);
+    try {
+      await deleteSoftwareProject();
+    } catch (cleanupError) {
+      console.error('Failed to cleanup software project:', cleanupError);
+    }
+    throw error;
+  }
+
+  console.log('Integration test environment setup complete');
+}

tests/integration/teardown.ts

@@ -0,0 +1,31 @@
+import 'dotenv/config';
+import { deleteAgileProject } from './utils/deleteAgileProject';
+import { deleteSoftwareProject } from './utils/deleteSoftwareProject';
+
+export default async function teardown() {
+  console.log('Tearing down integration test environment...');
+
+  const errors: Error[] = [];
+
+  try {
+    await deleteSoftwareProject();
+    console.log('[1/2] Software project deleted successfully');
+  } catch (error) {
+    console.error('[1/2] Failed to delete software project:', error);
+    errors.push(error as Error);
+  }
+
+  try {
+    await deleteAgileProject();
+    console.log('[2/2] Agile project deleted successfully');
+  } catch (error) {
+    console.error('[2/2] Failed to delete agile project:', error);
+    errors.push(error as Error);
+  }
+
+  if (errors.length > 0) {
+    console.error('Some projects could not be deleted:', errors);
+  }
+
+  console.log('Integration test environment teardown complete');
+}