feedback changes

Author: YunchuWang

CHANGELOG.md

@@ -1,5 +1,5 @@
 ## placeholder
-* Add automatic proto file download and commit hash tracking during build ([#TBD](https://github.com/microsoft/durabletask-java/pull/TBD))
+* Add automatic proto file download and commit hash tracking during build ([#201](https://github.com/microsoft/durabletask-java/pull/201))
 * Fix infinite loop when use continueasnew after wait external event ([#183](https://github.com/microsoft/durabletask-java/pull/183))
 * Fix the issue "Deserialize Exception got swallowed when use anyOf with external event." ([#185](https://github.com/microsoft/durabletask-java/pull/185))
 

client/build.gradle

@@ -17,7 +17,7 @@ def jacksonVersion = '2.15.3'
 // When build on local, you need to set this value to your local jdk11 directory.
 // Java11 is used to compile and run all the tests.
 // Example for Windows:  C:/Program Files/Java/openjdk-11.0.12_7/
-def PATH_TO_TEST_JAVA_RUNTIME = "$System.env.JDK_11"
+def PATH_TO_TEST_JAVA_RUNTIME = System.env.JDK_11 ?: System.getProperty("java.home")
 
 dependencies {
 
@@ -52,19 +52,21 @@ compileTestJava {
 }
 
 task downloadProtoFiles {
+    ext.branch = project.hasProperty('protoBranch') ? project.protoBranch : 'main'
+    
     doLast {
         def protoDir = file("${rootProject.projectDir}/internal/durabletask-protobuf/protos")
         protoDir.mkdirs()
 
         // Download the proto file
-        new URL('https://raw.githubusercontent.com/microsoft/durabletask-protobuf/main/protos/orchestrator_service.proto')
+        new URL("https://raw.githubusercontent.com/microsoft/durabletask-protobuf/${ext.branch}/protos/orchestrator_service.proto")
             .withInputStream { i -> 
                 new File(protoDir, 'orchestrator_service.proto').withOutputStream { it << i }
             }
 
         // Get and save the commit hash
         def commitHashFile = new File("${rootProject.projectDir}/internal/durabletask-protobuf/PROTO_SOURCE_COMMIT_HASH")
-        def commitApiUrl = new URL('https://api.github.com/repos/microsoft/durabletask-protobuf/commits?path=protos/orchestrator_service.proto&sha=main&per_page=1')
+        def commitApiUrl = new URL("https://api.github.com/repos/microsoft/durabletask-protobuf/commits?path=protos/orchestrator_service.proto&sha=${ext.branch}&per_page=1")
         def connection = commitApiUrl.openConnection()
         connection.setRequestProperty('Accept', 'application/vnd.github.v3+json')
         def commitHash = new groovy.json.JsonSlurper().parse(connection.inputStream)[0].sha

internal/durabletask-protobuf/PROTO_SOURCE_COMMIT_HASH

@@ -1 +1 @@
-443b333f4f65a438dc9eb4f090560d232afec4b7
+310000510e1c1544a4e99172007bd058ade66c55

internal/durabletask-protobuf/README.md

@@ -20,33 +20,5 @@ The proto files are automatically downloaded and updated when running Gradle bui
 If you need to manually update the proto files, you can run:
 
 ```bash
-./gradlew downloadProtoFiles
-```
-
-# Durable Task Protobuf Definitions
-
-This repo contains [protocol buffer](https://developers.google.com/protocol-buffers) (protobuf) definitions
-used by the Durable Task framework sidecar architecture. It's recommended that Durable Task language SDKs reference
-the protobuf contracts in this repo via [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
-
-## Contributing
-
-This project welcomes contributions and suggestions.  Most contributions require you to agree to a
-Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
-
-When you submit a pull request, a CLA bot will automatically determine whether you need to provide
-a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
-provided by the bot. You will only need to do this once across all repos using our CLA.
-
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
-For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
-contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
-
-## Trademarks
-
-This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
-trademarks or logos is subject to and must follow
-[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general).
-Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
-Any use of third-party trademarks or logos are subject to those third-party's policies.
+./gradlew downloadProtoFiles -PprotoBranch=<branch-name>
+```

internal/durabletask-protobuf/protos/orchestrator_service.proto

@@ -171,6 +171,51 @@ message ExecutionResumedEvent {
     google.protobuf.StringValue input = 1;
 }
 
+message EntityOperationSignaledEvent {
+    string requestId = 1;
+    string operation = 2;
+    google.protobuf.Timestamp scheduledTime = 3;
+    google.protobuf.StringValue input = 4;
+    google.protobuf.StringValue targetInstanceId = 5; // used only within histories, null in messages
+}
+
+message EntityOperationCalledEvent {
+    string requestId = 1;
+    string operation = 2;
+    google.protobuf.Timestamp scheduledTime = 3;
+    google.protobuf.StringValue input = 4;
+    google.protobuf.StringValue parentInstanceId = 5;  // used only within messages, null in histories
+    google.protobuf.StringValue parentExecutionId = 6;  // used only within messages, null in histories
+    google.protobuf.StringValue targetInstanceId = 7; // used only within histories, null in messages
+}
+
+message EntityLockRequestedEvent {
+    string criticalSectionId = 1;  
+    repeated string lockSet = 2;
+    int32 position = 3;
+    google.protobuf.StringValue parentInstanceId = 4; // used only within messages, null in histories 
+}
+
+message EntityOperationCompletedEvent {
+    string requestId = 1;
+    google.protobuf.StringValue output = 2;
+}
+
+message EntityOperationFailedEvent {
+    string requestId = 1;
+    TaskFailureDetails failureDetails = 2;
+}
+
+message EntityUnlockSentEvent {
+    string criticalSectionId = 1;
+    google.protobuf.StringValue parentInstanceId = 2;  // used only within messages, null in histories 
+    google.protobuf.StringValue targetInstanceId = 3;  // used only within histories, null in messages
+}
+
+message EntityLockGrantedEvent {
+    string criticalSectionId = 1;
+}
+ 
 message HistoryEvent {
     int32 eventId = 1;
     google.protobuf.Timestamp timestamp = 2;
@@ -195,6 +240,13 @@ message HistoryEvent {
         ContinueAsNewEvent continueAsNew = 20;
         ExecutionSuspendedEvent executionSuspended = 21;
         ExecutionResumedEvent executionResumed = 22;
+        EntityOperationSignaledEvent entityOperationSignaled = 23;
+        EntityOperationCalledEvent entityOperationCalled = 24;
+        EntityOperationCompletedEvent entityOperationCompleted = 25; 
+        EntityOperationFailedEvent entityOperationFailed = 26; 
+        EntityLockRequestedEvent entityLockRequested = 27;
+        EntityLockGrantedEvent entityLockGranted = 28;
+        EntityUnlockSentEvent entityUnlockSent = 29;
     }
 }
 
@@ -495,6 +547,13 @@ message EntityBatchResult {
     TaskFailureDetails failureDetails = 4;
 }
 
+message EntityRequest {
+    string instanceId = 1;
+    string executionId = 2;
+    google.protobuf.StringValue entityState = 3; // null if entity does not exist
+    repeated HistoryEvent operationRequests = 4;
+}
+
 message OperationRequest {
     string operation = 1;
     string requestId = 2;
@@ -602,14 +661,16 @@ service TaskHubSidecarService {
 message GetWorkItemsRequest {
     int32 maxConcurrentOrchestrationWorkItems = 1;
     int32 maxConcurrentActivityWorkItems = 2;
+    int32 maxConcurrentEntityWorkItems = 3;
 }
 
 message WorkItem {
     oneof request {
         OrchestratorRequest orchestratorRequest = 1;
         ActivityRequest activityRequest = 2;
-        EntityBatchRequest entityRequest = 3;
+        EntityBatchRequest entityRequest = 3; // (older) used by orchestration services implementations
         HealthPing healthPing = 4;
+        EntityRequest entityRequestV2 = 5; // (newer) used by backend service implementations
     }
     string completionToken = 10;
 }