mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Long TranandGitHub
1224e4d0cd
## What changed? ### **High level** With https://github.com/temporalio/api/pull/761 to add the linking on the Signal and Signal-with-Start responses, This PR adds logic from the server that: * Adds `requestID` from Signal and Signal-with-Start requests to the CHASM workflow tree under a new map field `IncomingSignals`, and event store, so these requestIDs stay in buffer * Return a backlink in the response that references the `requestID` * On buffer flush to the DB transaction, attach these `requestID` to a concrete `eventID`, which would allow users to later know which event correlated w/ this request. We will wire the concrete event ID to the signal request IDs stored in the workflow component CHASM tree (`IncomingSignals` map) > [!NOTE] > Feature is gated behind a new dynamicconfig `EnableCHASMSignalBacklinks`, which implicitly is only checked if `EnableChasm` is enabled. ## Why? This will enable the caller of the signal to have a backlink to the cross-namespace signal invoked, which will become more relevant for Nexus SDK ergonomics. ## How did you test it? - [ ] built - [ ] run locally and tested manually - [ ] covered by existing tests - [ ] added new unit test(s) - [x] added new functional test(s) In functional tests, I augmented existing tests for Signal and Signal-with-Start to: * Ensure that backlink is returned via the responses * Later use `DescribeWorkflow` to ensure that we get a concrete EventID (mapped when buffer flushed) * Multiple signals with the same `requestID` gets de-duped ``` $ go test ./tests/ -run TestLinksTestSuite ok go.temporal.io/server/tests 1.486s ``` ``` $ go test ./tests/ -run 'TestNexusWorkflowTestSuite' -count=1 ok go.temporal.io/server/tests 4.714s ``` ## Potential risks Need to test end-to-end to see that the link shows up correctly in the Web UI. Feature is gated behind dynamicconfig since it requires CHASM-based workflow to be enabled.
28 lines
1.0 KiB
Protocol Buffer
28 lines
1.0 KiB
Protocol Buffer
syntax = "proto3";
|
|
|
|
package temporal.server.chasm.lib.workflow.proto.v1;
|
|
|
|
option go_package = "go.temporal.io/server/chasm/lib/workflow/gen/workflowpb;workflowpb";
|
|
|
|
// NexusOperationParentData contains workflow-specific data stored in a nexus operation's
|
|
// parent_data field when the operation is embedded in a workflow.
|
|
message NexusOperationParentData {
|
|
// Event ID of the NEXUS_OPERATION_SCHEDULED event.
|
|
int64 scheduled_event_id = 1;
|
|
// Token for loading the NEXUS_OPERATION_SCHEDULED event.
|
|
bytes scheduled_event_token = 2;
|
|
}
|
|
|
|
// NexusCancellationParentData contains workflow-specific data stored in a nexus cancellation's
|
|
// parent_data field when the operation is embedded in a workflow.
|
|
message NexusCancellationParentData {
|
|
// Event ID of the NEXUS_OPERATION_CANCEL_REQUESTED event.
|
|
int64 requested_event_id = 1;
|
|
}
|
|
|
|
// IncomingSignalData records the event associated with a signal's request ID, which allows
|
|
// DescribeWorkflow to resolve RequestIDRef signal backlinks.
|
|
message IncomingSignalData {
|
|
int64 event_id = 1;
|
|
}
|