limit the number of files that can be reviewed by this tool (#27)

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

Purpose: Limit the number of files that can be reviewed by this tool.

- New Feature: Added a new input option `max_files` to specify the
maximum number of files that can be reviewed.
- Bug fix: Added checks to ensure that the number of files being
reviewed does not exceed this limit.
- Refactor: Updated the code to improve readability and maintainability.
<!-- end of auto-generated comment: release notes by openai -->

Author: harjotgill

action.yml

@@ -9,6 +9,10 @@ inputs:
     required: false
     description: 'Enable debug mode'
     default: 'false'
+  max_files:
+    required: false
+    description: 'Max files to review'
+    default: '30'
   temperature:
     required: false
     description: 'Temperature for GPT model'

dist/index.js

@@ -48,6 +48,8 @@ export class Bot {
   }
 
   private chat_ = async (message: string, ids: Ids): Promise<[string, Ids]> => {
+    // record timing
+    const start = Date.now()
     if (!message) {
       return ['', {}]
     }
@@ -57,13 +59,15 @@ export class Bot {
 
     let response: openai.ChatMessage | null = null
     if (this.turbo) {
-      let opts: openai.SendMessageOptions = {}
+      const opts: openai.SendMessageOptions = {}
       if (ids.parentMessageId) {
         opts.parentMessageId = ids.parentMessageId
       }
       response = await this.turbo.sendMessage(message, opts)
       try {
+        const end = Date.now()
         core.info(`response: ${JSON.stringify(response)}`)
+        core.info(`openai response time: ${end - start} ms`)
       } catch (e: any) {
         core.info(
           `response: ${response}, failed to stringify: ${e}, backtrace: ${e.stack}`

src/bot.ts

@@ -6,6 +6,7 @@ import {codeReview} from './review.js'
 async function run(): Promise<void> {
   const options: Options = new Options(
     core.getBooleanInput('debug'),
+    core.getInput('max_files'),
     core.getBooleanInput('review_comment_lgtm'),
     core.getMultilineInput('path_filters'),
     core.getInput('system_message'),

src/main.ts

@@ -141,19 +141,22 @@ export class Inputs {
 
 export class Options {
   debug: boolean
+  max_files: number
   review_comment_lgtm: boolean
   path_filters: PathFilter
   system_message: string
   temperature: number
 
   constructor(
     debug: boolean,
+    max_files = '30',
     review_comment_lgtm = false,
     path_filters: string[] | null = null,
     system_message = '',
     temperature = '0.0'
   ) {
     this.debug = debug
+    this.max_files = parseInt(max_files)
     this.review_comment_lgtm = review_comment_lgtm
     this.path_filters = new PathFilter(path_filters)
     this.system_message = system_message
@@ -188,7 +191,7 @@ export class PathFilter {
   }
 
   check(path: string): boolean {
-    let include_all = this.rules.length == 0
+    let include_all = this.rules.length === 0
     let matched = false
     for (const [rule, exclude] of this.rules) {
       if (exclude) {

src/options.ts

@@ -14,12 +14,16 @@ const context = github.context
 const repo = context.repo
 
 const MAX_TOKENS_FOR_EXTRA_CONTENT = 2500
+const comment_tag =
+  '<!-- This is an auto-generated comment: summarize by openai -->'
 
 export const codeReview = async (
   bot: Bot,
   options: Options,
   prompts: Prompts
 ) => {
+  const commenter: Commenter = new Commenter()
+
   if (
     context.eventName !== 'pull_request' &&
     context.eventName !== 'pull_request_target'
@@ -29,14 +33,11 @@ export const codeReview = async (
     )
     return
   }
-
   if (!context.payload.pull_request) {
     core.warning(`Skipped: context.payload.pull_request is null`)
     return
   }
 
-  const commenter: Commenter = new Commenter()
-
   const inputs: Inputs = new Inputs()
   inputs.title = context.payload.pull_request.title
   if (context.payload.pull_request.body) {
@@ -57,6 +58,22 @@ export const codeReview = async (
   const {files, commits} = diff.data
   if (!files) {
     core.warning(`Skipped: diff.data.files is null`)
+    await commenter.comment(
+      `Skipped: no files to review`,
+      comment_tag,
+      'replace'
+    )
+    return
+  }
+
+  // check if we are exceeding max_files
+  if (files.length > options.max_files) {
+    core.warning("Skipped: too many files to review, can't handle it")
+    await commenter.comment(
+      `Skipped: too many files to review, can't handle it`,
+      comment_tag,
+      'replace'
+    )
     return
   }
 
@@ -145,9 +162,11 @@ export const codeReview = async (
       inputs.summary = summarize_final_response
 
       next_summarize_ids = summarize_final_response_ids
-      const tag =
-        '<!-- This is an auto-generated comment: summarize by openai -->'
-      await commenter.comment(`${summarize_final_response}`, tag, 'replace')
+      await commenter.comment(
+        `${summarize_final_response}`,
+        comment_tag,
+        'replace'
+      )
     }
 
     // final release notes