addComment V3 support simple string body (MrRefactoring#260)

Cellule · web-flow · commit 81c91a82daca · 2023-04-12T22:55:47.000+04:00
* addComment V3 support simple string body

* Apply code review suggestions
diff --git a/.prettierrc b/.prettierrc
@@ -1,5 +1,10 @@
 {
-  "plugins": [
-    "prettier-plugin-jsdoc"
-  ]
+  "arrowParens": "avoid",
+  "endOfLine": "lf",
+  "plugins": ["prettier-plugin-jsdoc"],
+  "printWidth": 120,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "useTabs": false
 }
diff --git a/src/version3/issueComments.ts b/src/version3/issueComments.ts
@@ -24,7 +24,7 @@ export class IssueComments {
    */
   async getCommentsByIds<T = Models.PageComment>(
     parameters: Parameters.GetCommentsByIds,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of
@@ -77,7 +77,7 @@ export class IssueComments {
    */
   async getComments<T = Models.PageOfComments>(
     parameters: Parameters.GetComments | string,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all comments for an issue.
@@ -96,7 +96,7 @@ export class IssueComments {
    */
   async getComments<T = Models.PageOfComments>(
     parameters: Parameters.GetComments | string,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getComments<T = Models.PageOfComments>(
     parameters: Parameters.GetComments | string,
@@ -145,7 +145,16 @@ export class IssueComments {
    */
   async addComment<T = Models.Comment>(parameters: Parameters.AddComment, callback?: never): Promise<T>;
   async addComment<T = Models.Comment>(parameters: Parameters.AddComment, callback?: Callback<T>): Promise<void | T> {
-    // todo add simple comment structure (string)
+    const body = typeof parameters.body === 'string' ? {
+      type: 'doc',
+      version: 1,
+      content: [
+        {
+          type: 'paragraph',
+          content: [{ type: 'text', text: parameters.body }],
+        },
+      ],
+    } : parameters.body;
 
     const config: RequestConfig = {
       url: `/rest/api/3/issue/${parameters.issueIdOrKey}/comment`,
@@ -157,7 +166,7 @@ export class IssueComments {
         self: parameters.self,
         id: parameters.id,
         author: parameters.author,
-        body: parameters.body,
+        body,
         renderedBody: parameters.renderedBody,
         updateAuthor: parameters.updateAuthor,
         created: parameters.created,
diff --git a/src/version3/parameters/addComment.ts b/src/version3/parameters/addComment.ts
@@ -1,6 +1,6 @@
-import { Comment } from '../models';
+import { Comment, Document } from '../models';
 
-export interface AddComment extends Comment {
+export interface AddComment extends Omit<Comment, 'body'> {
   /** The ID or key of the issue. */
   issueIdOrKey: string;
   /**
@@ -9,4 +9,9 @@ export interface AddComment extends Comment {
    * rendered in HTML.
    */
   expand?: string;
+  /**
+   * The comment text in [Atlassian Document
+   * Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/).
+   */
+  body?: string | Document;
 }
diff --git a/tests/unit/version3/issueComments.test.ts b/tests/unit/version3/issueComments.test.ts
@@ -39,3 +39,40 @@ test('addComment should accept follow parameters', t => {
     visibility: undefined,
   });
 });
+
+test('addComment should accept body string and convert to simple Document', t => {
+  const client = new Version3Client({
+    host: 'http://localhost',
+    newErrorHandling: true,
+  });
+  const sendRequestStub = sinon.stub(client, 'sendRequest');
+
+  client.issueComments.addComment({
+    issueIdOrKey: 'key',
+    body: 'Comment',
+  });
+
+  t.truthy(sendRequestStub.calledOnce);
+
+  const callArgument = sendRequestStub.getCall(0).args[0];
+
+  t.is(callArgument.url, '/rest/api/3/issue/key/comment');
+  t.deepEqual(callArgument.data, {
+    author: undefined,
+    body: {
+      type: 'doc',
+      version: 1,
+      content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Comment' }] }],
+    },
+    created: undefined,
+    id: undefined,
+    jsdAuthorCanSeeRequest: undefined,
+    jsdPublic: undefined,
+    properties: undefined,
+    renderedBody: undefined,
+    self: undefined,
+    updateAuthor: undefined,
+    updated: undefined,
+    visibility: undefined,
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,10 @@`
`1`	`1`	`{`
`2`		`- "plugins": [`
`3`		`- "prettier-plugin-jsdoc"`
`4`		`- ]`
	`2`	`+ "arrowParens": "avoid",`
	`3`	`+ "endOfLine": "lf",`
	`4`	`+ "plugins": ["prettier-plugin-jsdoc"],`
	`5`	`+ "printWidth": 120,`
	`6`	`+ "singleQuote": true,`
	`7`	`+ "tabWidth": 2,`
	`8`	`+ "trailingComma": "all",`
	`9`	`+ "useTabs": false`
`5`	`10`	`}`