remove runID, improve comments

client/client.go

@@ -104,15 +104,16 @@ type (
 		//	- InternalServiceError
 		SignalWorkflow(ctx context.Context, workflowID string, runID string, signalName string, arg interface{}) error
 
-		// SignalWithStartWorkflow sends a signals to a workflow in execution, if workflow is not running or not found,
-		// it starts workflow then sends the signal in transaction.
-		// - workflowID, runID, signalName, signalArg are same as SignalWorkflow's parameters
-		// - options, workflow, workflowArgs are same as StartWorkflow's parameters
+		// SignalWithStartWorkflow sends a signal to a running workflow.
+		// If the workflow is not running or not found, it starts the workflow and then sends the signal in transaction.
+		// - workflowID, signalName, signalArg are same as SignalWorkflow's parameters
+		// - workflow, workflowArgs are same as StartWorkflow's parameters
+		// - options.WorkflowIDReusePolicy will be ignored, and WorkflowIDReusePolicyAllowDuplicate will be used as the policy
 		// The errors it can return:
-		//  - EntityNotExistsError, if domain does not exists
+		//  - EntityNotExistsError, if domain does not exist
 		//  - BadRequestError
 		//	- InternalServiceError
-		SignalWithStartWorkflow(ctx context.Context, workflowID string, runID string, signalName string, signalArg interface{},
+		SignalWithStartWorkflow(ctx context.Context, workflowID string, signalName string, signalArg interface{},
 			options StartWorkflowOptions, workflow interface{}, workflowArgs ...interface{}) (*workflow.Execution, error)
 
 		// CancelWorkflow cancels a workflow in execution

idl/github.com/uber/cadence/cadence.thrift

@@ -299,11 +299,11 @@ service WorkflowService {
     )
 
   /**
-  * SignalWithStartWorkflowExecution is used to ensure sending a signal event to a workflow execution.
-  * If workflow is running, this results in WorkflowExecutionSignaled event recorded in the history
+  * SignalWithStartWorkflowExecution is used to ensure sending signal to a workflow.
+  * If the workflow is running, this results in WorkflowExecutionSignaled event being recorded in the history
   * and a decision task being created for the execution.
-  * If workflow is not running or not found, this results in WorkflowExecutionStarted and WorkflowExecutionSignaled
-  * event recorded in history, and a decision task being created for the execution
+  * If the workflow is not running or not found, this results in WorkflowExecutionStarted and WorkflowExecutionSignaled
+  * events being recorded in history, and a decision task being created for the execution
   **/
   shared.StartWorkflowExecutionResponse SignalWithStartWorkflowExecution(1: shared.SignalWithStartWorkflowExecutionRequest signalWithStartRequest)
     throws (

idl/github.com/uber/cadence/shared.thrift

@@ -964,7 +964,7 @@ struct SignalWorkflowExecutionRequest {
 
 struct SignalWithStartWorkflowExecutionRequest {
   10: optional string domain
-  20: optional WorkflowExecution workflowExecution
+  20: optional string workflowId
   30: optional WorkflowType workflowType
   40: optional TaskList taskList
   50: optional binary input

internal/client.go

@@ -94,15 +94,16 @@ type (
 		//	- InternalServiceError
 		SignalWorkflow(ctx context.Context, workflowID string, runID string, signalName string, arg interface{}) error
 
-		// SignalWithStartWorkflow sends a signals to a workflow in execution, if workflow is not running or not found,
-		// it starts workflow then sends the signal in transaction.
-		// - workflowID, runID, signalName, signalArg are same as SignalWorkflow's parameters
-		// - options, workflow, workflowArgs are same as StartWorkflow's parameters
+		// SignalWithStartWorkflow sends a signal to a running workflow.
+		// If the workflow is not running or not found, it starts the workflow and then sends the signal in transaction.
+		// - workflowID, signalName, signalArg are same as SignalWorkflow's parameters
+		// - workflow, workflowArgs are same as StartWorkflow's parameters
+		// - options.WorkflowIDReusePolicy will be ignored, and WorkflowIDReusePolicyAllowDuplicate will be used as the policy
 		// The errors it can return:
-		//  - EntityNotExistsError, if domain does not exists
+		//  - EntityNotExistsError, if domain does not exist
 		//  - BadRequestError
 		//	- InternalServiceError
-		SignalWithStartWorkflow(ctx context.Context, workflowID string, runID string, signalName string, signalArg interface{},
+		SignalWithStartWorkflow(ctx context.Context, workflowID string, signalName string, signalArg interface{},
 			options StartWorkflowOptions, workflow interface{}, workflowArgs ...interface{}) (*WorkflowExecution, error)
 
 		// CancelWorkflow cancels a workflow in execution

internal/internal_workflow_client.go

@@ -263,9 +263,9 @@ func (wc *workflowClient) SignalWorkflow(ctx context.Context, workflowID string,
 		}, serviceOperationRetryPolicy, isServiceTransientError)
 }
 
-// SignalWithStartWorkflow sends a signals to a workflow in execution, if workflow is not running or not found,
-// it starts workflow then sends the signal in transaction
-func (wc *workflowClient) SignalWithStartWorkflow(ctx context.Context, workflowID string, runID string, signalName string, signalArg interface{},
+// SignalWithStartWorkflow sends a signal to a running workflow.
+// If the workflow is not running or not found, it starts the workflow and then sends the signal in transaction.
+func (wc *workflowClient) SignalWithStartWorkflow(ctx context.Context, workflowID string, signalName string, signalArg interface{},
 	options StartWorkflowOptions, workflowFunc interface{}, workflowArgs ...interface{}) (*WorkflowExecution, error) {
 
 	signalInput, err := getEncodedArg(signalArg)
@@ -300,17 +300,13 @@ func (wc *workflowClient) SignalWithStartWorkflow(ctx context.Context, workflowI
 		return nil, err
 	}
 
-	execution := &s.WorkflowExecution{
-		WorkflowId: common.StringPtr(workflowID),
-		RunId:      getRunID(runID),
-	}
 	signalWithStartRequest := &s.SignalWithStartWorkflowExecutionRequest{
-		Domain:            common.StringPtr(wc.domain),
-		RequestId:         common.StringPtr(uuid.New()),
-		WorkflowExecution: execution,
-		WorkflowType:      workflowTypePtr(*workflowType),
-		TaskList:          common.TaskListPtr(s.TaskList{Name: common.StringPtr(options.TaskList)}),
-		Input:             input,
+		Domain:       common.StringPtr(wc.domain),
+		RequestId:    common.StringPtr(uuid.New()),
+		WorkflowId:   common.StringPtr(workflowID),
+		WorkflowType: workflowTypePtr(*workflowType),
+		TaskList:     common.TaskListPtr(s.TaskList{Name: common.StringPtr(options.TaskList)}),
+		Input:        input,
 		ExecutionStartToCloseTimeoutSeconds: common.Int32Ptr(executionTimeout),
 		TaskStartToCloseTimeoutSeconds:      common.Int32Ptr(decisionTaskTimeout),
 		SignalName:                          common.StringPtr(signalName),

internal/internal_workflow_client_test.go

@@ -544,12 +544,12 @@ func (s *workflowClientTestSuite) TestSignalWithStartWorkflow() {
 	}
 	s.service.EXPECT().SignalWithStartWorkflowExecution(gomock.Any(), gomock.Any(), gomock.Any()).Return(createResponse, nil).Times(2)
 
-	resp, err := s.client.SignalWithStartWorkflow(context.Background(), workflowID, runID, signalName, signalInput,
+	resp, err := s.client.SignalWithStartWorkflow(context.Background(), workflowID, signalName, signalInput,
 		options, workflowType)
 	s.Nil(err)
 	s.Equal(createResponse.GetRunId(), resp.RunID)
 
-	resp, err = s.client.SignalWithStartWorkflow(context.Background(), "", runID, signalName, signalInput,
+	resp, err = s.client.SignalWithStartWorkflow(context.Background(), "", signalName, signalInput,
 		options, workflowType)
 	s.Nil(err)
 	s.Equal(createResponse.GetRunId(), resp.RunID)
@@ -560,13 +560,13 @@ func (s *workflowClientTestSuite) TestSignalWithStartWorkflow_Error() {
 	signalInput := []byte("my signal input")
 	options := StartWorkflowOptions{}
 
-	resp, err := s.client.SignalWithStartWorkflow(context.Background(), workflowID, runID, signalName, signalInput,
+	resp, err := s.client.SignalWithStartWorkflow(context.Background(), workflowID, signalName, signalInput,
 		options, workflowType)
 	s.NotNil(err)
 	s.Nil(resp)
 
 	options.TaskList = tasklist
-	resp, err = s.client.SignalWithStartWorkflow(context.Background(), workflowID, runID, signalName, signalInput,
+	resp, err = s.client.SignalWithStartWorkflow(context.Background(), workflowID, signalName, signalInput,
 		options, workflowType)
 	s.NotNil(err)
 	s.Nil(resp)
@@ -576,7 +576,7 @@ func (s *workflowClientTestSuite) TestSignalWithStartWorkflow_Error() {
 		RunId: common.StringPtr(runID),
 	}
 	s.service.EXPECT().SignalWithStartWorkflowExecution(gomock.Any(), gomock.Any(), gomock.Any()).Return(createResponse, nil).Times(2)
-	resp, err = s.client.SignalWithStartWorkflow(context.Background(), workflowID, runID, signalName, signalInput,
+	resp, err = s.client.SignalWithStartWorkflow(context.Background(), workflowID, signalName, signalInput,
 		options, workflowType)
 	s.Nil(err)
 	s.Equal(createResponse.GetRunId(), resp.RunID)