Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

t1 #589

Closed
wants to merge 132 commits into from
Closed

t1 #589

wants to merge 132 commits into from

Conversation

mrT23
Copy link
Collaborator

@mrT23 mrT23 commented Jan 12, 2024

Type

Enhancement


Description

This PR primarily focuses on enhancing the configuration of the project. The main changes include:

  • The language extension mappings and bad extensions are now loaded from the configuration settings in pr_agent/algo/language_handler.py.
  • A new helper function is_valid_file has been added to check if a file is valid based on its extension.
  • New files pr_agent/servers/serverless.py and pr_agent/settings/language_extensions.toml have been added, but their content is not provided in the diff.

Changes walkthrough

Relevant files                                                                                                                                 
Configuration changes
language_handler.py                                                                                 
    pr_agent/algo/language_handler.py

    The file pr_agent/algo/language_handler.py has been
    updated to load language extension mappings and bad
    extensions from the configuration settings. The
    filter_bad_extensions function has been updated to use a
    new helper function is_valid_file to check if a file is
    valid based on its extension.

+11/-58
language_extensions.toml                                                                       
    pr_agent/settings/language_extensions.toml

    This is a new file added to the PR, but its content is not
    provided in the diff.

+434/-0
Miscellaneous
serverless.py                                                                                             
    pr_agent/servers/serverless.py

    This is a new file added to the PR, but its content is not
    provided in the diff.

+18/-0

✨ Usage guide:

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...
Enabling\disabling automation
  • When you first install the app, the default mode for the describe tool is:
pr_commands = ["/describe --pr_description.add_original_user_description=true" 
                         "--pr_description.keep_original_user_title=true", ...]

meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.

  • Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
pr_commands = ["/describe --pr_description.use_description_markers=true", ...]

the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following:

  • type: the PR type.
  • summary: the PR summary.
  • walkthrough: the PR walkthrough.

Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

Custom labels

The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other].

If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
Examples for custom labels:

  • Main topic:performance - pr_agent:The main topic of this PR is performance
  • New endpoint - pr_agent:A new endpoint was added in this PR
  • SQL query - pr_agent:A new SQL query was added in this PR
  • Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile
  • ...

The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

zmeir and others added 30 commits July 17, 2023 10:41
…etrieval by gitlab provider.

It was handled by catching the error and replacing the file string with an empty string.
Type checking was added before byte decoding - necessary in case of the empty string.
…ovider-file-creation-handling

Fixes 404 error on gitlab file provider happening in case a MR introduced a new file.
consider changing section headers to reflect commands format
Enhancement of PR Agent with User Interaction
…e_api_call

Optimization of Inline Comments Publishing
changing image
Filter out bad files before getting their head and original source code and diff
This can help teams compare the review of the PR agent with that of a human reviewer, and fine-tune a score threshold for automatic approval where they decide the agent's review is satisfactory.
This can be useful in a few situations:
1. To reduce the number of GitHub API calls (thus avoiding hitting the rate limit)
2. When the trigger for the agent is an external process (e.g. some external CI job), so there is no need to publish a message like "preparing review..." because it's not a part of a natual conversation with the user
Add Insights from User's Answers and Fix User Answers Fetching
mrT23 and others added 23 commits July 23, 2023 13:33
Update Installation Instructions in README
Implementing Fallback Models for Tokenization
Handling exceptions in fallback models
Temporarily remove gitlab polling server until a rewrite is ready
…call

Optimize Code Suggestions API Calls
Bugfix - missing function argument
Add functionality to preserve existing labels in PRs
Copy link
Contributor

PR Description updated to latest commit (abca2fd)

Copy link
Contributor

qodo-merge-pro bot commented Jan 12, 2024

PR Analysis

(review updated until commit abca2fd)

  • 🎯 Main theme: Enhancement of the PR Agent with User Interaction
  • 📝 PR summary: This PR primarily focuses on enhancing the configuration of the project. It includes changes such as loading language extension mappings and bad extensions from configuration settings, adding a new helper function to check if a file is valid based on its extension, and adding new files for serverless operations and language extensions. It also includes updates to the GithubProvider class to support incremental PRs and publishing inline comments and code suggestions.
  • 📌 Type of PR: Enhancement
  • 🧪 Relevant tests added: No
  • ⏱️ Estimated effort to review [1-5]: 4, because the PR involves significant changes to the codebase, including the addition of new functionalities and modifications to existing ones. The changes are spread across multiple files and require a good understanding of the project's configuration and the GithubProvider class.
  • 🔒 Security concerns: No

PR Feedback

💡 General suggestions: The PR is well-structured and the changes are logically grouped. However, it would be beneficial to include tests for the new functionalities added, especially for the is_valid_file function and the new methods in the GithubProvider class. This would help ensure the correctness of the code and prevent potential issues in the future. Additionally, consider handling exceptions more specifically to provide more informative error messages and make debugging easier.

🤖 Code feedback:
relevant filepr_agent/git_providers/github_provider.py
suggestion      

Consider adding error handling for the case when self.incremental.is_incremental is True but self.file_set is None or empty. This could prevent potential issues when trying to access self.file_set.values() in the get_files method. [important]

relevant lineif self.incremental.is_incremental and self.file_set:

relevant filepr_agent/git_providers/github_provider.py
suggestion      

In the get_commit_range method, consider handling the case when self.commits[index].commit.author.date is not greater than last_review_time. Currently, if this condition is never met, self.incremental.last_seen_commit_sha will not be set, which could lead to issues in other parts of the code that rely on this attribute. [important]

relevant lineif self.commits[index].commit.author.date > last_review_time:

relevant filepr_agent/algo/utils.py
suggestion      

In the load_large_diff function, consider handling the case when patch is None and an exception is raised in the difflib.unified_diff call. Currently, if an exception is raised, patch will remain None, which could lead to issues in other parts of the code that rely on patch being a string. [important]

relevant linediff = difflib.unified_diff(original_file_content_str.splitlines(keepends=True),

relevant filepr_agent/algo/utils.py
suggestion      

In the convert_str_to_datetime function, consider handling the case when date_str is not in the expected format. Currently, if date_str is not in the '%a, %d %b %Y %H:%M:%S %Z' format, a ValueError will be raised. Handling this error and providing a more informative error message could make debugging easier. [medium]

relevant linedatetime_format = '%a, %d %b %Y %H:%M:%S %Z'


✨ Usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...
Utilizing extra instructions

The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

Examples for extra instructions:

[pr_reviewer] # /review #
extra_instructions="""
In the code feedback section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation
  • When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]

meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations

About the 'Code feedback' section

The review tool provides several type of feedbacks, one of them is code suggestions.
If you are interested only in the code suggestions, it is recommended to use the improve feature instead, since it dedicated only to code suggestions, and usually gives better results.
Use the review tool if you want to get a more comprehensive feedback, which includes code suggestions as well.

Auto-labels

The review tool can auto-generate two specific types of labels for a PR:

  • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
  • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools

The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
require_score_review, require_soc2_review, enable_review_labels_effort, and more.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

Copy link
Contributor

Persistent review updated to latest commit abca2fd

Copy link
Contributor

@barnett-yuxiang barnett-yuxiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mrT23 mrT23 closed this Jan 13, 2024
@mrT23 mrT23 deleted the tr/code_enhancment branch April 3, 2024 05:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants