search

AltimateAI / vscode-dbt-power-user

This extension makes vscode seamlessly work with dbt™: Auto-complete, preview, column lineage, AI docs generation, health checks, cost estimation etc
https://www.altimate.ai
MIT License
471 stars 94 forks source link

Fix dbt cloud project name lookup #1491

Closed mdesmet closed 3 weeks ago

mdesmet commented 3 weeks ago

Overview

Problem

Describe the problem you are solving. Mention the ticket/issue if applicable.

Solution

Describe the implemented solution. Add external references if needed.

Screenshot/Demo

A picture is worth a thousand words. Please highlight the changes if applicable.

How to test

Checklist

[!IMPORTANT] Fix project name lookup in DBTCloudProjectIntegration by reading from dbt_project.yml instead of command output.

  • Behavior:
    • Removed lookupValue function from DBTCloudProjectIntegration.
    • Project name is now read from dbt_project.yml using DBTProject.readAndParseProjectConfig.
    • If reading fails, logs a warning and defaults to a generated name.
  • Error Handling:
    • Updated error message for missing project name in initializePaths method.
  • Misc:
    • Updated warning message for DbtCloudIntegrationInitializePathsExceptionError in initializePaths.

This description was created by Ellipsis for 485af003425247f22a96e32aa101a4fe70e113c2. It will automatically update as commits are pushed.

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The pull request modifies the DBTCloudProjectIntegration class in src/dbt_client/dbtCloudIntegration.ts. The initializePaths method has been updated to replace the lookupValue function with a new method for setting the projectName using DBTProject.readAndParseProjectConfig. This change ensures the project name is sourced from the dbt_project.yml configuration file. Additionally, error handling within this method has been improved, providing clearer error messages when the environment show command fails to return necessary information.

Changes

File Change Summary
src/dbt_client/dbtCloudIntegration.ts - Updated initializePaths to use DBTProject.readAndParseProjectConfig for setting projectName instead of regex lookup.
- Improved error messages related to the environment show command.

Possibly related PRs

Suggested reviewers

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 0a48cd53835515134f0eb6fe691286269e339a6b and 485af003425247f22a96e32aa101a4fe70e113c2.
📒 Files selected for processing (1) * `src/dbt_client/dbtCloudIntegration.ts` (2 hunks)
🔇 Additional comments (2)
src/dbt_client/dbtCloudIntegration.ts (2) `1020-1020`: **LGTM! Error message improvement** The error message has been updated to be more specific about the actual issue, which is the dbt environment show command not returning required information. --- `1030-1043`: **LGTM! Improved project name lookup implementation** The new implementation correctly retrieves the project name from `dbt_project.yml` using `DBTProject.readAndParseProjectConfig`. This is a more reliable approach than the previous regex-based lookup from environment show command output. The error handling is robust, with appropriate warning logs if the project name cannot be read from the config file.

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): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `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 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
sweep-ai[bot] commented 3 weeks ago

Hey @mdesmet, here is an example of how you can ask me to improve this pull request:

@sweep Add unit tests for the new project name reading logic in `DBTCloudProjectIntegration` that cover:
1. Successfully reading project name from dbt_project.yml
2. Handling the case where dbt_project.yml cannot be read/parsed
3. Handling the case where project name is missing from dbt_project.yml

:book: For more information on how to use Sweep, please read our documentation.