type fixes (#112)

<!-- This is an auto-generated comment: release notes by openai -->
### Summary by OpenAI

Release Notes:

- Bug fix: Improves error handling and logging in `Bot` class's `chat`
and `chat_` methods.
- Refactor: Changes the function signature of `codeReview` to return a
Promise.
- Documentation: Updates some formatting in the generated comment.

> "Type fixes galore, 
> Bugs squashed forevermore. 
> Code now more robust, 
> Celebrate with a joyful thrust!"
<!-- end of auto-generated comment: release notes by openai -->

Author: gurinder39

src/bot.ts

@@ -38,14 +38,14 @@ export class Bot {
   }
 
   chat = async (message: string, ids: Ids): Promise<[string, Ids]> => {
-    let new_ids: Ids = {}
-    let response = ''
+    let res: [string, Ids] = ['', {}]
     try {
-      ;[response, new_ids] = await this.chat_(message, ids)
-    } catch (e: any) {
-      core.warning(`Failed to chat: ${e}, backtrace: ${e.stack}`)
-    } finally {
-      return [response, new_ids]
+      res = await this.chat_(message, ids)
+      return res
+    } catch (e: unknown) {
+      if (e instanceof openai.ChatGPTError)
+        core.warning(`Failed to chat: ${e}, backtrace: ${e.stack}`)
+      return res
     }
   }
 
@@ -59,7 +59,7 @@ export class Bot {
       core.info(`sending to openai: ${message}`)
     }
 
-    let response: openai.ChatMessage | null = null
+    let response: openai.ChatMessage | undefined
 
     if (this.api) {
       const opts: openai.SendMessageOptions = {
@@ -69,15 +69,16 @@ export class Bot {
         opts.parentMessageId = ids.parentMessageId
       }
       try {
-        response = await utils.retry(
+        response = await utils.retry<openai.ChatMessage>(
           this.api.sendMessage.bind(this.api),
           [message, opts],
           this.options.openai_retries
         )
-      } catch (e: any) {
-        core.info(
-          `response: ${response}, failed to send message to openai: ${e}, backtrace: ${e.stack}`
-        )
+      } catch (e: unknown) {
+        if (e instanceof openai.ChatGPTError)
+          core.info(
+            `response: ${response}, failed to send message to openai: ${e}, backtrace: ${e.stack}`
+          )
       }
       const end = Date.now()
       core.info(`response: ${JSON.stringify(response)}`)

src/commenter.ts

@@ -1,6 +1,8 @@
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
 import * as core from '@actions/core'
 import * as github from '@actions/github'
 import {Octokit} from '@octokit/action'
+import {ChatGPTError} from 'chatgpt'
 
 const token = core.getInput('token')
   ? core.getInput('token')
@@ -121,7 +123,7 @@ ${tag}`
           body: new_description
         })
       }
-    } catch (e: any) {
+    } catch (e) {
       core.warning(
         `Failed to get PR: ${e}, skipping adding release notes to description.`
       )
@@ -169,7 +171,7 @@ ${tag}`
           line
         })
       }
-    } catch (e: any) {
+    } catch (e) {
       core.warning(`Failed to post review comment: ${e}`)
     }
   }
@@ -239,7 +241,7 @@ ${COMMENT_REPLY_TAG}
     pull_number: number,
     path: string,
     line: number,
-    tag: string = ''
+    tag = ''
   ) {
     const existing_comments = await this.get_comments_at_line(
       pull_number,
@@ -300,7 +302,7 @@ ${chain}
         top_level_comment
       )
       return {chain, topLevelComment: top_level_comment}
-    } catch (e: any) {
+    } catch (e) {
       core.warning(`Failed to get conversation chain: ${e}`)
       return {
         chain: '',
@@ -347,8 +349,8 @@ ${chain}
       }
 
       return all_comments
-    } catch (e: any) {
-      console.warn(`Failed to list review comments: ${e}`)
+    } catch (e) {
+      core.warning(`Failed to list review comments: ${e}`)
       return all_comments
     }
   }
@@ -361,7 +363,7 @@ ${chain}
         issue_number: target,
         body
       })
-    } catch (e: any) {
+    } catch (e) {
       core.warning(`Failed to create comment: ${e}`)
     }
   }
@@ -379,7 +381,7 @@ ${chain}
       } else {
         await this.create(body, target)
       }
-    } catch (e: any) {
+    } catch (e) {
       core.warning(`Failed to replace comment: ${e}`)
     }
   }
@@ -397,7 +399,7 @@ ${chain}
       } else {
         await this.create(body, target)
       }
-    } catch (e: any) {
+    } catch (e) {
       core.warning(`Failed to append comment: ${e}`)
     }
   }
@@ -415,7 +417,7 @@ ${chain}
       } else {
         await this.create(body, target)
       }
-    } catch (e: any) {
+    } catch (e) {
       core.warning(`Failed to prepend comment: ${e}`)
     }
   }
@@ -430,7 +432,7 @@ ${chain}
       }
 
       return null
-    } catch (e: any) {
+    } catch (e: unknown) {
       core.warning(`Failed to find comment with tag: ${e}`)
       return null
     }
@@ -456,8 +458,10 @@ ${chain}
       }
 
       return all_comments
-    } catch (e: any) {
-      console.warn(`Failed to list comments: ${e}`)
+    } catch (e: unknown) {
+      if (e instanceof ChatGPTError) {
+        core.warning(`Failed to list comments: ${e}`)
+      }
       return all_comments
     }
   }

src/review.ts

@@ -6,6 +6,7 @@ import {Bot} from './bot.js'
 import {Commenter, COMMENT_REPLY_TAG, SUMMARIZE_TAG} from './commenter.js'
 import {Inputs, Options, Prompts} from './options.js'
 import * as tokenizer from './tokenizer.js'
+import {ChatGPTError} from 'chatgpt'
 
 const token = core.getInput('token')
   ? core.getInput('token')
@@ -18,7 +19,7 @@ export const codeReview = async (
   bot: Bot,
   options: Options,
   prompts: Prompts
-) => {
+): Promise<void> => {
   const commenter: Commenter = new Commenter()
 
   const openai_concurrency_limit = pLimit(options.openai_concurrency_limit)
@@ -122,12 +123,7 @@ export const codeReview = async (
         patches.push([line, patch])
       }
       if (patches.length > 0) {
-        return [file.filename, file_content, file_diff, patches] as [
-          string,
-          string,
-          string,
-          [number, string][]
-        ]
+        return [file.filename, file_content, file_diff, patches]
       } else {
         return null
       }
@@ -233,8 +229,9 @@ ${filename}: ${summary}
 
 ---
 
-${filter_ignored_files.length > 0
-          ? `
+${
+  filter_ignored_files.length > 0
+    ? `
 <details>
 <summary>Files ignored due to filter (${filter_ignored_files.length})</summary>
 
@@ -244,23 +241,25 @@ ${filter_ignored_files.length > 0
 
 </details>
 `
-          : ''
-        }
+    : ''
+}
 
-${skipped_files_to_summarize.length > 0
-          ? `
+${
+  skipped_files_to_summarize.length > 0
+    ? `
 <details>
-<summary>Files not summarized due to max files limit (${skipped_files_to_summarize.length
-          })</summary>
+<summary>Files not summarized due to max files limit (${
+        skipped_files_to_summarize.length
+      })</summary>
 
 ### Not summarized
 
 * ${skipped_files_to_summarize.join('\n* ')}
 
 </details>
 `
-          : ''
-        }
+    : ''
+}
 `
 
       next_summarize_ids = summarize_final_response_ids
@@ -388,10 +387,12 @@ ${skipped_files_to_summarize.length > 0
           } else {
             ins.comment_chain = 'no previous comments'
           }
-        } catch (e: any) {
-          core.warning(
-            `Failed to get comments: ${e}, skipping. backtrace: ${e.stack}`
-          )
+        } catch (e: unknown) {
+          if (e instanceof ChatGPTError) {
+            core.warning(
+              `Failed to get comments: ${e}, skipping. backtrace: ${e.stack}`
+            )
+          }
         }
 
         try {
@@ -414,12 +415,14 @@ ${skipped_files_to_summarize.length > 0
             line,
             `${response}`
           )
-        } catch (e: any) {
-          core.warning(`Failed to comment: ${e}, skipping.
+        } catch (e: unknown) {
+          if (e instanceof ChatGPTError) {
+            core.warning(`Failed to comment: ${e}, skipping.
         backtrace: ${e.stack}
         filename: ${filename}
         line: ${line}
         patch: ${patch}`)
+          }
         }
       }
     }
@@ -457,10 +460,12 @@ ${skipped_files_to_summarize.length > 0
     if (skipped_files_to_review.length > 0) {
       // make bullet points for skipped files
       const comment = `
-      ${skipped_files_to_review.length > 0
+      ${
+        skipped_files_to_review.length > 0
           ? `<details>
-<summary>Files not reviewed due to max files limit (${skipped_files_to_review.length
-          })</summary>
+<summary>Files not reviewed due to max files limit (${
+              skipped_files_to_review.length
+            })</summary>
 
 ### Not reviewed
 
@@ -469,7 +474,7 @@ ${skipped_files_to_summarize.length > 0
 </details>
 `
           : ''
-        }
+      }
       `
       if (comment.length > 0) {
         await commenter.comment(comment, SUMMARIZE_TAG, 'append')

src/utils.ts

@@ -1,10 +1,10 @@
 import * as core from '@actions/core'
 
-export const retry = async (
+export const retry = async <T = unknown>(
   fn: Function,
-  args: any[],
+  args: unknown[],
   times: number
-): Promise<any> => {
+): Promise<T | undefined> => {
   for (let i = 0; i < times; i++) {
     try {
       return await fn(...args)