Skip to content

Workaround regression in Neo4j 5.26.x with optional match usage in project sensitivity calc #3418

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

Closed

Conversation

CarsonF
Copy link
Member

@CarsonF CarsonF commented May 8, 2025

This isn't the first time we've seen problems with optional match clauses. Instead of trying to let neo4j maintain cardinality a carry a null value, now will require match in a subquery and then collect the result to maintain cardinality.

optional match -> subquery, match, collect

…oject sensitivity calc

This isn't the first time we've seen problems with optional match clauses.
Instead of trying to let neo4j maintain cardinality a carry a null value,
now will require match in a subquery and then collect the result to maintain cardinality.

optional match -> subquery, match, collect
Copy link

coderabbitai bot commented May 8, 2025

📝 Walkthrough

Walkthrough

The change updates the internal logic of the matchProjectSens function by replacing an optionalMatch clause with a subQuery. This adjustment ensures that a row is always returned for non-internship projects, even when no sensitivities are matched, by encapsulating the matching and ordering logic within a subquery.

Changes

File(s) Change Summary
src/core/database/query/match-project-based-props.ts Replaced an optionalMatch clause with a subQuery in the matchProjectSens function to ensure consistent row returns for non-internship projects. No changes to exported or public entity signatures.

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

✨ 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.

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 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.

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)
src/core/database/query/match-project-based-props.ts (1)

131-146: Solid approach to address the Neo4j 5.26.x regression.

This implementation correctly addresses the regression in Neo4j 5.26.x by replacing the optional match with a subquery. The collection of sensitivities using collect() ensures that cardinality is maintained, even when no sensitivities are matched, allowing the query to continue execution as expected.

The subquery approach effectively encapsulates the sensitivity matching and ordering logic while maintaining the same functional behavior.

Consider extracting the default sensitivity value "High" (which appears at line 146 and line 155) into a constant at the module level to improve maintainability.

+ const DEFAULT_SENSITIVITY: Sensitivity = "High";
// ...
- .return(coalesce('sensitivities[0]', '"High"').as(output))
+ .return(coalesce('sensitivities[0]', `"${DEFAULT_SENSITIVITY}"`).as(output))
// ...
- .return<Record<Output, Sensitivity>>(`"High" as ${output}`),
+ .return<Record<Output, Sensitivity>>(`"${DEFAULT_SENSITIVITY}" as ${output}`),
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 42d326f and 61cec75.

📒 Files selected for processing (1)
  • src/core/database/query/match-project-based-props.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/core/database/query/match-project-based-props.ts (2)
src/core/database/query/matching.ts (1)
  • ACTIVE (27-27)
src/core/database/query/cypher-functions.ts (2)
  • collect (29-29)
  • coalesce (47-47)
⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: E2E Tests (neo4j 6/6)
  • GitHub Check: E2E Tests (neo4j 5/6)
  • GitHub Check: E2E Tests (neo4j 4/6)
  • GitHub Check: E2E Tests (neo4j 3/6)
  • GitHub Check: E2E Tests (neo4j 2/6)
  • GitHub Check: Generate (head)
  • GitHub Check: Unit
  • GitHub Check: E2E Tests (neo4j 1/6)
  • GitHub Check: Generate (base)
  • GitHub Check: Clean
  • GitHub Check: lint
  • GitHub Check: Analyze (javascript)

@CarsonF CarsonF closed this May 8, 2025
@CarsonF CarsonF deleted the bugfix/neo4j-regression-project-sens–optional branch May 8, 2025 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant