refactor: make data validation a separate enhancement kind

[ymc9]

Fixes #1050

[coderabbitai]

Walkthrough

Walkthrough

The recent updates introduce a new enhancement type, 'validation', to manage data validation independently from policy controls. This change involves updating the EnhancementKind enum and adjusting the logic in the createEnhancement function. Additionally, the PolicyUtil class now features a method for retrieving authorization guards, ensuring consistent guard usage across the codebase. The QueryUtils class sees a minor tweak with a change in the access modifier for the options property. Integration tests have been updated to reflect these changes, particularly focusing on the interaction between policy and validation enhancements.

Changes

Files	Change Summary
.../src/enhancements/create-enhancement.ts	Added 'validation' type to EnhancementKind, updated createEnhancement logic.
.../src/enhancements/policy/policy-utils.ts	Added getModelAuthGuard method, updated methods for consistent guard retrieval.
.../src/enhancements/query-utils.ts	Changed options property access modifier from private to protected.
tests/integration/tests/enhancements/with-policy/field-validation.test.ts	Renamed test suite, updated test setup for validation, added 'Policy and validation interaction' tests.

Assessment against linked issues

Objective	Addressed	Explanation
Data validation should be controlled with its own enhancement kind (#1050)	✅

---

Recent Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 101e642 and f81ec17.

Files selected for processing (4)

• packages/runtime/src/enhancements/create-enhancement.ts (2 hunks)
• packages/runtime/src/enhancements/policy/policy-utils.ts (6 hunks)
• packages/runtime/src/enhancements/query-utils.ts (1 hunks)
• tests/integration/tests/enhancements/with-policy/field-validation.test.ts (17 hunks)

Additional comments not posted (12)

packages/runtime/src/enhancements/create-enhancement.ts (3)

17-17: The addition of 'validation' to the EnhancementKind enum aligns with the PR objectives.

---

22-22: The update to ALL_ENHANCEMENTS to include 'validation' is correct and necessary for the new feature.

---

151-154: Efficiently reusing the withPolicy function to handle both 'policy' and 'validation' enhancements is a smart choice. This maintains the modularity and clarity of the enhancement handling logic.

packages/runtime/src/enhancements/query-utils.ts (1)

16-16: Changing the options property's access modifier from private to protected increases flexibility for subclasses. Ensure that this change aligns with the intended encapsulation and security model for QueryUtils.

tests/integration/tests/enhancements/with-policy/field-validation.test.ts (3)

4-4: Renaming the test suite to 'Field validation' accurately reflects its broader scope, including both policy and validation enhancements.

---

48-49: Correctly removing @@allow('all', true) directives and adding { enhancements: ['validation'] } in loadSchema calls aligns with the PR objectives to segregate data validation from policy enforcement.

---

958-958: Introducing the 'Policy and validation interaction' test suite is a valuable addition for assessing the interplay between policy enforcement and data validation mechanisms.

packages/runtime/src/enhancements/policy/policy-utils.ts (5)

233-250: Introduced a default fully open authorization guard and a method to retrieve model-specific guards. Ensure the default open guard aligns with your security model.

---

259-259: Utilizing getModelAuthGuard centralizes guard retrieval logic. Consider refining error messages for better clarity and troubleshooting.

---

340-340: Consistent use of getModelAuthGuard in hasAuthGuard method enhances maintainability.

---

369-369: Integration of getModelAuthGuard in checkInputGuard method is consistent with the refactor. Verify handling of cases where no guard is defined.

---

1042-1058: Consistent use of getModelAuthGuard in getPreValueSelect, getReadFieldSelect, and checkReadField methods. Review error handling for robustness and clarity.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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