CT-2322/improve contracts error message #7223

kentkr · 2023-03-26T03:01:00Z

resolves #7209

Description

If a model has a contract error dbt currently prints the yaml columns and sql columns, respectively, as a single string with delimited column names and data type. This is hard to read. The changes made here split the strings and print the yaml and sql columns side by side.

Note that the columns are printed in the order that they are listed in the model or in the yaml file. So columns may not line up correctly. Because of this I decided not to add an extra column that checks if the two columns are the same, a feature requested in the original issue.

I'm not all that familiar with OOP and don't know how self.yaml_columns (and sql columns) is inherited or where it comes from. But surely it can be inherited as something other than a delimited string. If it was a dict ({col : data_type}) it'd be easier to compare and print in an ordered format. That may be more effort than its worth. @jtcohen6 any suggestions?

Checklist

I have read the contributing guide and understand what's expected of me
I have signed the CLA
I have run this code in development and it appears to resolve the stated issue
This PR includes tests, or tests are not required/relevant for this PR
I have opened an issue to add/update docs, or docs changes are not required/relevant for this PR
I have run changie new to create a changelog entry

cla-bot · 2023-03-26T03:01:03Z

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Kyle Kent.
This is most likely caused by a git client misconfiguration; please make sure to:

check if your git client is configured with an email to sign commits git config --list | grep email
If not, set it up using git config --global user.email [email protected]
Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

kentkr · 2023-03-26T03:09:12Z

Just signed the CLA but don't know how to rerun the github check.

cla-bot · 2023-03-26T03:17:41Z

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Kyle Kent.
This is most likely caused by a git client misconfiguration; please make sure to:

check if your git client is configured with an email to sign commits git config --list | grep email
If not, set it up using git config --global user.email [email protected]
Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

jtcohen6

@kentkr Thanks for picking this up so quickly!! :)

But surely it can be inherited as something other than a delimited string.

Surely it can! I don't think this should be too tricky, and it would let us do much nicer things when formatting the error message, to highlight / show only the diffs.

Re: the CLA bot: unfortunately, you might need to do a quick git rebase where you edit your previous commits to include the same email address that's associated with your GitHub username. If that's too tricky to sort out, no worries - I can see you've signed the CLA - once the changes here are good to go, one of us can take your commits, rebase, and open as a new PR to make the bot happy. (We'd of course still give you all credit for the contribution!)

jtcohen6 · 2023-03-29T18:36:29Z

core/dbt/exceptions.py

+        # print columns pretty
+        # split yaml and sql strings into list
+        yaml_list = self.yaml_columns.split(', ')
+        sql_list = self.sql_columns.split(', ')


Ah - I didn't realize that these are the stringified versions of yaml_columns and sql_columns, but that is indeed exactly how they're being passed in here (string_yaml_columns and string_sql_columns):

dbt-core/core/dbt/include/global_project/macros/materializations/models/table/columns_spec_ddl.sql

Lines 45 to 65 in 73ff497

{%- if sql_columns|length != yaml_columns|length -%}

{%- do exceptions.raise_contract_error(string_yaml_columns, string_sql_columns) -%}

{%- endif -%}

{%- for sql_col in sql_columns -%}

{%- set yaml_col = [] -%}

{%- for this_col in yaml_columns -%}

{%- if this_col['name'] == sql_col['name'] -%}

{%- do yaml_col.append(this_col) -%}

{%- break -%}

{%- endif -%}

{%- endfor -%}

{%- if not yaml_col -%}

{#-- Column with name not found in yaml #}

{%- do exceptions.raise_contract_error(string_yaml_columns, string_sql_columns) -%}

{%- endif -%}

{%- if sql_col['formatted'] != yaml_col[0]['formatted'] -%}

{#-- Column data types don't match #}

{%- do exceptions.raise_contract_error(string_yaml_columns, string_sql_columns) -%}

{%- endif -%}

{%- endfor -%}

It is also true that the logic we're using to compare columns one-by-one, and the logic we'd want to use to display pretty output, should be quite similar.

So, a couple of potential approaches here:

Pass the dict (not str) representation of these columns into the Python exception, so that we can do the same sort of comparison over here again

Since the Jinja macro is already detecting differences - pass only the ordered set of disagreeing columns, from the assert_columns_equivalent macro, into this exception. (But what about the case where the two column lengths differ? We'd still want to detect which columns are present in one, and missing from the other)

Move this comparison logic into a Python method, and have assert_columns_equivalent macro call that method instead of writing this logic in Jinja. That method would call this exception if it detects differences.

(1) is probably simplest with the existing implementation - just switch out string_yaml_columns + string_sql_columns for yaml_columns and sql_columns in the macro definition linked above.

@MichelleArk Curious if you have an opinion on what the right way to go here would be!

@jtcohen6 Alright, what I just pushed should work. It's not my favorite solution because the columns are actually passed as a list of dictionaries [{col1 : col1 INT}, ...]. I could've removed the list to avoid using so many for loops, but decided mimic the exception call in the .sql file as best I could. Cuz if it aint broke don't fix it. Attached is an image of how the error prints!

As for the rebase issue, if you're happy with these changes I'll open a new PR with the modified files.

@kentkr This is a big improvement!

Sorry for the delay getting back to you. To have a better chance of getting this over the finish line, I'm going to open a new PR with

rebased commits to fix the CLA issue

a few more aesthetic touch-ups (e.g. highlighting columns with mismatches, and using our existing library for printing markdown tables to stdout)

cla-bot · 2023-04-03T01:45:15Z

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Kyle Kent.
This is most likely caused by a git client misconfiguration; please make sure to:

check if your git client is configured with an email to sign commits git config --list | grep email
If not, set it up using git config --global user.email [email protected]
Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

cla-bot · 2023-04-03T02:23:22Z

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Kyle Kent.
This is most likely caused by a git client misconfiguration; please make sure to:

check if your git client is configured with an email to sign commits git config --list | grep email
If not, set it up using git config --global user.email [email protected]
Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

cla-bot · 2023-04-03T02:26:16Z

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Kyle Kent.
This is most likely caused by a git client misconfiguration; please make sure to:

check if your git client is configured with an email to sign commits git config --list | grep email
If not, set it up using git config --global user.email [email protected]
Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

* improved first line of error * added basic printing of yaml and sql cols as columns * added changie log * used listed dictionary as input to match columns * swapped order of col headers for printing * used listed dictionary as input to match columns * removed merge conflict text from file * Touch-ups * Update log introspection in functional tests * Update format_column macro. Case insensitive test * PR feedback: just data_type, not formatted --------- Co-authored-by: Kyle Kent <[email protected]>

jtcohen6 · 2023-04-11T20:31:29Z

Incorporated into #7319 !

Kyle Kent added 2 commits March 25, 2023 15:58

improved first line of error

099d248

added basic printing of yaml and sql cols as columns

87c3886

kentkr requested a review from a team as a code owner March 26, 2023 03:01

kentkr requested review from Fleid and nssalian March 26, 2023 03:01

kentkr mentioned this pull request Mar 26, 2023

[CT-2322] [Feature] Side-by-side diff when an enforced model contract fails #7209

Closed

3 tasks

added changie log

da35566

kentkr force-pushed the CT-2322/improve_contracts_error branch from fa66513 to da35566 Compare March 26, 2023 03:17

jtcohen6 reviewed Mar 29, 2023

View reviewed changes

used listed dictionary as input to match columns

86a614f

kentkr requested a review from a team as a code owner April 3, 2023 01:45

kentkr added 3 commits April 2, 2023 19:05

used listed dictionary as input to match columns

6b174fd

swapped order of col headers for printing

d7c2edd

fixed merge conflict after attempted rebase

d160a41

removed merge conflict text from file

43e3e55

jtcohen6 mentioned this pull request Apr 11, 2023

Rebase #7223: improve contracts error message #7319

Merged

5 tasks

jtcohen6 closed this Apr 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CT-2322/improve contracts error message #7223

CT-2322/improve contracts error message #7223

kentkr commented Mar 26, 2023 •

edited

Loading

cla-bot bot commented Mar 26, 2023

kentkr commented Mar 26, 2023

cla-bot bot commented Mar 26, 2023

jtcohen6 left a comment

jtcohen6 Mar 29, 2023

kentkr Apr 3, 2023

kentkr Apr 3, 2023

jtcohen6 Apr 11, 2023

cla-bot bot commented Apr 3, 2023

cla-bot bot commented Apr 3, 2023

cla-bot bot commented Apr 3, 2023

jtcohen6 commented Apr 11, 2023

	{%- if sql_columns\|length != yaml_columns\|length -%}
	{%- do exceptions.raise_contract_error(string_yaml_columns, string_sql_columns) -%}
	{%- endif -%}

	{%- for sql_col in sql_columns -%}
	{%- set yaml_col = [] -%}
	{%- for this_col in yaml_columns -%}
	{%- if this_col['name'] == sql_col['name'] -%}
	{%- do yaml_col.append(this_col) -%}
	{%- break -%}
	{%- endif -%}
	{%- endfor -%}
	{%- if not yaml_col -%}
	{#-- Column with name not found in yaml #}
	{%- do exceptions.raise_contract_error(string_yaml_columns, string_sql_columns) -%}
	{%- endif -%}
	{%- if sql_col['formatted'] != yaml_col[0]['formatted'] -%}
	{#-- Column data types don't match #}
	{%- do exceptions.raise_contract_error(string_yaml_columns, string_sql_columns) -%}
	{%- endif -%}
	{%- endfor -%}

CT-2322/improve contracts error message #7223

CT-2322/improve contracts error message #7223

Conversation

kentkr commented Mar 26, 2023 • edited Loading

Description

Checklist

cla-bot bot commented Mar 26, 2023

kentkr commented Mar 26, 2023

cla-bot bot commented Mar 26, 2023

jtcohen6 left a comment

Choose a reason for hiding this comment

jtcohen6 Mar 29, 2023

Choose a reason for hiding this comment

kentkr Apr 3, 2023

Choose a reason for hiding this comment

kentkr Apr 3, 2023

Choose a reason for hiding this comment

jtcohen6 Apr 11, 2023

Choose a reason for hiding this comment

cla-bot bot commented Apr 3, 2023

cla-bot bot commented Apr 3, 2023

cla-bot bot commented Apr 3, 2023

jtcohen6 commented Apr 11, 2023

kentkr commented Mar 26, 2023 •

edited

Loading