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

fix: setup store country state validation #2550

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

osmansufy
Copy link
Contributor

@osmansufy osmansufy commented Feb 3, 2025

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

Title

Detailed Description of the pull request. What was previous behaviour
and what will be changed in this PR.

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

Summary by CodeRabbit

  • Bug Fixes
    • Streamlined address validation during the store setup process to ensure errors are shown only when necessary.
    • Improved consistency in the verification of country and state inputs for a more reliable setup experience.
    • Enhanced clarity and efficiency in validation logic for country and state fields.

@osmansufy osmansufy self-assigned this Feb 3, 2025
@osmansufy osmansufy requested a review from mrabbani February 3, 2025 09:58
Copy link
Contributor

coderabbitai bot commented Feb 3, 2025

Warning

Rate limit exceeded

@osmansufy has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 36 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between c2e8047 and adf7adf.

📒 Files selected for processing (1)
  • includes/Vendor/SetupWizard.php (2 hunks)

Walkthrough

This pull request refactors the internal logic of the dokan_setup_store_save method in the SetupWizard class. It removes the use of null coalescing for $country and $state, directly assigning values from the address data instead. The changes also simplify state validation by eliminating a count check and adjusting error handling so that state validation only occurs when the country supports states. Comments within the method have been updated for clarity.

Changes

File Change Summary
includes/.../SetupWizard.php Modified the dokan_setup_store_save method: directly assigns $country and $state from the address array; simplified state validation by removing count checks; updated error handling and comments.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant SW as SetupWizard
    participant V as Validator

    U->>SW: Submit store setup data
    SW->>SW: Extract $country and $state from address array
    SW->>V: Validate state if country supports states
    V-->>SW: Return validation outcome
    SW->>U: Return success or error response
Loading

Assessment against linked issues

Objective Addressed Explanation
Clicking the Continue button should redirect the user to the next step (##283) The changes do not address the button's redirect functionality.

Possibly related PRs

Suggested labels

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

Suggested reviewers

  • mrabbani
  • shohag121

Poem

I'm a curious rabbit on a coding spree,
Skipping through logic as swift as can be,
With refined checks and errors at bay,
My code's now dancing in a cleaner way,
Hop along the bytes with a joyful beat,
Celebrating improvements in every little leap!


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. (Beta)
  • @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

🧹 Nitpick comments (3)
includes/Vendor/SetupWizard.php (3)

488-491: Improve variable declarations and fix spacing issues.

The variable declarations improve code readability, but there are some style issues to fix.

-        $country = $dokan_settings['address']['country'] ;
-        $state = $dokan_settings['address']['state'];
-        $country_has_states = isset( $states[ $country ] );
-        $state_is_empty = empty( $state );        // Validating filed.
+        $country = $dokan_settings['address']['country'];
+        $state = $dokan_settings['address']['state'];
+        $country_has_states = isset( $states[ $country ] );
+        $state_is_empty = empty( $state );
🧰 Tools
🪛 GitHub Check: Run PHPCS inspection

[failure] 488-488:
Space found before semicolon; expected "];" but found "] ;"


509-515: Fix spacing in conditional checks and improve state validation.

The state validation logic has been improved, but there are spacing issues in the conditions.

-        } elseif ( ( $country_has_states && count( $states[ $country ] ) > 0 &&  $state_is_empty) ) {
+        } elseif ( ( $country_has_states && count( $states[ $country ] ) > 0 && $state_is_empty ) ) {
             $is_valid_form = false;
             $_POST['error_address[state]'] = 'error';
-        } elseif ( ! $country_has_states && $state_is_empty ) {
+        } elseif ( ! $country_has_states && $state_is_empty ) {
             $is_valid_form = false;
             $_POST['error_address[state]'] = 'error';
         }
🧰 Tools
🪛 GitHub Check: Run PHPCS inspection

[failure] 509-509:
Expected 1 space after "&&"; 2 found


[failure] 509-509:
Expected 1 space before close parenthesis; 0 found


492-515: Consider architectural improvements for validation handling.

The current validation implementation has several areas for improvement:

  1. Using $_POST for error storage mixes concerns and could lead to conflicts
  2. Error messages are hardcoded and not internationalized
  3. Validation logic could be extracted into a separate method for reusability

Consider:

  1. Creating a dedicated error handling class/structure
  2. Extracting validation logic into a separate method
  3. Using WordPress internationalization for error messages
  4. Adding input sanitization checks

Would you like me to provide a code example implementing these improvements?

🧰 Tools
🪛 GitHub Check: Run PHPCS inspection

[failure] 509-509:
Expected 1 space after "&&"; 2 found


[failure] 509-509:
Expected 1 space before close parenthesis; 0 found

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e743934 and b11e2db.

📒 Files selected for processing (1)
  • includes/Vendor/SetupWizard.php (2 hunks)
🧰 Additional context used
🪛 GitHub Check: Run PHPCS inspection
includes/Vendor/SetupWizard.php

[failure] 488-488:
Space found before semicolon; expected "];" but found "] ;"


[failure] 509-509:
Expected 1 space after "&&"; 2 found


[failure] 509-509:
Expected 1 space before close parenthesis; 0 found

🪛 GitHub Actions: Inspections
includes/Vendor/SetupWizard.php

[error] 1-1: Space found before semicolon; expected '];' but found '] ;'

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: e2e tests (3, 3)
  • GitHub Check: e2e tests (2, 3)
  • GitHub Check: e2e tests (1, 3)
  • GitHub Check: api tests (1, 1)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant