Skip to content

Redirect immediately to onboarding when activating a single plugin#2046

Merged
Crabcyborg merged 7 commits into
masterfrom
issue_5411
Oct 15, 2024
Merged

Redirect immediately to onboarding when activating a single plugin#2046
Crabcyborg merged 7 commits into
masterfrom
issue_5411

Conversation

@Crabcyborg
Copy link
Copy Markdown
Contributor

@Crabcyborg Crabcyborg commented Oct 11, 2024

…sient

Fixes https://github.com/Strategy11/formidable-pro/issues/5411

Now we only avoid redirecting immediately when we are not bulk-activating. If the plugin is activated when bulk-activating, we fallback to the old behaviour, where we check for a Formidable admin page.

@Crabcyborg Crabcyborg changed the title Try to fix issue 5411 / set a separate multi value to onboarding tran… Redirect immediately to onboarding when activating a single plugin Oct 11, 2024
@Crabcyborg Crabcyborg marked this pull request as ready for review October 11, 2024 18:17
@Crabcyborg Crabcyborg added this to the 6.16 milestone Oct 11, 2024
@Crabcyborg Crabcyborg requested a review from shervElmi October 11, 2024 18:17
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 11, 2024

Walkthrough

The FrmOnboardingWizardController class has been updated with new constants and refined logic in the do_admin_redirects method. A new constant, TRANSIENT_MULTI_VALUE, has been added to manage redirection for multiple activated plugins. The method's checks for redirection conditions have been simplified, focusing on whether onboarding has been skipped or if the Pro version is connected. The deprecated method is_onboarding_wizard_displayed has been removed from the current logic flow, enhancing the clarity and functionality of the onboarding wizard's redirection process.

Changes

File Path Change Summary
classes/controllers/FrmOnboardingWizardController.php - Added constant TRANSIENT_MULTI_VALUE.
- Deprecated method is_onboarding_wizard_displayed().
- Refined logic in do_admin_redirects method for redirection handling.

Possibly related PRs


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.

Copy link
Copy Markdown
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: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 60e7be5 and 2a97188.

📒 Files selected for processing (1)
  • classes/controllers/FrmOnboardingWizardController.php (4 hunks)
🧰 Additional context used
🔇 Additional comments (5)
classes/controllers/FrmOnboardingWizardController.php (5)

49-49: Comment addition is informative and clear.

The added comment clearly specifies that the transient value is used when activating a single plugin, which enhances code readability.


55-62: Addition of TRANSIENT_MULTI_VALUE constant is well-documented.

The new constant TRANSIENT_MULTI_VALUE for handling multiple plugin activations is properly defined with comprehensive documentation.


157-159: Logical check prevents unnecessary redirects effectively.

The condition if ( self::has_onboarding_been_skipped() || FrmAppHelper::pro_is_connected() ) ensures that users who have already skipped onboarding or are connected to Pro are not redirected again.


161-165: Transient value validation is correctly implemented.

The check for both TRANSIENT_VALUE and TRANSIENT_MULTI_VALUE correctly handles redirection scenarios for single and multiple plugin activations.


176-177: Conditional logic for multi-plugin activation is appropriate.

The condition ensures that after multiple plugins are activated, the user is only redirected when accessing a Formidable admin page, enhancing user experience.

Comment thread classes/controllers/FrmOnboardingWizardController.php
Comment thread classes/controllers/FrmOnboardingWizardController.php
Copy link
Copy Markdown
Contributor

@shervElmi shervElmi left a comment

Choose a reason for hiding this comment

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

Thanks @Crabcyborg, It looks great to me! 🚀

@Crabcyborg
Copy link
Copy Markdown
Contributor Author

Thanks Sherv!

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