Skip to content
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

Minor fixes for Nexus Go SDK proposal #90

Merged
merged 1 commit into from
May 7, 2024
Merged

Minor fixes for Nexus Go SDK proposal #90

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 8 additions & 5 deletions nexus/sdk-go.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,8 +267,8 @@ type NexusClient interface {
ExecuteOperation(ctx Context, operation any, input any, options NexusOperationOptions) NexusOperationFuture
}

// Create a [NexusClient] from a service name and an endpoint name.
func NewNexusClient(service, endpoint string) NexusClient
// Create a [NexusClient] from an endpoint name and a service name.
func NewNexusClient(endpoint, service string) NexusClient
```

**Usage**:
Expand All @@ -282,7 +282,7 @@ import (
)

func MyCallerWorkflow(ctx workflow.Context) (MyOutput, error) {
client := workflow.NewNexusClient("payments", "prod-payments")
client := workflow.NewNexusClient(ctx, "prod-payments", "payments")
fut := client.ExecuteOperation(ctx, "start-transaction", MyInput{ID: "tx-deadbeef"}, workflow.NexusOperationOptions{
ScheduleToCloseTimeout: time.Hour,
})
Expand All @@ -303,8 +303,8 @@ More interceptors are likely to come later.

```go
type WorkflowOutboundInterceptor interface {
NewNexusClient(service, endpoint string) workflow.NexusClient
RequestCancelNexusOperation(ctx Context, service, operation, id string, options nexus.CancelOperationOptions) error
ExecuteNexusOperation(ctx workflow.Context, client workflow.NexusClient, operation any, input any, options NexusOperationOptions)
RequestCancelNexusOperation(ctx workflow.Context, client workflow.NexusClient, operation any, id string, options nexus.CancelOperationOptions) error
}
```

Expand All @@ -327,6 +327,7 @@ sequenceDiagram
UserHandler-->>HandlerWorker: OperationID
HandlerWorker-->>HandlerTemporal: RespondNexusTaskCompleted(OperationID)
HandlerTemporal-->>CallerTemporal: OperationID
CallerTemporal->>CallerTemporal: Record NexusOperationStarted(OperationID)
end
CallerWorker->>CallerTemporal: PollWorkflowTaskQueue
CallerTemporal-->>CallerWorker: Workflow Task (NexusOperationStarted)
Expand All @@ -339,6 +340,7 @@ sequenceDiagram
ArbitraryHandlerWorker->>HandlerTemporal: RespondWorkflowTaskCompleted<br>(WorkflowExecutionCompleted)
HandlerTemporal-->>ArbitraryHandlerWorker: OK
HandlerTemporal->>CallerTemporal: POST callback with operation (workflow) result
CallerTemporal->>CallerTemporal: Record NexusOperationCompleted
CallerTemporal-->>HandlerTemporal: OK
CallerWorker->>CallerTemporal: PollWorkflowTaskQueue
CallerTemporal-->>CallerWorker: Workflow Task (NexusOperationCompleted)
Expand All @@ -362,6 +364,7 @@ sequenceDiagram
UserHandler-->>HandlerWorker: Result
HandlerWorker-->>HandlerTemporal: RespondNexusTaskCompleted(Result)
HandlerTemporal-->>CallerTemporal: Result
CallerTemporal->>CallerTemporal: Record NexusOperationCompleted
end
CallerWorker->>CallerTemporal: PollWorkflowTaskQueue
CallerTemporal-->>CallerWorker: Workflow Task (NexusOperationCompleted)
Expand Down