Worklow: add now about start time (dapr#742)

JoshVanL · mikeee · yaron2 · web-flow · commit 2e40804f14d2 · 2025-08-07T08:54:08.000-07:00
Signed-off-by: joshvanl &lt;me@joshvanl.dev&gt;
Co-authored-by: Mike Nguyen &lt;hey@mike.ee&gt;
Co-authored-by: Yaron Schneider &lt;schneider.yaron@live.com&gt;
diff --git a/examples/workflow/main.go b/examples/workflow/main.go
@@ -64,6 +64,10 @@ func main() {
 	ctx := context.Background()
 
 	// Start workflow test
+	// Set the start time to the current time to not wait for the workflow to
+	// "start". This is useful for increasing the throughput of creating
+	// workflows.
+	// workflow.WithStartTime(time.Now())
 	instanceID, err := wfClient.ScheduleNewWorkflow(ctx, "TestWorkflow", workflow.WithInstanceID("a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9"), workflow.WithInput(1))
 	if err != nil {
 		log.Fatalf("failed to start workflow: %v", err)
diff --git a/workflow/client.go b/workflow/client.go
@@ -65,7 +65,10 @@ func WithRawInput(input string) api.NewOrchestrationOptions {
 	return api.WithRawInput(wrapperspb.String(input))
 }
 
-// WithStartTime is an option to set the start time when scheduling a new workflow.
+// WithStartTime is an option to set the start time when scheduling a new
+// workflow. Setting this option will prevent Dapr from "waiting" for the
+// Workflow to start, meaning that it can improve workflow creation throughput.
+// Meaning setting this value to `time.Now()` can be useful.
 func WithStartTime(time time.Time) api.NewOrchestrationOptions {
 	return api.WithStartTime(time)
 }

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,10 @@ func WithRawInput(input string) api.NewOrchestrationOptions {`
`65`	`65`	`return api.WithRawInput(wrapperspb.String(input))`
`66`	`66`	`}`
`67`	`67`
`68`		`-// WithStartTime is an option to set the start time when scheduling a new workflow.`
	`68`	`+// WithStartTime is an option to set the start time when scheduling a new`
	`69`	`+// workflow. Setting this option will prevent Dapr from "waiting" for the`
	`70`	`+// Workflow to start, meaning that it can improve workflow creation throughput.`
	`71`	+// Meaning setting this value to `time.Now()` can be useful.
`69`	`72`	`func WithStartTime(time time.Time) api.NewOrchestrationOptions {`
`70`	`73`	`return api.WithStartTime(time)`
`71`	`74`	`}`