feat: Add support for `Parse.Query.include` in LiveQuery

[mtrezza]

Pull Request

• Report security issues confidentially.
• Any contribution is under this license.
• Link this pull request to an issue.

Issue

Closes: https://github.com/parse-community/parse-server/issues/1686

Approach

Add Parse.Query.include to LiveQuery.

Tasks

• [ ] Add tests
• [ ] Add changes to documentation (guides, repository pages, code comments)
• [ ] Add change to Parse JS SDK to pass include on subscribe and resubscribe --> https://github.com/parse-community/Parse-SDK-JS/pull/2694

Summary by CodeRabbit

• New Features

  • Live queries now support the "include" directive, allowing related objects referenced by pointers to be automatically fetched and embedded in real-time subscription results.

• Tests

  • Added a new test to verify that live queries correctly handle the "include" directive and return related pointer data as expected.

[parse-github-assistant[bot]]

🚀 Thanks for opening this pull request!

[coderabbitai[bot]]

📝 Walkthrough

Walkthrough

Support for the include directive in live query subscriptions was added to the live query server, enabling automatic fetching and embedding of related pointer objects in real-time events. A focused test case was introduced to verify that live queries correctly resolve and include related pointer data when the include directive is specified.

Changes

File(s)	Change Summary
spec/ParseLiveQuery.spec.js	Added a focused test to verify live query support for the include directive with pointer data.
src/LiveQuery/ParseLiveQueryServer.ts	Implemented support for include in live queries: added methods for pointer resolution, object embedding, and updated event handling to process includes. Modified subscription handling to parse and store include fields.
src/LiveQuery/RequestSchema.js	Extended subscribe and update query schemas to include an optional include array of strings.
types/LiveQuery/ParseLiveQueryServer.d.ts	Added type declarations for new methods supporting include functionality in ParseLiveQueryServer.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant LiveQueryServer
    participant Database

    Client->>LiveQueryServer: Subscribe to class with include (e.g., Queue include user)
    LiveQueryServer->>Database: Register subscription

    Note over LiveQueryServer: On object creation or update
    Database-->>LiveQueryServer: New/updated object (with pointer)
    LiveQueryServer->>Database: Fetch related pointer objects (e.g., user)
    Database-->>LiveQueryServer: Return full related objects
    LiveQueryServer->>Client: Send event with included pointer objects

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm warn EBADENGINE Unsupported engine { npm warn EBADENGINE package: '[email protected]', npm warn EBADENGINE required: { node: '18 || 19 || 20 || 22' }, npm warn EBADENGINE current: { node: 'v24.3.0', npm: '11.4.2' } npm warn EBADENGINE } npm error Exit handler never called! npm error This is an error with npm itself. Please report this error at: npm error https://github.com/npm/cli/issues npm error A complete log of this run can be found in: /.npm/_logs/2025-07-17T01_41_42_538Z-debug-0.log

---

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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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

[parseplatformorg]

:tada: Snyk checks have passed. No issues have been found so far.

:white_check_mark: security/snyk check is complete. No issues have been found. (View Details)