Enhance issue copy message formatting and links

guibranco commented 1 month ago

Description

Enhanced the message formatting for copied issues to include clearer links.
Added a source link to the original issue for better traceability.
Improved variable naming for better code readability.

Changes walkthrough 📝

Relevant files

Enhancement

comments.php

Enhance issue copy message formatting and links

src/comments.php

Improved formatting of issue copy messages.

Added source issue link for better traceability.

Updated variable names for clarity.

+8/-3

penify-dev[bot] commented 1 month ago

PR Review 🔍

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and primarily involve string formatting and variable renaming.
🧪 Relevant tests	No
⚡ Possible issues	No
🔒 Security concerns	No

deepsource-io[bot] commented 1 month ago

Here's the code health analysis summary for commits c1bb83d..f08a1dd. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Link
Docker	✅ Success	View Check ↗
PHP	✅ Success	View Check ↗
Secrets	✅ Success	View Check ↗
SQL	✅ Success	View Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

github-actions[bot] commented 1 month ago

Infisical secrets check: :white_check_mark: No secrets leaked!

Scan results:

12:02PM INF scanning for exposed secrets...
12:02PM INF 433 commits scanned.
12:02PM INF scan completed in 121ms
12:02PM INF no leaks found

penify-dev[bot] commented 1 month ago

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Add error handling for the API request to ensure robustness ___ Ensure that the `doRequestGitHub` function handles potential errors from the API calls, such as checking the response status. [Src/comments.php [326]](https://github.com/guibranco/gstraccini-bot/pull/497/files#diff-c016a4b724b06cf94f3e5e764ca4f4eb4d42b550ddca3566f9b03c2f3bec51faR326-R326) ```diff -doRequestGitHub($metadata["token"], $metadata["commentUrl"], array("body" => $body), "POST"); +$response = doRequestGitHub($metadata["token"], $metadata["commentUrl"], array("body" => $body), "POST"); +if ($response->status !== 200) { /* handle error / } ``` Suggestion importance[1-10]: 8* Why: Adding error handling for API requests is crucial for robustness and reliability, making this a significant improvement to the code.	8
Possible issue	Add validation for the target and source variables to handle potential undefined properties ___ Ensure that the `$target` and `$source` variables are properly validated to avoid potential issues with undefined properties or incorrect formatting. [Src/comments.php [319-322]](https://github.com/guibranco/gstraccini-bot/pull/497/files#diff-c016a4b724b06cf94f3e5e764ca4f4eb4d42b550ddca3566f9b03c2f3bec51faR319-R322) ```diff -$target = "{$targetRepository}#{$number}"; -$source = "{$comment->RepositoryOwner}/{$comment->RepositoryName}#{$comment->PullRequestNumber}"; +$target = isset($number) ? "{$targetRepository}#{$number}" : "{$targetRepository}#unknown"; +$source = isset($comment->PullRequestNumber) ? "{$comment->RepositoryOwner}/{$comment->RepositoryName}#{$comment->PullRequestNumber}" : "{$comment->RepositoryOwner}/{$comment->RepositoryName}#unknown"; ``` Suggestion importance[1-10]: 7 Why: The suggestion addresses potential issues with undefined properties, which is important for robustness, but the proposed solution may be overly cautious since the properties are expected to be set.	7
Best practice	Use URL encoding for constructing the source URL to prevent issues with special characters ___ Consider using `http_build_query` for constructing URLs to ensure proper encoding of query parameters. [Src/comments.php [323]](https://github.com/guibranco/gstraccini-bot/pull/497/files#diff-c016a4b724b06cf94f3e5e764ca4f4eb4d42b550ddca3566f9b03c2f3bec51faR323-R323) ```diff -$sourceUrl = "https://github.com/{$comment->RepositoryOwner}/{$comment->RepositoryName}/issues/{$comment->PullRequestNumber}"; +$sourceUrl = "https://github.com/" . urlencode($comment->RepositoryOwner) . "/" . urlencode($comment->RepositoryName) . "/issues/" . urlencode($comment->PullRequestNumber); ``` Suggestion importance[1-10]: 6 Why: While using URL encoding is a good practice, the suggestion does not account for the fact that the current implementation may already handle most cases correctly, making this a minor improvement.	6
Maintainability	Refactor the duplicate API calls into a single function to enhance code maintainability ___ Consider consolidating the two `doRequestGitHub` calls into a single function to reduce redundancy and improve maintainability. [Src/comments.php [326-329]](https://github.com/guibranco/gstraccini-bot/pull/497/files#diff-c016a4b724b06cf94f3e5e764ca4f4eb4d42b550ddca3566f9b03c2f3bec51faR326-R329) ```diff -doRequestGitHub($metadata["token"], $metadata["commentUrl"], array("body" => $body), "POST"); -doRequestGitHub($metadata["token"], "repos/{$targetRepository}/issues/{$number}/comments", array("body" => $body), "POST"); +function postComment($token, $url, $body) { + return doRequestGitHub($token, $url, array("body" => $body), "POST"); +} +postComment($metadata["token"], $metadata["commentUrl"], $body); +postComment($metadata["token"], "repos/{$targetRepository}/issues/{$number}/comments", $body); ``` Suggestion importance[1-10]: 5 Why: While reducing redundancy is beneficial, the suggestion does not address the immediate functionality of the code and may complicate the implementation without substantial benefit.	5