Files
tasks/chasm/lib/callback/statemachine.go
b701b9bae2 Add CHASM callback into mutable state (#8582)
## What changed?
Integrated chasm/lib/callback into MutableState and updated
callback-related APIs to use CHASM implementation. Added integration
tests following the scheduler pattern.

## Why?
Porting callback functionality from HSM to CHASM as part of the ongoing
HSM-to-CHASM migration effort.

## How did you test it?
- [X] built
- [X] run locally and tested manually
- [X] covered by existing tests
- [ ] added new unit test(s)
- [X] added new functional test(s)

## Potential risks
This will need to be tested more, but is not being turned on with this
PR

---

> [!NOTE]
> Integrates CHASM-based callbacks into mutable state and history APIs,
adds configs and error types, updates routing/state transitions, and
includes migration tests.
> 
> - **CHASM Callback Integration**:
> - Add CHASM callback module (FX wiring, HTTP caller provider, request
routing) and metrics shared with HSM implementation.
> - Implement `ToAPICallback`, invocation flow changes, and refined
error wrapping.
> - **History/MutableState**:
> - Expose `ChasmEnabled`, `ChasmWorkflowComponent{,ReadOnly}`; use
CHASM for adding/processing completion callbacks when enabled.
> - Describe API now builds callback info from both CHASM and HSM trees.
> - Continue-as-new/retry path aggregates callbacks from both
implementations.
> - **State Machine/Executors**:
> - Switch to `queues/errors` types; move `NamespaceIDAndDestination` to
`queues/common`.
> - Adjust transitions: generate `BackoffTask` with scheduled time;
include destination on reschedule; no tasks on success/fail.
> - Simplify retry result (policy passed separately) and validation
signatures.
> - **Config**:
> - Add `EnableCHASMCallbacks` and `MaxCHASMCallbacksPerWorkflow`; wire
through history configs.
> - **Tests**:
> - Add migration and CHASM-enabled functional tests; update unit tests
to new error/types and behaviors.
> 
> <sup>Written by [Cursor
Bugbot]() for commit
e3b51a931d3ea2dd7f18fb2f9c55fc880ba828d8. This will update automatically
on new commits. Configure
[here]().</sup>

---------

Co-authored-by: Roey Berman <[email protected]>
2025-11-24 12:31:44 -07:00

123 lines
3.8 KiB
Go

package callback
import (
"fmt"
"net/url"
"time"
failurepb "go.temporal.io/api/failure/v1"
"go.temporal.io/server/chasm"
callbackspb "go.temporal.io/server/chasm/lib/callback/gen/callbackpb/v1"
"go.temporal.io/server/common/backoff"
"google.golang.org/protobuf/types/known/timestamppb"
)
// EventScheduled is triggered when the callback is meant to be scheduled for the first time - when its Trigger
// condition is met.
type EventScheduled struct{}
var TransitionScheduled = chasm.NewTransition(
[]callbackspb.CallbackStatus{callbackspb.CALLBACK_STATUS_STANDBY},
callbackspb.CALLBACK_STATUS_SCHEDULED,
func(cb *Callback, ctx chasm.MutableContext, event EventScheduled) error {
u, err := url.Parse(cb.Callback.GetNexus().GetUrl())
if err != nil {
return fmt.Errorf("failed to parse URL: %v: %w", cb.Callback, err)
}
ctx.AddTask(cb, chasm.TaskAttributes{Destination: u.Scheme + "://" + u.Host}, &callbackspb.InvocationTask{})
return nil
},
)
// EventRescheduled is triggered when the callback is meant to be rescheduled after backing off from a previous attempt.
type EventRescheduled struct{}
var TransitionRescheduled = chasm.NewTransition(
[]callbackspb.CallbackStatus{callbackspb.CALLBACK_STATUS_BACKING_OFF},
callbackspb.CALLBACK_STATUS_SCHEDULED,
func(cb *Callback, ctx chasm.MutableContext, event EventRescheduled) error {
cb.NextAttemptScheduleTime = nil
u, err := url.Parse(cb.Callback.GetNexus().Url)
if err != nil {
return fmt.Errorf("failed to parse URL: %v: %w", cb.Callback, err)
}
ctx.AddTask(
cb,
chasm.TaskAttributes{Destination: u.Scheme + "://" + u.Host},
&callbackspb.InvocationTask{Attempt: cb.Attempt},
)
return nil
},
)
// EventAttemptFailed is triggered when an attempt is failed with a retryable error.
type EventAttemptFailed struct {
Time time.Time
Err error
RetryPolicy backoff.RetryPolicy
}
var TransitionAttemptFailed = chasm.NewTransition(
[]callbackspb.CallbackStatus{callbackspb.CALLBACK_STATUS_SCHEDULED},
callbackspb.CALLBACK_STATUS_BACKING_OFF,
func(cb *Callback, ctx chasm.MutableContext, event EventAttemptFailed) error {
cb.recordAttempt(event.Time)
// Use 0 for elapsed time as we don't limit the retry by time (for now).
nextDelay := event.RetryPolicy.ComputeNextDelay(0, int(cb.Attempt), event.Err)
nextAttemptScheduleTime := event.Time.Add(nextDelay)
cb.NextAttemptScheduleTime = timestamppb.New(nextAttemptScheduleTime)
cb.LastAttemptFailure = &failurepb.Failure{
Message: event.Err.Error(),
FailureInfo: &failurepb.Failure_ApplicationFailureInfo{
ApplicationFailureInfo: &failurepb.ApplicationFailureInfo{
NonRetryable: false,
},
},
}
ctx.AddTask(
cb,
chasm.TaskAttributes{ScheduledTime: nextAttemptScheduleTime},
&callbackspb.BackoffTask{Attempt: cb.Attempt},
)
return nil
},
)
// EventFailed is triggered when an attempt is failed with a non retryable error.
type EventFailed struct {
Time time.Time
Err error
}
var TransitionFailed = chasm.NewTransition(
[]callbackspb.CallbackStatus{callbackspb.CALLBACK_STATUS_SCHEDULED},
callbackspb.CALLBACK_STATUS_FAILED,
func(cb *Callback, ctx chasm.MutableContext, event EventFailed) error {
cb.recordAttempt(event.Time)
cb.LastAttemptFailure = &failurepb.Failure{
Message: event.Err.Error(),
FailureInfo: &failurepb.Failure_ApplicationFailureInfo{
ApplicationFailureInfo: &failurepb.ApplicationFailureInfo{
NonRetryable: true,
},
},
}
return nil
},
)
// EventSucceeded is triggered when an attempt succeeds.
type EventSucceeded struct {
Time time.Time
}
var TransitionSucceeded = chasm.NewTransition(
[]callbackspb.CallbackStatus{callbackspb.CALLBACK_STATUS_SCHEDULED},
callbackspb.CALLBACK_STATUS_SUCCEEDED,
func(cb *Callback, ctx chasm.MutableContext, event EventSucceeded) error {
cb.recordAttempt(event.Time)
cb.LastAttemptFailure = nil
return nil
},
)