Support for mocking nexus operations #1666
Conversation
|
This PR could use some tests and there would be an example in the documentation showing how this may be used. I want to understand the experience you had in mind better before diving deeper into the review. |
| func (env *testWorkflowEnvironmentImpl) RegisterNexusAsyncOperationCompletion( | ||
| service string, | ||
| operation string, | ||
| operationID string, |
There was a problem hiding this comment.
I wonder if this would be intuitive for users to specify the operationID at registration time.
Also don't we need locks to protect the map here?
There was a problem hiding this comment.
I wonder if this would be intuitive for users to specify the operationID at registration time.
The user needs to specify the operation id when specifying the return value of the mock call.
Also don't we need locks to protect the map here?
Why do we need to protect this map?
| panic(fmt.Sprintf("mock of ExecuteNexusOperation failed to deserialize input")) | ||
| } | ||
|
|
||
| // rebuild the input as *nexus.LazyValue |
There was a problem hiding this comment.
Because, after I call input.Consume on L3208, it closed the reader, so it can't call again, which is needed if the user didn't mock the operation.
There was a problem hiding this comment.
Well, actually, I can see that the reader isn't really being used at this moment, so maybe I could just skip this...
| // t.OnNexusOperation( | ||
| // service, | ||
| // HelloOperation, | ||
| // HelloInput{Message: "Temporal"}, | ||
| // mock.Anything, | ||
| // ).Return( | ||
| // &nexus.HandlerStartOperationResultAsync{ | ||
| // OperationID: "hello-operation-id", | ||
| // }, | ||
| // nil, | ||
| // ) | ||
| // | ||
| // t.RegisterNexusAsyncOperationCompletion( | ||
| // service, | ||
| // HelloOperation.Name(), | ||
| // "hello-operation-id", | ||
| // HelloOutput{Message: "Hello Temporal"}, | ||
| // nil, | ||
| // 1*time.Second, | ||
| // ) |
There was a problem hiding this comment.
In addition to this, maybe we could have helper functions to mock sync and async operations. Example: for async operation, we could have something like this:
func (e *TestWorkflowEnvironment) MockNexusAsyncOperation(
service any,
operation any,
input any,
options any,
result any,
err error,
delay time.Duration,
) *MockCallWrapper {
operationID := uuid.New() // maybe also input?
m := e.OnNexusOperation(service, operation, input, options).Return(
&nexus.HandlerStartOperationResultAsync{
OperationID: operationID,
},
nil,
)
e.RegisterNexusAsyncOperationCompletion(service, operation, operationID, result, err, delay)
return m
}
And we could also have something similar for the sync which basically abstract the returned value type nexus.HandlerStartOperationResultSync.
| if h.env.onNexusOperationCanceledListener != nil { | ||
| h.env.onNexusOperationCanceledListener(h.params.client.Service(), h.params.operation) | ||
| } |
There was a problem hiding this comment.
I'm not sure how useful is the canceled listener here. It doesn't seem that the user can cancel a Nexus operation through the SDK.
What was changed
Support for mocking nexus operations in the test framework.
Why?
Checklist
Closes
How was this tested: