Add comments to workflow code for clarity

Signed-off-by: “Kevin” <“[email protected]”>

Author: “Kevin”

cmd/samples/batch/workflow.go

@@ -3,6 +3,7 @@ package main
 import (
 	"context"
 	"fmt"
+	"math/rand"
 	"time"
 
 	"go.uber.org/cadence/workflow"
@@ -20,31 +21,36 @@ type BatchWorkflowInput struct {
 }
 
 func BatchWorkflow(ctx workflow.Context, input BatchWorkflowInput) error {
+	// Create activity factories for each task (not yet executed)
 	factories := make([]func(workflow.Context) workflow.Future, input.TotalSize)
 	for taskID := 0; taskID < input.TotalSize; taskID++ {
-		taskID := taskID
+		taskID := taskID // Capture loop variable for closure
 		factories[taskID] = func(ctx workflow.Context) workflow.Future {
+			// Configure activity timeouts
 			aCtx := workflow.WithActivityOptions(ctx, workflow.ActivityOptions{
-				ScheduleToStartTimeout: time.Minute * 10,
-				StartToCloseTimeout:    time.Minute * 10,
+				ScheduleToStartTimeout: time.Minute * 1,
+				StartToCloseTimeout:    time.Minute * 1,
 			})
 			return workflow.ExecuteActivity(aCtx, BatchActivity, taskID)
 		}
 	}
 
+	// Execute all activities with controlled concurrency
 	batch, err := x.NewBatchFuture(ctx, input.Concurrency, factories)
 	if err != nil {
 		return fmt.Errorf("failed to create batch future: %w", err)
 	}
 
+	// Wait for all activities to complete
 	return batch.Get(ctx, nil)
 }
 
 func BatchActivity(ctx context.Context, taskID int) error {
 	select {
 	case <-ctx.Done():
+		// Return error if workflow/activity is cancelled
 		return fmt.Errorf("batch activity %d failed: %w", taskID, ctx.Err())
-	case <-time.After(time.Duration(10000)*time.Millisecond):
+	case <-time.After(time.Duration(rand.Int63n(100))*time.Millisecond + 900*time.Millisecond):
 		return nil
 	}
 }

cmd/samples/batch/workflow_test.go

@@ -8,17 +8,21 @@ import (
 )
 
 func Test_BatchWorkflow(t *testing.T) {
+	// Create test environment for workflow testing
 	testSuite := &testsuite.WorkflowTestSuite{}
 	env := testSuite.NewTestWorkflowEnvironment()
 
+	// Register the workflow and activity functions
 	env.RegisterWorkflow(BatchWorkflow)
 	env.RegisterActivity(BatchActivity)
 
+	// Execute workflow with 2 concurrent workers processing 10 tasks
 	env.ExecuteWorkflow(BatchWorkflow, BatchWorkflowInput{
 		Concurrency: 2,
 		TotalSize:   10,
 	})
 
+	// Assert workflow completed successfully without errors
 	assert.True(t, env.IsWorkflowCompleted())
 	assert.Nil(t, env.GetWorkflowError())
 }