Skip to content

Include WCI connectivity health in worker deployment API#10778

Merged
smuneebahmad merged 9 commits into
mainfrom
muneeb/wci-validation
Jun 25, 2026
Merged

Include WCI connectivity health in worker deployment API#10778
smuneebahmad merged 9 commits into
mainfrom
muneeb/wci-validation

Conversation

@smuneebahmad

@smuneebahmad smuneebahmad commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

What changed?

DescribeWorkerDeployment now returns compute status per version, checking whether Temporal can successfully interact with the version's compute resource. ListWorkerDeployments also returns compute status on the current, ramping, and latest version summaries, fetched in parallel.

When connectivity changes (e.g. Lambda becomes unreachable or is restored), WCI signals the version workflow, which propagates the update to the deployment workflow memo. The list view reads from the memo — versions that have been validated since deployment will show their status immediately; others will appear once the first validation runs.

Why?

Allows customers to see whether Temporal can successfully interact with their compute resource directly from the Worker Deployments list and detail views, without navigating into each individual version.

How did you test it?

  • built
  • run locally and tested manually
  • covered by existing tests
  • added new unit test(s)
  • added new functional test(s)

@smuneebahmad smuneebahmad changed the title Include WCI connectivity health in worker deployment API Include WCI connectivity health in worker deployment API Jun 19, 2026
@smuneebahmad
smuneebahmad force-pushed the muneeb/wci-validation branch from 32f2623 to bb3d98a Compare June 19, 2026 15:57
@smuneebahmad
smuneebahmad force-pushed the muneeb/wci-validation branch from bb3d98a to e442af1 Compare June 19, 2026 16:52
smuneebahmad added a commit to temporalio/api that referenced this pull request Jun 22, 2026
…810)

**What changed?**
Added `ComputeStatus` to the Worker Deployment API with a
`ProviderValidationStatus` that tracks the result of the most recent
connectivity check between Temporal and a customer's compute resource.
An empty error message means validation passed; a non-empty message
describes what failed.

**Why?**
Enables surfacing the connectivity health between Temporal and a
customer's compute resource (e.g. Lambda) through the Worker Deployment
API, so the UI can show ongoing validations status of compute configs
without additional queries.

**Breaking changes**
None. All additions are new optional fields; existing clients are
unaffected.

**Server PR**
temporalio/temporal#10778
temporal-cicd Bot pushed a commit to temporalio/api-go that referenced this pull request Jun 22, 2026
…(#810)

**What changed?**
Added `ComputeStatus` to the Worker Deployment API with a
`ProviderValidationStatus` that tracks the result of the most recent
connectivity check between Temporal and a customer's compute resource.
An empty error message means validation passed; a non-empty message
describes what failed.

**Why?**
Enables surfacing the connectivity health between Temporal and a
customer's compute resource (e.g. Lambda) through the Worker Deployment
API, so the UI can show ongoing validations status of compute configs
without additional queries.

**Breaking changes**
None. All additions are new optional fields; existing clients are
unaffected.

**Server PR**
temporalio/temporal#10778
@smuneebahmad
smuneebahmad force-pushed the muneeb/wci-validation branch from 8f0d9fe to 15c5335 Compare June 22, 2026 22:53

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Expose Worker Controller Instance (WCI) connectivity/validation health as ComputeStatus on worker deployment version summaries, so list/describe APIs can surface compute reachability/validation results per version.

Changes:

  • Add compute_status to internal deployment/version workflow state protos and regenerate Go protos.
  • Update version workflow to ingest WCI validation status signals and propagate ComputeStatus into deployment summaries/memo.
  • Plumb ComputeStatus through worker deployment API response mapping; bump related module versions.

Reviewed changes

Copilot reviewed 6 out of 9 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
service/worker/workerdeployment/workflow.go Include ComputeStatus when mapping internal version summaries to API version summaries.
service/worker/workerdeployment/version_workflow.go Listen for WCI validation status signals and sync updated compute status to the deployment workflow.
service/worker/workerdeployment/compute_util.go Add helper converting WCI validation status to public deploymentpb.ComputeStatus.
service/worker/workerdeployment/client.go Include ComputeStatus in DescribeWorkerDeployment response mapping for each version summary.
proto/internal/temporal/server/api/deployment/v1/message.proto Add compute_status fields to internal workflow state protos.
api/deployment/v1/message.pb.go Regenerated output for internal proto changes.
cmd/tools/getproto/files.go Generated proto import map update (formatting issues introduced).
go.mod Bump go.temporal.io/api and go.temporal.io/auto-scaled-workers versions.
go.sum Update sums for bumped module versions.
Files not reviewed (2)
  • api/deployment/v1/message.pb.go: Generated file
  • cmd/tools/getproto/files.go: Generated file

Comment thread service/worker/workerdeployment/version_workflow.go Outdated
Comment thread service/worker/workerdeployment/compute_util.go
Comment thread proto/internal/temporal/server/api/deployment/v1/message.proto Outdated
Comment thread proto/internal/temporal/server/api/deployment/v1/message.proto Outdated
Comment thread cmd/tools/getproto/files.go Outdated
Comment thread cmd/tools/getproto/files.go Outdated
Comment thread service/worker/workerdeployment/client.go

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 8 out of 10 changed files in this pull request and generated 4 comments.

Files not reviewed (1)
  • api/deployment/v1/message.pb.go: Generated file

Comment thread service/worker/workerdeployment/version_workflow.go
Comment thread service/worker/workerdeployment/version_workflow.go
Comment thread api/deployment/v1/message.pb.go Outdated
Comment thread api/deployment/v1/message.pb.go Outdated
@smuneebahmad
smuneebahmad force-pushed the muneeb/wci-validation branch from 6e171dd to 0dc9e8c Compare June 24, 2026 16:20
@smuneebahmad
smuneebahmad force-pushed the muneeb/wci-validation branch from 0dc9e8c to 2d15ad9 Compare June 24, 2026 16:24
@smuneebahmad
smuneebahmad marked this pull request as ready for review June 24, 2026 17:17
@smuneebahmad
smuneebahmad requested review from a team as code owners June 24, 2026 17:17
}

// Version gate for sync-validation-status signal to prevent NDEs during rollback
if workflow.GetVersion(ctx, "sync-validation-status-signal", workflow.DefaultVersion, 0) >= 0 {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It seems we've been doing this patchings for other signal handlers, but I don't think patching (GetVersion) really helps with NDEs related to the new signal. Because the handler registration itself does not create history events and is safe to hit during replay of a workflow ran in the previous version without signal handler.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good point. Will clean this up in a follow-up PR

@rkannan82
rkannan82 self-requested a review June 25, 2026 00:00

@rkannan82 rkannan82 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we need to update existing e2e test to verify this?

@smuneebahmad

Copy link
Copy Markdown
Contributor Author

Do we need to update existing e2e test to verify this?

Good question. The unit tests in compute_util_test.go and version_workflow_test.go cover the new ComputeStatus conversion and signal propagation. E2E tests have been validated as part of temporalio/temporal-auto-scaled-workers#60

@smuneebahmad
smuneebahmad merged commit d4cab6b into main Jun 25, 2026
50 checks passed
@smuneebahmad
smuneebahmad deleted the muneeb/wci-validation branch June 25, 2026 05:39
stephanos pushed a commit that referenced this pull request Jun 25, 2026
## What changed?
`DescribeWorkerDeployment` now returns compute status per version,
checking whether Temporal can successfully interact with the version's
compute resource. `ListWorkerDeployments` also returns compute status on
the current, ramping, and latest version summaries, fetched in parallel.

When connectivity changes (e.g. Lambda becomes unreachable or is
restored), WCI signals the version workflow, which propagates the update
to the deployment workflow memo. The list view reads from the memo —
versions that have been validated since deployment will show their
status immediately; others will appear once the first validation runs.

## Why?
Allows customers to see whether Temporal can successfully interact with
their compute resource directly from the Worker Deployments list and
detail views, without navigating into each individual version.

## How did you test it?
- [x] built
- [x] run locally and tested manually
- [ ] covered by existing tests
- [x] added new unit test(s)
- [ ] added new functional test(s)
rossnelson added a commit to temporalio/ui that referenced this pull request Jul 7, 2026
…ts (DT-4174) (#3618)

* Add connection status types, util, and ConnectionBadge (DT-4174)

Phase 1-2 of DT-4174 (connection status on Deployments/Versions).

- Add ProviderValidation/ComputeStatus types + computeStatus on VersionSummaryNew
- Add deriveConnectionStatus + formatConnectionCheckTime pure utils with tests
- Add ConnectionBadge component (dot + word + tooltip) and i18n keys

State is derived client-side from compute_status.provider_validation
(error_message + last_check_time): pending / connected / failed. The
failure message from the API is rendered directly (no client-side code map).

These phases are API-independent and degrade to Pending until the backend
(temporalio/api#810, temporalio/temporal#10778) lands. List/details wiring
and the configurable Latest Version column are follow-ups.

* Wire connection status into deployments list and versions table (DT-4174)

Phase 3-4 of DT-4174.

List page: replace the Latest Version column with a composite Current
Version cell (build ID + compute + connection badge); show No Current
Version when there is no current version. Latest Version as an optional
column is a follow-up.

Details page: add a Connection column to the versions table, shown for
Current/Ramping/Draining versions and an em dash otherwise. All new UI is
behind the serverScaledDeployments capability; the validate-connection
flow is unchanged.

* Only show connection status when a compute config is present (DT-4174)

Self-managed (non-serverless) deployments have no compute provider, so a
connection indicator is meaningless for them. Gate the ConnectionBadge on
the compute provider being present: the list Current Version cell shows it
alongside the compute badge, and the versions table shows an em dash when
there is no compute config. Found via local testing against a self-managed
worker deployment.

* Match designs: connection inside compute pill, Lifecycle header (DT-4174)

- List Current Version cell renders the connection dot + word inside the
  compute pill (Lambda • Connected) instead of as a separate badge, per design
- ComputeBadge accepts children so the connection can be composed inside it
- Rename the versions-table lifecycle column header to Lifecycle

* Refine connection dot: smaller/centered in pill, hidden in details column (DT-4174)

- Shrink the in-pill status dot (size-2 -> size-1.5) and shrink-0 so it stays
  small and vertically centered next to the label, matching the design
- Add showDot prop to ConnectionBadge (default off); the list pill opts in, the
  details Connection column renders the word only

* Flatten connection into the compute pill layout (DT-4174)

Move the connection rendering into ComputeBadge via a computeStatus prop so
the icon, label, status dot, and status word are direct flex children of one
pill (Lambda • Connected), with the tooltip on the pill. ConnectionBadge is
now the word-only badge used by the details Connection column.

* Add Storybook story showing all connection/compute scenarios (DT-4174)

Showcases the composite pill across providers x Connected/Failed/Pending,
compute-only (self-managed), and the details word-only ConnectionBadge.

* Use design-system status colors + story render tests (DT-4174)

- Connection colors use design tokens (text-success/text-danger/text-subtle)
  instead of raw green/red; the in-pill dot uses bg-current so it matches
- Add Storybook play() render assertions for each connection scenario
  (Lambda/Cloud Run x Connected/Failed/Pending, compute-only), runnable via
  pnpm stories:test

* Drop misleading Validate Connection hint from Pending tooltip (DT-4174)

The on-demand Validate Connection API is a dry-run and does not persist to
compute_status, so it does not update the connection badge. Remove the
implication that it does.

* Extract shared connection presentation helpers (DT-4174)

Both ComputeBadge (list pill) and ConnectionBadge (details column) duplicated
the state->color map, state->label, and tooltip-text logic. Move them to
connection-status.ts (connectionStateColor, connectionStateLabel,
connectionTooltip) so there is a single source of truth; the components are
now thin presentational shells.

* Consolidate duplicate connection tooltip i18n key (DT-4174)

connection-tooltip-connected and connection-tooltip-failed-checked were the
same string ('Checked {{ time }}'). Replace both with a single state-neutral
connection-tooltip-checked key used by connectionTooltip for the connected
and failed states.

* Route connection freshness text through i18n (DT-4174)

formatConnectionCheckTime previously returned hardcoded English (date-fns
output + a literal 'less than an hour ago'). Replace with translate keys
(connection-checked-recently/-hour/-hours) and a manual hour calc, dropping
the date-fns dependency from this helper. Output is unchanged for the
existing states.

* Add Latest Version optional column to Deployments list (DT-4174) (#3625)

* Add Latest Version optional column to Deployments list (DT-4174)

The second half of DT-4174. Latest Version is an opt-in, hidden-by-default
column on the Worker Deployments list, toggled via the table's
configurable-columns drawer (the same control Workflows/Schedules/Activities
use).

- Extend the configurable-table-columns store with a DEPLOYMENTS table type:
  DEFAULT_DEPLOYMENTS_COLUMNS (Deployment, Current Version, Created At) with
  Latest Version as an available/hidden column, a namespace-scoped
  persistStore, and availableDeploymentColumns.
- Source the deployments list columns from the store, translate labels for
  the header, and add the footer gear + reused drawer.
- The Latest Version cell renders build ID, lifecycle status, and compute
  provider, with no connection indicator (connection stays on Current
  Version). Shows 'Same as Current' when the latest version equals the
  current one, and an em dash when there is no latest version.
- Gate the drawer's custom search attributes section off for deployments so
  it does not show an irrelevant empty section (workflows/schedules/
  activities are unaffected).

* Tighten deployment list version cells (DT-4174)

Match the design for the Current and Latest Version cells on the deployments
list:

- Remove the min-w-32 on the build-ID container so the compute badge sits
  next to the build ID instead of leaving a large gap for short IDs.
- Drop the copy button from the build-ID cells (not shown in the design); the
  deployment name keeps its copy button.

* Remove compute-badge Storybook story (DT-4174)

Drop the compute-badge story to check whether it is the source of the
Chromatic UI Tests failure.

* Revert "Remove compute-badge Storybook story (DT-4174)"

This reverts commit e07018c.

* Address review nits (DT-4174)

- formatConnectionCheckTime: guard against NaN diff (invalid dates) and use
  Math.floor so elapsed hours are not overstated. Add an invalid-date test.
- Remove the now-unused 'build-status' i18n key (replaced by 'lifecycle').
- Configurable-columns MOVE reducer: fall back to the table-aware
  defaultColumns instead of hardcoded DEFAULT_WORKFLOWS_COLUMNS.
trangnguyenkp pushed a commit to trangnguyenkp/temporal that referenced this pull request Jul 9, 2026
…10778)

## What changed?
`DescribeWorkerDeployment` now returns compute status per version,
checking whether Temporal can successfully interact with the version's
compute resource. `ListWorkerDeployments` also returns compute status on
the current, ramping, and latest version summaries, fetched in parallel.

When connectivity changes (e.g. Lambda becomes unreachable or is
restored), WCI signals the version workflow, which propagates the update
to the deployment workflow memo. The list view reads from the memo —
versions that have been validated since deployment will show their
status immediately; others will appear once the first validation runs.

## Why?
Allows customers to see whether Temporal can successfully interact with
their compute resource directly from the Worker Deployments list and
detail views, without navigating into each individual version.

## How did you test it?
- [x] built
- [x] run locally and tested manually
- [ ] covered by existing tests
- [x] added new unit test(s)
- [ ] added new functional test(s)
spkane31 pushed a commit that referenced this pull request Jul 15, 2026
## What changed?
`DescribeWorkerDeployment` now returns compute status per version,
checking whether Temporal can successfully interact with the version's
compute resource. `ListWorkerDeployments` also returns compute status on
the current, ramping, and latest version summaries, fetched in parallel.

When connectivity changes (e.g. Lambda becomes unreachable or is
restored), WCI signals the version workflow, which propagates the update
to the deployment workflow memo. The list view reads from the memo —
versions that have been validated since deployment will show their
status immediately; others will appear once the first validation runs.

## Why?
Allows customers to see whether Temporal can successfully interact with
their compute resource directly from the Worker Deployments list and
detail views, without navigating into each individual version.

## How did you test it?
- [x] built
- [x] run locally and tested manually
- [ ] covered by existing tests
- [x] added new unit test(s)
- [ ] added new functional test(s)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants