Skip to content

Include license type in usage data#2168

Merged
Crabcyborg merged 1 commit into
masterfrom
pro-issue-5519
Dec 5, 2024
Merged

Include license type in usage data#2168
Crabcyborg merged 1 commit into
masterfrom
pro-issue-5519

Conversation

@truongwp
Copy link
Copy Markdown
Contributor

@truongwp truongwp commented Dec 5, 2024

@Crabcyborg
Copy link
Copy Markdown
Contributor

@truongwp Would it make sense to just put this in Pro instead?

We can use the frm_usage_snapshot filter.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Dec 5, 2024

Walkthrough

The changes in this pull request involve a modification to the snapshot method within the FrmUsage class. A conditional check is introduced to verify the existence of the get_readable_license_type method in the FrmProAddonsController class. If the method is present, the active_license key in the $snap array is updated with its returned value, enhancing the snapshot data.

Changes

File Path Change Summary
classes/models/FrmUsage.php Modified the snapshot method to include a conditional check for get_readable_license_type in FrmProAddonsController. Updated active_license in $snap if the method exists.

Possibly related PRs

Suggested labels

run analysis, run tests

Suggested reviewers

  • Crabcyborg

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: 0

🧹 Outside diff range and nitpick comments (1)
classes/models/FrmUsage.php (1)

104-106: LGTM! Consider preserving both license values.

The implementation safely enhances the usage data by including the readable license type when available. However, consider preserving both the boolean installation status and the readable type for better data tracking.

Here's a suggested improvement:

 if ( method_exists( 'FrmProAddonsController', 'get_readable_license_type' ) ) {
-    $snap['active_license'] = FrmProAddonsController::get_readable_license_type();
+    $snap['license_type'] = FrmProAddonsController::get_readable_license_type();
 }

This way:

  • active_license remains a boolean indicating if Pro is installed
  • license_type provides the readable license type when available
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 48d0653 and b93ae71.

📒 Files selected for processing (1)
  • classes/models/FrmUsage.php (1 hunks)
🔇 Additional comments (1)
classes/models/FrmUsage.php (1)

104-106: Verify usage and implementation.

Let's verify the usage of active_license field and the implementation of get_readable_license_type.

✅ Verification successful

Let me gather more information about the FrmProAddonsController class to understand its implementation better.


Changes are safe and properly implemented

The verification shows that:

  1. The active_license field is used consistently in FrmUsage.php for tracking license information
  2. get_readable_license_type() is a valid method in FrmProAddonsController (defined in stubs.php)
  3. The code properly checks for method existence before calling it
  4. The implementation follows the established pattern of license type handling across the codebase
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check the usage of active_license field and get_readable_license_type implementation

# Check for other usages of active_license field in snapshot data
echo "Checking active_license field usage..."
rg "active_license" --type php

# Check the implementation of get_readable_license_type
echo "Checking get_readable_license_type implementation..."
ast-grep --pattern 'class FrmProAddonsController {
  $$$
  static function get_readable_license_type() {
    $$$
  }
  $$$
}'

Length of output: 558


Script:

#!/bin/bash
# Search for FrmProAddonsController class definition and usage
echo "Searching for FrmProAddonsController class..."
rg "class FrmProAddonsController" --type php -A 5

# Search for any references to license type or readable license
echo "Searching for license type related code..."
rg "license.*type" --type php -i

Length of output: 7681

@truongwp
Copy link
Copy Markdown
Contributor Author

truongwp commented Dec 5, 2024

@truongwp Would it make sense to just put this in Pro instead?

We can use the frm_usage_snapshot filter.

That makes sense. I changed here because I don't want to create an add_filter() call.

Copy link
Copy Markdown
Contributor

@Crabcyborg Crabcyborg left a comment

Choose a reason for hiding this comment

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

Thanks @truongwp!

If it's here to avoid a hook, I think that's fine.

I'll merge this as-is.

@Crabcyborg Crabcyborg added this to the 6.16.3 milestone Dec 5, 2024
@Crabcyborg Crabcyborg merged commit 5262a01 into master Dec 5, 2024
@Crabcyborg Crabcyborg deleted the pro-issue-5519 branch December 5, 2024 18:03
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