Skip to content

VersionLocalState in sync with VersionSummary + Activation/Deactivation timestamps #585

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.

Sign up for GitHub

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

Merged
Shivs11 merged 13 commits into from
May 14, 2025
Merged

VersionLocalState in sync with VersionSummary + Activation/Deactivation timestamps #585

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
07dcfaa
required timestamps to be emitted from deploymentStateInfo
Shivs11 May 1, 2025
42c5c50
add timestamps
Shivs11 May 7, 2025
36d69be
add timestamps in WorkerDeploymentVersionInfo
Shivs11 May 7, 2025
a59aebe
Merge branch 'ss/sync_version_summary_version_state' into ss/traffic_…
Shivs11 May 8, 2025
ac49d06
running make proto after merge
Shivs11 May 8, 2025
6fa3aff
first_activation + last_deactivation
Shivs11 May 8, 2025
c71337b
grammar
Shivs11 May 8, 2025
8aca99d
replace nil with unset for _since timestamps
Shivs11 May 8, 2025
ee8e6b0
last_routing_update_time
Shivs11 May 9, 2025
e683888
reverting back to using routing_update_time
Shivs11 May 9, 2025
7e863db
Merge branch 'master' into ss/traffic_timestamps
Shivs11 May 12, 2025
d419206
Merge branch 'master' into ss/traffic_timestamps
Shivs11 May 14, 2025
e4d2b3b
resolve attribute number conflict since main got merged in before thi…
Shivs11 May 14, 2025
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
46 changes: 43 additions & 3 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7008,7 +7008,37 @@
"format": "date-time"
},
"drainageStatus": {
"$ref": "#/definitions/v1VersionDrainageStatus"
"$ref": "#/definitions/v1VersionDrainageStatus",
"description": "Deprecated. Use `drainage_info` instead."
},
"drainageInfo": {
"$ref": "#/definitions/v1VersionDrainageInfo",
"title": "Information about workflow drainage to help the user determine when it is safe\nto decommission a Version. Not present while version is current or ramping"
},
"currentSinceTime": {
"type": "string",
"format": "date-time",
"description": "Unset if not current."
},
"rampingSinceTime": {
"type": "string",
"format": "date-time",
"description": "Unset if not ramping. Updated when the version first starts ramping, not on each ramp change."
},
"routingUpdateTime": {
"type": "string",
"format": "date-time",
"description": "Last time `current_since_time`, `ramping_since_time, or `ramp_percentage` of this version changed."
},
"firstActivationTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp when this version first became current or ramping."
},
"lastDeactivationTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp when this version last stopped being current or ramping."
}
}
},
Expand Down Expand Up @@ -14754,12 +14784,22 @@
"currentSinceTime": {
"type": "string",
"format": "date-time",
"description": "\nNil if not current."
"description": "\nUnset if not current."
},
"rampingSinceTime": {
"type": "string",
"format": "date-time",
"description": "\nNil if not ramping. Updated when the version first starts ramping, not on each ramp change."
"description": "\nUnset if not ramping. Updated when the version first starts ramping, not on each ramp change."
},
"firstActivationTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp when this version first became current or ramping."
},
"lastDeactivationTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp when this version last stopped being current or ramping."
},
"rampPercentage": {
"type": "number",
Expand Down
45 changes: 43 additions & 2 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12056,7 +12056,40 @@ components:
- VERSION_DRAINAGE_STATUS_DRAINING
- VERSION_DRAINAGE_STATUS_DRAINED
type: string
description: Deprecated. Use `drainage_info` instead.
format: enum
drainageInfo:
allOf:
- $ref: '#/components/schemas/VersionDrainageInfo'
description: |-
Information about workflow drainage to help the user determine when it is safe
to decommission a Version. Not present while version is current or ramping
currentSinceTime:
type: string
description: |-
Unset if not current.
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
format: date-time
rampingSinceTime:
type: string
description: |-
Unset if not ramping. Updated when the version first starts ramping, not on each ramp change.
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
format: date-time
routingUpdateTime:
type: string
description: Last time `current_since_time`, `ramping_since_time, or `ramp_percentage` of this version changed.
format: date-time
firstActivationTime:
type: string
description: Timestamp when this version first became current or ramping.
format: date-time
lastDeactivationTime:
type: string
description: Timestamp when this version last stopped being current or ramping.
format: date-time
WorkerDeploymentOptions:
type: object
properties:
Expand Down Expand Up @@ -12103,14 +12136,22 @@ components:
description: |-
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
Nil if not current.
Unset if not current.
format: date-time
rampingSinceTime:
type: string
description: |-
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
Nil if not ramping. Updated when the version first starts ramping, not on each ramp change.
Unset if not ramping. Updated when the version first starts ramping, not on each ramp change.
format: date-time
firstActivationTime:
type: string
description: Timestamp when this version first became current or ramping.
format: date-time
lastDeactivationTime:
type: string
description: Timestamp when this version last stopped being current or ramping.
format: date-time
rampPercentage:
type: number
Expand Down
27 changes: 25 additions & 2 deletions temporal/api/deployment/v1/message.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,19 @@ message WorkerDeploymentVersionInfo {

// (-- api-linter: core::0140::prepositions=disabled
// aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
// Nil if not current.
// Unset if not current.
google.protobuf.Timestamp current_since_time = 5;

// (-- api-linter: core::0140::prepositions=disabled
// aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
// Nil if not ramping. Updated when the version first starts ramping, not on each ramp change.
// Unset if not ramping. Updated when the version first starts ramping, not on each ramp change.
google.protobuf.Timestamp ramping_since_time = 6;

// Timestamp when this version first became current or ramping.
google.protobuf.Timestamp first_activation_time = 11;
// Timestamp when this version last stopped being current or ramping.
google.protobuf.Timestamp last_deactivation_time = 12;

// Range: [0, 100]. Must be zero if the version is not ramping (i.e. `ramping_since_time` is nil).
// Can be in the range [0, 100] if the version is ramping.
float ramp_percentage = 7;
Expand Down Expand Up @@ -188,7 +193,25 @@ message WorkerDeploymentInfo {
// The fully-qualified string representation of the version, in the form "<deployment_name>.<build_id>".
string version = 1;
google.protobuf.Timestamp create_time = 2;
// Deprecated. Use `drainage_info` instead.
enums.v1.VersionDrainageStatus drainage_status = 3;
// Information about workflow drainage to help the user determine when it is safe
// to decommission a Version. Not present while version is current or ramping
VersionDrainageInfo drainage_info = 4;
// Unset if not current.
// (-- api-linter: core::0140::prepositions=disabled
// aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
google.protobuf.Timestamp current_since_time = 5;
// Unset if not ramping. Updated when the version first starts ramping, not on each ramp change.
// (-- api-linter: core::0140::prepositions=disabled
// aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
google.protobuf.Timestamp ramping_since_time = 6;
// Last time `current_since_time`, `ramping_since_time, or `ramp_percentage` of this version changed.
google.protobuf.Timestamp routing_update_time = 7;
Copy link
Copy Markdown

@drewhoskins-temporal drewhoskins-temporal May 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

nit: last_routing_update_time for clarity?

Copy link
Copy Markdown
Member Author

@Shivs11 Shivs11 May 9, 2025

Choose a reason for hiding this comment

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

Thanks for the suggestion! Hmm, I still am leaning towards routing_update_time since the word 'update' already implies the latest change, so adding last_ felt a bit redundant to me.

Not making this change right now, but let me know if you still feel strongly about this.

// Timestamp when this version first became current or ramping.
google.protobuf.Timestamp first_activation_time = 8;
// Timestamp when this version last stopped being current or ramping.
google.protobuf.Timestamp last_deactivation_time = 9;
}
}

Expand Down
Loading