Use task request labels to encode information required by dashboard

packages/api-client/lib/version.ts

@@ -3,6 +3,6 @@ import { version as rmfModelVer } from 'rmf-models';
 
 export const version = {
   rmfModels: rmfModelVer,
-  rmfServer: 'fd45675f94b75df6845303db4f45276d0998f3e6',
+  rmfServer: '98741b14ceca74208ca98e4bb0c3ca9e41ca1e3c',
   openapiGenerator: '6.2.1',
 };

packages/api-client/schema/index.ts

@@ -917,6 +917,36 @@ export default {
         },
       },
     },
+    '/tasks/{task_id}/booking_label': {
+      get: {
+        tags: ['Tasks'],
+        summary: 'Get Task Booking Label',
+        operationId: 'get_task_booking_label_tasks__task_id__booking_label_get',
+        parameters: [
+          {
+            description: 'task_id',
+            required: true,
+            schema: { title: 'Task Id', type: 'string', description: 'task_id' },
+            name: 'task_id',
+            in: 'path',
+          },
+        ],
+        responses: {
+          '200': {
+            description: 'Successful Response',
+            content: {
+              'application/json': { schema: { $ref: '#/components/schemas/TaskBookingLabel' } },
+            },
+          },
+          '422': {
+            description: 'Validation Error',
+            content: {
+              'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } },
+            },
+          },
+        },
+      },
+    },
     '/tasks/{task_id}/log': {
       get: {
         tags: ['Tasks'],
@@ -1556,7 +1586,7 @@ export default {
                 schema: {
                   title: 'Response Get Favorites Tasks Favorite Tasks Get',
                   type: 'array',
-                  items: { $ref: '#/components/schemas/TaskFavoritePydantic' },
+                  items: { $ref: '#/components/schemas/TaskFavorite' },
                 },
               },
             },
@@ -1569,20 +1599,14 @@ export default {
         operationId: 'post_favorite_task_favorite_tasks_post',
         requestBody: {
           content: {
-            'application/json': { schema: { $ref: '#/components/schemas/TaskFavoritePydantic' } },
+            'application/json': { schema: { $ref: '#/components/schemas/TaskFavorite' } },
           },
           required: true,
         },
         responses: {
           '200': {
             description: 'Successful Response',
-            content: {
-              'application/json': {
-                schema: {
-                  $ref: '#/components/schemas/api_server.models.tortoise_models.tasks.TaskFavorite.leaf',
-                },
-              },
-            },
+            content: { 'application/json': { schema: {} } },
           },
           '422': {
             description: 'Validation Error',
@@ -3647,6 +3671,28 @@ export default {
           },
         },
       },
+      TaskBookingLabel: {
+        title: 'TaskBookingLabel',
+        required: ['description'],
+        type: 'object',
+        properties: { description: { $ref: '#/components/schemas/TaskBookingLabelDescription' } },
+        description:
+          'This label is to be populated by any frontend during a task dispatch, by\nbeing added to TaskRequest.labels, which in turn populates\nTaskState.booking.labels, and can be used to display relevant information\nneeded for any frontends.',
+      },
+      TaskBookingLabelDescription: {
+        title: 'TaskBookingLabelDescription',
+        required: ['task_definition_id'],
+        type: 'object',
+        properties: {
+          task_definition_id: { title: 'Task Definition Id', type: 'string' },
+          unix_millis_warn_time: { title: 'Unix Millis Warn Time', type: 'integer' },
+          pickup: { title: 'Pickup', type: 'string' },
+          destination: { title: 'Destination', type: 'string' },
+          cart_id: { title: 'Cart Id', type: 'string' },
+        },
+        description:
+          'This description holds several fields that could be useful for frontend\ndashboards when dispatching a task, to then be identified or rendered\naccordingly back on the same frontend.',
+      },
       TaskCancelResponse: {
         title: 'TaskCancelResponse',
         allOf: [{ $ref: '#/components/schemas/SimpleResponse' }],
@@ -3730,9 +3776,16 @@ export default {
         },
         additionalProperties: false,
       },
-      TaskFavoritePydantic: {
-        title: 'TaskFavoritePydantic',
-        required: ['id', 'name', 'unix_millis_earliest_start_time', 'category', 'user'],
+      TaskFavorite: {
+        title: 'TaskFavorite',
+        required: [
+          'id',
+          'name',
+          'unix_millis_earliest_start_time',
+          'category',
+          'user',
+          'task_definition_id',
+        ],
         type: 'object',
         properties: {
           id: { title: 'Id', type: 'string' },
@@ -3745,6 +3798,7 @@ export default {
           category: { title: 'Category', type: 'string' },
           description: { title: 'Description', type: 'object' },
           user: { title: 'User', type: 'string' },
+          task_definition_id: { title: 'Task Definition Id', type: 'string' },
         },
       },
       TaskInterruptionRequest: {
@@ -4259,26 +4313,6 @@ export default {
           $ref: '#/components/schemas/api_server.models.tortoise_models.scheduled_task.ScheduledTask',
         },
       },
-      'api_server.models.tortoise_models.tasks.TaskFavorite.leaf': {
-        title: 'TaskFavorite',
-        required: ['id', 'name', 'category', 'user'],
-        type: 'object',
-        properties: {
-          id: { title: 'Id', maxLength: 255, type: 'string' },
-          name: { title: 'Name', maxLength: 255, type: 'string' },
-          unix_millis_earliest_start_time: {
-            title: 'Unix Millis Earliest Start Time',
-            type: 'string',
-            format: 'date-time',
-            nullable: true,
-          },
-          priority: { title: 'Priority' },
-          category: { title: 'Category', maxLength: 255, type: 'string' },
-          description: { title: 'Description' },
-          user: { title: 'User', maxLength: 255, type: 'string' },
-        },
-        additionalProperties: false,
-      },
       api_server__models__delivery_alerts__DeliveryAlert__Category: {
         title: 'Category',
         enum: ['missing', 'wrong', 'obstructed', 'cancelled'],

packages/api-server/api_server/models/__init__.py

@@ -50,4 +50,6 @@
 from .rmf_api.task_state_update import TaskStateUpdate
 from .rmf_api.undo_skip_phase_request import UndoPhaseSkipRequest
 from .rmf_api.undo_skip_phase_response import UndoPhaseSkipResponse
+from .task_booking_label import *
+from .task_favorite import *
 from .user import *

packages/api-server/api_server/models/task_booking_label.py

@@ -0,0 +1,46 @@
+from typing import Optional
+
+import pydantic
+from pydantic import BaseModel
+
+# NOTE: This label model needs to exactly match the fields that are defined and
+# populated by the dashboard. Any changes to either side will require syncing.
+
+
+class TaskBookingLabelDescription(BaseModel):
+    """
+    This description holds several fields that could be useful for frontend
+    dashboards when dispatching a task, to then be identified or rendered
+    accordingly back on the same frontend.
+    """
+
+    task_definition_id: str
+    unix_millis_warn_time: Optional[int]
+    pickup: Optional[str]
+    destination: Optional[str]
+    cart_id: Optional[str]
+
+    @staticmethod
+    def from_json_string(json_str: str) -> Optional["TaskBookingLabelDescription"]:
+        try:
+            return TaskBookingLabelDescription.parse_raw(json_str)
+        except pydantic.error_wrappers.ValidationError:
+            return None
+
+
+class TaskBookingLabel(BaseModel):
+    """
+    This label is to be populated by any frontend during a task dispatch, by
+    being added to TaskRequest.labels, which in turn populates
+    TaskState.booking.labels, and can be used to display relevant information
+    needed for any frontends.
+    """
+
+    description: TaskBookingLabelDescription
+
+    @staticmethod
+    def from_json_string(json_str: str) -> Optional["TaskBookingLabel"]:
+        try:
+            return TaskBookingLabel.parse_raw(json_str)
+        except pydantic.error_wrappers.ValidationError:
+            return None

packages/api-server/api_server/models/task_favorite.py

@@ -0,0 +1,14 @@
+from typing import Dict
+
+from pydantic import BaseModel
+
+
+class TaskFavorite(BaseModel):
+    id: str
+    name: str
+    unix_millis_earliest_start_time: int
+    priority: Dict | None
+    category: str
+    description: Dict | None
+    user: str
+    task_definition_id: str

packages/api-server/api_server/models/tortoise_models/__init__.py

@@ -26,7 +26,6 @@
     TaskEventLogPhasesEventsLog,
     TaskEventLogPhasesLog,
     TaskFavorite,
-    TaskFavoritePydantic,
     TaskRequest,
     TaskState,
 )

packages/api-server/api_server/models/tortoise_models/tasks.py

@@ -1,4 +1,3 @@
-from tortoise.contrib.pydantic.creator import pydantic_model_creator
 from tortoise.fields import (
     CharField,
     DatetimeField,
@@ -80,6 +79,4 @@ class TaskFavorite(Model):
     category = CharField(255, null=False, index=True)
     description = JSONField()
     user = CharField(255, null=False, index=True)
-
-
-TaskFavoritePydantic = pydantic_model_creator(TaskFavorite)
+    task_definition_id = CharField(255, null=True, index=True)