Skip to content

Fix profile change not updating target #1665

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

anandgupta42
Copy link
Contributor

@anandgupta42 anandgupta42 commented May 19, 2025

Summary

fix for #1588

  • refresh project configuration when profiles.yml changes

Testing

  • npm test
  • npm run lint

Important

Refresh project configuration in DBTCoreProjectIntegration when profiles.yml changes to keep settings up-to-date.

  • Behavior:
    • Updates setupWatcherHandler in DBTCoreProjectIntegration to call refreshProjectConfig() and rebuildManifest() when profiles.yml changes.
  • Functions:
    • Adds refreshProjectConfig() to DBTCoreProjectIntegration to update project configuration details like targetName, targetPath, modelPaths, etc.
  • Testing:
    • Run npm test and npm run lint to ensure functionality and code quality.

This description was created by Ellipsis for 250b25b. You can customize this summary. It will automatically update as commits are pushed.

Summary by CodeRabbit

  • Bug Fixes
    • Improved reliability by ensuring project configuration is refreshed before rebuilding the manifest when the profile file changes. This helps keep the project state up-to-date automatically.

Copy link
Contributor

coderabbitai bot commented May 19, 2025

Walkthrough

The change updates the file system watcher handler in the DBTCoreProjectIntegration class to asynchronously refresh the project configuration before rebuilding the manifest when the dbt profile file changes. The handler now awaits both the configuration refresh and the manifest rebuild, ensuring sequential and up-to-date processing.

Changes

File(s) Change Summary
src/dbt_client/dbtCoreIntegration.ts Modified the file watcher handler in initializeProject to asynchronously refresh config and rebuild manifest before acting on profile file changes.

Suggested reviewers

  • mdesmet

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm warn config production Use --omit=dev instead.
npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-05-19T15_04_09_838Z-debug-0.log

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f787955 and 250b25b.

📒 Files selected for processing (1)
  • src/dbt_client/dbtCoreIntegration.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/dbt_client/dbtCoreIntegration.ts (1)
src/utils.ts (1)
  • setupWatcherHandler (93-100)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test (windows-latest)
  • GitHub Check: build (windows-latest)
🔇 Additional comments (1)
src/dbt_client/dbtCoreIntegration.ts (1)

494-499: Perfect implementation of async profile refreshing.

The change properly addresses the issue where profile changes weren't updating target configurations. By adding the refreshProjectConfig() call before rebuildManifest() and making the handler async with proper awaits, the code now correctly ensures that project configuration is refreshed when profiles.yml changes.

This sequential approach guarantees that the manifest rebuild will use the updated configuration, fixing the issue described in the PR.

✨ Finishing Touches
  • 📝 Generate Docstrings

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

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.

@anandgupta42 anandgupta42 requested review from mdesmet and Copilot May 19, 2025 15:03
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Changes requested ❌

Reviewed everything up to 250b25b in 1 minute and 23 seconds. Click for details.
  • Reviewed 20 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 0 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

Workflow ID: wflow_MBOYfo5D0iV7hex8

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

this.rebuildManifest(),
),
// when the profile changes we need to refresh the project configuration
...setupWatcherHandler(dbtProfileWatcher, async () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding error handling (e.g. a try-catch) inside the async watcher callback to log or handle failures from refreshProjectConfig or rebuildManifest. This avoids unhandled promise rejections if one of these operations fails.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR ensures that changes to profiles.yml trigger a full project configuration refresh before rebuilding the manifest, keeping settings like targetName and modelPaths up to date.

  • Update the watcher handler to call refreshProjectConfig() then rebuildManifest()
  • Introduce refreshProjectConfig() in DBTCoreProjectIntegration
  • Maintain existing tests and linting
Comments suppressed due to low confidence (1)

src/dbt_client/dbtCoreIntegration.ts:496

  • Add a unit or integration test that simulates a profiles.yml change and verifies that both refreshProjectConfig and rebuildManifest are invoked as expected.
...setupWatcherHandler(dbtProfileWatcher, async () => {

Comment on lines +497 to +498
await this.refreshProjectConfig();
await this.rebuildManifest();
Copy link
Preview

Copilot AI May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a try/catch block inside the async watcher callback to handle potential errors from refreshProjectConfig or rebuildManifest, preventing unhandled promise rejections.

Suggested change
await this.refreshProjectConfig();
await this.rebuildManifest();
try {
await this.refreshProjectConfig();
await this.rebuildManifest();
} catch (error) {
console.error("Error in watcher callback:", error);
this.telemetry.sendTelemetryError("watcherCallbackError", error);
}

Copilot uses AI. Check for mistakes.

Comment on lines +496 to +499
...setupWatcherHandler(dbtProfileWatcher, async () => {
await this.refreshProjectConfig();
await this.rebuildManifest();
}),
Copy link
Preview

Copilot AI May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Extract the inline async callback into a named method (e.g., handleProfileChange) to improve readability and allow direct testing of the handler logic.

Suggested change
...setupWatcherHandler(dbtProfileWatcher, async () => {
await this.refreshProjectConfig();
await this.rebuildManifest();
}),
...setupWatcherHandler(dbtProfileWatcher, this.handleProfileChange.bind(this)),

Copilot uses AI. Check for mistakes.

@mdesmet
Copy link
Contributor

mdesmet commented May 20, 2025

As profiles can be located outside of the workspace folders, the vscode file watcher won't work. We should use a node js file watcher instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants