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

chore: updated missing args for dummy-data API endpoints #2480

Closed
wants to merge 1 commit into from

Conversation

pronob1010
Copy link
Contributor

@pronob1010 pronob1010 commented Dec 13, 2024

All Submissions:

  • My code follow the WordPress' coding standards
  • My code satisfies feature requirements
  • My code is tested
  • My code passes the PHPCS tests
  • My code has proper inline documentation
  • I've included related pull request(s) (optional)
  • I've included developer documentation (optional)
  • I've added proper labels to this pull request

Changes proposed in this Pull Request:

Related Pull Request(s)

  • Full PR Link

Closes

How to test the changes in this Pull Request:

  • Steps or issue link

Changelog entry

Missing args for dummy-data API endpoints

No args are needed for this endpoint.

Before Changes

Describe the issue before changes with screenshots(s).

After Changes

Describe the issue after changes with screenshot(s).

Feature Video (optional)

Link of detailed video if this PR is for a feature.

PR Self Review Checklist:

  • Code is not following code style guidelines
  • Bad naming: make sure you would understand your code if you read it a few months from now.
  • KISS: Keep it simple, Sweetie (not stupid!).
  • DRY: Don't Repeat Yourself.
  • Code that is not readable: too many nested 'if's are a bad sign.
  • Performance issues
  • Complicated constructions that need refactoring or comments: code should almost always be self-explanatory.
  • Grammar errors.

FOR PR REVIEWER ONLY:

As a reviewer, your feedback should be focused on the idea, not the person. Seek to understand, be respectful, and focus on constructive dialog.

As a contributor, your responsibility is to learn from suggestions and iterate your pull request should it be needed based on feedback. Seek to collaborate and produce the best possible contribution to the greater whole.

  • Correct — Does the change do what it’s supposed to? ie: code 100% fulfilling the requirements?
  • Secure — Would a nefarious party find some way to exploit this change? ie: everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities?
  • Readable — Will your future self be able to understand this change months down the road?
  • Elegant — Does the change fit aesthetically within the overall style and architecture?

Summary by CodeRabbit

  • New Features
    • Introduced two new REST API routes:
      • /status for checking the status of dummy data imports.
      • /clear for clearing dummy data.
  • Improvements
    • Enhanced API interaction by allowing these routes to function without requiring input parameters.

@pronob1010 pronob1010 added the Needs: Dev Review It requires a developer review and approval label Dec 13, 2024
@pronob1010 pronob1010 self-assigned this Dec 13, 2024
Copy link
Contributor

coderabbitai bot commented Dec 13, 2024

Walkthrough

The DummyDataController class within the WeDevs\Dokan\REST namespace has been updated to include two new REST API routes: /status for checking the status of dummy data imports and /clear for clearing dummy data. Both routes are defined without requiring input parameters and include permission callbacks. The register_routes method has been modified to accommodate these changes, enhancing the API's functionality.

Changes

File Change Summary
includes/REST/DummyDataController.php - Added /status route with import_dummy_data_status callback.
- Added /clear route with clear_dummy_data callback.
- Updated register_routes method.

Possibly related PRs

Suggested labels

QA approved, :+1: Dev Review Done, Upcoming Release

Suggested reviewers

  • shohag121

🐇 In the code, we hop and play,
New routes added, hip-hip-hooray!
Check the status, clear with ease,
API magic, sure to please!
With every change, we grow and thrive,
In the digital burrow, we come alive! 🌟


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
includes/REST/DummyDataController.php (1)

Line range hint 1-72: Consider adding PHP type hints for improved type safety.

While the documentation is thorough, consider adding PHP 7+ type hints to methods for better type safety and IDE support.

Example for the register_routes method:

- public function register_routes() {
+ public function register_routes(): void {

And for other methods:

- public function import_dummy_data_status()
+ public function import_dummy_data_status(): \WP_REST_Response

- public function import_dummy_data( $request )
+ public function import_dummy_data( \WP_REST_Request $request ): \WP_REST_Response

- public function clear_dummy_data()
+ public function clear_dummy_data(): \WP_REST_Response

- public function get_permissions_check()
+ public function get_permissions_check(): bool
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 98d3958 and 8c943c3.

📒 Files selected for processing (1)
  • includes/REST/DummyDataController.php (2 hunks)
🔇 Additional comments (2)
includes/REST/DummyDataController.php (2)

44-44: LGTM! The empty args arrays are properly documented.

The changes explicitly declare that these endpoints don't require any arguments, which improves API clarity and documentation.

Also applies to: 67-67


Line range hint 73-1000: LGTM! The schema implementation is thorough and secure.

The schema provides:

  • Comprehensive field definitions with proper types
  • Consistent sanitization callbacks for user input
  • Clear documentation for all properties

Copy link
Member

@mrabbani mrabbani left a comment

Choose a reason for hiding this comment

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

It is replicated in #2482

@mrabbani mrabbani added Needs: Author Reply and removed Needs: Dev Review It requires a developer review and approval labels Dec 30, 2024
@pronob1010
Copy link
Contributor Author

As empty args means not dependency on args. so I 'm closing this.

@pronob1010 pronob1010 closed this Dec 31, 2024
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.

2 participants