Skip to content

Implement full refresh preview option #1671

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

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

Conversation

anandgupta42
Copy link
Contributor

Summary

  • add dbt.previewFullRefresh setting to allow full-refresh preview
  • support passing a fullRefresh flag from dbt project when compiling or executing SQL
  • adjust dbt core integrations to handle the new flag
  • update python integration to toggle full_refresh when compiling/executing

Testing

  • npm test

Copy link
Contributor

coderabbitai bot commented May 23, 2025

Important

Review skipped

Draft detected.

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
🪧 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 a review from Copilot May 23, 2025 01:08
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

Adds a new “full refresh” preview mode by introducing a previewFullRefresh setting and threading a fullRefresh flag through all compile and execution code paths.

  • Exposes dbt.previewFullRefresh in package.json and reads it in the client.
  • Updates TypeScript interfaces and implementations (core, command, cloud) to accept and pass fullRefresh.
  • Extends Python integration to temporarily toggle full_refresh during compile_sql and execute_sql.

Reviewed Changes

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

Show a summary per file
File Description
src/manifest/dbtProject.ts Retrieve previewFullRefresh and pass fullRefresh to methods
src/dbt_client/dbtIntegration.ts Add fullRefresh to interface signatures
src/dbt_client/dbtCoreIntegration.ts Pass flag into core Python bridge calls
src/dbt_client/dbtCoreCommandIntegration.ts Append --full-refresh in CLI commands if flag is true
src/dbt_client/dbtCloudIntegration.ts Mirror full-refresh flag handling for dbt Cloud
package.json Define new dbt.previewFullRefresh configuration schema
dbt_core_integration.py Add and restore full_refresh in Python execute_sql/compile_sql
Comments suppressed due to low confidence (2)

src/manifest/dbtProject.ts:851

  • [nitpick] The previewFullRefresh setting is fetched in multiple methods; extract this into a helper (e.g., getFullRefreshSetting()) to reduce duplication and improve readability.
const fullRefresh = workspace.getConfiguration("dbt").get<boolean>("previewFullRefresh", false);

src/manifest/dbtProject.ts:851

  • There are no tests covering the new previewFullRefresh flag; add unit tests to verify that both unsafeCompileQuery and executeSQL respect the setting.
const fullRefresh = workspace.getConfiguration("dbt").get<boolean>("previewFullRefresh", false);

@@ -216,6 +216,11 @@
"default": 500,
"minimum": 1
},
"dbt.previewFullRefresh": {
Copy link
Preview

Copilot AI May 23, 2025

Choose a reason for hiding this comment

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

[nitpick] Document the new dbt.previewFullRefresh setting in the project README or changelog so users know about and can configure the full-refresh preview mode.

Copilot uses AI. Check for mistakes.

@@ -674,21 +678,28 @@ def execute_macro(
"""Wraps adapter execute_macro. Execute a macro like a function."""
return self.get_macro_function(macro, compiled_code)(kwargs=kwargs)

def execute_sql(self, raw_sql: str, original_node: Optional[Union["ManifestNode", str]] = None) -> DbtAdapterExecutionResult:
def execute_sql(self, raw_sql: str, original_node: Optional[Union["ManifestNode", str]] = None, full_refresh: bool = False) -> DbtAdapterExecutionResult:
"""Execute dbt SQL statement against database"""
Copy link
Preview

Copilot AI May 23, 2025

Choose a reason for hiding this comment

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

The execute_sql method's docstring doesn't mention the new full_refresh parameter; update the docstring to explain how this flag alters execution behavior.

Suggested change
"""Execute dbt SQL statement against database"""
"""Execute dbt SQL statement against the database.
Args:
raw_sql (str): The raw SQL statement to execute.
original_node (Optional[Union["ManifestNode", str]]): The original node associated with the SQL, if any.
full_refresh (bool): If True, forces a full refresh of incremental models by setting the `full_refresh`
flag in the execution context. This temporarily overrides the `self.args.full_refresh` attribute.
Returns:
DbtAdapterExecutionResult: The result of the SQL execution, including raw and compiled SQL.
"""

Copilot uses AI. Check for mistakes.

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.

1 participant