scheduling frontend

packages/api-client/lib/version.ts

@@ -3,6 +3,6 @@ import { version as rmfModelVer } from 'rmf-models';
 
 export const version = {
   rmfModels: rmfModelVer,
-  rmfServer: '796aa7a6b92f0df4ec0872dc71df915c3a58a0d3',
+  rmfServer: '8a2a35c3b36709e67dc704d0e2f890e2b0d6865b',
   openapiGenerator: '6.2.1',
 };

packages/api-client/schema/index.ts

@@ -380,25 +380,26 @@ export default {
             in: 'query',
           },
           {
+            description: 'defaults to 100',
             required: false,
             schema: {
               title: 'Limit',
-              maximum: 1000000.0,
+              maximum: 1000.0,
               exclusiveMinimum: 0.0,
               type: 'integer',
-              default: 1000000,
+              description: 'defaults to 100',
             },
             name: 'limit',
             in: 'query',
           },
           {
+            description: 'defaults to 0',
             required: false,
             schema: {
               title: 'Offset',
-              maximum: 1000000.0,
               minimum: 0.0,
               type: 'integer',
-              default: 0,
+              description: 'defaults to 0',
             },
             name: 'offset',
             in: 'query',
@@ -834,6 +835,186 @@ export default {
         },
       },
     },
+    '/scheduled_tasks': {
+      get: {
+        tags: ['Tasks'],
+        summary: 'Get Scheduled Tasks',
+        operationId: 'get_scheduled_tasks_scheduled_tasks_get',
+        parameters: [
+          {
+            description: 'Only return scheduled tasks that start before given timestamp',
+            required: true,
+            schema: {
+              title: 'Start Before',
+              type: 'string',
+              description: 'Only return scheduled tasks that start before given timestamp',
+              format: 'date-time',
+            },
+            name: 'start_before',
+            in: 'query',
+          },
+          {
+            description: 'Only return scheduled tasks that stop after given timestamp',
+            required: true,
+            schema: {
+              title: 'Until After',
+              type: 'string',
+              description: 'Only return scheduled tasks that stop after given timestamp',
+              format: 'date-time',
+            },
+            name: 'until_after',
+            in: 'query',
+          },
+          {
+            description: 'defaults to 100',
+            required: false,
+            schema: {
+              title: 'Limit',
+              maximum: 1000.0,
+              exclusiveMinimum: 0.0,
+              type: 'integer',
+              description: 'defaults to 100',
+            },
+            name: 'limit',
+            in: 'query',
+          },
+          {
+            description: 'defaults to 0',
+            required: false,
+            schema: {
+              title: 'Offset',
+              minimum: 0.0,
+              type: 'integer',
+              description: 'defaults to 0',
+            },
+            name: 'offset',
+            in: 'query',
+          },
+          {
+            description:
+              "common separated list of fields to order by, prefix with '-' to sort descendingly.",
+            required: false,
+            schema: {
+              title: 'Order By',
+              type: 'string',
+              description:
+                "common separated list of fields to order by, prefix with '-' to sort descendingly.",
+            },
+            name: 'order_by',
+            in: 'query',
+          },
+        ],
+        responses: {
+          '200': {
+            description: 'Successful Response',
+            content: {
+              'application/json': {
+                schema: {
+                  $ref: '#/components/schemas/api_server.models.tortoise_models.scheduled_task.ScheduledTask_list',
+                },
+              },
+            },
+          },
+          '422': {
+            description: 'Validation Error',
+            content: {
+              'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } },
+            },
+          },
+        },
+      },
+      post: {
+        tags: ['Tasks'],
+        summary: 'Post Scheduled Task',
+        description:
+          'Create a scheduled task. Below are some examples of how the schedules are represented.\nFor more examples, check the docs of the underlying library used [here](https://github.com/dbader/schedule/blob/6eb0b5346b1ce35ece5050e65789fa6e44368175/docs/examples.rst).\n\n| every | to | period | at | description |\n| - | - | - | - | - |\n| 10 | - | minutes | - | Every 10 minutes |\n| - | - | hour | - | Every hour |\n| - | - | day | 10:30 | Every day at 10:30am |\n| - | - | monday | - | Every monday |\n| - | - | wednesday | 13:15 | Every wednesday at 01:15pm |\n| - | - | minute | :17 | Every 17th sec of a mintue |\n| 5 | 10 | seconds | - | Every 5-10 seconds (randomly) |',
+        operationId: 'post_scheduled_task_scheduled_tasks_post',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: { $ref: '#/components/schemas/PostScheduledTaskRequest' },
+            },
+          },
+          required: true,
+        },
+        responses: {
+          '201': {
+            description: 'Successful Response',
+            content: {
+              'application/json': {
+                schema: {
+                  $ref: '#/components/schemas/api_server.models.tortoise_models.scheduled_task.ScheduledTask',
+                },
+              },
+            },
+          },
+          '422': {
+            description: 'Validation Error',
+            content: {
+              'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } },
+            },
+          },
+        },
+      },
+    },
+    '/scheduled_tasks/{task_id}': {
+      get: {
+        tags: ['Tasks'],
+        summary: 'Get Scheduled Task',
+        operationId: 'get_scheduled_task_scheduled_tasks__task_id__get',
+        parameters: [
+          {
+            required: true,
+            schema: { title: 'Task Id', type: 'integer' },
+            name: 'task_id',
+            in: 'path',
+          },
+        ],
+        responses: {
+          '200': {
+            description: 'Successful Response',
+            content: {
+              'application/json': {
+                schema: {
+                  $ref: '#/components/schemas/api_server.models.tortoise_models.scheduled_task.ScheduledTask',
+                },
+              },
+            },
+          },
+          '422': {
+            description: 'Validation Error',
+            content: {
+              'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } },
+            },
+          },
+        },
+      },
+      delete: {
+        tags: ['Tasks'],
+        summary: 'Del Scheduled Tasks',
+        operationId: 'del_scheduled_tasks_scheduled_tasks__task_id__delete',
+        parameters: [
+          {
+            required: true,
+            schema: { title: 'Task Id', type: 'integer' },
+            name: 'task_id',
+            in: 'path',
+          },
+        ],
+        responses: {
+          '200': {
+            description: 'Successful Response',
+            content: { 'application/json': { schema: {} } },
+          },
+          '422': {
+            description: 'Validation Error',
+            content: {
+              'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } },
+            },
+          },
+        },
+      },
+    },
     '/favorite_tasks': {
       get: {
         tags: ['Tasks'],
@@ -1173,25 +1354,26 @@ export default {
             in: 'query',
           },
           {
+            description: 'defaults to 100',
             required: false,
             schema: {
               title: 'Limit',
-              maximum: 1000000.0,
+              maximum: 1000.0,
               exclusiveMinimum: 0.0,
               type: 'integer',
-              default: 1000000,
+              description: 'defaults to 100',
             },
             name: 'limit',
             in: 'query',
           },
           {
+            description: 'defaults to 0',
             required: false,
             schema: {
               title: 'Offset',
-              maximum: 1000000.0,
               minimum: 0.0,
               type: 'integer',
-              default: 0,
+              description: 'defaults to 0',
             },
             name: 'offset',
             in: 'query',
@@ -2480,6 +2662,21 @@ export default {
         type: 'object',
         properties: { name: { title: 'Name', type: 'string' } },
       },
+      PostScheduledTaskRequest: {
+        title: 'PostScheduledTaskRequest',
+        required: ['task_request', 'schedules'],
+        type: 'object',
+        properties: {
+          task_request: { $ref: '#/components/schemas/TaskRequest' },
+          schedules: {
+            title: 'Schedules',
+            type: 'array',
+            items: {
+              $ref: '#/components/schemas/api_server.models.tortoise_models.scheduled_task.ScheduledTaskSchedule.leaf',
+            },
+          },
+        },
+      },
       PostUsers: {
         title: 'PostUsers',
         required: ['username'],
@@ -3163,6 +3360,59 @@ export default {
           type: { title: 'Error Type', type: 'string' },
         },
       },
+      'api_server.models.tortoise_models.scheduled_task.ScheduledTask': {
+        title: 'ScheduledTask',
+        required: ['id', 'created_by', 'schedules'],
+        type: 'object',
+        properties: {
+          id: { title: 'Id', maximum: 2147483647.0, minimum: 1.0, type: 'integer' },
+          task_request: { title: 'Task Request' },
+          created_by: { title: 'Created By', maxLength: 255, type: 'string' },
+          last_ran: { title: 'Last Ran', type: 'string', format: 'date-time', nullable: true },
+          schedules: {
+            title: 'Schedules',
+            type: 'array',
+            items: {
+              $ref: '#/components/schemas/api_server.models.tortoise_models.scheduled_task.ScheduledTaskSchedule.leaf',
+            },
+          },
+        },
+        additionalProperties: false,
+      },
+      'api_server.models.tortoise_models.scheduled_task.ScheduledTaskSchedule.leaf': {
+        title: 'ScheduledTaskSchedule',
+        required: ['period'],
+        type: 'object',
+        properties: {
+          every: {
+            title: 'Every',
+            maximum: 32767.0,
+            minimum: -32768.0,
+            type: 'integer',
+            nullable: true,
+          },
+          start_from: { title: 'Start From', type: 'string', format: 'date-time', nullable: true },
+          until: { title: 'Until', type: 'string', format: 'date-time', nullable: true },
+          period: {
+            title: 'Period',
+            maxLength: 9,
+            type: 'string',
+            description:
+              'Monday: monday<br/>Tuesday: tuesday<br/>Wednesday: wednesday<br/>Thursday: thursday<br/>Friday: friday<br/>Saturday: saturday<br/>Sunday: sunday<br/>Day: day<br/>Hour: hour<br/>Minute: minute',
+          },
+          at: { title: 'At', maxLength: 255, type: 'string', nullable: true },
+        },
+        additionalProperties: false,
+        description:
+          'The schedules for a scheduled task request.<br/>A scheduled task may have multiple schedules.',
+      },
+      'api_server.models.tortoise_models.scheduled_task.ScheduledTask_list': {
+        title: 'ScheduledTask_list',
+        type: 'array',
+        items: {
+          $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'],

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

@@ -4,7 +4,10 @@
 
 import schedule
 from schedule import Job
-from tortoise.contrib.pydantic.creator import pydantic_model_creator
+from tortoise.contrib.pydantic.creator import (
+    pydantic_model_creator,
+    pydantic_queryset_creator,
+)
 from tortoise.fields import (
     CharEnumField,
     CharField,
@@ -24,7 +27,6 @@ class ScheduledTask(Model):
     created_by = CharField(255)
     schedules: ReverseRelation["ScheduledTaskSchedule"]
     last_ran: Optional[datetime] = DatetimeField(null=True)
-    next_run: Optional[datetime] = DatetimeField(null=True)
 
 
 class ScheduledTaskSchedule(Model):
@@ -50,7 +52,8 @@ class Period(str, Enum):
         "models.ScheduledTask", related_name="schedules"
     )
     every = SmallIntField(null=True)
-    to = SmallIntField(null=True)
+    start_from = DatetimeField(null=True)
+    until = DatetimeField(null=True)
     period = CharEnumField(Period)
     at = CharField(255, null=True)
 
@@ -59,8 +62,9 @@ def to_job(self) -> Job:
             job = schedule.every(self.every)
         else:
             job = schedule.every()
-        if self.to is not None:
-            job = job.to(self.to)
+        if self.until is not None:
+            # schedule uses `datetime.now()`, which is tz naive
+            job = job.until(datetime.fromtimestamp(self.until.timestamp()))
 
         if self.period in (
             ScheduledTaskSchedule.Period.Monday,
@@ -88,5 +92,11 @@ def to_job(self) -> Job:
         return job
 
 
+from tortoise import Tortoise
+
+Tortoise.init_models(["api_server.models.tortoise_models.scheduled_task"], "models")
 ScheduledTaskPydantic = pydantic_model_creator(ScheduledTask)
-ScheduledTaskSchedulePydantic = pydantic_model_creator(ScheduledTaskSchedule)
+ScheduledTaskPydanticList = pydantic_queryset_creator(ScheduledTask)
+ScheduledTaskSchedulePydantic = pydantic_model_creator(
+    ScheduledTaskSchedule, exclude=("scheduled_task",)
+)