Skip to content
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

Microbatch first last batch serial #11072

Merged
merged 21 commits into from
Dec 7, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
0d61609
microbatch: split out first and last batch to run in serial
MichelleArk Nov 28, 2024
bec5d57
use Task.get_runner
MichelleArk Nov 28, 2024
32002ea
only run pre_hook on first batch, post_hook on last batch
MichelleArk Nov 28, 2024
37dbd11
refactor: internalize parallel to RunTask._submit_batch
MichelleArk Nov 28, 2024
23271b9
Add optional `force_sequential` to `_submit_batch` to allow for skipp…
QMalcolm Dec 4, 2024
9c903f7
Force last batch to run sequentially
QMalcolm Dec 4, 2024
e624057
Force first batch to run sequentially
QMalcolm Dec 4, 2024
0c2e327
Fixup
QMalcolm Dec 4, 2024
a37f3a6
Remove batch_idx check in `should_run_in_parallel`
QMalcolm Dec 4, 2024
cfe1dcf
Begin skipping batches if first batch fails
QMalcolm Dec 6, 2024
8424209
Write custom `on_skip` for `MicrobatchModelRunner` to better handle w…
QMalcolm Dec 6, 2024
50abb45
Add microbatch pre-hook, post-hook, and sequential first/last batch t…
QMalcolm Dec 6, 2024
9bc3816
Fix/Add tests around first batch failure vs latter batch failure
QMalcolm Dec 6, 2024
7699f52
Fix MicrobatchModelRunner.on_skip to handle skipping the entire node
QMalcolm Dec 6, 2024
74a76c4
Fix conditional logic for setting pre and post hooks for batches
QMalcolm Dec 6, 2024
0c16d07
Revert back to using the MicrobatchModelRunner initializer directly
QMalcolm Dec 6, 2024
3fa7bbc
Add two new event types `LogStartBatch` and `LogBatchResult`
QMalcolm Dec 7, 2024
f4315ef
Update MicrobatchModelRunner to use new batch specific log events
QMalcolm Dec 7, 2024
bec65b8
Fix event testing
QMalcolm Dec 7, 2024
c0743e0
Update microbatch integrationt tests to catch batch specific event types
QMalcolm Dec 7, 2024
0198741
Add changie doc
QMalcolm Dec 7, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 61 additions & 34 deletions core/dbt/task/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -602,15 +602,15 @@
)
return relation is not None

def _should_run_in_parallel(
self,
relation_exists: bool,
) -> bool:
def should_run_in_parallel(self) -> bool:
if not self.adapter.supports(Capability.MicrobatchConcurrency):
run_in_parallel = False
elif not relation_exists:
elif not self.relation_exists:
# If the relation doesn't exist, we can't run in parallel
run_in_parallel = False
elif self.batch_idx == 0 or self.batch_idx == len(self.batches) - 1:
# First and last batch don't run in parallel
run_in_parallel = False

Check warning on line 613 in core/dbt/task/run.py

View check run for this annotation

Codecov / codecov/patch

core/dbt/task/run.py#L613

Added line #L613 was not covered by tests
Copy link
Contributor

Choose a reason for hiding this comment

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

This check could also be skipped if we're instead handling force_sequential to determine if we should even check should_run_in_parallel in _submit_batch. It'd be nice for this function to be less dependent on "where" it is, and I think this check breaks that.

elif self.node.config.concurrent_batches is not None:
# If the relation exists and the `concurrent_batches` config isn't None, use the config value
run_in_parallel = self.node.config.concurrent_batches
Expand Down Expand Up @@ -703,52 +703,79 @@
runner: MicrobatchModelRunner,
pool: ThreadPool,
) -> RunResult:
# Initial run computes batch metadata, unless model is skipped
# Initial run computes batch metadata
result = self.call_runner(runner)
batches, node, relation_exists = runner.batches, runner.node, runner.relation_exists

# Return early if model should be skipped, or there are no batches to execute
if result.status == RunStatus.Skipped:
return result
elif len(runner.batches) == 0:
return result

Check warning on line 714 in core/dbt/task/run.py

View check run for this annotation

Codecov / codecov/patch

core/dbt/task/run.py#L714

Added line #L714 was not covered by tests

batch_results: List[RunResult] = []

# Execute batches serially until a relation exists, at which point future batches are run in parallel
relation_exists = runner.relation_exists
batch_idx = 0
while batch_idx < len(runner.batches):
batch_runner = MicrobatchModelRunner(
self.config, runner.adapter, deepcopy(runner.node), self.run_count, self.num_nodes
# Run all batches except last batch, in parallel if possible
while batch_idx < len(runner.batches) - 1:
relation_exists = self._submit_batch(
node, relation_exists, batches, batch_idx, batch_results, pool
Copy link
Contributor

Choose a reason for hiding this comment

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

Another reason for splitting out the first batch:
We don't want to do any of the other batches if the first batch fails. By lumping it in the while loop which all other batches (except for the last batch), we lose that. We could add that logic to the loop, however I think that'd crowd the loop logic as it will only ever be logic needed for the first batch result.

)
batch_runner.set_batch_idx(batch_idx)
batch_runner.set_relation_exists(relation_exists)
batch_runner.set_batches(runner.batches)

if runner._should_run_in_parallel(relation_exists):
fire_event(
MicrobatchExecutionDebug(
msg=f"{batch_runner.describe_batch} is being run concurrently"
)
)
self._submit(pool, [batch_runner], batch_results.append)
else:
fire_event(
MicrobatchExecutionDebug(
msg=f"{batch_runner.describe_batch} is being run sequentially"
)
)
batch_results.append(self.call_runner(batch_runner))
relation_exists = batch_runner.relation_exists

batch_idx += 1

# Wait until all batches have completed
while len(batch_results) != len(runner.batches):
# Wait until all submitted batches have completed
while len(batch_results) != batch_idx:
pass
# Final batch runs once all others complete to ensure post_hook runs at the end
self._submit_batch(node, relation_exists, batches, batch_idx, batch_results, pool)

# Finalize run: merge results, track model run, and print final result line
runner.merge_batch_results(result, batch_results)
track_model_run(runner.node_index, runner.num_nodes, result, adapter=runner.adapter)
runner.print_result_line(result)

return result

def _submit_batch(
self,
node: ModelNode,
relation_exists: bool,
batches: Dict[int, BatchType],
batch_idx: int,
batch_results: List[RunResult],
pool: ThreadPool,
):
node_copy = deepcopy(node)
# Only run pre_hook(s) for first batch
if batch_idx != 0:
node_copy.config.pre_hook = []
# Only run post_hook(s) for last batch
elif batch_idx != len(batches) - 1:
node_copy.config.post_hook = []

batch_runner = self.get_runner(node_copy)
assert isinstance(batch_runner, MicrobatchModelRunner)
batch_runner.set_batch_idx(batch_idx)
batch_runner.set_relation_exists(relation_exists)
batch_runner.set_batches(batches)

if batch_runner.should_run_in_parallel():
fire_event(
MicrobatchExecutionDebug(
msg=f"{batch_runner.describe_batch} is being run concurrently"
)
)
self._submit(pool, [batch_runner], batch_results.append)
else:
fire_event(
MicrobatchExecutionDebug(
msg=f"{batch_runner.describe_batch} is being run sequentially"
)
)
batch_results.append(self.call_runner(batch_runner))
relation_exists = batch_runner.relation_exists

return relation_exists

def _hook_keyfunc(self, hook: HookNode) -> Tuple[str, Optional[int]]:
package_name = hook.package_name
if package_name == self.config.project_name:
Expand Down
2 changes: 1 addition & 1 deletion tests/functional/microbatch/test_microbatch.py
Original file line number Diff line number Diff line change
Expand Up @@ -875,7 +875,7 @@ def batch_exc_catcher(self) -> EventCatcher:
def test_microbatch(
self, mocker: MockerFixture, project, batch_exc_catcher: EventCatcher
) -> None:
mocked_srip = mocker.patch("dbt.task.run.MicrobatchModelRunner._should_run_in_parallel")
mocked_srip = mocker.patch("dbt.task.run.MicrobatchModelRunner.should_run_in_parallel")

# Should be run in parallel
mocked_srip.return_value = True
Expand Down
8 changes: 5 additions & 3 deletions tests/unit/task/test_run.py
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ class Relation:
(False, False, False, True, False),
],
)
def test__should_run_in_parallel(
def test_should_run_in_parallel(
self,
mocker: MockerFixture,
model_runner: MicrobatchModelRunner,
Expand All @@ -276,11 +276,13 @@ def test__should_run_in_parallel(
) -> None:
model_runner.node._has_this = has_this
model_runner.node.config = ModelConfig(concurrent_batches=concurrent_batches)
model_runner.set_relation_exists(has_relation)

mocked_supports = mocker.patch.object(model_runner.adapter, "supports")
mocked_supports.return_value = adapter_microbatch_concurrency

# Assert result of _should_run_in_parallel
assert model_runner._should_run_in_parallel(has_relation) == expectation
# Assert result of should_run_in_parallel
assert model_runner.should_run_in_parallel() == expectation


class TestRunTask:
Expand Down
Loading