🎯 fix: Seller setup wizard store address validation error for countries without states

[devAsadNur]

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

• Closes: https://github.com/getdokan/dokan-pro/issues/4110

How to test the changes in this Pull Request:

• Please follow the steps from: https://github.com/getdokan/dokan-pro/issues/4110

Changelog entry

fix: Seller setup wizard store address validation error for countries without states

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

• Bug Fixes
  • Improved store setup validation so that the state field is now only required when the selected country supports states, streamlining the store setup process and reducing unnecessary errors.

[coderabbitai]

Walkthrough

The change modifies the validation logic in the dokan_setup_store_save() method of the SetupWizard class. The updated condition now only requires the state field when the selected country has states, removing an unnecessary check for countries without states.

Changes

File	Change Summary
includes/Vendor/SetupWizard.php	Updated the conditional logic in the dokan_setup_store_save() method to require the state only when the country has states, simplifying the validation process.

Sequence Diagram(s)

sequenceDiagram
    participant V as Vendor
    participant SW as SetupWizard
    V->>SW: Submit store setup information
    SW->>SW: Check if selected country has states
    alt Country has states and state field is empty
        SW->>V: Return error "State information is required"
    else
        SW->>V: Proceed with saving store information
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Ensure vendors can save setup information when selecting a country with no states (#4110)	✅

Possibly related PRs

• [Skip] payment in Setup wizard when no payment is active #2468: Related changes in the SetupWizard class involving variable renaming and similar code-level modifications.

Suggested labels

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

Suggested reviewers

• mrabbani

Poem

In my code burrow, I hopped with delight,
Simplifying checks to make things right.
No more errors for states when none exist,
The setup now flows smooth and brisk.
🐰 Happy to code, I rap with might!
Cheers to fixes, shining bright.

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent 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 7fbbbf4.

📒 Files selected for processing (1)

• includes/Vendor/SetupWizard.php (1 hunks)

⏰ 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)

🔇 Additional comments (2)

includes/Vendor/SetupWizard.php (2)

509-512: LGTM! The validation fix correctly handles countries without states.

The updated condition now only requires the state field when the selected country has states, fixing the validation error for countries without states.

---

490-491: LGTM! Clear and descriptive variable declarations.

The variables $country_has_states and $state_is_empty are well-named and correctly implemented to support the validation logic.

---

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
• Mastodon
• Reddit
• LinkedIn

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

[mrabbani]

Pls crosscheck with #2550

[devAsadNur]

Closing this PR as the issue has been resolved already in the following PR:

• fix: setup store country state validation  #2550.