[PLA-1659] Remove decoder from submodules

leonardocustodio commented 7 months ago

Type

enhancement

Description

Removed the platform-decoder submodule from the project, simplifying the architecture.
Updated the Docker Compose configuration to use the decoder image from Docker Hub instead of building from a local context.
Corrected the URL for the wallet-daemon submodule to prevent a newline error.

Changes walkthrough

Relevant files

Configuration changes

.gitmodules Removal of `platform-decoder` submodule and URL correction .gitmodules Removed `platform-decoder` submodule. Corrected the URL for `wallet-daemon` submodule to ensure it does not include a newline.	+1/-4
docker-compose.yml Simplify `decoder` service configuration in Docker Compose docker-compose.yml Removed build context for `decoder` service, now solely relying on Docker Hub image.	+0/-2
platform-decoder Removal of `platform-decoder` submodule reference platform-decoder - Removed the `platform-decoder` submodule reference.	+0/-1
wallet-daemon Update `wallet-daemon` submodule reference wallet-daemon - Updated the `wallet-daemon` submodule reference.	+0/-1

✨ PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

github-actions[bot] commented 7 months ago

PR Description updated to latest commit (https://github.com/enjin/platform/commit/2f3bc9f41a799c2ad5d8f827a49ae31eaa5daf9c)

github-actions[bot] commented 7 months ago

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and involve removing submodules and updating configurations. The main areas to focus on are ensuring that the removal of the `platform-decoder` submodule and the update to the Docker Compose configuration do not introduce any integration issues.
🧪 Relevant tests	No
🔍 Possible issues	Missing Validation: There's no mention or evidence of testing to ensure that the Docker Compose setup works as expected with the `decoder` image from Docker Hub. This could potentially lead to runtime issues if the Docker Hub image is not compatible with the current setup.
🔒 Security concerns	No

Code feedback:

relevant file	.gitmodules
suggestion	Ensure that the removal of the `platform-decoder` submodule and the correction of the `wallet-daemon` URL have been reflected across all environments and documentation to prevent any confusion or misconfiguration. [important]
relevant line	- url = https://github.com/enjin/platform-decoder.git

relevant file	docker-compose.yml
suggestion	Verify the `decoder` image version from Docker Hub to ensure it's compatible with the current platform version. Consider pinning the image to a specific version instead of using `latest` to avoid unexpected updates that could break compatibility. [important]
relevant line	image: enjin/decoder:latest

✨ Review tool usage guide:

**Overview:** The `review` tool scans the PR code changes, and generates a PR review. The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on any PR. When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L19) 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), 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 'possible issues' 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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

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](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`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](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#enabledisable-features), 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_ticket`, and more.

Auto-approve PRs

By invoking: ``` /review auto_approve ``` The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: ``` [pr_reviewer] enable_auto_approval = true ``` (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` is equal or below a certain threshold, by adjusting the flag: ``` [pr_reviewer] maximal_review_effort = 5 ```

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 \**: 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](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details. >To list the possible configuration parameters, add a **/config** comment.

See the [review usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md) page for a comprehensive guide on using this tool.

github-actions[bot] commented 7 months ago

PR Code Suggestions

Category	Suggestions
Possible issue	Ensure the decoder service does not rely on removed local dependencies. ___ Since the 'platform-decoder' submodule is being removed, ensure that the decoder service in the 'docker-compose.yml' file does not rely on any local build context or artifacts that were previously part of 'platform-decoder'. If it does, consider providing an alternative method to include those dependencies, such as pulling them from a remote repository or including them directly in the 'enjin/decoder' image. [docker-compose.yml [29-33]](https://github.com/enjin/platform/pull/33/files#diff-e45e45baeda1c1e73482975a664062aa56f20c03dd9d64a827aba57775bed0d3R29-R33) ```diff decoder: - image: enjin/decoder:latest + image: enjin/decoder:latest # Ensure this image includes all necessary dependencies restart: unless-stopped ports: - "${DECODER_EXTERNAL_PORT}:8090" ```

Category

Suggestions

Possible issue

Ensure the decoder service does not rely on removed local dependencies.

___ **Since the 'platform-decoder' submodule is being removed, ensure that the decoder service
in the 'docker-compose.yml' file does not rely on any local build context or artifacts
that were previously part of 'platform-decoder'. If it does, consider providing an
alternative method to include those dependencies, such as pulling them from a remote
repository or including them directly in the 'enjin/decoder' image.** [docker-compose.yml [29-33]](https://github.com/enjin/platform/pull/33/files#diff-e45e45baeda1c1e73482975a664062aa56f20c03dd9d64a827aba57775bed0d3R29-R33) ```diff decoder: - image: enjin/decoder:latest + image: enjin/decoder:latest # Ensure this image includes all necessary dependencies restart: unless-stopped ports: - "${DECODER_EXTERNAL_PORT}:8090" ```

✨ Improve tool usage guide:

**Overview:** The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR. When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L69) related to the improve tool (`pr_code_suggestions` section), use the following template: ``` /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=... ``` With a [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template: ``` [pr_code_suggestions] some_config1=... some_config2=... ```

Enabling\disabling automation

When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the improve tool is: ``` pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] ``` meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions

Extra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: ``` [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - 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.

A note on code suggestions quality

- While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. - Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. - Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the [custom suggestions :gem:](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md) tool - With large PRs, best quality will be obtained by using 'improve --extended' mode.

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 \**: 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](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details. >To list the possible configuration parameters, add a **/config** comment.

See the [improve usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md) page for a more comprehensive guide on using this tool.

enjin / platform