Creation of e2e test for favorite tasks

.github/actions/bootstrap/action.yml

@@ -13,7 +13,7 @@ runs:
   steps:
     - uses: pnpm/[email protected]
       with:
-        version: '8.6.12'
+        version: 'latest'
     - uses: actions/setup-node@v2
       with:
         node-version: '16'

.github/workflows/dashboard.yml

@@ -31,6 +31,8 @@ jobs:
       - name: setup python
         run: apt update && apt install -y python3-venv python-is-python3
       - name: bootstrap
+        env:
+          NODE_OPTIONS: '--max_old_space_size=4096'
         uses: ./.github/actions/bootstrap
         with:
           package: rmf-dashboard

.prettierignore

@@ -0,0 +1,2 @@
+packages/api-server/api_server/static/
+

packages/api-client/lib/openapi/api.ts

@@ -8431,6 +8431,69 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
         ...options.headers,
       };
 
+      return {
+        url: toPathString(localVarUrlObj),
+        options: localVarRequestOptions,
+      };
+    },
+    /**
+     *
+     * @summary Update Schedule Task
+     * @param {number} taskId
+     * @param {PostScheduledTaskRequest} postScheduledTaskRequest
+     * @param {string} [exceptDate]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateScheduleTaskScheduledTasksTaskIdUpdatePost: async (
+      taskId: number,
+      postScheduledTaskRequest: PostScheduledTaskRequest,
+      exceptDate?: string,
+      options: AxiosRequestConfig = {},
+    ): Promise<RequestArgs> => {
+      // verify required parameter 'taskId' is not null or undefined
+      assertParamExists('updateScheduleTaskScheduledTasksTaskIdUpdatePost', 'taskId', taskId);
+      // verify required parameter 'postScheduledTaskRequest' is not null or undefined
+      assertParamExists(
+        'updateScheduleTaskScheduledTasksTaskIdUpdatePost',
+        'postScheduledTaskRequest',
+        postScheduledTaskRequest,
+      );
+      const localVarPath = `/scheduled_tasks/{task_id}/update`.replace(
+        `{${'task_id'}}`,
+        encodeURIComponent(String(taskId)),
+      );
+      // use dummy base URL string because the URL constructor only accepts absolute URLs.
+      const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+      let baseOptions;
+      if (configuration) {
+        baseOptions = configuration.baseOptions;
+      }
+
+      const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
+      const localVarHeaderParameter = {} as any;
+      const localVarQueryParameter = {} as any;
+
+      if (exceptDate !== undefined) {
+        localVarQueryParameter['except_date'] =
+          (exceptDate as any) instanceof Date ? (exceptDate as any).toISOString() : exceptDate;
+      }
+
+      localVarHeaderParameter['Content-Type'] = 'application/json';
+
+      setSearchParams(localVarUrlObj, localVarQueryParameter);
+      let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+      localVarRequestOptions.headers = {
+        ...localVarHeaderParameter,
+        ...headersFromBaseOptions,
+        ...options.headers,
+      };
+      localVarRequestOptions.data = serializeDataIfNeeded(
+        postScheduledTaskRequest,
+        localVarRequestOptions,
+        configuration,
+      );
+
       return {
         url: toPathString(localVarUrlObj),
         options: localVarRequestOptions,
@@ -8891,6 +8954,35 @@ export const TasksApiFp = function (configuration?: Configuration) {
       );
       return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
     },
+    /**
+     *
+     * @summary Update Schedule Task
+     * @param {number} taskId
+     * @param {PostScheduledTaskRequest} postScheduledTaskRequest
+     * @param {string} [exceptDate]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    async updateScheduleTaskScheduledTasksTaskIdUpdatePost(
+      taskId: number,
+      postScheduledTaskRequest: PostScheduledTaskRequest,
+      exceptDate?: string,
+      options?: AxiosRequestConfig,
+    ): Promise<
+      (
+        axios?: AxiosInstance,
+        basePath?: string,
+      ) => AxiosPromise<ApiServerModelsTortoiseModelsScheduledTaskScheduledTask>
+    > {
+      const localVarAxiosArgs =
+        await localVarAxiosParamCreator.updateScheduleTaskScheduledTasksTaskIdUpdatePost(
+          taskId,
+          postScheduledTaskRequest,
+          exceptDate,
+          options,
+        );
+      return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+    },
   };
 };
 
@@ -9271,6 +9363,30 @@ export const TasksApiFactory = function (
         )
         .then((request) => request(axios, basePath));
     },
+    /**
+     *
+     * @summary Update Schedule Task
+     * @param {number} taskId
+     * @param {PostScheduledTaskRequest} postScheduledTaskRequest
+     * @param {string} [exceptDate]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateScheduleTaskScheduledTasksTaskIdUpdatePost(
+      taskId: number,
+      postScheduledTaskRequest: PostScheduledTaskRequest,
+      exceptDate?: string,
+      options?: any,
+    ): AxiosPromise<ApiServerModelsTortoiseModelsScheduledTaskScheduledTask> {
+      return localVarFp
+        .updateScheduleTaskScheduledTasksTaskIdUpdatePost(
+          taskId,
+          postScheduledTaskRequest,
+          exceptDate,
+          options,
+        )
+        .then((request) => request(axios, basePath));
+    },
   };
 };
 
@@ -9680,4 +9796,30 @@ export class TasksApi extends BaseAPI {
       )
       .then((request) => request(this.axios, this.basePath));
   }
+
+  /**
+   *
+   * @summary Update Schedule Task
+   * @param {number} taskId
+   * @param {PostScheduledTaskRequest} postScheduledTaskRequest
+   * @param {string} [exceptDate]
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof TasksApi
+   */
+  public updateScheduleTaskScheduledTasksTaskIdUpdatePost(
+    taskId: number,
+    postScheduledTaskRequest: PostScheduledTaskRequest,
+    exceptDate?: string,
+    options?: AxiosRequestConfig,
+  ) {
+    return TasksApiFp(this.configuration)
+      .updateScheduleTaskScheduledTasksTaskIdUpdatePost(
+        taskId,
+        postScheduledTaskRequest,
+        exceptDate,
+        options,
+      )
+      .then((request) => request(this.axios, this.basePath));
+  }
 }

packages/api-client/lib/version.ts

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

packages/api-client/schema/index.ts

@@ -1283,6 +1283,53 @@ export default {
         },
       },
     },
+    '/scheduled_tasks/{task_id}/update': {
+      post: {
+        tags: ['Tasks'],
+        summary: 'Update Schedule Task',
+        operationId: 'update_schedule_task_scheduled_tasks__task_id__update_post',
+        parameters: [
+          {
+            required: true,
+            schema: { title: 'Task Id', type: 'integer' },
+            name: 'task_id',
+            in: 'path',
+          },
+          {
+            required: false,
+            schema: { title: 'Except Date', type: 'string', format: 'date-time' },
+            name: 'except_date',
+            in: 'query',
+          },
+        ],
+        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' } },
+            },
+          },
+        },
+      },
+    },
     '/favorite_tasks': {
       get: {
         tags: ['Tasks'],

packages/api-server/api_server/app.py

@@ -7,6 +7,11 @@
 import schedule
 from fastapi import Depends
 from fastapi.middleware.cors import CORSMiddleware
+from fastapi.openapi.docs import (
+    get_redoc_html,
+    get_swagger_ui_html,
+    get_swagger_ui_oauth2_redirect_html,
+)
 from fastapi.staticfiles import StaticFiles
 from tortoise import Tortoise
 
@@ -27,7 +32,7 @@
     User,
 )
 from .models import tortoise_models as ttm
-from .repositories import StaticFilesRepository, TaskRepository
+from .repositories import TaskRepository
 from .rmf_io import HealthWatchdog, RmfBookKeeper, rmf_events
 from .types import is_coroutine
 
@@ -46,7 +51,12 @@ async def on_sio_connect(sid: str, _environ: dict, auth: Optional[dict] = None):
         return False
 
 
-app = FastIO(title="RMF API Server", socketio_connect=on_sio_connect)
+app = FastIO(
+    title="RMF API Server",
+    socketio_connect=on_sio_connect,
+    docs_url=None,
+    redoc_url=None,
+)
 
 
 app.add_middleware(
@@ -56,22 +66,25 @@ async def on_sio_connect(sid: str, _environ: dict, auth: Optional[dict] = None):
     allow_methods=["*"],
     allow_headers=["*"],
 )
-os.makedirs(app_config.static_directory, exist_ok=True)
+
 app.mount(
     "/static",
-    StaticFiles(directory=app_config.static_directory),
+    StaticFiles(
+        directory=os.path.join(os.path.dirname(os.path.abspath(__file__)), "static")
+    ),
     name="static",
 )
 
+os.makedirs(app_config.cache_directory, exist_ok=True)
+app.mount(
+    "/cache",
+    StaticFiles(directory=app_config.cache_directory),
+    name="cache",
+)
+
 # will be called in reverse order on app shutdown
 shutdown_cbs: List[Union[Coroutine[Any, Any, Any], Callable[[], None]]] = []
 
-static_files_repo = StaticFilesRepository(
-    f"{app_config.public_url.geturl()}/static",
-    app_config.static_directory,
-    logger.getChild("static_files"),
-)
-
 rmf_bookkeeper = RmfBookKeeper(rmf_events, logger=logger.getChild("BookKeeper"))
 
 app.include_router(routes.main_router)
@@ -202,6 +215,33 @@ async def on_shutdown():
     logger.info("shutdown app")
 
 
+@app.get("/docs", include_in_schema=False)
+async def custom_swagger_ui_html():
+    openapi_url = app.openapi_url if app.openapi_url is not None else "/openapi.json"
+    return get_swagger_ui_html(
+        openapi_url=openapi_url,
+        title=app.title + " - Swagger UI",
+        oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url,
+        swagger_js_url="/static/swagger-ui-bundle.js",
+        swagger_css_url="/static/swagger-ui.css",
+    )
+
+
+@app.get(app.swagger_ui_oauth2_redirect_url, include_in_schema=False)
+async def swagger_ui_redirect():
+    return get_swagger_ui_oauth2_redirect_html()
+
+
+@app.get("/redoc", include_in_schema=False)
+async def redoc_html():
+    openapi_url = app.openapi_url if app.openapi_url is not None else "/openapi.json"
+    return get_redoc_html(
+        openapi_url=openapi_url,
+        title=app.title + " - ReDoc",
+        redoc_js_url="/static/redoc.standalone.js",
+    )
+
+
 async def _spin_scheduler():
     while True:
         schedule.run_pending()

packages/api-server/api_server/app_config.py

@@ -13,7 +13,7 @@ class AppConfig:
     port: int
     db_url: str
     public_url: urllib.parse.ParseResult
-    static_directory: str
+    cache_directory: str
     log_level: str
     builtin_admin: str
     jwt_public_key: Optional[str]

packages/api-server/api_server/default_config.py

@@ -10,7 +10,7 @@
     # When being a proxy, this must be the url that rmf-server is mounted on.
     # E.g. https://example.com/rmf/api/v1
     "public_url": "http://localhost:8000",
-    "static_directory": "static",  # The directory where static files should be stored.
+    "cache_directory": "run/cache",  # The directory where cached files should be stored.
     "log_level": "WARNING",  # https://docs.python.org/3.8/library/logging.html#levels
     # a user that is automatically given admin privileges, note that this does not guarantee that the user exists in the identity provider.
     "builtin_admin": "admin",

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

@@ -154,6 +154,8 @@ def __init__(
         **kwargs,
     ):
         super().__init__(*args, **kwargs)
+        if self.swagger_ui_oauth2_redirect_url is None:
+            self.swagger_ui_oauth2_redirect_url = "docs/oauth2-redirect"
         self.sio = socketio.AsyncServer(
             async_mode="asgi", cors_allowed_origins=[], serializer=FastIOPacket
         )