Independent Dynamic Scaling for different Activities in Temporal WorkFlow #4159

agam-99 · 2025-12-15T18:14:32Z

Dear Gobblin maintainers,

Please accept this PR. I understand that it will not be reviewed until I have checked off all the steps below!

JIRA

My PR addresses the following Gobblin JIRA issues and references them in the PR title. For example, "[GOBBLIN-XXX] My Gobblin PR"
- https://issues.apache.org/jira/browse/GOBBLIN-XXX

Description

This PR introduces a separate memory configuration and dedicated task queue for the work execution phase in Temporal workflows to support better scalability and resource utilization.

Key Changes:

Created dedicated execution task queue (EXECUTION_TASK_QUEUE) to isolate work execution activities from work discovery and commit phases
Added ExecutionWorker to handle execution-stage activities independently
Introduced WorkflowStage enum for stage-specific task queue routing
When dynamic scaling is enabled, NestingExecWorkflow (work execution) routes to the execution queue while other stages use the default queue

Configuration:

GobblinTemporalConfigurationKeys.EXECUTION_TASK_QUEUE - Execution task queue name (default: "GobblinTemporalExecutionTaskQueue")
GobblinTemporalConfigurationKeys.EXECUTION_WORKER_MEMORY_MBS - Memory allocation for execution workers

Benefits:

Independent scaling for work execution vs. discovery/commit phases
More efficient compute utilization

Tests

My PR adds relevant unit tests for the changes made.
All tests use reflection and mocking to test actual method behavior without requiring full Temporal infrastructure.

Commits

My commits all reference JIRA issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "How to write a good git commit message":
1. Subject is separated from body by a blank line
2. Subject is limited to 50 characters
3. Subject does not end with a period
4. Subject uses the imperative mood ("add", not "adding")
5. Body wraps at 72 characters
6. Body explains "what" and "why", not "how"

- unit tests

codecov-commenter · 2025-12-16T06:45:23Z

Codecov Report

❌ Patch coverage is 59.21053% with 31 lines in your changes missing coverage. Please review.
✅ Project coverage is 48.12%. Comparing base (8ba6c1f) to head (04b2b6c).
⚠️ Report is 9 commits behind head on master.

Files with missing lines	Patch %	Lines
...in/temporal/cluster/GobblinTemporalTaskRunner.java	31.57%	12 Missing and 1 partial ⚠️
...he/gobblin/temporal/ddm/activity/ActivityType.java	0.00%	7 Missing ⚠️
...e/gobblin/temporal/ddm/worker/ExecutionWorker.java	69.23%	4 Missing ⚠️
...e/gobblin/temporal/ddm/workflow/WorkflowStage.java	78.57%	3 Missing ⚠️
...bblin/temporal/cluster/AbstractTemporalWorker.java	0.00%	2 Missing ⚠️
...impl/AbstractRecommendScalingForWorkUnitsImpl.java	88.88%	0 Missing and 1 partial ⚠️
...dm/workflow/impl/ProcessWorkUnitsWorkflowImpl.java	90.90%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #4159      +/-   ##
============================================
- Coverage     48.96%   48.12%   -0.84%     
+ Complexity    10148     8651    -1497     
============================================
  Files          1912     1607     -305     
  Lines         74708    64530   -10178     
  Branches       8289     7287    -1002     
============================================
- Hits          36580    31058    -5522     
+ Misses        34852    30683    -4169     
+ Partials       3276     2789     -487

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot

Pull request overview

This PR introduces independent dynamic scaling for different workflow stages in Gobblin's Temporal integration by enabling separate memory configuration and dedicated task queues for work execution activities.

Key Changes:

Created dedicated execution task queue and ExecutionWorker class to isolate work execution from discovery/commit phases
Added WorkflowStage enum for stage-specific task queue routing with configurable memory allocation
Modified ProcessWorkUnitsWorkflowImpl to route NestingExecWorkflow to execution queue when dynamic scaling is enabled

Reviewed changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
`GobblinTemporalConfigurationKeys.java`	Added execution worker class constant, execution task queue configuration keys, and stage-specific memory configuration
`ExecutionWorker.java`	New specialized worker for work execution stage with dedicated task queue and concurrency settings
`WorkflowStage.java`	New enum defining workflow stages (WORK_DISCOVERY, WORK_EXECUTION, COMMIT) with stage-specific task queue routing
`AbstractRecommendScalingForWorkUnitsImpl.java`	Enhanced to create profile overlays with ExecutionWorker class and optional memory configuration for scaled containers
`ProcessWorkUnitsWorkflowImpl.java`	Modified to route child workflows to appropriate task queues based on dynamic scaling configuration
`GobblinTemporalTaskRunner.java`	Added initialization logic to start ExecutionWorker in initial container when dynamic scaling is enabled
`AbstractTemporalWorker.java`	Refactored to make config field protected and extracted getTaskQueue() method for subclass customization
`ActivityType.java`	Added overloaded buildActivityOptions() method accepting taskQueue parameter
Test files	Comprehensive unit tests for workflow routing, worker configuration, and scaling behavior
`application.conf`	Minor whitespace cleanup

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-16T11:08:53Z

.../org/apache/gobblin/temporal/ddm/activity/impl/AbstractRecommendScalingForWorkUnitsImpl.java

+        GobblinTemporalConfigurationKeys.EXECUTION_WORKER_CLASS
+    ));
+
+    return overlayPairs.isEmpty() ? ProfileOverlay.unchanged() : new ProfileOverlay.Adding(overlayPairs);


The check for overlayPairs.isEmpty() on line 100 will always be false because the ExecutionWorker class is unconditionally added to overlayPairs on line 95. This means ProfileOverlay.unchanged() will never be returned. Consider removing this check or restructuring the logic since overlayPairs will always contain at least one element.

Suggested change

return overlayPairs.isEmpty() ? ProfileOverlay.unchanged() : new ProfileOverlay.Adding(overlayPairs);

return new ProfileOverlay.Adding(overlayPairs);

Copilot · 2025-12-16T11:08:53Z

gobblin-temporal/src/test/java/org/apache/gobblin/temporal/ddm/workflow/WorkflowStageTest.java

+
+    // Verify
+    Assert.assertEquals(taskQueue, GobblinTemporalConfigurationKeys.DEFAULT_GOBBLIN_TEMPORAL_TASK_QUEUE,
+        "WORK_COMMIT should use default task queue");


The comment mentions "WORK_COMMIT" but the actual enum value being tested is "COMMIT". Update the comment to match the enum value for consistency.

Copilot · 2025-12-16T11:08:54Z

gobblin-temporal/src/main/java/org/apache/gobblin/temporal/ddm/activity/ActivityType.java

+  public ActivityOptions buildActivityOptions(Properties props, boolean setHeartbeatTimeout, String taskQueue) {
+    ActivityOptions.Builder builder = ActivityOptions.newBuilder()
+        .setStartToCloseTimeout(getStartToCloseTimeout(props))
+        .setRetryOptions(buildRetryOptions(props))
+        .setTaskQueue(taskQueue);
+
+    if (setHeartbeatTimeout) {
+      builder.setHeartbeatTimeout(getHeartbeatTimeout(props));
+    }
+
+    return builder.build();
+  }
+


The newly added buildActivityOptions method with taskQueue parameter is not used anywhere in the codebase. If this method is intended for future use, consider documenting this in a code comment. Otherwise, consider removing it to avoid maintaining unused code. Alternatively, if this should be used for routing activities to the execution queue when dynamic scaling is enabled, the implementation may be incomplete.

Suggested change

public ActivityOptions buildActivityOptions(Properties props, boolean setHeartbeatTimeout, String taskQueue) {

ActivityOptions.Builder builder = ActivityOptions.newBuilder()

.setStartToCloseTimeout(getStartToCloseTimeout(props))

.setRetryOptions(buildRetryOptions(props))

.setTaskQueue(taskQueue);

if (setHeartbeatTimeout) {

builder.setHeartbeatTimeout(getHeartbeatTimeout(props));

}

return builder.build();

}

Copilot · 2025-12-16T11:08:54Z

gobblin-temporal/src/main/java/org/apache/gobblin/temporal/ddm/worker/ExecutionWorker.java

+ */
+public class ExecutionWorker extends AbstractTemporalWorker {
+    public static final long DEADLOCK_DETECTION_TIMEOUT_SECONDS = 120;
+    public int maxExecutionConcurrency;


The field maxExecutionConcurrency should be declared as private or have documentation explaining why it needs package-private visibility. Consider making it private if external access is not required, or document the reason for package-private visibility if it's intentional for testing purposes.

Suggested change

public int maxExecutionConcurrency;

private int maxExecutionConcurrency;

Copilot · 2025-12-16T11:08:54Z

...lin-temporal/src/main/java/org/apache/gobblin/temporal/GobblinTemporalConfigurationKeys.java

  double DEFAULT_TEMPORAL_ACTIVITY_RETRY_OPTIONS_BACKOFF_COEFFICIENT = 2;
  String TEMPORAL_ACTIVITY_RETRY_OPTIONS_MAXIMUM_ATTEMPTS = TEMPORAL_ACTIVITY_RETRY_OPTIONS + "maximum.attempts";
  int DEFAULT_TEMPORAL_ACTIVITY_RETRY_OPTIONS_MAXIMUM_ATTEMPTS = 4;



Add a documentation comment for the WORK_EXECUTION_MEMORY_MB configuration key to explain its purpose and usage, similar to other configuration keys in this interface. The comment should clarify that this is the memory allocation in megabytes for execution worker containers when dynamic scaling is enabled.

Suggested change

/**

* Memory allocation (in megabytes) for execution worker containers when dynamic scaling is enabled.

* This value determines the amount of memory assigned to each worker container during execution.

*/

Agam Pal Singh and others added 11 commits December 8, 2025 14:41

independent memory and container configuration for temporal stages

0ca2cb7

route non execute activities to default queue

383a7cd

code refactoring

a428b4b

code cleanup

7b98621

fix: spin up 1 container initially by default

af5e22b

proper queue routing for commit phase

c6f8647

code cleanup

4bdc43a

- spin up initial container with execution worker

c31b0ca

- unit tests

- only forward NestingExecWorkflow to execution queue

bb49427

removed redundant unit tests

85959e3

removed redundant unit tests

82b4dc0

agam-99 force-pushed the feat/dynamic-stage-scaling branch from 1196a45 to 82b4dc0 Compare December 16, 2025 06:15

Merge branch 'master' into feat/dynamic-stage-scaling

04b2b6c

Blazer-007 requested a review from Copilot December 16, 2025 10:53

Copilot started reviewing on behalf of Blazer-007 December 16, 2025 10:53 View session

Copilot AI reviewed Dec 16, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Independent Dynamic Scaling for different Activities in Temporal WorkFlow #4159

Independent Dynamic Scaling for different Activities in Temporal WorkFlow #4159

Uh oh!

agam-99 commented Dec 15, 2025 •

edited

Loading

Uh oh!

codecov-commenter commented Dec 16, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 16, 2025

Uh oh!

Copilot AI Dec 16, 2025

Uh oh!

Copilot AI Dec 16, 2025

Uh oh!

Copilot AI Dec 16, 2025

Uh oh!

Copilot AI Dec 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	return overlayPairs.isEmpty() ? ProfileOverlay.unchanged() : new ProfileOverlay.Adding(overlayPairs);
	return new ProfileOverlay.Adding(overlayPairs);

	public int maxExecutionConcurrency;
	private int maxExecutionConcurrency;

+  /**
+   * Memory allocation (in megabytes) for execution worker containers when dynamic scaling is enabled.
+   * This value determines the amount of memory assigned to each worker container during execution.
+   */

Independent Dynamic Scaling for different Activities in Temporal WorkFlow #4159

Are you sure you want to change the base?

Independent Dynamic Scaling for different Activities in Temporal WorkFlow #4159

Uh oh!

Conversation

agam-99 commented Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

JIRA

Description

Tests

Commits

Uh oh!

codecov-commenter commented Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

agam-99 commented Dec 15, 2025 •

edited

Loading

codecov-commenter commented Dec 16, 2025 •

edited

Loading