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: plugin version after activation #2447

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

kzamanbd
Copy link

@kzamanbd kzamanbd commented Nov 22, 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

  • Closes #

How to test the changes in this Pull Request:

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

  • New Features
    • Enhanced installation process to update the theme version only during the first installation.
  • Bug Fixes
    • Improved control flow in the installation method to prevent unnecessary updates.
  • Refactor
    • Changed visibility of certain methods to private for better encapsulation and clarity.

@kzamanbd kzamanbd self-assigned this Nov 22, 2024
Copy link
Contributor

coderabbitai bot commented Nov 22, 2024

Walkthrough

The changes in this pull request modify the do_install method in the Installer class located in includes/Install/Installer.php. The update_option call for dokan_theme_version has been repositioned to execute only during the first installation, based on the state of the $was_installed_before variable. Additionally, two methods, create_reverse_withdrawal_base_product and create_reverse_withdrawal_table, have been made private to indicate they are for internal use only. The overall installation process structure remains unchanged.

Changes

File Change Summary
includes/Install/Installer.php - Modified do_install to update dokan_theme_version only on first installation.
- Changed visibility of create_reverse_withdrawal_base_product() from public to private.
- Changed visibility of create_reverse_withdrawal_table() from public to private.

Possibly related PRs

Suggested labels

QA approved, :+1: Dev Review Done

Suggested reviewers

  • mrabbani
  • shohag121

🐰 In the code, we hop and play,
To update versions in a clever way.
With methods tucked away from sight,
Our installer shines both day and night!
Let's celebrate this change with cheer,
For a smoother install, the time is near! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3d3c9d3 and 0d0e551.

📒 Files selected for processing (1)
  • includes/Install/Installer.php (1 hunks)
🔇 Additional comments (3)
includes/Install/Installer.php (3)

45-48: LGTM: Appropriate visibility changes for internal methods

The change of visibility from public to private for the reverse withdrawal methods aligns with encapsulation principles, as these methods are only used internally during installation.


45-48: LGTM: Version update logic correctly scoped to first installation

The version update is now properly conditioned to execute only during first installation, fixing the issue where the version was being updated on every activation. This change:

  1. Prevents unnecessary version updates
  2. Maintains proper version tracking
  3. Correctly sets up initial installation flags

45-48: Verify installation process integrity

While the changes look correct, let's verify there are no regressions in the installation process.

✅ Verification successful

The search results show that the version handling is consistent throughout the codebase. Let me verify the setup wizard and activation process to ensure complete installation integrity.


Installation process integrity is maintained

The verification shows that the installation process is properly maintained:

  • Version tracking (dokan_theme_version) is consistently handled across the codebase
  • Setup wizard flag (dokan_admin_setup_wizard_ready) is properly managed in the setup wizard, notices, and installation process
  • Redirect mechanism (_dokan_setup_page_redirect) is correctly implemented with proper cleanup
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify version handling in the codebase
# Look for other places that might depend on dokan_theme_version option

# Check for direct option access
rg "get_option\(\s*['\"]dokan_theme_version" -A 2

# Check for update_option calls
rg "update_option\(\s*['\"]dokan_theme_version" -A 2

# Check for version-dependent logic
rg "dokan_theme_version" -A 2

Length of output: 2119


Script:

#!/bin/bash
# Check setup wizard and activation related code
# Look for dependencies on admin setup wizard flag and redirect transient

# Check setup wizard ready flag usage
rg "dokan_admin_setup_wizard_ready" -A 2

# Check redirect transient usage
rg "_dokan_setup_page_redirect" -A 2

# Check overall activation hooks
ast-grep --pattern 'register_activation_hook($$$)'

Length of output: 2244


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

@kzamanbd kzamanbd added Needs: Testing This requires further testing Needs: Dev Review It requires a developer review and approval labels Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs: Dev Review It requires a developer review and approval Needs: Testing This requires further testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant