[PLA-1652] Allows www-data to call horizon supervisorctl

[Bradez]

Type

bug_fix, enhancement

---

Description

• Introduced a new Supervisor configuration file and adjusted existing configurations to enhance control and fix permission issues.
• Simplified command executions in the start script and made role-specific adjustments, particularly for the websocket role.
• Adjusted Dockerfile to change ownership of /var/log/supervisor to www-data and updated the supervisor configuration directory path.

---

Changes walkthrough

	Relevant files
Enhancement	start.sh Simplification and Role-Specific Command Execution in Start Script configs/core/start.sh Simplified command executions for different roles by removing unnecessary subshells. Granted www-data ownership for storage logs only for the websocket role. Introduced supervisorctl start horizon and php artisan websockets:serve commands for the websocket role. +4/-4      Dockerfile Dockerfile Adjustments for Supervisor and Permissions        configs/core/Dockerfile Removed unnecessary newline and comments. Changed ownership to include /var/log/supervisor for www-data. Updated supervisor configuration directory path. +2/-3
Configuration changes	horizon.conf Horizon Supervisor Configuration Adjustments                          configs/core/supervisor/conf.d/horizon.conf Set autostart to false for Horizon to prevent automatic start. Added chown directive to ensure www-data ownership. +3/-2      supervisord.conf New Supervisor Configuration for Enhanced Control                configs/core/supervisor/supervisord.conf Introduced a new Supervisor configuration file with detailed settings for the Unix HTTP server, supervisord, and supervisorctl. Specified www-data as the user and owner for Supervisor processes. +30/-0    websockets.conf Removal of Websockets Supervisor Configuration                      configs/core/supervisor/websockets.conf Removed the websockets supervisor configuration. +0/-10

---

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

[github-actions]

PR Description updated to latest commit (28bd305)

[github-actions]

PR Review

⏱️ Estimated effort to review [1-5]	3, because the PR involves changes across multiple files including shell scripts, Dockerfile, and Supervisor configuration files. Understanding the context and impact of these changes requires a good grasp of the system architecture and the specific roles these configurations play.
🧪 Relevant tests	No
🔍 Possible issues	Possible Bug: The removal of subshells in start.sh might lead to unexpected behavior if any of the commands rely on being executed in a subshell environment.
	Configuration Concern: Changing autostart to false in horizon.conf might delay necessary services from starting automatically, requiring manual intervention.
🔒 Security concerns	No

Code feedback:

---

relevant file	configs/core/start.sh
suggestion	Consider adding error handling for each command in the script to ensure that the script stops executing if any command fails. This can be achieved by adding set -e at the beginning of the script. [important]
relevant line	php artisan cache:clear && php artisan config:cache && php artisan migrate && php artisan platform:sync && php artisan platform:ingest

---

relevant file	configs/core/Dockerfile
suggestion	It's recommended to avoid using chmod 777 for directory permissions due to security concerns. Consider using more restrictive permissions that allow necessary access to the www-data user and group only. [important]
relevant line	RUN chmod 777 -R /var/www/html/storage/

---

relevant file	configs/core/supervisor/conf.d/horizon.conf
suggestion	If autostart is set to false, ensure there's a mechanism in place (either manual or automated) to start this service when needed. This change might affect deployments expecting horizon to start automatically. [medium]
relevant line	autostart=false

---

relevant file	configs/core/supervisor/supervisord.conf
suggestion	Ensure that the chown=www-data:www-data directive in the [supervisord] section is necessary and correctly applied, as it might lead to permission issues if other processes need access to the supervisor logs or pid files. [medium]
relevant line	chown=www-data:www-data

---

---

✨ Review tool 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 '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 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 (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_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 <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.

[github-actions]

PR Code Suggestions

Category	Suggestions
Best practice	Wrap command sequences in a subshell with error checking. Consider wrapping the command sequence in a subshell using parentheses and adding set -e at the beginning. This ensures that if any command in the sequence fails, the script stops execution and exits with an error, making it easier to detect and troubleshoot issues. configs/core/start.sh [8] -php artisan cache:clear && php artisan config:cache && php artisan migrate && php artisan platform:sync && php artisan platform:ingest +(set -e; php artisan cache:clear && php artisan config:cache && php artisan migrate && php artisan platform:sync && php artisan platform:ingest)
	Check if supervisord starts successfully before running supervisorctl. It's recommended to check if supervisord successfully starts before attempting to start horizon with supervisorctl. You can achieve this by checking the exit status of supervisord. configs/core/start.sh [22] -supervisord && supervisorctl start horizon +supervisord +if [ $? -eq 0 ]; then + supervisorctl start horizon +else + echo "Failed to start supervisord." + exit 1 +fi
Security	Use more secure file permissions for storage. Using chmod 777 for storage permissions is insecure and can expose the application to unnecessary risks. Consider using more restrictive permissions and ensuring that the www-data user has the necessary access. configs/core/Dockerfile [61] -RUN chmod 777 -R /var/www/html/storage/ +RUN chown -R www-data:www-data /var/www/html/storage/ && chmod -R 755 /var/www/html/storage/
	Review socket file permissions for appropriate access control. The chmod=0700 for the Unix socket file restricts access to the supervisord socket to only the user that supervisord is running as. Ensure that any processes or users that need to communicate with supervisord through this socket have the appropriate access permissions. configs/core/supervisor/supervisord.conf [5] -chmod=0700 ; sockef file mode (default 0700) +chmod=0770 ; Adjust the mode as necessary for your security requirements and user groups
Possible issue	Review the autostart setting for horizon. The autostart=false setting prevents horizon from starting automatically when supervisord starts. If this is intentional, ensure that there's a mechanism in place to start it when needed. Otherwise, consider setting autostart=true for automatic startup. configs/core/supervisor/conf.d/horizon.conf [4] -autostart=false +autostart=true

---

✨ 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 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 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, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode 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 💎 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 <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 improve usage page for a more comprehensive guide on using this tool.