chore: update test schema generation

[ymc9]

No description provided.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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

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.

[claude]

Claude finished @ymc9's task —— View job

---

PR Review: Test Schema Generation Refactoring

I'll provide a comprehensive review of this test schema generation refactoring.

Todo List:

• Read and analyze the changed files
• Review the refactoring approach (single file → directory structure)
• Check for potential bugs or regressions
• Evaluate code quality and best practices
• Assess performance implications
• Review security considerations
• Analyze test coverage changes
• Provide final feedback and recommendations

Analysis of Changes

The PR refactors the test schema generation from a single file approach to a directory-based structure. Here are the key changes identified:

Major Structural Changes:

1. Deleted files:

   • test-schema.ts (319 lines) - Single consolidated test schema file
   • typing/generate.ts (19 lines) - Old generation script

2. New directory structure:

   • test/test-schema/ directory with separate files for schema, models, input types, and utilities
   • test/scripts/generate.ts - New unified generation script

3. New test-schema structure:

   • schema.zmodel - ZModel schema definition with User, Post, Comment, Profile models
   • schema.ts - Generated TypeScript schema (211 lines)
   • models.ts - Model type exports (15 lines)
   • input.ts - Input type definitions (90 lines)
   • helper.ts - Schema helper utilities (11 lines)
   • index.ts - Main exports (2 lines)

Refactoring Approach Assessment:

✅ Positive aspects:

• Separation of concerns: The new structure clearly separates schema definition (.zmodel), generated code (schema.ts), and type exports (models.ts, input.ts)
• Maintainability: Directory-based organization makes it easier to locate and modify specific parts
• Unified generation: Single generate.ts script handles both typing and test-schema generation
• Better build integration: Updated package.json includes test:generate script

⚠️ Concerns:

• Duplication: Both typing/ and test-schema/ directories now have similar input.ts files with identical structure but different models
• Schema divergence: The two schemas have different models (typing has Tag/Region/Meta, test-schema has Comment)

Code Quality & Best Practices Review

✅ Strengths:

1. Consistent Code Generation: All generated files include proper headers indicating they're auto-generated
2. ESLint Compliance: Generated files include /* eslint-disable */ to avoid linting issues
3. Type Safety: Strong TypeScript typing with proper generic usage
4. Import Path Handling: Generator correctly rewrites import paths (@zenstackhq/runtime → ../../dist) in generate.ts:21

⚠️ Areas for Improvement:

1. File Path Handling in generate.ts:18:

   const pluginModelFiles = glob.sync(path.resolve(dir, '../../dist/**/plugin.zmodel'));

   This assumes a specific build structure. Consider making this more configurable or add error handling if files don't exist.

2. Error Handling: The generation script lacks error handling for file operations and schema compilation.

3. Schema Consistency: The two schemas (typing-test.zmodel vs test-schema/schema.zmodel) serve different purposes but have some overlap. Consider documenting the purpose of each.

Security & Performance Considerations

✅ Security:

• No security concerns identified
• Generated files are properly marked as auto-generated
• No sensitive information exposed

✅ Performance:

• Improved build performance: Directory structure allows for more granular rebuilds
• Better caching: Separate files can be cached independently
• Reduced memory usage: Smaller individual files vs one large file

Test Coverage Analysis

✅ Test Integration:

• package.json updated with test:generate script that runs the new generation
• Generation is integrated into the test pipeline (test script includes test:generate)
• Both schemas are generated as part of the test process

⚠️ Considerations:

• The refactoring maintains the same test coverage but with a cleaner structure
• Consider adding tests for the generation script itself to ensure it handles edge cases

Final Recommendations

✅ Approve with minor suggestions:

1. Add error handling to generate.ts:

   async function generate(schemaPath: string) {
       try {
           const generator = new TsSchemaGenerator();
           // ... existing code
       } catch (error) {
           console.error(`Failed to generate schema for ${schemaPath}:`, error);
           process.exit(1);
       }
   }

2. Consider adding a README in the test-schema/ directory explaining the purpose and how to regenerate.

3. Document schema differences: Add comments explaining why typing-test.zmodel and test-schema/schema.zmodel have different models.

Summary

This is a well-executed refactoring that improves code organization and maintainability without introducing breaking changes. The directory structure is logical, the code quality is high, and the integration with the build system is proper. The minor suggestions above would further enhance the robustness of the implementation.

Overall Assessment: ✅ LGTM with minor suggestions

---

[Copilot]

Pull Request Overview

This PR restructures test schema generation by consolidating generation scripts and moving from inline schema definitions to .zmodel file-based generation. The changes support automated generation of TypeScript schema files and type definitions for testing purposes.

Key changes:

• Consolidates test schema generation into a single script that handles multiple schema files
• Replaces inline schema definitions with .zmodel files and auto-generated TypeScript schemas
• Updates build configuration to properly handle plugin file copying

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/runtime/tsup.config.ts	Adds plugin file copying and updates entry point naming
packages/runtime/test/typing/models.ts	Updates import naming to use prefixed aliases
packages/runtime/test/typing/input.ts	New auto-generated input type definitions file
packages/runtime/test/typing/generate.ts	Removes old generation script
packages/runtime/test/test-schema/*	New test schema files including .zmodel and generated TypeScript
packages/runtime/test/test-schema.ts	Removes old inline schema definition
packages/runtime/test/scripts/generate.ts	New consolidated generation script
packages/runtime/package.json	Updates test generation script path

[claude]

Claude finished @ymc9's task —— View job

---

PR Review: Test Schema Generation Refactoring

I'll provide a comprehensive review of this test schema generation refactoring.

Todo List:

• Read and analyze the changed files
• Review the refactoring approach (single file → directory structure)
• Check for potential bugs or regressions
• Evaluate code quality and best practices
• Assess performance implications
• Review security considerations
• Analyze test coverage changes
• Provide final feedback and recommendations

Analysis of Changes

This PR significantly refactors the test schema generation from a single file approach to a directory-based structure. Here are the key changes:

Major Structural Changes:

1. Unified generation script: Consolidated from separate generation scripts to a single test/scripts/generate.ts that handles both typing and test-schema generation
2. New directory structure: Created test/test-schema/ directory with separate files for schema definition, models, input types, and utilities
3. E2E test reorganization: Broke down the large zmodel-validation.test.ts (1012 lines) into smaller, focused test files
4. Build configuration updates: Updated tsup.config.ts to copy plugin files during build

Code Quality & Best Practices Review

✅ Strengths:

1. Separation of concerns: Clear separation between schema definition (.zmodel), generated code (schema.ts), and type exports (models.ts, input.ts)
2. Maintainability: Directory-based organization makes it easier to locate and modify specific components
3. Consistent code generation: All generated files include proper headers and ESLint disable comments
4. Unified build process: Single generation script handles both schemas efficiently
5. Better test organization: Breaking down the large test file into focused, domain-specific tests improves maintainability

⚠️ Areas for Improvement:

1. Hard-coded paths in generate.ts:18:

   const pluginModelFiles = glob.sync(path.resolve(dir, '../../dist/**/plugin.zmodel'));

   This assumes a specific build structure. Consider adding error handling or making paths configurable.

2. No error handling: The generation script lacks error handling for file operations and schema compilation failures.

3. Schema divergence: The two schemas (typing-test.zmodel vs test-schema/schema.zmodel) have different models but similar structure - consider documenting their distinct purposes.

Potential Bugs or Issues

✅ No critical bugs identified, but some considerations:

1. Path resolution: The relative path ../../dist/**/plugin.zmodel in generate.ts:18 could fail if the build structure changes
2. Missing error handling: If schema compilation fails, the script will crash without helpful error messages
3. Import path rewriting: The regex replacement in generate.ts:21 is functional but fragile - consider using a more robust AST-based approach

Performance Considerations

✅ Performance improvements:

1. Faster builds: Directory structure allows for more granular rebuilds
2. Better caching: Smaller individual files can be cached independently
3. Reduced memory usage: Splitting large files reduces memory footprint during compilation
4. Parallel test execution: Smaller test files can run in parallel more effectively

Security Considerations

✅ No security concerns identified:

• Generated files are properly marked as auto-generated
• No sensitive information exposed in schema definitions
• Build process doesn't introduce security vulnerabilities
• Plugin file copying is safe and contained

Test Coverage Analysis

✅ Test coverage improvements:

1. Better organization: Breaking down the 1012-line test file into focused test files improves maintainability
2. Domain-specific testing: Tests are now organized by feature (relations, constraints, enums, etc.)
3. Proper test utilities: The new test-utils.ts provides a clean testing infrastructure
4. Comprehensive coverage: The split maintains the same test coverage but with better organization

Test file breakdown:

• basic-models.test.ts: Core model validation
• relations-*.test.ts: Relationship validation across different types
• field-types.test.ts: Field type validation
• attributes.test.ts: Attribute validation
• unique-constraints.test.ts: Constraint validation
• enums.test.ts: Enum validation
• datasource.test.ts: Datasource configuration

Final Recommendations

✅ Approve with minor suggestions:

1. Add error handling to generate.ts:

   async function generate(schemaPath: string) {
       try {
           const generator = new TsSchemaGenerator();
           // ... existing code
       } catch (error) {
           console.error(`Failed to generate schema for ${schemaPath}:`, error);
           process.exit(1);
       }
   }

2. Improve path handling in generate.ts:18:

   const pluginBaseDir = process.env.PLUGIN_BASE_DIR || path.resolve(dir, '../../dist');
   const pluginModelFiles = glob.sync(path.join(pluginBaseDir, '**/plugin.zmodel'));

3. Consider adding validation for required files:

   if (!existsSync(schemaPath)) {
       throw new Error(`Schema file not found: ${schemaPath}`);
   }

4. Document schema purposes: Add comments or README explaining the difference between typing-test.zmodel and test-schema/schema.zmodel.

Summary

This is a well-executed refactoring that significantly improves code organization, maintainability, and test structure. The changes are backwards-compatible and enhance the development experience without introducing breaking changes. The directory structure is logical, the code quality is high, and the test organization is much improved.

Overall Assessment: ✅ LGTM - This refactoring brings clear benefits with minimal risk.

---