Skip to content

Commit 1592217

Browse files
committed
change sleep to fast forward
1 parent 708cc3a commit 1592217

4 files changed

Lines changed: 24 additions & 24 deletions

File tree

openapi/openapiv2.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19515,16 +19515,16 @@
1951519515
"type": "boolean",
1951619516
"description": "Enables or disables time skipping for this workflow execution."
1951719517
},
19518-
"sleep": {
19518+
"fastForward": {
1951919519
"type": "string",
19520-
"description": "Optionally register a sleep for the current workflow execution.\nWhen the sleep completes, time skipping is disabled and this action is recorded in\nthe WorkflowExecutionTimeSkippingTransitionedEvent, but it can be re-enabled by\nsetting `enabled` to true via UpdateWorkflowExecutionOptions.\nThe current workflow execution is a chain of runs (retries, cron, continue-as-new);\nchild workflows are separate executions, so this sleep won't affect them."
19520+
"description": "Optionally fast-forward the current workflow execution to this point in time.\nWhen the fast-forward completes, time skipping is disabled and this action is recorded in\nthe WorkflowExecutionTimeSkippingTransitionedEvent, but it can be re-enabled by\nsetting `enabled` to true via UpdateWorkflowExecutionOptions.\nThe current workflow execution is a chain of runs (retries, cron, continue-as-new);\nchild workflows are separate executions, so this fast_forward won't affect them."
1952119521
},
1952219522
"disableChildPropagation": {
1952319523
"type": "boolean",
1952419524
"description": "By default, child workflows inherit the \"enabled\" flag when they are started.\nThis flag disables that inheritance."
1952519525
}
1952619526
},
19527-
"description": "The configuration for time skipping of a workflow execution (a chain of runs including retries, cron, continue-as-new).\nWhen time skipping is enabled, virtual time advances automatically whenever there is no in-flight work.\nIn-flight work includes activities, child workflows, Nexus operations, signal/cancel external workflow operations,\nand possibly other features added in the future.\nUser timers are not classified as in-flight work and will be skipped over; the virtual clock may also skip to the\ntime point of the registered sleep when there is no in-flight work.\n\nFor child workflows, by default, if the parent execution is skipping time, the child execution will also skip time,\nbut the parent's sleep won't affect the child execution. A flag is provided to disable propagation of the\n\"enabled\" flag to child workflows; regardless of that flag, a child workflow inherits the virtual time from the\nparent execution as its start time."
19527+
"description": "The configuration for time skipping of a workflow execution (a chain of runs including retries, cron, continue-as-new).\nWhen time skipping is enabled, virtual time advances automatically whenever there is no in-flight work.\nIn-flight work includes activities, child workflows, Nexus operations, signal/cancel external workflow operations,\nand possibly other features added in the future.\nUser timers are not classified as in-flight work and will be skipped over; the virtual clock may also skip to the\ntime point of the registered fast_forward when there is no in-flight work.\n\nFor child workflows, by default, if the parent execution is skipping time, the child execution will also skip time,\nbut the parent's fast_forward won't affect the child execution. A flag is provided to disable propagation of the\n\"enabled\" flag to child workflows; regardless of that flag, a child workflow inherits the virtual time from the\nparent execution as its start time."
1952819528
},
1952919529
"v1TimeoutFailureInfo": {
1953019530
"type": "object",
@@ -21157,17 +21157,17 @@
2115721157
"format": "date-time",
2115821158
"description": "The virtual time point that time skipping advanced to."
2115921159
},
21160-
"disabledAfterSleep": {
21160+
"disabledAfterFastForward": {
2116121161
"type": "boolean",
21162-
"description": "When true, time skipping has been disabled automatically due to the sleep completing."
21162+
"description": "When true, time skipping has been disabled automatically due to the fast_forward completing."
2116321163
},
2116421164
"wallClockTime": {
2116521165
"type": "string",
2116621166
"format": "date-time",
2116721167
"description": "The wall-clock time when the time-skipping state changed event was generated."
2116821168
}
2116921169
},
21170-
"description": "Attributes for an event indicating that time skipping state changed for a workflow execution,\neither time was advanced or time skipping was disabled automatically due to the sleep completing.\nThe worker_may_ignore field in HistoryEvent should always be set true for this event."
21170+
"description": "Attributes for an event indicating that time skipping state changed for a workflow execution,\neither time was advanced or time skipping was disabled automatically due to the fast_forward completing.\nThe worker_may_ignore field in HistoryEvent should always be set true for this event."
2117121171
},
2117221172
"v1WorkflowExecutionTimedOutEventAttributes": {
2117321173
"type": "object",

openapi/openapiv3.yaml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17278,16 +17278,16 @@ components:
1727817278
enabled:
1727917279
type: boolean
1728017280
description: Enables or disables time skipping for this workflow execution.
17281-
sleep:
17281+
fastForward:
1728217282
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
1728317283
type: string
1728417284
description: |-
17285-
Optionally register a sleep for the current workflow execution.
17286-
When the sleep completes, time skipping is disabled and this action is recorded in
17285+
Optionally fast-forward the current workflow execution to this point in time.
17286+
When the fast-forward completes, time skipping is disabled and this action is recorded in
1728717287
the WorkflowExecutionTimeSkippingTransitionedEvent, but it can be re-enabled by
1728817288
setting `enabled` to true via UpdateWorkflowExecutionOptions.
1728917289
The current workflow execution is a chain of runs (retries, cron, continue-as-new);
17290-
child workflows are separate executions, so this sleep won't affect them.
17290+
child workflows are separate executions, so this fast_forward won't affect them.
1729117291
disableChildPropagation:
1729217292
type: boolean
1729317293
description: |-
@@ -17299,10 +17299,10 @@ components:
1729917299
In-flight work includes activities, child workflows, Nexus operations, signal/cancel external workflow operations,
1730017300
and possibly other features added in the future.
1730117301
User timers are not classified as in-flight work and will be skipped over; the virtual clock may also skip to the
17302-
time point of the registered sleep when there is no in-flight work.
17302+
time point of the registered fast_forward when there is no in-flight work.
1730317303

1730417304
For child workflows, by default, if the parent execution is skipping time, the child execution will also skip time,
17305-
but the parent's sleep won't affect the child execution. A flag is provided to disable propagation of the
17305+
but the parent's fast_forward won't affect the child execution. A flag is provided to disable propagation of the
1730617306
"enabled" flag to child workflows; regardless of that flag, a child workflow inherits the virtual time from the
1730717307
parent execution as its start time.
1730817308
TimeoutFailureInfo:
@@ -19747,10 +19747,10 @@ components:
1974719747
type: string
1974819748
description: The virtual time point that time skipping advanced to.
1974919749
format: date-time
19750-
disabledAfterSleep:
19750+
disabledAfterFastForward:
1975119751
type: boolean
1975219752
description: |-
19753-
When true, time skipping has been disabled automatically due to the sleep completing.
19753+
When true, time skipping has been disabled automatically due to the fast_forward completing.
1975419754
(-- api-linter: core::0140::prepositions=disabled
1975519755
aip.dev/not-precedent: "after" is used to indicate temporal ordering. --)
1975619756
wallClockTime:
@@ -19759,7 +19759,7 @@ components:
1975919759
format: date-time
1976019760
description: |-
1976119761
Attributes for an event indicating that time skipping state changed for a workflow execution,
19762-
either time was advanced or time skipping was disabled automatically due to the sleep completing.
19762+
either time was advanced or time skipping was disabled automatically due to the fast_forward completing.
1976319763
The worker_may_ignore field in HistoryEvent should always be set true for this event.
1976419764
WorkflowExecutionTimedOutEventAttributes:
1976519765
type: object

temporal/api/history/v1/message.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1002,16 +1002,16 @@ message WorkflowExecutionUnpausedEventAttributes {
10021002
}
10031003

10041004
// Attributes for an event indicating that time skipping state changed for a workflow execution,
1005-
// either time was advanced or time skipping was disabled automatically due to the sleep completing.
1005+
// either time was advanced or time skipping was disabled automatically due to the fast_forward completing.
10061006
// The worker_may_ignore field in HistoryEvent should always be set true for this event.
10071007
message WorkflowExecutionTimeSkippingTransitionedEventAttributes {
10081008
// The virtual time point that time skipping advanced to.
10091009
google.protobuf.Timestamp target_time = 1;
10101010

1011-
// When true, time skipping has been disabled automatically due to the sleep completing.
1011+
// When true, time skipping has been disabled automatically due to the fast_forward completing.
10121012
// (-- api-linter: core::0140::prepositions=disabled
10131013
// aip.dev/not-precedent: "after" is used to indicate temporal ordering. --)
1014-
bool disabled_after_sleep = 2;
1014+
bool disabled_after_fast_forward = 2;
10151015

10161016
// The wall-clock time when the time-skipping state changed event was generated.
10171017
google.protobuf.Timestamp wall_clock_time = 3;

temporal/api/workflow/v1/message.proto

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -596,23 +596,23 @@ message WorkflowExecutionOptions {
596596
// In-flight work includes activities, child workflows, Nexus operations, signal/cancel external workflow operations,
597597
// and possibly other features added in the future.
598598
// User timers are not classified as in-flight work and will be skipped over; the virtual clock may also skip to the
599-
// time point of the registered sleep when there is no in-flight work.
599+
// time point of the registered fast_forward when there is no in-flight work.
600600
//
601601
// For child workflows, by default, if the parent execution is skipping time, the child execution will also skip time,
602-
// but the parent's sleep won't affect the child execution. A flag is provided to disable propagation of the
602+
// but the parent's fast_forward won't affect the child execution. A flag is provided to disable propagation of the
603603
// "enabled" flag to child workflows; regardless of that flag, a child workflow inherits the virtual time from the
604604
// parent execution as its start time.
605605
message TimeSkippingConfig {
606606
// Enables or disables time skipping for this workflow execution.
607607
bool enabled = 1;
608608

609-
// Optionally register a sleep for the current workflow execution.
610-
// When the sleep completes, time skipping is disabled and this action is recorded in
609+
// Optionally fast-forward the current workflow execution to this point in time.
610+
// When the fast-forward completes, time skipping is disabled and this action is recorded in
611611
// the WorkflowExecutionTimeSkippingTransitionedEvent, but it can be re-enabled by
612612
// setting `enabled` to true via UpdateWorkflowExecutionOptions.
613613
// The current workflow execution is a chain of runs (retries, cron, continue-as-new);
614-
// child workflows are separate executions, so this sleep won't affect them.
615-
google.protobuf.Duration sleep = 2;
614+
// child workflows are separate executions, so this fast_forward won't affect them.
615+
google.protobuf.Duration fast_forward = 2;
616616

617617
// By default, child workflows inherit the "enabled" flag when they are started.
618618
// This flag disables that inheritance.

0 commit comments

Comments
 (0)