-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
manifest.py
1907 lines (1677 loc) · 78.2 KB
/
manifest.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from copy import deepcopy
from dataclasses import dataclass
from dataclasses import field
import datetime
import os
import traceback
from typing import (
Dict,
Optional,
Mapping,
Callable,
Any,
List,
Type,
Union,
Tuple,
Set,
)
from itertools import chain
import time
from dbt.context.query_header import generate_query_header_context
from dbt.contracts.graph.semantic_manifest import SemanticManifest
from dbt_common.events.base_types import EventLevel
from dbt_common.exceptions.base import DbtValidationError
import dbt_common.utils
import json
import pprint
from dbt.mp_context import get_mp_context
import msgpack
import dbt.exceptions
import dbt.tracking
import dbt.utils
from dbt.flags import get_flags
from dbt.adapters.factory import (
get_adapter,
get_relation_class_by_name,
get_adapter_package_names,
register_adapter,
)
from dbt.constants import (
MANIFEST_FILE_NAME,
PARTIAL_PARSE_FILE_NAME,
SEMANTIC_MANIFEST_FILE_NAME,
SECRET_ENV_PREFIX,
)
from dbt_common.helper_types import PathSet
from dbt_common.events.functions import fire_event, get_invocation_id, warn_or_error
from dbt_common.events.types import (
Note,
)
from dbt.events.types import (
PartialParsingErrorProcessingFile,
PartialParsingError,
ParsePerfInfoPath,
PartialParsingSkipParsing,
UnableToPartialParse,
PartialParsingNotEnabled,
ParsedFileLoadFailed,
InvalidDisabledTargetInTestNode,
NodeNotFoundOrDisabled,
StateCheckVarsHash,
DeprecatedModel,
DeprecatedReference,
SpacesInModelNameDeprecation,
TotalModelNamesWithSpacesDeprecation,
UpcomingReferenceDeprecation,
)
from dbt.logger import DbtProcessState
from dbt.node_types import NodeType, AccessType
from dbt.clients.jinja import get_rendered, MacroStack
from dbt.clients.jinja_static import statically_extract_macro_calls
from dbt_common.clients.system import (
make_directory,
path_exists,
read_json,
write_file,
)
from dbt.config import Project, RuntimeConfig
from dbt.context.docs import generate_runtime_docs_context
from dbt.context.macro_resolver import MacroResolver, TestMacroNamespace
from dbt.context.configured import generate_macro_context
from dbt.context.providers import ParseProvider, generate_runtime_macro_context
from dbt.contracts.files import ParseFileType, SchemaSourceFile
from dbt.parser.read_files import (
ReadFilesFromFileSystem,
load_source_file,
FileDiff,
ReadFilesFromDiff,
ReadFiles,
)
from dbt.parser.partial import PartialParsing, special_override_macros
from dbt.contracts.graph.manifest import (
Manifest,
Disabled,
MacroManifest,
ManifestStateCheck,
ParsingInfo,
)
from dbt.contracts.graph.nodes import (
SourceDefinition,
Macro,
Exposure,
Metric,
SavedQuery,
SeedNode,
SemanticModel,
ManifestNode,
ResultNode,
ModelNode,
)
from dbt.artifacts.resources import NodeRelation, NodeVersion, FileHash
from dbt.artifacts.schemas.base import Writable
from dbt.exceptions import (
TargetNotFoundError,
AmbiguousAliasError,
InvalidAccessTypeError,
scrub_secrets,
)
from dbt.parser.base import Parser
from dbt.parser.analysis import AnalysisParser
from dbt.parser.generic_test import GenericTestParser
from dbt.parser.singular_test import SingularTestParser
from dbt.parser.docs import DocumentationParser
from dbt.parser.fixtures import FixtureParser
from dbt.parser.hooks import HookParser
from dbt.parser.macros import MacroParser
from dbt.parser.models import ModelParser
from dbt.parser.schemas import SchemaParser
from dbt.parser.search import FileBlock
from dbt.parser.seeds import SeedParser
from dbt.parser.snapshots import SnapshotParser
from dbt.parser.sources import SourcePatcher
from dbt.parser.unit_tests import process_models_for_unit_test
from dbt.version import __version__
from dbt_common.dataclass_schema import StrEnum, dbtClassMixin
from dbt import plugins
from dbt_semantic_interfaces.enum_extension import assert_values_exhausted
from dbt_semantic_interfaces.type_enums import MetricType
PARSING_STATE = DbtProcessState("parsing")
PERF_INFO_FILE_NAME = "perf_info.json"
def extended_mashumaro_encoder(data):
return msgpack.packb(data, default=extended_msgpack_encoder, use_bin_type=True)
def extended_msgpack_encoder(obj):
if type(obj) is datetime.date:
date_bytes = msgpack.ExtType(1, obj.isoformat().encode())
return date_bytes
elif type(obj) is datetime.datetime:
datetime_bytes = msgpack.ExtType(2, obj.isoformat().encode())
return datetime_bytes
return obj
def extended_mashumuro_decoder(data):
return msgpack.unpackb(data, ext_hook=extended_msgpack_decoder, raw=False)
def extended_msgpack_decoder(code, data):
if code == 1:
d = datetime.date.fromisoformat(data.decode())
return d
elif code == 2:
dt = datetime.datetime.fromisoformat(data.decode())
return dt
else:
return msgpack.ExtType(code, data)
def version_to_str(version: Optional[Union[str, int]]) -> str:
if isinstance(version, int):
return str(version)
elif isinstance(version, str):
return version
return ""
class ReparseReason(StrEnum):
version_mismatch = "01_version_mismatch"
file_not_found = "02_file_not_found"
vars_changed = "03_vars_changed"
profile_changed = "04_profile_changed"
deps_changed = "05_deps_changed"
project_config_changed = "06_project_config_changed"
load_file_failure = "07_load_file_failure"
exception = "08_exception"
proj_env_vars_changed = "09_project_env_vars_changed"
prof_env_vars_changed = "10_profile_env_vars_changed"
# Part of saved performance info
@dataclass
class ParserInfo(dbtClassMixin):
parser: str
elapsed: float
parsed_path_count: int = 0
# Part of saved performance info
@dataclass
class ProjectLoaderInfo(dbtClassMixin):
project_name: str
elapsed: float
parsers: List[ParserInfo] = field(default_factory=list)
parsed_path_count: int = 0
# Part of saved performance info
@dataclass
class ManifestLoaderInfo(dbtClassMixin, Writable):
path_count: int = 0
parsed_path_count: int = 0
static_analysis_path_count: int = 0
static_analysis_parsed_path_count: int = 0
is_partial_parse_enabled: Optional[bool] = None
is_static_analysis_enabled: Optional[bool] = None
read_files_elapsed: Optional[float] = None
load_macros_elapsed: Optional[float] = None
parse_project_elapsed: Optional[float] = None
patch_sources_elapsed: Optional[float] = None
process_manifest_elapsed: Optional[float] = None
load_all_elapsed: Optional[float] = None
projects: List[ProjectLoaderInfo] = field(default_factory=list)
_project_index: Dict[str, ProjectLoaderInfo] = field(default_factory=dict)
def __post_serialize__(self, dct):
del dct["_project_index"]
return dct
# The ManifestLoader loads the manifest. The standard way to use the
# ManifestLoader is using the 'get_full_manifest' class method, but
# many tests use abbreviated processes.
class ManifestLoader:
def __init__(
self,
root_project: RuntimeConfig,
all_projects: Mapping[str, Project],
macro_hook: Optional[Callable[[Manifest], Any]] = None,
file_diff: Optional[FileDiff] = None,
) -> None:
self.root_project: RuntimeConfig = root_project
self.all_projects: Mapping[str, Project] = all_projects
self.file_diff = file_diff
self.manifest: Manifest = Manifest()
self.new_manifest = self.manifest
self.manifest.metadata = root_project.get_metadata()
self.macro_resolver = None # built after macros are loaded
self.started_at = time.time()
# This is a MacroQueryStringSetter callable, which is called
# later after we set the MacroManifest in the adapter. It sets
# up the query headers.
self.macro_hook: Callable[[Manifest], Any]
if macro_hook is None:
self.macro_hook = lambda m: None
else:
self.macro_hook = macro_hook
self._perf_info = self.build_perf_info()
# State check determines whether the saved_manifest and the current
# manifest match well enough to do partial parsing
self.manifest.state_check = self.build_manifest_state_check()
# We need to know if we're actually partially parsing. It could
# have been enabled, but not happening because of some issue.
self.partially_parsing = False
self.partial_parser: Optional[PartialParsing] = None
self.skip_parsing = False
# This is a saved manifest from a previous run that's used for partial parsing
self.saved_manifest: Optional[Manifest] = self.read_manifest_for_partial_parse()
# This is the method that builds a complete manifest. We sometimes
# use an abbreviated process in tests.
@classmethod
def get_full_manifest(
cls,
config: RuntimeConfig,
*,
file_diff: Optional[FileDiff] = None,
reset: bool = False,
write_perf_info=False,
) -> Manifest:
adapter = get_adapter(config) # type: ignore
# reset is set in a TaskManager load_manifest call, since
# the config and adapter may be persistent.
if reset:
config.clear_dependencies()
adapter.clear_macro_resolver()
macro_hook = adapter.connections.set_query_header
flags = get_flags()
if not flags.PARTIAL_PARSE_FILE_DIFF:
file_diff = FileDiff.from_dict(
{
"deleted": [],
"changed": [],
"added": [],
}
)
# Hack to test file_diffs
elif os.environ.get("DBT_PP_FILE_DIFF_TEST"):
file_diff_path = "file_diff.json"
if path_exists(file_diff_path):
file_diff_dct = read_json(file_diff_path)
file_diff = FileDiff.from_dict(file_diff_dct)
with PARSING_STATE: # set up logbook.Processor for parsing
# Start performance counting
start_load_all = time.perf_counter()
projects = config.load_dependencies()
loader = cls(
config,
projects,
macro_hook=macro_hook,
file_diff=file_diff,
)
manifest = loader.load()
_check_manifest(manifest, config)
manifest.build_flat_graph()
# This needs to happen after loading from a partial parse,
# so that the adapter has the query headers from the macro_hook.
loader.save_macros_to_adapter(adapter)
# Save performance info
loader._perf_info.load_all_elapsed = time.perf_counter() - start_load_all
loader.track_project_load()
if write_perf_info:
loader.write_perf_info(config.project_target_path)
return manifest
# This is where the main action happens
def load(self) -> Manifest:
start_read_files = time.perf_counter()
# This updates the "files" dictionary in self.manifest, and creates
# the partial_parser_files dictionary (see read_files.py),
# which is a dictionary of projects to a dictionary
# of parsers to lists of file strings. The file strings are
# used to get the SourceFiles from the manifest files.
saved_files = self.saved_manifest.files if self.saved_manifest else {}
file_reader: Optional[ReadFiles] = None
if self.file_diff:
# We're getting files from a file diff
file_reader = ReadFilesFromDiff(
all_projects=self.all_projects,
files=self.manifest.files,
saved_files=saved_files,
root_project_name=self.root_project.project_name,
file_diff=self.file_diff,
)
else:
# We're getting files from the file system
file_reader = ReadFilesFromFileSystem(
all_projects=self.all_projects,
files=self.manifest.files,
saved_files=saved_files,
)
# Set the files in the manifest and save the project_parser_files
file_reader.read_files()
self.manifest.files = file_reader.files
project_parser_files = orig_project_parser_files = file_reader.project_parser_files
self._perf_info.path_count = len(self.manifest.files)
self._perf_info.read_files_elapsed = time.perf_counter() - start_read_files
self.skip_parsing = False
project_parser_files = self.safe_update_project_parser_files_partially(
project_parser_files
)
if self.manifest._parsing_info is None:
self.manifest._parsing_info = ParsingInfo()
if self.skip_parsing:
fire_event(PartialParsingSkipParsing())
else:
# Load Macros and tests
# We need to parse the macros first, so they're resolvable when
# the other files are loaded. Also need to parse tests, specifically
# generic tests
start_load_macros = time.perf_counter()
self.load_and_parse_macros(project_parser_files)
# If we're partially parsing check that certain macros have not been changed
if self.partially_parsing and self.skip_partial_parsing_because_of_macros():
fire_event(
UnableToPartialParse(
reason="change detected to override macro. Starting full parse."
)
)
# Get new Manifest with original file records and move over the macros
self.manifest = self.new_manifest # contains newly read files
project_parser_files = orig_project_parser_files
self.partially_parsing = False
self.load_and_parse_macros(project_parser_files)
self._perf_info.load_macros_elapsed = time.perf_counter() - start_load_macros
# Now that the macros are parsed, parse the rest of the files.
# This is currently done on a per project basis.
start_parse_projects = time.perf_counter()
# Load the rest of the files except for schema yaml files
parser_types: List[Type[Parser]] = [
ModelParser,
SnapshotParser,
AnalysisParser,
SingularTestParser,
SeedParser,
DocumentationParser,
HookParser,
FixtureParser,
]
for project in self.all_projects.values():
if project.project_name not in project_parser_files:
continue
self.parse_project(
project, project_parser_files[project.project_name], parser_types
)
# Now that we've loaded most of the nodes (except for schema tests, sources, metrics)
# load up the Lookup objects to resolve them by name, so the SourceFiles store
# the unique_id instead of the name. Sources are loaded from yaml files, so
# aren't in place yet
self.manifest.rebuild_ref_lookup()
self.manifest.rebuild_doc_lookup()
self.manifest.rebuild_disabled_lookup()
# Load yaml files
parser_types = [SchemaParser] # type: ignore
for project in self.all_projects.values():
if project.project_name not in project_parser_files:
continue
self.parse_project(
project, project_parser_files[project.project_name], parser_types
)
self.cleanup_disabled()
self._perf_info.parse_project_elapsed = time.perf_counter() - start_parse_projects
# patch_sources converts the UnparsedSourceDefinitions in the
# Manifest.sources to SourceDefinition via 'patch_source'
# in SourcePatcher
start_patch = time.perf_counter()
patcher = SourcePatcher(self.root_project, self.manifest)
patcher.construct_sources()
self.manifest.sources = patcher.sources
self._perf_info.patch_sources_elapsed = time.perf_counter() - start_patch
# We need to rebuild disabled in order to include disabled sources
self.manifest.rebuild_disabled_lookup()
# copy the selectors from the root_project to the manifest
self.manifest.selectors = self.root_project.manifest_selectors
# inject any available external nodes
self.manifest.build_parent_and_child_maps()
external_nodes_modified = self.inject_external_nodes()
if external_nodes_modified:
self.manifest.rebuild_ref_lookup()
# update the refs, sources, docs and metrics depends_on.nodes
# These check the created_at time on the nodes to
# determine whether they need processing.
start_process = time.perf_counter()
self.process_sources(self.root_project.project_name)
self.process_refs(self.root_project.project_name, self.root_project.dependencies)
self.process_unit_tests(self.root_project.project_name)
self.process_docs(self.root_project)
self.process_metrics(self.root_project)
self.process_saved_queries(self.root_project)
self.check_valid_group_config()
self.check_valid_access_property()
semantic_manifest = SemanticManifest(self.manifest)
if not semantic_manifest.validate():
raise dbt.exceptions.ParsingError("Semantic Manifest validation failed.")
# update tracking data
self._perf_info.process_manifest_elapsed = time.perf_counter() - start_process
self._perf_info.static_analysis_parsed_path_count = (
self.manifest._parsing_info.static_analysis_parsed_path_count
)
self._perf_info.static_analysis_path_count = (
self.manifest._parsing_info.static_analysis_path_count
)
# Inject any available external nodes, reprocess refs if changes to the manifest were made.
external_nodes_modified = False
if self.skip_parsing:
# If we didn't skip parsing, this will have already run because it must run
# before process_refs. If we did skip parsing, then it's possible that only
# external nodes have changed and we need to run this to capture that.
self.manifest.build_parent_and_child_maps()
external_nodes_modified = self.inject_external_nodes()
if external_nodes_modified:
self.manifest.rebuild_ref_lookup()
self.process_refs(
self.root_project.project_name,
self.root_project.dependencies,
)
# parent and child maps will be rebuilt by write_manifest
if not self.skip_parsing or external_nodes_modified:
# write out the fully parsed manifest
self.write_manifest_for_partial_parse()
self.check_for_model_deprecations()
self.check_for_spaces_in_model_names()
return self.manifest
def safe_update_project_parser_files_partially(self, project_parser_files: Dict) -> Dict:
if self.saved_manifest is None:
return project_parser_files
self.partial_parser = PartialParsing(self.saved_manifest, self.manifest.files) # type: ignore[arg-type]
self.skip_parsing = self.partial_parser.skip_parsing()
if self.skip_parsing:
# nothing changed, so we don't need to generate project_parser_files
self.manifest = self.saved_manifest # type: ignore[assignment]
else:
# create child_map and parent_map
self.saved_manifest.build_parent_and_child_maps() # type: ignore[union-attr]
# create group_map
self.saved_manifest.build_group_map() # type: ignore[union-attr]
# files are different, we need to create a new set of
# project_parser_files.
try:
project_parser_files = self.partial_parser.get_parsing_files()
self.partially_parsing = True
self.manifest = self.saved_manifest # type: ignore[assignment]
except Exception as exc:
# pp_files should still be the full set and manifest is new manifest,
# since get_parsing_files failed
fire_event(
UnableToPartialParse(reason="an error occurred. Switching to full reparse.")
)
# Get traceback info
tb_info = traceback.format_exc()
# index last stack frame in traceback (i.e. lastest exception and its context)
tb_last_frame = traceback.extract_tb(exc.__traceback__)[-1]
exc_info = {
"traceback": tb_info,
"exception": tb_info.splitlines()[-1],
"code": tb_last_frame.line, # if the source is not available, it is None
"location": f"line {tb_last_frame.lineno} in {tb_last_frame.name}",
}
# get file info for local logs
parse_file_type: str = ""
file_id = self.partial_parser.processing_file
if file_id:
source_file = None
if file_id in self.saved_manifest.files:
source_file = self.saved_manifest.files[file_id]
elif file_id in self.manifest.files:
source_file = self.manifest.files[file_id]
if source_file:
parse_file_type = source_file.parse_file_type
fire_event(PartialParsingErrorProcessingFile(file=file_id))
exc_info["parse_file_type"] = parse_file_type
fire_event(PartialParsingError(exc_info=exc_info))
# Send event
if dbt.tracking.active_user is not None:
exc_info["full_reparse_reason"] = ReparseReason.exception
dbt.tracking.track_partial_parser(exc_info)
if os.environ.get("DBT_PP_TEST"):
raise exc
return project_parser_files
def check_for_model_deprecations(self):
for node in self.manifest.nodes.values():
if isinstance(node, ModelNode):
if (
node.deprecation_date
and node.deprecation_date < datetime.datetime.now().astimezone()
):
warn_or_error(
DeprecatedModel(
model_name=node.name,
model_version=version_to_str(node.version),
deprecation_date=node.deprecation_date.isoformat(),
)
)
resolved_refs = self.manifest.resolve_refs(node, self.root_project.project_name)
resolved_model_refs = [r for r in resolved_refs if isinstance(r, ModelNode)]
node.depends_on
for resolved_ref in resolved_model_refs:
if resolved_ref.deprecation_date:
if resolved_ref.deprecation_date < datetime.datetime.now().astimezone():
event_cls = DeprecatedReference
else:
event_cls = UpcomingReferenceDeprecation
warn_or_error(
event_cls(
model_name=node.name,
ref_model_package=resolved_ref.package_name,
ref_model_name=resolved_ref.name,
ref_model_version=version_to_str(resolved_ref.version),
ref_model_latest_version=str(resolved_ref.latest_version),
ref_model_deprecation_date=resolved_ref.deprecation_date.isoformat(),
)
)
def check_for_spaces_in_model_names(self):
"""Validates that model names do not contain spaces
If `DEBUG` flag is `False`, logs only first bad model name
If `DEBUG` flag is `True`, logs every bad model name
If `ALLOW_SPACES_IN_MODEL_NAMES` is `False`, logs are `ERROR` level and an exception is raised if any names are bad
If `ALLOW_SPACES_IN_MODEL_NAMES` is `True`, logs are `WARN` level
"""
improper_model_names = 0
level = (
EventLevel.WARN
if self.root_project.args.ALLOW_SPACES_IN_MODEL_NAMES
else EventLevel.ERROR
)
for node in self.manifest.nodes.values():
if isinstance(node, ModelNode) and " " in node.name:
if improper_model_names == 0 or self.root_project.args.DEBUG:
fire_event(
SpacesInModelNameDeprecation(
model_name=node.name,
model_version=version_to_str(node.version),
level=level.value,
),
level=level,
)
improper_model_names += 1
if improper_model_names > 0:
fire_event(
TotalModelNamesWithSpacesDeprecation(
count_invalid_names=improper_model_names,
show_debug_hint=(not self.root_project.args.DEBUG),
level=level.value,
),
level=level,
)
if level == EventLevel.ERROR:
raise DbtValidationError("Model names cannot contain spaces")
def load_and_parse_macros(self, project_parser_files):
for project in self.all_projects.values():
if project.project_name not in project_parser_files:
continue
parser_files = project_parser_files[project.project_name]
if "MacroParser" in parser_files:
parser = MacroParser(project, self.manifest)
for file_id in parser_files["MacroParser"]:
block = FileBlock(self.manifest.files[file_id])
parser.parse_file(block)
# increment parsed path count for performance tracking
self._perf_info.parsed_path_count += 1
# generic tests hisotrically lived in the macros directoy but can now be nested
# in a /generic directory under /tests so we want to process them here as well
if "GenericTestParser" in parser_files:
parser = GenericTestParser(project, self.manifest)
for file_id in parser_files["GenericTestParser"]:
block = FileBlock(self.manifest.files[file_id])
parser.parse_file(block)
# increment parsed path count for performance tracking
self._perf_info.parsed_path_count += 1
self.build_macro_resolver()
# Look at changed macros and update the macro.depends_on.macros
self.macro_depends_on()
# Parse the files in the 'parser_files' dictionary, for parsers listed in
# 'parser_types'
def parse_project(
self,
project: Project,
parser_files,
parser_types: List[Type[Parser]],
) -> None:
project_loader_info = self._perf_info._project_index[project.project_name]
start_timer = time.perf_counter()
total_parsed_path_count = 0
# Loop through parsers with loaded files.
for parser_cls in parser_types:
parser_name = parser_cls.__name__
# No point in creating a parser if we don't have files for it
if parser_name not in parser_files or not parser_files[parser_name]:
continue
# Initialize timing info
project_parsed_path_count = 0
parser_start_timer = time.perf_counter()
# Parse the project files for this parser
parser: Parser = parser_cls(project, self.manifest, self.root_project)
for file_id in parser_files[parser_name]:
block = FileBlock(self.manifest.files[file_id])
if isinstance(parser, SchemaParser):
assert isinstance(block.file, SchemaSourceFile)
if self.partially_parsing:
dct = block.file.pp_dict
else:
dct = block.file.dict_from_yaml
# this is where the schema file gets parsed
parser.parse_file(block, dct=dct)
# Came out of here with UnpatchedSourceDefinition containing configs at the source level
# and not configs at the table level (as expected)
else:
parser.parse_file(block)
project_parsed_path_count += 1
# Save timing info
project_loader_info.parsers.append(
ParserInfo(
parser=parser.resource_type,
parsed_path_count=project_parsed_path_count,
elapsed=time.perf_counter() - parser_start_timer,
)
)
total_parsed_path_count += project_parsed_path_count
# HookParser doesn't run from loaded files, just dbt_project.yml,
# so do separately
# This shouldn't need to be parsed again if we're starting from
# a saved manifest, because that won't be allowed if dbt_project.yml
# changed, but leave for now.
if not self.partially_parsing and HookParser in parser_types:
hook_parser = HookParser(project, self.manifest, self.root_project)
path = hook_parser.get_path()
file = load_source_file(path, ParseFileType.Hook, project.project_name, {})
if file:
file_block = FileBlock(file)
hook_parser.parse_file(file_block)
# Store the performance info
elapsed = time.perf_counter() - start_timer
project_loader_info.parsed_path_count = (
project_loader_info.parsed_path_count + total_parsed_path_count
)
project_loader_info.elapsed += elapsed
self._perf_info.parsed_path_count = (
self._perf_info.parsed_path_count + total_parsed_path_count
)
# This should only be called after the macros have been loaded
def build_macro_resolver(self):
internal_package_names = get_adapter_package_names(self.root_project.credentials.type)
self.macro_resolver = MacroResolver(
self.manifest.macros, self.root_project.project_name, internal_package_names
)
# Loop through macros in the manifest and statically parse
# the 'macro_sql' to find depends_on.macros
def macro_depends_on(self):
macro_ctx = generate_macro_context(self.root_project)
macro_namespace = TestMacroNamespace(self.macro_resolver, {}, None, MacroStack(), [])
adapter = get_adapter(self.root_project)
db_wrapper = ParseProvider().DatabaseWrapper(adapter, macro_namespace)
for macro in self.manifest.macros.values():
if macro.created_at < self.started_at:
continue
possible_macro_calls = statically_extract_macro_calls(
macro.macro_sql, macro_ctx, db_wrapper
)
for macro_name in possible_macro_calls:
# adapter.dispatch calls can generate a call with the same name as the macro
# it ought to be an adapter prefix (postgres_) or default_
if macro_name == macro.name:
continue
package_name = macro.package_name
if "." in macro_name:
package_name, macro_name = macro_name.split(".")
dep_macro_id = self.macro_resolver.get_macro_id(package_name, macro_name)
if dep_macro_id:
macro.depends_on.add_macro(dep_macro_id) # will check for dupes
def write_manifest_for_partial_parse(self):
path = os.path.join(self.root_project.project_target_path, PARTIAL_PARSE_FILE_NAME)
try:
# This shouldn't be necessary, but we have gotten bug reports (#3757) of the
# saved manifest not matching the code version.
if self.manifest.metadata.dbt_version != __version__:
fire_event(
UnableToPartialParse(reason="saved manifest contained the wrong version")
)
self.manifest.metadata.dbt_version = __version__
manifest_msgpack = self.manifest.to_msgpack(extended_mashumaro_encoder)
make_directory(os.path.dirname(path))
with open(path, "wb") as fp:
fp.write(manifest_msgpack)
except Exception:
raise
def inject_external_nodes(self) -> bool:
# Remove previously existing external nodes since we are regenerating them
manifest_nodes_modified = False
# Remove all dependent nodes before removing referencing nodes
for unique_id in self.manifest.external_node_unique_ids:
remove_dependent_project_references(self.manifest, unique_id)
manifest_nodes_modified = True
for unique_id in self.manifest.external_node_unique_ids:
# remove external nodes from manifest only after dependent project references safely removed
self.manifest.nodes.pop(unique_id)
# Inject any newly-available external nodes
pm = plugins.get_plugin_manager(self.root_project.project_name)
plugin_model_nodes = pm.get_nodes().models
for node_arg in plugin_model_nodes.values():
node = ModelNode.from_args(node_arg)
# node may already exist from package or running project - in which case we should avoid clobbering it with an external node
if node.unique_id not in self.manifest.nodes:
self.manifest.add_node_nofile(node)
manifest_nodes_modified = True
return manifest_nodes_modified
def is_partial_parsable(self, manifest: Manifest) -> Tuple[bool, Optional[str]]:
"""Compare the global hashes of the read-in parse results' values to
the known ones, and return if it is ok to re-use the results.
"""
valid = True
reparse_reason = None
if manifest.metadata.dbt_version != __version__:
# #3757 log both versions because of reports of invalid cases of mismatch.
fire_event(UnableToPartialParse(reason="of a version mismatch"))
# If the version is wrong, the other checks might not work
return False, ReparseReason.version_mismatch
if self.manifest.state_check.vars_hash != manifest.state_check.vars_hash:
fire_event(
UnableToPartialParse(
reason="config vars, config profile, or config target have changed"
)
)
fire_event(
Note(
msg=f"previous checksum: {self.manifest.state_check.vars_hash.checksum}, current checksum: {manifest.state_check.vars_hash.checksum}"
),
level=EventLevel.DEBUG,
)
valid = False
reparse_reason = ReparseReason.vars_changed
if self.manifest.state_check.profile_hash != manifest.state_check.profile_hash:
# Note: This should be made more granular. We shouldn't need to invalidate
# partial parsing if a non-used profile section has changed.
fire_event(UnableToPartialParse(reason="profile has changed"))
valid = False
reparse_reason = ReparseReason.profile_changed
if (
self.manifest.state_check.project_env_vars_hash
!= manifest.state_check.project_env_vars_hash
):
fire_event(
UnableToPartialParse(reason="env vars used in dbt_project.yml have changed")
)
valid = False
reparse_reason = ReparseReason.proj_env_vars_changed
missing_keys = {
k
for k in self.manifest.state_check.project_hashes
if k not in manifest.state_check.project_hashes
}
if missing_keys:
fire_event(UnableToPartialParse(reason="a project dependency has been added"))
valid = False
reparse_reason = ReparseReason.deps_changed
for key, new_value in self.manifest.state_check.project_hashes.items():
if key in manifest.state_check.project_hashes:
old_value = manifest.state_check.project_hashes[key]
if new_value != old_value:
fire_event(UnableToPartialParse(reason="a project config has changed"))
valid = False
reparse_reason = ReparseReason.project_config_changed
return valid, reparse_reason
def skip_partial_parsing_because_of_macros(self):
if not self.partial_parser:
return False
if self.partial_parser.deleted_special_override_macro:
return True
# Check for custom versions of these special macros
for macro_name in special_override_macros:
macro = self.macro_resolver.get_macro(None, macro_name)
if macro and macro.package_name != "dbt":
if (
macro.file_id in self.partial_parser.file_diff["changed"]
or macro.file_id in self.partial_parser.file_diff["added"]
):
# The file with the macro in it has changed
return True
return False
def read_manifest_for_partial_parse(self) -> Optional[Manifest]:
flags = get_flags()
if not flags.PARTIAL_PARSE:
fire_event(PartialParsingNotEnabled())
return None
path = flags.PARTIAL_PARSE_FILE_PATH or os.path.join(
self.root_project.project_target_path, PARTIAL_PARSE_FILE_NAME
)
reparse_reason = None
if os.path.exists(path):
try:
with open(path, "rb") as fp:
manifest_mp = fp.read()
manifest: Manifest = Manifest.from_msgpack(manifest_mp, decoder=extended_mashumuro_decoder) # type: ignore
# keep this check inside the try/except in case something about
# the file has changed in weird ways, perhaps due to being a
# different version of dbt
is_partial_parsable, reparse_reason = self.is_partial_parsable(manifest)
if is_partial_parsable:
# We don't want to have stale generated_at dates
manifest.metadata.generated_at = datetime.datetime.utcnow()
# or invocation_ids
manifest.metadata.invocation_id = get_invocation_id()
return manifest
except Exception as exc:
fire_event(
ParsedFileLoadFailed(path=path, exc=str(exc), exc_info=traceback.format_exc())
)
reparse_reason = ReparseReason.load_file_failure
else:
fire_event(
UnableToPartialParse(reason="saved manifest not found. Starting full parse.")
)
reparse_reason = ReparseReason.file_not_found
# this event is only fired if a full reparse is needed
if dbt.tracking.active_user is not None: # no active_user if doing load_macros
dbt.tracking.track_partial_parser({"full_reparse_reason": reparse_reason})
return None
def build_perf_info(self):
flags = get_flags()
mli = ManifestLoaderInfo(
is_partial_parse_enabled=flags.PARTIAL_PARSE,
is_static_analysis_enabled=flags.STATIC_PARSER,
)
for project in self.all_projects.values():
project_info = ProjectLoaderInfo(
project_name=project.project_name,
elapsed=0,
)
mli.projects.append(project_info)
mli._project_index[project.project_name] = project_info
return mli
# TODO: handle --vars in the same way we handle env_var
# https://github.com/dbt-labs/dbt-core/issues/6323
def build_manifest_state_check(self):
config = self.root_project
all_projects = self.all_projects
# if any of these change, we need to reject the parser
# Create a FileHash of vars string, profile name and target name
# This does not capture vars in dbt_project, just the command line
# arg vars, but since any changes to that file will cause state_check
# to not pass, it doesn't matter. If we move to more granular checking
# of env_vars, that would need to change.
# We are using the parsed cli_vars instead of config.args.vars, in order
# to sort them and avoid reparsing because of ordering issues.
secret_vars = [
v for k, v in config.cli_vars.items() if k.startswith(SECRET_ENV_PREFIX) and v.strip()
]
stringified_cli_vars = pprint.pformat(config.cli_vars)
vars_hash = FileHash.from_contents(
"\x00".join(
[