Skip to content

fix: VSCode extension fails to resolve imports from npm packages in pnpm workspaces #1779

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

Merged
merged 2 commits into from
Oct 15, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Oct 15, 2024

Fixes #1760 #1627

Copy link
Contributor

coderabbitai bot commented Oct 15, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the ast-utils.ts file, specifically altering the import statements and updating the logic within the resolveImportUri function. The import of the path module has changed from a named import to a default import. The function now uses path.isAbsolute() for checking absolute paths and incorporates a context path from the current model's document URI when resolving imports. Additionally, a console log statement has been added to enhance traceability of the loaded import path.

Changes

File Change Summary
packages/schema/src/utils/ast-utils.ts Updated import statement for path module; modified logic in resolveImportUri and resolveImport functions. Added console log for import path traceability.

Assessment against linked issues

Objective Addressed Explanation
Import models from npm module doesn't work since zenstack version 2.6.2 (#1760)

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 (1)
packages/schema/src/utils/ast-utils.ts (1)

187-196: LGTM: Import resolution logic improved.

The changes enhance the handling of import paths, particularly for npm packages in pnpm workspaces. The use of path.isAbsolute() is consistent with the updated import statement, and the added context path improves the resolution of relative imports.

The console log statement provides useful debugging information, which is helpful for traceability.

Consider adding error handling for the case where imp.$container.$document is undefined:

 const contextPath = imp.$container.$document
-    ? path.dirname(imp.$container.$document.uri.fsPath)
-    : process.cwd();
+    ? path.dirname(imp.$container.$document.uri.fsPath)
+    : (() => {
+        console.warn('Document URI not available, falling back to current working directory');
+        return process.cwd();
+      })();

This change would provide more context if the document URI is unexpectedly unavailable.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f7ccc89 and 8cab8c0.

📒 Files selected for processing (1)
  • packages/schema/src/utils/ast-utils.ts (2 hunks)
🧰 Additional context used
🔇 Additional comments (2)
packages/schema/src/utils/ast-utils.ts (2)

33-33: LGTM: Import statement updated correctly.

The change to use a default import with the node: prefix for the path module aligns with best practices for Node.js built-in modules.

To ensure consistency, let's verify the usage of path methods throughout the file:

✅ Verification successful

Verified: path methods are used correctly throughout the file.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining named imports of 'path' and verify correct usage of path methods
rg --type typescript 'path\.' packages/schema/src/utils/ast-utils.ts

Length of output: 105


Script:

#!/bin/bash
# Description: Check for any remaining named imports of 'path' and verify correct usage of path methods
rg --glob '*.ts' 'path\.' packages/schema/src/utils/ast-utils.ts

Length of output: 295


Line range hint 1-332: Verification: No other changes detected.

I've reviewed the entire file, and no other changes were detected beyond the import statement and the resolveImportUri function modifications.

To ensure we haven't missed any changes, let's run a final verification:

This command will show any additions or deletions in the file, helping us catch any overlooked modifications.

@ymc9 ymc9 merged commit d83b7ee into dev Oct 15, 2024
13 checks passed
@ymc9 ymc9 deleted the fix/issue-1760 branch October 15, 2024 19:42
@coderabbitai coderabbitai bot mentioned this pull request Oct 18, 2024
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