feat(rst): TODO update commit - add support for bulk job request and xtreemstore

TODO:
* Update commit to reflect final changes.
* Break into muliple commits if reasonable.

Author: swartzn

cpp/beeremote.pb.cc

@@ -3,6 +3,7 @@ package beeremote;
 option go_package = "github.com/thinkparq/protobuf/go/beeremote";
 
 import "flex.proto";
+import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
 
 // Externally facing RPCs and messages clients and worker nodes use to interact
@@ -102,6 +103,13 @@ message JobRequest {
     optional flex.RestorePolicy restore_policy = 13;
     // Time in seconds to wait after a file is closed before replication begins.
     optional uint32 cooldown_secs = 14;
+    // delay_execution specifies a delay used to generate the execute-after
+    // time for the work request by adding it to the current time.
+    optional google.protobuf.Duration delay_execution = 15;
+    // bulk_info is optionally included when the job request participates in a provider-controlled
+    // bulk operation. It contains builder-maintained metadata needed to track the request within
+    // that bulk operation.
+    optional flex.BulkJobRequestInfo bulk_info = 16;
 }
 
 // Job contains all the data from the original request plus the job ID and
@@ -150,7 +158,7 @@ message Job {
         // When all worker node(s) have accepted the job's work requests, but may be waiting on
         // an available worker goroutine to pickup the request.
         SCHEDULED = 3;
-        // When all work requests for this job are in progress.
+        // When any work requests for this job are in progress.
         RUNNING = 4;
         // TODO: https://github.com/ThinkParQ/bee-remote/issues/16
         // A user manually requested the job be paused.

cpp/beeremote.pb.h

@@ -3,6 +3,7 @@ syntax = "proto3";
 package flex;
 option go_package = "github.com/thinkparq/protobuf/go/flex";
 
+import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
 
 // A WorkerNode is able to handle one or more types of work requests.
@@ -180,6 +181,34 @@ message WorkRequest {
     optional RestorePolicy restore_policy = 13;
     // Time in seconds to wait after a file is closed before replication begins.
     optional uint32 cooldown_secs = 14;
+    // A work request scheduled for a future time is placed in the wait queue until it's expired.
+    google.protobuf.Timestamp execute_after = 15;
+    // delay_execution specifies a delay before execution. The executing node converts it to
+    // execute_after using its local time to avoid clock synchronization issues.
+    google.protobuf.Duration delay_execution = 16;
+    // bulk_info is optionally set when this work request belongs to a provider-controlled bulk
+    // operation. It carries builder-maintained metadata used to correlate the request with the
+    // provider's bulk operation and track its state within that operation.
+    optional BulkJobRequestInfo bulk_info = 17;
+}
+
+// BulkJobRequestInfo contains builder-maintained metadata for requests that participate in a
+// provider controlled bulk operation.
+message BulkJobRequestInfo {
+    // Builder-maintained in-mount path for provider bulk-operation state.
+    string state_mount_path = 1;
+    // Provider-defined bulk operation identifier for this request.
+    string operation = 2;
+    // Zero-based request index within the bulk operation.
+    int64 job_index = 3;
+}
+
+message BulkOperation {
+    string state_mount_path = 1;
+    uint32 rst_id = 2;
+    string operation = 3;
+    int64 next_job_index = 4;
+    optional string errors = 5;
 }
 
 // JobBuilderJob is a special type of job that creates job requests of any time.
@@ -189,6 +218,11 @@ message BuilderJob {
     int32 submitted = 2;
     // Stores the number of failed job requests.
     int32 errors = 3;
+    // Stores the number of jobs that were not created due to another job or process holding the
+    // file access lock.
+    int32 conflicts = 5;
+    // Any bulk operations that are started.
+    repeated BulkOperation bulk_operations = 4;
 }
 
 message MockJob {
@@ -316,9 +350,15 @@ message Work {
         // the ETag in that it is an application layer integrity check of the part's content.
         string checksum_sha256 = 5;
         bool completed = 6;
+        optional bool started = 7;
     }
     // Indicates whether the work is a job builder task.
     bool job_builder = 6;
+    optional JobBuilderInfo job_builder_info = 7;
+    message JobBuilderInfo {
+        // Any bulk operations that were started.
+        repeated BulkOperation bulk_operations = 1;
+    }
 }
 
 // We use a common configuration update request/response types for all worker
@@ -410,6 +450,7 @@ message RemoteStorageTarget {
         POSIX posix = 5;
         Azure azure = 6;
         string mock = 7;
+        XtreemStore xtreemstore = 8;
     }
 
     // The S3 type uses the AWS S3 SDK under the hood. To support non-AWS S3
@@ -462,6 +503,10 @@ message RemoteStorageTarget {
         S3 s3 = 1;
         string account = 2;
     }
+
+    message XtreemStore {
+        S3 s3 = 1;
+    }
 
     message POSIX {
         string path = 1;