gpnf-sortable-entries.php: Fixed an issue with sortable entries not working correctly.

[saifsultanc]

Context

⛑️ Ticket(s): https://secure.helpscout.net/conversation/2918586555/82589

Summary

The snippet doesn't appear to work when applied to all forms and also all nested forms field on a form. It only works when the configuration is set to apply it to a specific form and specific Nested Forms field.

Loom of the issue (Samuel):
https://www.loom.com/share/bff4f13258cd4ddaa8fc24e7819558b7

After the update:
https://www.loom.com/share/837b523b30ad495c945a2e976fd896ac

[coderabbitai]

Walkthrough

The JavaScript event handler for the gpnf_session_initialized action in the gp-nested-forms/gpnf-sortable-entries.php file was updated. The handler now includes a check to ensure self.formId is truthy before comparing it to gpnf.formId, preventing an early return when self.formId is falsy. Additionally, the jQuery selectors for form and field elements were updated to use the dynamic IDs from the gpnf object passed to the handler, rather than static values from self.

Changes

File(s)	Change Summary
gp-nested-forms/gpnf-sortable-entries.php	Updated the JavaScript event handler to check for self.formId before comparing to gpnf.formId, and changed jQuery selectors to use dynamic IDs from the gpnf object.

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

• 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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

gp-nested-forms/gpnf-sortable-entries.php (1)

286-286: Consider removing the debug console.log statement

There's a console.log(gpnf) statement that was likely used for debugging during development. It's best to remove this before moving to production.

-						console.log(gpnf)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a4c8c66 and fd96682.

📒 Files selected for processing (1)

• gp-nested-forms/gpnf-sortable-entries.php (1 hunks)

🔇 Additional comments (2)

gp-nested-forms/gpnf-sortable-entries.php (2)

239-242: Great fix for enabling sorting on all forms!

By adding a check to see if self.formId is truthy before comparing it to gpnf.formId, you've ensured that when the sortable entries feature is configured to work on all forms (when self.formId is false), the code won't return early. This effectively fixes the issue where the snippet only worked for a specific form configuration.

---

244-245: Correctly updated selectors to use dynamic form and field IDs

These changes ensure that the jQuery selectors use the dynamic IDs from the gpnf object rather than static values from self. This is essential for making the feature work across all forms and fields, especially when self.formId and self.fieldId are falsy in the "all forms/fields" configuration.

[github-actions]

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

Generated by 🚫 dangerJS against fd96682