fix(vscode): add extension version in doc preview request

[ymc9]

Summary by CodeRabbit

Release Notes

• New Features
  • The VS Code extension now captures and includes its version information when generating documentation, enhancing diagnostic and tracking capabilities.

[claude]

Claude finished @ymc9's task —— View job

---

Code Review Complete ✅

I've analyzed this pull request that adds extension version information to the ZModel documentation preview request. Here's my comprehensive review:

Todo List:

• Read and analyze the changed file
• Evaluate code quality and best practices
• Check for potential bugs or issues
• Assess performance considerations
• Review security concerns
• Evaluate test coverage needs
• Provide comprehensive feedback

---

Summary

This is a clean, focused change that adds extension version tracking to the ZModel documentation preview API requests. The change includes:

1. Added extensionVersion: string property to the class (packages/ide/vscode/src/extension/zmodel-preview.ts:18)
2. Updated the Zod schema to include optional extensionVersion field (packages/ide/vscode/src/extension/zmodel-preview.ts:39)
3. Initialized the extension version in the constructor (packages/ide/vscode/src/extension/zmodel-preview.ts:45)
4. Included extension version in the API request payload (packages/ide/vscode/src/extension/zmodel-preview.ts:229)

✅ Code Quality & Best Practices

• Excellent: Proper TypeScript typing with clear property declarations
• Good: Uses Zod schema validation for request structure
• Good: Consistent naming conventions following existing patterns
• Good: Safe null handling with nullish coalescing (??) operator for version fallback
• Good: Maintains existing code structure and patterns

✅ Potential Bugs or Issues

No significant issues found. The implementation is robust:

• Safe access to context.extension.packageJSON.version with fallback to empty string
• Optional field in Zod schema prevents validation errors if version is missing
• Maintains backward compatibility with existing API consumers

✅ Performance Considerations

Minimal performance impact:

• Only adds one string property to the class (negligible memory overhead)
• Version is read once during construction and cached
• No additional API calls or processing overhead
• The version string addition to request payload is minimal data (~10 bytes)

✅ Security Concerns

No security issues identified:

• Extension version is public information, no sensitive data exposure
• Version comes from trusted source (package.json)
• No user input validation required as version is internally controlled
• Maintains existing authentication patterns

⚠️ Test Coverage

Recommendation: Consider adding tests
While this is a small change, adding test coverage would be beneficial:

// Suggested test cases:
// 1. Verify extension version is correctly initialized from package.json
// 2. Verify extension version is included in API request payload  
// 3. Verify graceful handling when package.json.version is undefined
// 4. Verify Zod schema accepts requests with/without extensionVersion

The existing codebase may already have integration tests that cover the API request flow, which would implicitly test this change.

Additional Observations

• Purpose: This change likely supports analytics, debugging, or API versioning on the server side
• Backward Compatibility: ✅ Fully maintained through optional schema field
• Documentation: The PR lacks a description, but the change is self-explanatory
• File Organization: Change is appropriately placed within the existing class structure

Recommendation: APPROVE ✅

This is a well-implemented, low-risk enhancement that follows established patterns and maintains code quality standards. The change is focused, safe, and adds valuable telemetry capability without introducing technical debt.

--- | Branch: fix/vscode-request

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 26b32e55-f670-4d17-98b4-9bc789c5f432

📥 Commits

Reviewing files that changed from the base of the PR and between dbca9ed and 3da6395.

📒 Files selected for processing (1)

• packages/ide/vscode/src/extension/zmodel-preview.ts

---

📝 Walkthrough

Walkthrough

The extension now captures its version during initialization and includes this version information in API documentation requests, enabling the backend to track which extension version generated each documentation request.

Changes

Cohort / File(s)	Summary
Extension Version Tracking packages/ide/vscode/src/extension/zmodel-preview.ts	Added extensionVersion field initialization from package metadata, extended request schema to include optional version, and wired version into POST request payload to documentation API.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A version now travels with every request,
Through schemas and payloads, it passes the test,
The rabbit hops quickly from init to send,
Tracking extensions—a helpful blend! 🎉

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding extension version to the documentation preview request in the VSCode extension.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/vscode-request

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}