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

gppa-populate-child-entries.php: Fixed an issue with missing cookie values. #1055

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

saifsultanc
Copy link
Contributor

Context

⛑️ Ticket(s): https://secure.helpscout.net/conversation/2882383665/79731

Summary

The temporary parent entry ID doesn't populate the field on the form after the form is submitted and opened again. The cookie wasn't found strangely. Added logic to look out for the cookie in this context.

Copy link

coderabbitai bot commented Mar 25, 2025

Walkthrough

The changes update the cookie handling within the populate_parent_entry_id method. Initially, the method directly extracted the hash value from a cookie obtained through a helper function. The new implementation checks for the existence of that cookie and, if absent, scans the global cookie array for keys matching a specific pattern. Matching cookies are iterated over, decoded from JSON, and the hash value is then extracted. These modifications alter the control flow to allow for dynamic cookie retrieval.

Changes

File Change Summary
gp-populate-anything/gppa-populate-child-entries.php Enhanced populate_parent_entry_id method: Added conditional check for cookie existence, scanned $_COOKIE for keys matching gpnf_form_session_, decoded matching cookies, and extracted the 'hash' value.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant Method as populate_parent_entry_id
    participant CookieStorage as $_COOKIE

    Caller ->> Method: Call populate_parent_entry_id
    Method ->> Method: Attempt to retrieve cookie using get_cookie()
    alt Cookie exists
        Method ->> Caller: Return cookie['hash'] value
    else Cookie missing
        Method ->> CookieStorage: Scan for keys matching "gpnf_form_session_"
        CookieStorage -->> Method: Return matching keys
        Method ->> Method: Iterate through matches and decode JSON data
        Method ->> Caller: Return extracted cookie['hash'] value
    end
Loading

Suggested reviewers

  • veryspry
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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

Warnings
⚠️ When ready, don't forget to request reviews on this pull request from your fellow wizards.

Generated by 🚫 dangerJS against 710c14f

Copy link

@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 (1)
gp-populate-anything/gppa-populate-child-entries.php (1)

69-82: Good enhancement to the cookie retrieval logic.

The additional code now properly handles the case when the cookie is not available through the primary retrieval method, addressing the issue mentioned in the PR objectives where the temporary parent entry ID fails to populate after form submission and reopening.

A few suggestions to make this more robust:

  1. Since you're processing multiple cookies but only keeping the last one in the loop, consider adding a break statement once you've found a valid cookie to avoid unnecessary iterations.

  2. Add validation after JSON decoding to ensure the cookie has the expected structure before using it.

if ( ! empty( $matches ) ) {
  foreach ( $matches as $matched_cookie ) {
    $cookie = json_decode(stripslashes( $_COOKIE[ $matched_cookie ] ), true);
+   if ( $cookie && isset( $cookie['hash'] ) ) {
+     break; // Valid cookie found, no need to process more
+   }
  }
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ff20239 and 710c14f.

📒 Files selected for processing (1)
  • gp-populate-anything/gppa-populate-child-entries.php (1 hunks)

Comment on lines 68 to +71
$cookie = $session->get_cookie();
$value = rgar( $cookie, 'hash', '' );

// try to find cookie, if available.
if ( ! $cookie ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

So a cookie exists and but it's not retrieved by the session? Could you explain more about this scenario and why the cookie is not being found?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The standard cookie gpnf_form_session wasn't there, which I thought was to do with some logic on the snippet. But there was another one with the a suffix of gfpreview and form Id (forgot the exact format) available. The proposal here is to look out for that if the standard isn't available.

Copy link
Contributor

@spivurno spivurno Mar 25, 2025

Choose a reason for hiding this comment

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

I think we'll want to identify why the expected cookie isn't there and why the unexpected cookie is there.

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

Successfully merging this pull request may close these issues.

2 participants