fix(github): select the comment endpoint by comment type, not by path

The endpoint was chosen by the presence of path, while the body was chosen by
commentType, so a pr_comment naming a file posted a review body to
POST /pulls/{n}/comments. GitHub documents body, commit_id and path as required
there, so that request can only ever 422 — it has been broken since before this
PR. The endpoint now follows the comment type: only a file comment carrying a
path uses /comments, everything else stays on /reviews. The test that codified
the broken routing is corrected, and the full type/path matrix is pinned.

Author: waleedlatif1

apps/sim/tools/github/comment.test.ts

@@ -109,7 +109,12 @@ describe('github_comment routing', () => {
     ])
   })
 
-  it('never looks the pull request up for a general PR comment carrying a path', async () => {
+  /**
+   * `POST /pulls/{n}/comments` documents `body`, `commit_id` and `path` as required,
+   * so a review body sent there is a guaranteed 422. The endpoint therefore follows
+   * the comment type, not the presence of a path.
+   */
+  it('keeps a general PR comment carrying a path on the reviews endpoint', async () => {
     secureGitHubRequest.mockResolvedValueOnce(createdCommentResponse())
 
     await commentTool.directExecution!({
@@ -124,7 +129,29 @@ describe('github_comment routing', () => {
 
     expect(calls()).toEqual([
       {
-        url: 'https://api.github.com/repos/octo/demo/pulls/7/comments',
+        url: 'https://api.github.com/repos/octo/demo/pulls/7/reviews',
+        method: 'POST',
+        body: { body: 'Nice', event: 'COMMENT' },
+        signal: undefined,
+      },
+    ])
+  })
+
+  it('keeps a comment with no type carrying a path on the reviews endpoint', async () => {
+    secureGitHubRequest.mockResolvedValueOnce(createdCommentResponse())
+
+    await commentTool.directExecution!({
+      owner: 'octo',
+      repo: 'demo',
+      pullNumber: 7,
+      body: 'Nice',
+      path: 'src/main.ts',
+      apiKey: 'ghp_test',
+    })
+
+    expect(calls()).toEqual([
+      {
+        url: 'https://api.github.com/repos/octo/demo/pulls/7/reviews',
         method: 'POST',
         body: { body: 'Nice', event: 'COMMENT' },
         signal: undefined,
@@ -214,6 +241,24 @@ describe('github_comment routing', () => {
     expect(commentTool.params.position).toBeUndefined()
   })
 
+  it('routes every comment type / path combination to the endpoint that accepts it', () => {
+    const url = commentTool.request.url as (params: CreateCommentParams) => string
+    const base = { owner: 'octo', repo: 'demo', pullNumber: 7, body: 'Nice', apiKey: 'ghp_test' }
+    const reviews = 'https://api.github.com/repos/octo/demo/pulls/7/reviews'
+    const comments = 'https://api.github.com/repos/octo/demo/pulls/7/comments'
+
+    expect(url({ ...base, commitId: OTHER_SHA })).toBe(reviews)
+    expect(url({ ...base, commitId: OTHER_SHA, path: 'src/main.ts' })).toBe(reviews)
+    expect(url({ ...base, commitId: OTHER_SHA, commentType: 'pr_comment' })).toBe(reviews)
+    expect(
+      url({ ...base, commitId: OTHER_SHA, commentType: 'pr_comment', path: 'src/main.ts' })
+    ).toBe(reviews)
+    expect(url({ ...base, commitId: OTHER_SHA, commentType: 'file_comment' })).toBe(reviews)
+    expect(
+      url({ ...base, commitId: OTHER_SHA, commentType: 'file_comment', path: 'src/main.ts' })
+    ).toBe(comments)
+  })
+
   it('keeps the declarative request in step with the executed routing', () => {
     const url = commentTool.request.url as (params: CreateCommentParams) => string
     const method = commentTool.request.method as (params: CreateCommentParams) => string

apps/sim/tools/github/comment.ts

@@ -48,18 +48,26 @@ function pullRequestUrl(params: CreateCommentParams): string {
   return `${GITHUB_API_BASE}/repos/${params.owner}/${params.repo}/pulls/${params.pullNumber}`
 }
 
+/**
+ * Whether the request is headed for `POST /pulls/{n}/comments`. GitHub documents
+ * `body`, `commit_id` and `path` as required there, so only a file comment that
+ * actually carries a path can use it. `path` is optional on the block, so a file
+ * comment left without one falls back to `/pulls/{n}/reviews`, where GitHub creates
+ * a pending review and neither field is required.
+ */
+function isFileCommentRequest(params: CreateCommentParams): boolean {
+  return params.commentType === 'file_comment' && Boolean(params.path)
+}
+
 /**
  * GitHub requires `commit_id` on a pull request review comment. When the caller did
  * not supply one, the pull request is fetched first so its head SHA can be used —
  * mirroring how Jira resolves a missing `cloudId` from `domain`.
  *
- * The lookup is gated on `path` because only a request headed for the `/comments`
- * endpoint needs a commit SHA. `path` is optional on the block, so a file comment
- * left without one still falls through to `/pulls/{n}/reviews`, where GitHub creates
- * a pending review and `commit_id` is optional.
+ * The lookup is gated on the endpoint, because only `/comments` needs a commit SHA.
  */
 function needsCommitLookup(params: CreateCommentParams): boolean {
-  return params.commentType === 'file_comment' && Boolean(params.path) && !params.commitId
+  return isFileCommentRequest(params) && !params.commitId
 }
 
 /**
@@ -104,12 +112,15 @@ function fileCommentBody(
 }
 
 /**
- * The endpoint the comment itself is posted to. `path` selects the review-comment
- * endpoint; everything else lands on the reviews endpoint, where GitHub creates a
- * pending review whose `commit_id` is optional.
+ * The endpoint the comment itself is posted to. The comment TYPE selects it, not the
+ * mere presence of `path`: a general PR comment sends `{body, event}`, which the
+ * review-comment endpoint rejects with a 422 for the missing `commit_id` and `path`,
+ * so a `pr_comment` that happens to name a file has to stay on `/reviews`.
  */
 function commentEndpointUrl(params: CreateCommentParams): string {
-  return params.path ? `${pullRequestUrl(params)}/comments` : `${pullRequestUrl(params)}/reviews`
+  return isFileCommentRequest(params)
+    ? `${pullRequestUrl(params)}/comments`
+    : `${pullRequestUrl(params)}/reviews`
 }
 
 function commentRequestBody(