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

fix: support "Unsupported" type of fields in "@@index" #1902

Merged
merged 1 commit into from
Dec 3, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Dec 3, 2024

fixes #1870

Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

📝 Walkthrough

Walkthrough

The changes primarily involve modifications to the ExpressionValidator class, where a specific error handling condition for unsupported types has been removed. This adjustment simplifies the validation process for expressions. Additionally, the test suite has been updated to reflect these changes, including modifications to error messages and the introduction of new test cases. A new regression test file has also been added to address a specific issue related to unsupported field types in model definitions.

Changes

File Path Change Summary
packages/schema/src/language-server/validator/expression-validator.ts Removed error handling for unsupported types in ExpressionValidator.
packages/schema/tests/schema/validation/datamodel-validation.test.ts Updated error messages and added new test cases for data model validation, including unsupported types.
tests/regression/tests/issue-1870.test.ts Introduced a new regression test for issue #1870, validating unsupported field types in model definitions.

Assessment against linked issues

Objective Addressed Explanation
Allow unsupported field types in @@index (Issue #1870)

Possibly related PRs


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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
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 (2)
tests/regression/tests/issue-1870.test.ts (2)

4-14: LGTM! Consider adding more test cases.

The test correctly validates the fix for issue #1870, allowing Unsupported types in @@index. However, consider adding more test cases to cover:

  • Different Unsupported type variations
  • Invalid index configurations
  • Multiple indexes on the same Unsupported field

1-14: Add documentation comments.

Consider adding JSDoc comments to explain:

Example:

+/**
+ * Regression test for issue #1870
+ * Validates that Unsupported types (specifically PostGIS geometry fields)
+ * can be used in @@index directives with PostGIS-specific index types.
+ */
 describe('issue 1870', () => {
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7fce0f0 and 7824795.

📒 Files selected for processing (3)
  • packages/schema/src/language-server/validator/expression-validator.ts (0 hunks)
  • packages/schema/tests/schema/validation/datamodel-validation.test.ts (1 hunks)
  • tests/regression/tests/issue-1870.test.ts (1 hunks)
💤 Files with no reviewable changes (1)
  • packages/schema/src/language-server/validator/expression-validator.ts
🔇 Additional comments (1)
packages/schema/tests/schema/validation/datamodel-validation.test.ts (1)

78-78: Verify error message consistency.

The error message change from "Field of 'Unsupported' type cannot be used in expressions" to "incompatible operand types" aligns with the PR objectives. However, let's verify this is consistent across the codebase.

✅ Verification successful

Error message change is consistent with the codebase

The search results confirm that the error message "incompatible operand types" is the standard error message used throughout the codebase for type incompatibility validation in expressions. This is evidenced by:

  1. The error message is consistently used in expression-validator.ts for various type incompatibility scenarios
  2. Multiple test files (attribute-validation.test.ts, datamodel-validation.test.ts) verify this error message
  3. The old message "Field of 'Unsupported' type cannot be used in expressions" is not found anywhere else in the codebase

The change aligns with the existing error message patterns and maintains consistency across the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other occurrences of the old error message to ensure all instances are updated
rg -l "Field of 'Unsupported' type cannot be used in expressions"

# Search for other error message definitions related to Unsupported types
rg "Unsupported.*type.*(?i)error"

Length of output: 109


Script:

#!/bin/bash
# Let's try a broader search for error messages related to type incompatibility in expressions
rg -i "incompatible.*type" -A 2 -B 2

# Also search for error messages containing 'operand'
rg -i "operand.*type" -A 2 -B 2

# Search for test cases related to type validation
fd "validation.*test" --exec grep -l "incompatible" {} \;

Length of output: 27613

@ymc9 ymc9 merged commit 1bdfbf4 into dev Dec 3, 2024
13 checks passed
@ymc9 ymc9 deleted the fix/unsupported-in-index branch December 3, 2024 05:57
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