fix: '@password' attribute doesn't work well with data validation

[ymc9]

Fixes #1502

[gitguardian[bot]]

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

| GitGuardian id | GitGuardian status | Secret | Commit | Filename | | | -------------- | ------------------ | ------------------------------ | ---------------- | --------------- | -------------------- | | [12331553](https://dashboard.gitguardian.com/workspace/313618/incidents/12331553?occurrence=151650618) | Triggered | Generic Password | e1e6e6bd25db05070054103ab267e69a9dcc91c4 | tests/integration/tests/enhancements/with-password/with-password.test.ts | [View secret](https://github.com/zenstackhq/zenstack/commit/e1e6e6bd25db05070054103ab267e69a9dcc91c4#diff-ed6d17b9707718a9d9e451af528d504524172f75f235e36b69b8adb953bfcbb1R73) | | [12331553](https://dashboard.gitguardian.com/workspace/313618/incidents/12331553?occurrence=151650619) | Triggered | Generic Password | e1e6e6bd25db05070054103ab267e69a9dcc91c4 | tests/integration/tests/enhancements/with-password/with-password.test.ts | [View secret](https://github.com/zenstackhq/zenstack/commit/e1e6e6bd25db05070054103ab267e69a9dcc91c4#diff-ed6d17b9707718a9d9e451af528d504524172f75f235e36b69b8adb953bfcbb1R82) |

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secrets safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate these secrets](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/detectors/generics/generic_password#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data. To avoid such incidents in the future consider - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

[coderabbitai[bot]]

Walkthrough

## Walkthrough The changes primarily focus on reordering the application of password and policy enhancements to ensure proper validation, refining validation logic in policy handlers, and restructuring integration tests to include more detailed checks, especially related to password fields. ## Changes | File Path | Change Summary | |----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `packages/runtime/src/enhancements/create-enhancement.ts` | Reordered password and policy enhancements application in `createEnhancement` function to ensure accurate validation. | | `packages/runtime/src/enhancements/policy/handler.ts` | Refactored `PolicyProxyHandler` class methods (`validateCreateInputSchema`, `validateUpdateInputSchema`) to enhance Zod schema validation. | | `packages/runtime/src/enhancements/policy/policy-utils.ts`| Improved `validateZodSchema` method to handle schema validation more flexibly, including password field exclusions and error callbacks. | | `tests/integration/tests/enhancements/with-password/...` | Updated `with-password.test.ts` to introduce new tests for password length and prefix validation. | | `tests/integration/tests/enhancements/with-policy/...` | Added specific rejection messages in `field-validation.test.ts`, `postgres.test.ts`, and `todo-sample.test.ts` for policy-related test cases. | ## Sequence Diagram(s) ### Password and Policy Enhancement Application ```mermaid sequenceDiagram participant User participant createEnhancement participant PolicyProxyHandler participant validateZodSchema User ->> createEnhancement: call function createEnhancement ->> createEnhancement: apply password enhancement createEnhancement ->> createEnhancement: apply policy enhancement createEnhancement ->> PolicyProxyHandler: initiate PolicyProxyHandler ->> validateZodSchema: validate schemas validateZodSchema -->> PolicyProxyHandler: return result PolicyProxyHandler -->> createEnhancement: return result createEnhancement -->> User: return result ``` ## Assessment against linked issues | Objective | Addressed | Explanation | |----------------------------------------------------------------------------------|-----------|------------------------------------------------------------------------------------------------| | Validation on length to be done on the unhashed password (#1502) | ✅ | | | Flexible validation schema to exclude password fields (#1502) | ✅ | | | Error callback integration for better error handling in validation (#1502) | ✅ | |

---

[!TIP]

Early access features: enabled

We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are always opted into early access features.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > :bangbang: **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 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.` - `@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 as 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. 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.