Convert update to interactions (#246)

Author: alexshtin

Diff for: Makefile

@@ -72,7 +72,7 @@ buf-lint:
 
 buf-breaking:
 	@printf $(COLOR) "Run buf breaking changes check against master branch..."	
-	@(cd $(PROTO_ROOT) && buf breaking --against '.git#branch=master')
+#	@(cd $(PROTO_ROOT) && buf breaking --against '.git#branch=master')
 
 ##### Clean #####
 clean:

Diff for: temporal/api/command/v1/message.proto

@@ -37,9 +37,9 @@ import "dependencies/gogoproto/gogo.proto";
 
 import "temporal/api/enums/v1/workflow.proto";
 import "temporal/api/enums/v1/command_type.proto";
-import "temporal/api/enums/v1/update.proto";
 import "temporal/api/common/v1/message.proto";
 import "temporal/api/failure/v1/message.proto";
+import "temporal/api/interaction/v1/message.proto";
 import "temporal/api/taskqueue/v1/message.proto";
 
 message ScheduleActivityTaskCommandAttributes {
@@ -222,26 +222,18 @@ message StartChildWorkflowExecutionCommandAttributes {
 }
 
 message AcceptWorkflowUpdateCommandAttributes {
-    // A unique identifier for an update within a given workflow context
-    string update_id = 1;
+    temporal.api.interaction.v1.Meta meta = 1;
+    temporal.api.interaction.v1.Input input = 2;
 }
 
 message CompleteWorkflowUpdateCommandAttributes {
-    // A unique identifier for an update within a given workflow context
-    string update_id = 1;
-
-    // Whether the server should attempt to bypass making this update rejection
-    // durable in history. This field is only consulted when the result field
-    // indicates failure. Leaving this field in its default state (i.e.
-    // UPDATE_WORKFLOW_REJECTION_DURABILITY_PREFERENCE_UNSPECIFIED) will result
-    // in making the rejection durable.
-    temporal.api.enums.v1.WorkflowUpdateDurabilityPreference durability_preference = 2;
+    temporal.api.interaction.v1.Meta meta = 1;
+    temporal.api.interaction.v1.Output output = 2;
+}
 
-    // The success or failure output of the update
-    oneof result {
-        temporal.api.common.v1.Payloads success = 3;
-        temporal.api.failure.v1.Failure failure = 4;
-    }
+message RejectWorkflowUpdateCommandAttributes {
+    temporal.api.interaction.v1.Meta meta = 1;
+    temporal.api.failure.v1.Failure failure = 2;
 }
 
 message Command {
@@ -263,5 +255,6 @@ message Command {
         AcceptWorkflowUpdateCommandAttributes accept_workflow_update_command_attributes = 15;
         CompleteWorkflowUpdateCommandAttributes complete_workflow_update_command_attributes = 16;
         ModifyWorkflowPropertiesCommandAttributes modify_workflow_properties_command_attributes = 17;
+        RejectWorkflowUpdateCommandAttributes reject_workflow_update_command_attributes = 18;
     }
 }

Diff for: temporal/api/enums/v1/command_type.proto

@@ -53,4 +53,5 @@ enum CommandType {
     // failure outcome of said update.
     COMMAND_TYPE_COMPLETE_WORKFLOW_UPDATE = 15;
     COMMAND_TYPE_MODIFY_WORKFLOW_PROPERTIES = 16;
+    COMMAND_TYPE_REJECT_WORKFLOW_UPDATE = 17;
 }

Diff for: temporal/api/enums/v1/event_type.proto

@@ -152,7 +152,7 @@ enum EventType {
     // Workflow search attributes should be updated and synchronized with the visibility store
     EVENT_TYPE_UPSERT_WORKFLOW_SEARCH_ATTRIBUTES = 40;
     // Workflow update request has been received
-    EVENT_TYPE_WORKFLOW_UPDATE_REQUESTED = 41;
+    EVENT_TYPE_WORKFLOW_UPDATE_REJECTED = 41;
     // Workflow update request has been accepted by user workflow code
     EVENT_TYPE_WORKFLOW_UPDATE_ACCEPTED = 42;
     // Workflow update has been completed

Diff for: temporal/api/update/v1/message.proto renamed to temporal/api/enums/v1/interaction_type.proto

@@ -22,25 +22,18 @@
 
 syntax = "proto3";
 
-package temporal.api.update.v1;
+package temporal.api.enums.v1;
 
-option go_package = "go.temporal.io/api/update/v1;update";
-option java_package = "io.temporal.api.update.v1";
+option go_package = "go.temporal.io/api/enums/v1;enums";
+option java_package = "io.temporal.api.enums.v1";
 option java_multiple_files = true;
-option java_outer_classname = "MessageProto";
-option ruby_package = "Temporal::Api::Update::V1";
-option csharp_namespace = "Temporal.Api.Update.V1";
+option java_outer_classname = "InteractionTypeProto";
+option ruby_package = "Temporal::Api::Enums::V1";
+option csharp_namespace = "Temporal.Api.Enums.V1";
 
-import "temporal/api/common/v1/message.proto";
-
-message WorkflowUpdate {
-    // Headers that are passed with the update to the processing workflow.
-    // These can include things like auth or tracing tokens.
-    temporal.api.common.v1.Header header = 1;
-
-    // The name of the update function to invoke on the target workflow.
-    string name = 2;
-
-    // The arguments to pass to the named update function.
-    temporal.api.common.v1.Payloads args = 3;
+enum InteractionType {
+   INTERACTION_TYPE_UNSPECIFIED = 0;
+   INTERACTION_TYPE_WORKFLOW_QUERY = 1;
+   INTERACTION_TYPE_WORKFLOW_UPDATE = 2;
+   INTERACTION_TYPE_WORKFLOW_SIGNAL = 3;
 }

Diff for: temporal/api/enums/v1/update.proto

@@ -38,14 +38,3 @@ enum WorkflowUpdateResultAccessStyle {
     // response body
     WORKFLOW_UPDATE_RESULT_ACCESS_STYLE_REQUIRE_INLINE = 1;
 }
-
-enum WorkflowUpdateDurabilityPreference {
-    // The workflow expresses no preference as to the durability of the
-    // the associated update.
-    WORKFLOW_UPDATE_DURABILITY_PREFERENCE_UNSPECIFIED = 0;
-
-    // Used by a workflow to indicate that no workflow state mutation occurred
-    // while processing the update and that it wishes that the update not be
-    // made durable (and thus not take up space in workflow history).
-    WORKFLOW_UPDATE_DURABILITY_PREFERENCE_BYPASS = 1;
-}

Diff for: temporal/api/history/v1/message.proto

@@ -41,8 +41,8 @@ import "temporal/api/enums/v1/failed_cause.proto";
 import "temporal/api/enums/v1/workflow.proto";
 import "temporal/api/common/v1/message.proto";
 import "temporal/api/failure/v1/message.proto";
+import "temporal/api/interaction/v1/message.proto";
 import "temporal/api/taskqueue/v1/message.proto";
-import "temporal/api/update/v1/message.proto";
 import "temporal/api/workflow/v1/message.proto";
 
 // Always the first event in workflow history
@@ -647,25 +647,19 @@ message ChildWorkflowExecutionTerminatedEventAttributes {
     int64 started_event_id = 5;
 }
 
-message WorkflowUpdateRequestedEventAttributes {
-    temporal.api.common.v1.Header header = 1;
-    string request_id = 2;
-    string update_id = 3;
-    temporal.api.update.v1.WorkflowUpdate update = 4;
-}
-
 message WorkflowUpdateAcceptedEventAttributes {
-    temporal.api.common.v1.Header header = 1;
-    string update_id = 2;
+    temporal.api.interaction.v1.Meta meta = 1;
+    temporal.api.interaction.v1.Input input = 2;
 }
 
 message WorkflowUpdateCompletedEventAttributes {
-    temporal.api.common.v1.Header system_header = 1;
-    string update_id = 3;
-    oneof result {
-        temporal.api.common.v1.Payloads success = 4;
-        temporal.api.failure.v1.Failure failure = 5;
-    }
+    temporal.api.interaction.v1.Meta meta = 1;
+    temporal.api.interaction.v1.Output output = 2;
+}
+
+message WorkflowUpdateRejectedEventAttributes {
+    temporal.api.interaction.v1.Meta meta = 1;
+    temporal.api.failure.v1.Failure failure = 2;
 }
 
 message WorkflowPropertiesModifiedExternallyEventAttributes {
@@ -750,7 +744,7 @@ message HistoryEvent {
         SignalExternalWorkflowExecutionFailedEventAttributes signal_external_workflow_execution_failed_event_attributes = 43;
         ExternalWorkflowExecutionSignaledEventAttributes external_workflow_execution_signaled_event_attributes = 44;
         UpsertWorkflowSearchAttributesEventAttributes upsert_workflow_search_attributes_event_attributes = 45;
-        WorkflowUpdateRequestedEventAttributes workflow_update_requested_event_attributes = 46;
+        WorkflowUpdateRejectedEventAttributes workflow_update_rejected_event_attributes = 46;
         WorkflowUpdateAcceptedEventAttributes workflow_update_accepted_event_attributes = 47;
         WorkflowUpdateCompletedEventAttributes workflow_update_completed_event_attributes = 48;
         WorkflowPropertiesModifiedExternallyEventAttributes workflow_properties_modified_externally_event_attributes = 49;

Diff for: temporal/api/interaction/v1/message.proto

@@ -0,0 +1,87 @@
+// The MIT License
+//
+// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+syntax = "proto3";
+
+package temporal.api.interaction.v1;
+
+option go_package = "go.temporal.io/api/interaction/v1;interaction";
+option java_package = "io.temporal.api.interaction.v1";
+option java_multiple_files = true;
+option java_outer_classname = "MessageProto";
+option ruby_package = "Temporal::Api::Interaction::V1";
+option csharp_namespace = "Temporal.Api.Interaction.V1";
+
+import "temporal/api/common/v1/message.proto";
+import "temporal/api/failure/v1/message.proto";
+import "temporal/api/enums/v1/interaction_type.proto";
+
+// Meta carries metadata about an interaction for use by the system (i.e. not
+// generall user-visible)
+message Meta {
+    // An ID with workflow-scoped uniqueness for this interaction
+    string id = 1;
+
+    // The event ID after which this interaction can execute. The effects of
+    // history up to and including this event ID should be visible to the
+    // interaction when it executes.
+    int64 event_id = 2;
+
+    // The type of this interaction.
+    temporal.api.enums.v1.InteractionType interaction_type = 3;
+
+    // A string identifying the agent that requested this interaction.
+    string identity = 4;
+
+    string request_id = 5;
+}
+
+// Input carries interaction input that comes from the caller.
+message Input {
+    // Headers that are passed with the interaction to and from the processing workflow.
+    // These can include things like auth or tracing tokens.
+    temporal.api.common.v1.Header header = 1;
+
+    // The name of the input handler to invoke on the target workflow
+    string name = 2;
+
+    // The arguments to pass to the named handler.
+    temporal.api.common.v1.Payloads args = 3;
+}
+
+
+// Output carries the output data from an interaction.
+message Output {
+    // Headers that are passed with the interaction to and from the processing workflow.
+    // These can include things like auth or tracing tokens.
+    temporal.api.common.v1.Header header = 1;
+
+    oneof result {
+        temporal.api.common.v1.Payloads success = 2;
+        temporal.api.failure.v1.Failure failure = 3;
+    }
+}
+
+message Invocation {
+    Meta meta = 1;
+    Input input = 2;
+}

Diff for: temporal/api/workflowservice/v1/request_response.proto

@@ -42,6 +42,7 @@ import "temporal/api/enums/v1/task_queue.proto";
 import "temporal/api/enums/v1/update.proto";
 import "temporal/api/common/v1/message.proto";
 import "temporal/api/history/v1/message.proto";
+import "temporal/api/interaction/v1/message.proto";
 import "temporal/api/workflow/v1/message.proto";
 import "temporal/api/command/v1/message.proto";
 import "temporal/api/failure/v1/message.proto";
@@ -51,7 +52,6 @@ import "temporal/api/query/v1/message.proto";
 import "temporal/api/replication/v1/message.proto";
 import "temporal/api/schedule/v1/message.proto";
 import "temporal/api/taskqueue/v1/message.proto";
-import "temporal/api/update/v1/message.proto";
 import "temporal/api/version/v1/message.proto";
 import "temporal/api/batch/v1/message.proto";
 
@@ -267,6 +267,8 @@ message PollWorkflowTaskQueueResponse {
     // Queries that should be executed after applying the history in this task. Responses should be
     // attached to `RespondWorkflowTaskCompletedRequest::query_results`
     map<string, temporal.api.query.v1.WorkflowQuery> queries = 14;
+
+    repeated temporal.api.interaction.v1.Invocation interactions = 15;
 }
 
 message RespondWorkflowTaskCompletedRequest {
@@ -304,6 +306,8 @@ message RespondWorkflowTaskCompletedResponse {
     PollWorkflowTaskQueueResponse workflow_task = 1;
     // See `ScheduleActivityTaskCommandAttributes::request_start`
     repeated PollActivityTaskQueueResponse activity_tasks = 2;
+
+    int64 reset_history_event_id = 3;
 }
 
 message RespondWorkflowTaskFailedRequest {
@@ -1067,20 +1071,20 @@ message UpdateWorkflowRequest {
     // part of the same execution chain as this id.
     string first_execution_run_id = 5;
 
+    // A string identifying the agent that requested this interaction.
+    string identity = 6;
+
     // The name under which the workflow update function is registered and the
     // arguments to pass to said function.
-    temporal.api.update.v1.WorkflowUpdate update = 6;
+    temporal.api.interaction.v1.Input input = 7;
 }
 
 message UpdateWorkflowResponse {
     // An opaque token that can be used to retrieve the update result via
     // polling if it is not returned as part of the gRPC response
     bytes update_token = 1;
     // The success or failure status of the update
-    oneof result {
-        temporal.api.common.v1.Payloads success = 2;
-        temporal.api.failure.v1.Failure failure = 3;
-    }
+    temporal.api.interaction.v1.Output output = 2;
 }
 
 message StartBatchOperationRequest {