Refactor Webhooks.php for Enhanced API Request Management

[guibranco]

Description

• Refactored the API request handling in Webhooks.php to improve code reuse and clarity.
• Added a private method doRequest to centralize API request logic.
• Updated existing methods to use the new doRequest method.
• Introduced new methods for rerunning and deleting workflows.

---

Changes walkthrough 📝

	Relevant files
Enhancement	Webhooks.php Refactor Webhooks.php for Improved API Request Handling    src/Library/Webhooks.php Introduced a new private method doRequest to handle API requests. Refactored getDashboard and getWebhook methods to utilize doRequest. Added new methods requestRerun and requestDelete for specific API actions. +35/-10

Summary by CodeRabbit

• New Features

  • Introduced two new public methods: requestRerun and requestDelete, enhancing workflow management.

• Improvements

  • Streamlined HTTP request handling for dashboard and webhook functionalities, improving code clarity and maintainability.

[coderabbitai[bot]]

Walkthrough

The changes involve the introduction of a new private method doRequest in the Webhooks class, which consolidates the logic for making HTTP requests. This method supports GET, POST, and DELETE requests and is utilized by the existing getDashboard and getWebhook methods, which have been modified accordingly. Additionally, two new public methods, requestRerun and requestDelete, have been added to handle specific workflow actions.

Changes

File	Change Summary
Src/Library/Webhooks.php	- Added: public function requestRerun($sequence)
	- Added: public function requestDelete($sequence)
	- Modified: public function getDashboard() (now calls doRequest)
	- Modified: public function getWebhook($sequence) (now calls doRequest)
	- Changed: private function doRequest($endpoint, $method, $expectedStatusCode, $data = null) (new method added)

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Webhooks
    participant API

    Client->>Webhooks: requestRerun(sequence)
    Webhooks->>API: doRequest(endpoint, POST, expectedStatusCode, data)
    API-->>Webhooks: response
    Webhooks-->>Client: result

    Client->>Webhooks: requestDelete(sequence)
    Webhooks->>API: doRequest(endpoint, DELETE, expectedStatusCode)
    API-->>Webhooks: response
    Webhooks-->>Client: result

Poem

🐰 In the code where requests do flow,
A new method joins the show!
With doRequest, we simplify,
Making calls with a happy sigh.
Rerun or delete, just a hop away,
Coding magic brightens the day! ✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: -- `@coderabbitai generate unit testing code for this file.` -- `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: -- `@coderabbitai generate interesting stats about this repository and render them as a table.` -- `@coderabbitai read src/utils.ts and generate unit testing code.` -- `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` -- `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[penify-dev[bot]]

PR Review 🔍

⏱️ Estimated effort to review [1-5]	3, because the changes involve refactoring existing methods and adding new functionality, which requires a moderate level of understanding of the existing codebase.
🧪 Relevant tests	No
⚡ Possible issues	Possible Bug: In the `requestRerun` method, the data is being passed as `array("sequence", $sequence)`, which may not be the intended format. It should likely be `array("sequence" => $sequence)`.
🔒 Security concerns	No

[penify-dev[bot]]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Validate the HTTP method to ensure it is one of the allowed methods before making the request ___ **Validate the method parameter to ensure it is one of the allowed HTTP methods before proceeding with the request.** [Src/Library/Webhooks.php [44]](https://github.com/guibranco/projects-monitor/pull/514/files#diff-01b1e7c1ff2dfa0797d841d8a8a649395df9cb2d4ee6993910d72965e058912dR44-R44) ```diff -$method = strtolower($method); +if (!in_array($method, ['get', 'post', 'delete'])) { + throw new RequestException("Invalid HTTP method: {$method}"); +} ``` Suggestion importance[1-10]: 9 Why: Validating the HTTP method is important to prevent unexpected behavior and ensure that only valid methods are processed, addressing a potential issue.	9
Possible bug	Add a null check for the response variable to prevent null reference errors ___ **Ensure that the $response variable is checked for null before accessing its properties to avoid potential null reference errors.** [Src/Library/Webhooks.php [43]](https://github.com/guibranco/projects-monitor/pull/514/files#diff-01b1e7c1ff2dfa0797d841d8a8a649395df9cb2d4ee6993910d72965e058912dR43-R43) ```diff -$response = null; +if ($response === null) { + throw new RequestException("No response received from the request."); +} ``` Suggestion importance[1-10]: 8 Why: Adding a null check for the `$response` variable is crucial to prevent potential null reference errors, which could lead to runtime exceptions.	8
Maintainability	Improve the error message in the exception for better debugging context ___ **Consider using a more descriptive error message in the RequestException to provide better context for debugging.** [Src/Library/Webhooks.php [65]](https://github.com/guibranco/projects-monitor/pull/514/files#diff-01b1e7c1ff2dfa0797d841d8a8a649395df9cb2d4ee6993910d72965e058912dR65-R65) ```diff -throw new RequestException("Code: {$response->statusCode} - Error: {$error}"); +throw new RequestException("Request failed with status code {$response->statusCode}: {$error}"); ``` Suggestion importance[1-10]: 6 Why: Improving the error message enhances debugging capabilities, but it does not address a critical issue, hence a moderate score.	6
Best practice	Update the array syntax to use the short array syntax for better readability ___ **Use `array` instead of `array()` for creating arrays to follow modern PHP syntax.** [Src/Library/Webhooks.php [80]](https://github.com/guibranco/projects-monitor/pull/514/files#diff-01b1e7c1ff2dfa0797d841d8a8a649395df9cb2d4ee6993910d72965e058912dR80-R80) ```diff -return $this->doRequest("github/workflow", "post", 201, array("sequence", $sequence)); +return $this->doRequest("github/workflow", "post", 201, ["sequence" => $sequence]); ``` Suggestion importance[1-10]: 5 Why: While updating to short array syntax improves readability, it is a minor style change and does not impact functionality significantly.	5

[github-actions[bot]]

Infisical secrets check: :white_check_mark: No secrets leaked!

Scan results:

11:11PM INF scanning for exposed secrets...
11:11PM INF 467 commits scanned.
11:11PM INF scan completed in 207ms
11:11PM INF no leaks found

[sonarcloud[bot]]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[github-actions[bot]]

:rocket: Postman tests are disabled

:x: The Postman collection run is disabled.

[github-actions[bot]]

:test_tube: Request tests summary

:white_check_mark: All test requests succeeded

[github-actions[bot]]

:mag: Database integrity summary

:white_check_mark: The database integrity check succeeded

[github-actions[bot]]

:fire_engine: Smoke tests summary

:fire: Smoke tests passed!