Move end_time to RecurrenceRule and add duration field (#78)

Fixes #71

Author: stefan-brus-frequenz

RELEASE_NOTES.md

@@ -2,17 +2,16 @@
 
 ## Summary
 
-This release is mainly about updating the names of some objects, and improving documentation.
+- End time has been moved to the recurrence rule object, replaced by `duration` on the base dispatch object.
 
 ## Upgrading
 
-- Service and its methods have been renamed to `MicrogridDispatchService`
-- `DispatchComponentSelector` has been renamed to `ComponentSelector`
-- `DispatchComponentIDs` has been renamed to `ComponentIDs`
+- Queries that compare against a time interval filter should check for the end time inside the recurrence rule.
+- `end_time` has been renamed `until` and is mutually exclusive with `count`.
 
 ## New Features
 
-- `DispatchFilter` now supports filtering by `is_active` and `is_dry_run`
+- Introduced a new field `duration`.
 
 ## Bug Fixes
 

proto/frequenz/api/dispatch/v1/dispatch.proto

@@ -92,8 +92,8 @@ message Dispatch {
   // The start time in UTC
   google.protobuf.Timestamp start_time = 6;
 
-  // The end time in UTC
-  google.protobuf.Timestamp end_time = 7;
+  // Duration in seconds
+  uint32 duration = 7;
 
   // The component selector
   ComponentSelector selector = 8;
@@ -129,10 +129,10 @@ message TimeIntervalFilter {
   // Filter by start_time < this timestamp
   google.protobuf.Timestamp start_to = 2;
 
-  // Filter by end_time >= this timestamp
+  // Filter by recurrence.end_time >= this timestamp
   google.protobuf.Timestamp end_from = 3;
 
-  // Filter by end_time < this timestamp
+  // Filter by recurrence.end_time < this timestamp
   google.protobuf.Timestamp end_to = 4;
 }
 
@@ -219,6 +219,19 @@ message RecurrenceRule {
     FREQUENCY_MONTHLY = 5;
   }
 
+  // Controls when a recurring dispatch should end
+  message EndCriteria {
+    oneof count_or_until {
+      // The number of times this dispatch should recur.
+      // If this field is set, the dispatch will recur the given number of times.
+      uint32 count = 1;
+
+      // The end time of this dispatch in UTC.
+      // If this field is set, the dispatch will recur until the given timestamp.
+      google.protobuf.Timestamp until = 2;
+    }
+  }
+
   // The frequency specifier of this recurring dispatch
   Frequency freq = 1;
 
@@ -229,9 +242,10 @@ message RecurrenceRule {
   //   interval = 2
   uint32 interval = 2;
 
-  // (Optional) limit the number of occurences
-  // If this field is not set, the dispatch will recur indefinitely
-  optional uint32 count = 3;
+  // When this dispatch should end.
+  // A dispatch can either recur a fixed number of times, or until a given timestamp.
+  // If this field is not set, the dispatch will recur indefinitely.bool
+  EndCriteria end_criteria = 3;
 
   // On which minute(s) of the hour does the event occur
   repeated uint32 byminutes = 4;
@@ -297,8 +311,8 @@ message DispatchCreateRequest {
   // Timestamps earlier than the current time are not allowed.
   google.protobuf.Timestamp start_time = 3;
 
-  // The end time
-  google.protobuf.Timestamp end_time = 4;
+  // Duration in seconds
+  uint32 duration = 4;
 
   // The component selector
   ComponentSelector selector = 5;
@@ -327,8 +341,8 @@ message DispatchUpdateRequest {
   // Timestamps earlier than the current time are not allowed.
   google.protobuf.Timestamp start_time = 2;
 
-  // The end time
-  google.protobuf.Timestamp end_time = 3;
+  // Duration in seconds
+  optional uint32 duration = 3;
 
   // The component selector
   ComponentSelector selector = 4;