[Fix] respect project root when loading seeds #8762

MichelleArk · 2023-10-03T19:11:18Z

resolves #6875

Problem

dbt seed fails when attempting to leverage partial parse file across dbt invocations in the same project, but different root directories.

Solution

Use the project root instead of the root path on the model node (which could be from a prior dbt run in a different directory, but the same project) when loading seeds.

Risk assessment (for backporting):

Added additional safety here wrt preserving previous behaviour and try to use the model.root_path, and if the file doesn't exist, falling back to the project root.
no changes to manifest schema

Checklist

I have read the contributing guide and understand what's expected of me
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
This PR has no interface changes (e.g. macros, cli, logs, json artifacts, config files, adapter interface, etc) or this PR has already received feedback and approval from Product or DX
This PR includes type annotations for new and modified functions

github-actions · 2023-10-03T19:11:32Z

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

codecov · 2023-10-03T19:14:32Z

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (0c965c8) 86.62% compared to head (f778dec) 86.50%.
Report is 15 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8762      +/-   ##
==========================================
- Coverage   86.62%   86.50%   -0.13%     
==========================================
  Files         176      176              
  Lines       25772    25861      +89     
==========================================
+ Hits        22325    22371      +46     
- Misses       3447     3490      +43

Flag	Coverage Δ
integration	`83.25% <71.42%> (-0.14%)`	⬇️
unit	`65.06% <14.28%> (-0.08%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
core/dbt/tests/util.py	`86.59% <100.00%> (+0.09%)`	⬆️
core/dbt/context/providers.py	`88.71% <60.00%> (-0.24%)`	⬇️

... and 14 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

core/dbt/parser/seeds.py

jtcohen6 · 2023-10-04T12:00:14Z

core/dbt/contracts/graph/nodes.py

@@ -875,6 +875,7 @@ class SeedNode(ParsedNode):  # No SQLDefaults!
    config: SeedConfig = field(default_factory=SeedConfig)
    # seeds need the root_path because the contents are not loaded initially
    # and we need the root_path to load the seed later
+    # TODO: remove root_path as it is unused, and instead computed dynamically in load_agate_table


What do you think of:

remove root_path for v1.7 (manifest v11)

backport just the load_agate_table change to earlier versions

Yep! This is what I was thinking as well. I left this as a TODO so this spike could be merged + backported as-is.

I've opted to preserve the existing behaviour for getting the seed path that leverages root_path to mitigate risk of regression - so it's not quite in a state yet where this TODO makes sense as root_path is still used in load_agate_table

github-actions · 2023-10-10T15:26:45Z

The backport to 1.6.latest failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.6.latest 1.6.latest
# Navigate to the new working tree
cd .worktrees/backport-1.6.latest
# Create a new branch
git switch --create backport-8762-to-1.6.latest
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 964e0e4e8ad50a917074aabc8493b210a84e0258
# Push it to GitHub
git push --set-upstream origin backport-8762-to-1.6.latest
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.6.latest

Then, create a pull request where the base branch is 1.6.latest and the compare/head branch is backport-8762-to-1.6.latest.

(cherry picked from commit 964e0e4)

MichelleArk · 2023-10-10T21:38:40Z

Backports:
1.6: #8804
1.5: #8805
1.4: #8806
1.3: #8810
1.2: #8814 (draft)
1.1: #8815 (draft)
1.0:#8816 (draft)

(cherry picked from commit 964e0e4)

…#8805) (cherry picked from commit 964e0e4)

…#8804) (cherry picked from commit 964e0e4) Co-authored-by: Kshitij Aranke <[email protected]>

Fix] respect project root when loading seeds (#8762)

With the introduction of enabling partial parse in PR #904, upon testing the implementation, it is observed that the seeds files were not been able to be located as the partial parse file contained a stale `root_path` from previous command runs. This issue is observed on specific earlier versions of dbt-core like `1.5.4` and `1.6.5`, but not on recent versions of dbt-core `1.5.8`, `1.6.6` and `1.7.0`. I am suspecting that PR dbt-labs/dbt-core#8762 is likely the fix and the fix appears to be backported to later version releases of `1.5.x` and `1.6.x`. However, irrespective of the dbt-core version, this PR attempts to correct the `root_path` in the partial parse file by replacing it with the needed project directory where the project files are located. And thus ensures that the feature runs correctly for older and newer versions of dbt-core. closes: #937 --------- Co-authored-by: Tatiana Al-Chueyr <[email protected]>

With the introduction of enabling partial parse in PR astronomer#904, upon testing the implementation, it is observed that the seeds files were not been able to be located as the partial parse file contained a stale `root_path` from previous command runs. This issue is observed on specific earlier versions of dbt-core like `1.5.4` and `1.6.5`, but not on recent versions of dbt-core `1.5.8`, `1.6.6` and `1.7.0`. I am suspecting that PR dbt-labs/dbt-core#8762 is likely the fix and the fix appears to be backported to later version releases of `1.5.x` and `1.6.x`. However, irrespective of the dbt-core version, this PR attempts to correct the `root_path` in the partial parse file by replacing it with the needed project directory where the project files are located. And thus ensures that the feature runs correctly for older and newer versions of dbt-core. closes: astronomer#937 --------- Co-authored-by: Tatiana Al-Chueyr <[email protected]>

respect project root when loading seeds

62aeebf

cla-bot bot added the cla:yes label Oct 3, 2023

preserve relative path in seed root_path

7100ff9

MichelleArk commented Oct 3, 2023

View reviewed changes

core/dbt/parser/seeds.py Outdated Show resolved Hide resolved

MichelleArk added 2 commits October 3, 2023 16:25

fix artifact tests

86eebae

restore root_path, use packages_install_path in load_agate_table instead

60bbe0e

jtcohen6 reviewed Oct 4, 2023

View reviewed changes

MichelleArk self-assigned this Oct 5, 2023

add functional test: TestPortablePartialParsing

0494a17

MichelleArk changed the title ~~[Spike] respect project root when loading seeds~~ [Fix] respect project root when loading seeds Oct 6, 2023

MichelleArk force-pushed the spike/portable-partial-parsing-seeds branch from 5ad4646 to 8e46d49 Compare October 6, 2023 17:44

fallback to existing model.root_path behaviour for seed loading

d316e77

MichelleArk force-pushed the spike/portable-partial-parsing-seeds branch from 8e46d49 to d316e77 Compare October 6, 2023 17:45

MichelleArk added 2 commits October 6, 2023 13:45

changelog entry

55789a7

restructure portable partial parsing tests

bb92c04

MichelleArk force-pushed the spike/portable-partial-parsing-seeds branch 2 times, most recently from 5a8ba41 to 3b23a51 Compare October 9, 2023 19:40

try: fix permission issue w up_one

f778dec

MichelleArk force-pushed the spike/portable-partial-parsing-seeds branch from 3b23a51 to f778dec Compare October 9, 2023 22:10

MichelleArk marked this pull request as ready for review October 9, 2023 22:38

MichelleArk requested a review from a team as a code owner October 9, 2023 22:38

MichelleArk requested review from martynydbt and gshank and removed request for martynydbt October 9, 2023 22:38

gshank approved these changes Oct 10, 2023

View reviewed changes

MichelleArk merged commit 964e0e4 into main Oct 10, 2023
47 of 48 checks passed

MichelleArk deleted the spike/portable-partial-parsing-seeds branch October 10, 2023 15:17

MichelleArk added the backport 1.6.latest label Oct 10, 2023

MichelleArk added a commit that referenced this pull request Oct 10, 2023

[Fix] respect project root when loading seeds (#8762)

d27975e

(cherry picked from commit 964e0e4)

MichelleArk added a commit that referenced this pull request Oct 10, 2023

[Fix] respect project root when loading seeds (#8762)

78a8d8a

(cherry picked from commit 964e0e4)

MichelleArk added a commit that referenced this pull request Oct 10, 2023

[Fix] respect project root when loading seeds (#8762)

4915f43

(cherry picked from commit 964e0e4)

MichelleArk added a commit that referenced this pull request Oct 10, 2023

[Fix] respect project root when loading seeds (#8762)

a5a1c9c

(cherry picked from commit 964e0e4)

MichelleArk added a commit that referenced this pull request Oct 10, 2023

[Fix] respect project root when loading seeds (#8762)

da092a6

(cherry picked from commit 964e0e4)

MichelleArk added a commit that referenced this pull request Oct 10, 2023

[Fix] respect project root when loading seeds (#8762)

6e2cddd

(cherry picked from commit 964e0e4)

MichelleArk added a commit that referenced this pull request Oct 10, 2023

[Fix] respect project root when loading seeds (#8762)

b27c3cf

(cherry picked from commit 964e0e4)

MichelleArk added a commit that referenced this pull request Oct 10, 2023

[Fix] respect project root when loading seeds (#8762)

6a7dad5

(cherry picked from commit 964e0e4)

aranke pushed a commit that referenced this pull request Oct 11, 2023

[Backport 1.5.latest] respect project root when loading seeds (#8762) (…

3c8cf85

…#8805) (cherry picked from commit 964e0e4)

aranke added a commit that referenced this pull request Oct 11, 2023

[Backport 1.6.latest] respect project root when loading seeds (#8762) (…

de6b75b

…#8804) (cherry picked from commit 964e0e4) Co-authored-by: Kshitij Aranke <[email protected]>

aranke pushed a commit that referenced this pull request Oct 11, 2023

[Backport 1.0.0] respect project root when loading seeds (#8762) (#8816)

13dafdc

Fix] respect project root when loading seeds (#8762)

aranke pushed a commit that referenced this pull request Oct 11, 2023

[Backport 1.4.latest] respect project root when loading seeds (#8762) (…

e1cf586

…#8806)

aranke pushed a commit that referenced this pull request Oct 11, 2023

[Backport 1.1.latest] respect project root when loading seeds (#8762) (…

452d311

…#8815)

aranke pushed a commit that referenced this pull request Oct 11, 2023

[Backport 1.2.latest] respect project root when loading seeds (#8762) (…

0d80e3a

…#8814)

aranke pushed a commit that referenced this pull request Oct 11, 2023

[Backport 1.3.latest] respect project root when loading seeds (#8762) (…

5e657d3

…#8810)

tlento mentioned this pull request Nov 6, 2023

Update typing-extensions version to >=4.4 #9012

Merged

5 tasks

tlento mentioned this pull request Feb 26, 2024

Update dbt-semantic-interfaces dependency to compatible range #9671

Merged

pankajkoti mentioned this pull request May 10, 2024

Correct stale root_path in partial parse file astronomer/astronomer-cosmos#950

Merged

This was referenced May 20, 2024

[Backport 1.0.latest] Fix #9907: Add retry to tox to reduce flaky tests due to network failures #10178

Merged

[Backport 1.1.latest] Fix #9907: Add retry to tox to reduce flaky tests due to network failures #10179

Merged

aranke mentioned this pull request Jul 12, 2024

test env vars casing 1 6 latest #10437

Draft

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fix] respect project root when loading seeds #8762

[Fix] respect project root when loading seeds #8762

MichelleArk commented Oct 3, 2023 •

edited

Loading

github-actions bot commented Oct 3, 2023

codecov bot commented Oct 3, 2023 •

edited

Loading

jtcohen6 Oct 4, 2023

MichelleArk Oct 4, 2023

MichelleArk Oct 6, 2023

github-actions bot commented Oct 10, 2023

MichelleArk commented Oct 10, 2023 •

edited

Loading

[Fix] respect project root when loading seeds #8762

[Fix] respect project root when loading seeds #8762

Conversation

MichelleArk commented Oct 3, 2023 • edited Loading

Problem

Solution

Checklist

github-actions bot commented Oct 3, 2023

codecov bot commented Oct 3, 2023 • edited Loading

Codecov Report

jtcohen6 Oct 4, 2023

Choose a reason for hiding this comment

MichelleArk Oct 4, 2023

Choose a reason for hiding this comment

MichelleArk Oct 6, 2023

Choose a reason for hiding this comment

github-actions bot commented Oct 10, 2023

MichelleArk commented Oct 10, 2023 • edited Loading

MichelleArk commented Oct 3, 2023 •

edited

Loading

codecov bot commented Oct 3, 2023 •

edited

Loading

MichelleArk commented Oct 10, 2023 •

edited

Loading